Webhob REST API Tasks
From Yocto Project
Jump to navigationJump to search
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 | - | - | - |
[Object Root].list[].fields.disk_io | string array | - | YES | - | - | - |
[Object Root].list[].fields.elapsed_time | number representation of date | - | 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.message | string array | - | YES | - | - | - |
[Object Root].list[].fields.logfile | string array | - | YES | - | - | - |
[Object Root].list[].fields.work_directory | string array | - | YES | - | - | - |