Webhob REST API Tasks: Difference between revisions
From Yocto Project
Jump to navigationJump to search
No edit summary |
|||
| Line 45: | Line 45: | ||
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || - | | [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || - | ||
|- | |- | ||
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">build</span> || number || 2 || YES || - || - || -|- | | [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">build</span> || number || 2 || YES || - || - || - | ||
|- | |||
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">cpu_usage</span> || string || - || YES || - || The name of the build target(s) || - | | [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">cpu_usage</span> || string || - || YES || - || The name of the build target(s) || - | ||
|- | |- | ||
Revision as of 16:31, 29 July 2013
Endpoints
| Method | Endpoint | Body | Description | Comments |
|---|---|---|---|---|
| GET | /tasks | 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. | "<FIELD>:<ORDER_DIRECTION>" |
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[].model | string | - | YES | - | - | - |
| [Object Root].list[].fields | object | - | YES | - | - | - |
| [Object Root].list[].fields.build | number | 2 | YES | - | - | - |
| [Object Root].list[].fields.cpu_usage | string | - | YES | - | The name of the build target(s) | - |
| [Object Root].list[].fields.disk_io | string array | - | YES | - | The selected hardware | - |
| [Object Root].list[].fields.elapsed_time | number representation of date | - | YES | - | - | - |
| [Object Root].list[].fields.errors | number representation of date | - | YES | - | - | - |
| [Object Root].list[].fields.errors_no | number | - | YES | - | - | - |
| [Object Root].list[].fields.line_number | number | - | YES | - | - | - |
| [Object Root].list[].fields.log_file | string | - | YES | - | Path to log file | - |
| [Object Root].list[].fields.order | string array | - | YES | - | - | - |
| [Object Root].list[].fields.outcome | string array | - | YES | - | - | - |
| [Object Root].list[].fields.path_to_sstate_obj | string array | - | YES | - | - | - |
| [Object Root].list[].fields.py_stack_trace | string array | - | YES | - | - | - |
| [Object Root].list[].fields.script_type | string array | - | YES | - | - | - |
| [Object Root].list[].fields.source_url | string array | - | YES | - | - | - |
| [Object Root].list[].fields.sstate_checksum | string array | - | YES | - | - | - |
| [Object Root].list[].fields.sstate_result | string array | - | YES | - | - | - |
| [Object Root].list[].fields.task_executed | string array | - | YES | - | - | - |
| [Object Root].list[].fields.task_name | string array | - | YES | - | - | - |
| [Object Root].list[].fields.warning | string array | - | YES | - | - | - |
| [Object Root].list[].fields.warnings_no | string array | - | YES | - | - | - |
| [Object Root].list[].fields.work_directory | string array | - | YES | - | - | - |
