Webhob REST API Builds: Difference between revisions
From Yocto Project
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 51: | Line 51: | ||
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">machine</span> || string array || - || YES || - || The selected hardware || - | | [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">machine</span> || string array || - || YES || - || The selected hardware || - | ||
|- | |- | ||
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600"> | | [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">started_on</span> || number representation of date || - || YES || - || Marks the moment the process is started || - | ||
|- | |- | ||
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600"> | | [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">completed_on</span> || number representation of date || - || YES || - || Marks the moment the process is completed || - | ||
|- | |- | ||
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600"> | | [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">errors_no</span> || number || - || YES || - || Number of errors thrown by the build || - | ||
|- | |- | ||
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600"> | | [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">warnings_no</span> || number || - || YES || - || Number of warnings thrown by the build || - | ||
|- | |- | ||
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600"> | | [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">cooker_log_path</span> || string || - || YES || - || Path to log file || - | ||
|- | |- | ||
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600"> | | [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">image_fstypes</span> || string array || - || YES || - || The extensions of the root file systems produced by the build || - | ||
|} | |} | ||
Revision as of 10:41, 23 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 |
| search | string | Search string for all fields | - |
| filter | string | Consists of a string used to filter results | The general form: "<FIELD>:<VALUE>". |
| orderby | string | the name of the field that determens the soring of the resuls. | - |
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[].pk | number | - | YES | - | - | - |
| [Object Root].list[].string | number | - | YES | - | - | - |
| [Object Root].list[].fields | object | - | YES | - | - | - |
| [Object Root].list[].fields.outcome | number | 2 | YES | - | Signals successful or failed build | 0 - the build has failed, 1 - successful build |
| [Object Root].list[].fields.target | string | - | YES | - | The name of the build target(s) | - |
| [Object Root].list[].fields.machine | string array | - | YES | - | The selected hardware | - |
| [Object Root].list[].fields.started_on | number representation of date | - | YES | - | Marks the moment the process is started | - |
| [Object Root].list[].fields.completed_on | number representation of date | - | YES | - | Marks the moment the process is completed | - |
| [Object Root].list[].fields.errors_no | number | - | YES | - | Number of errors thrown by the build | - |
| [Object Root].list[].fields.warnings_no | number | - | YES | - | Number of warnings thrown by the build | - |
| [Object Root].list[].fields.cooker_log_path | string | - | YES | - | Path to log file | - |
| [Object Root].list[].fields.image_fstypes | string array | - | YES | - | The extensions of the root file systems produced by the build | - |
