List work order tasks
https://carchost.fieldcontrol.com.br/orders/{id}/tasksLists the tasks of a work order, with pagination, filters and sorting.
Requires the
X-Api-KeyandUser-Agentheaders. Limit: 1 request per second (learn more).
Request
Path parameters
idstringrequiredWork order identifier.
Example: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.
Query parameters
limitintegerNumber of items per page.
From 1 to 100.Default: 10.
offsetintegerNumber of items to skip.
From 0 to 200000.Default: 0.
qstringFilters in the field:value format, separated by spaces (how to filter). The accepted filters are in the table below.
Example: status:done.
| Filter | What it does |
|---|---|
status | Task status ( |
employee_id | Identifier of the employee in charge. |
archived |
|
created_at | Date equal to the given date (ISO 8601, UTC). |
created_at>= | Created on or after the given date. |
created_at<= | Created on or before the given date. |
created_at> | Created after the given date. |
created_at< | Created before the given date. |
updated_at | Date equal to the given date (ISO 8601, UTC). |
updated_at>= | Changed on or after the given date. |
updated_at<= | Changed on or before the given date. |
updated_at> | Changed after the given date. |
updated_at< | Changed before the given date. |
completed_at | Date equal to the given date (ISO 8601, UTC). |
completed_at>= | Completed on or after the given date. |
completed_at<= | Completed on or before the given date. |
completed_at> | Completed after the given date. |
completed_at< | Completed before the given date. |
scheduled_date | Date equal to the given date (ISO 8601, UTC). |
scheduled_date>= | Scheduled on or after the given date. |
scheduled_date<= | Scheduled on or before the given date. |
scheduled_date> | Scheduled after the given date. |
scheduled_date< | Scheduled before the given date. |
sortstringSorting. The - prefix reverses the order.
Accepted values: id, created_at, -created_at, updated_at, -updated_at, scheduled_date, -scheduled_date.Default: id.
Headers
User-AgentstringrequiredIdentification of your application.
Example: MinhaIntegracao/1.0.
Responses
- 200
List of tasks.
- 401
API key missing (
Missing API Key) or invalid (Invalid API Key). See Authentication. - 403
Account blocked (
Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication. - 404
Resource not found. The response body is empty.
- 422
Invalid filter, pagination or sorting (parametersValidationErr), or invalid order identifier (uriValidationErr).
- 429
Limit of 1 request per second exceeded. See Rate limit.
- 500
Unexpected server error.