Webhob REST API Builds: Difference between revisions
From Yocto Project
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 14: | Line 14: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Name !! Type !! Description !! Comments | ! Name !! Type !! Description !! Comments | ||
|- | |- | ||
| limit || number || The amout of builds to be displayed in one page || - | | limit || number || The amout of builds to be displayed in one page || - | ||
| Line 20: | Line 20: | ||
| offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id | | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id | ||
|- | |- | ||
| filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application. | | filter[searchString] || string || Consists of a string used to filter results || Generic parameter sent from front-end application. | ||
|- | |||
| filter[{FIELD_NAME}] || string || Reffers to the field that the retrieved date is orderd by || Possible values: ASC, DESC | |||
|} | |} | ||
Revision as of 13:17, 22 July 2013
Endpoints
| Method | Endpoint | Body | Description | Comments |
|---|---|---|---|---|
| GET | /builds | JSON | Returns page size limited and search criteria filtered amount of builds from the data base | - |
Parameters
| Name | Type | Description | Comments |
|---|---|---|---|
| limit | number | The amout of builds to be displayed in one page | - |
| offset | number | Represents the position of the first record in the page | If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id |
| filter[searchString] | string | Consists of a string used to filter results | Generic parameter sent from front-end application. |
| filter[{FIELD_NAME}] | string | Reffers to the field that the retrieved date is orderd by | Possible values: ASC, DESC |
Response
| Name | Type | Dimension | Required | Default value(s) | Description | Comments |
|---|---|---|---|---|---|---|
| [Object Root] | object | - | YES | - | - | - |
| [Object Root].count | number | - | YES | - | Total amount of builds to be displayed (according to filter parameter) | - |
| [Object Root].list | object array | - | YES | - | - | To describe a generic object element of the array, the refference to it's root is "list[]" |
| [Object Root].list[].outcome | number | 2 | YES | - | Signals successful or failed build | 0 - the build has failed, 1 - successful build |
| [Object Root].list[].target | string | - | YES | - | The name of the build target(s) | - |
| [Object Root].list[].machine | string array | - | YES | - | The selected hardware | - |
| [Object Root].list[].startedOn | number representation of date | - | YES | - | Marks the moment the process is started | - |
| [Object Root].list[].completedOn | number representation of date | - | YES | - | Marks the moment the process is completed | - |
| [Object Root].list[].errors | number | - | YES | - | Number of errors thrown by the build | - |
| [Object Root].list[].warnings | number | - | YES | - | Number of warnings thrown by the build | - |
| [Object Root].list[].log | string | - | YES | - | Path to log file | - |
| [Object Root].list[].output | string array | - | YES | - | The extensions of the root file systems produced by the build | - |
