Get all the commands related with a delivery job.
GET {{baseUrl}}/deliveryJobs/:id/commands?filter=<string>&size=20&page=0
Get all the commands for the given delivery job Id.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filter | string | JSON string describing filter operations performed on commands associated with a delivery job to be returned. The following fields and operations are supported |
Filter
clientId: eq, in, endsWith,startsWith, contains
status: eq, in, endsWith,startsWith, contains
updatedAt: before, after, between
Examples
Unencoded example filter value to fetch all commands associated with delivery job for clientId "punint05_testDevice":
{ "clientId": "punint05_testDevice" }
{ "clientId": { "startsWith" : "punint05" }}
Unencoded example filter value to fetch all commands associated with delivery job for status "EXECUTED":
{ "status": "EXECUTED" }
{ "status": { "startsWith" : "EXE" }}
Unencoded example filter value to fetch all commands associated with delivery job based on updatedAt:
{"updatedAt": {"between": "[2021-08-06T13:46:00Z, 2021-11-11T13:46:00Z]"}}
{"updatedAt": {"after": "2021-11-06T13:46:00Z"}}
{"updatedAt": {"before": "2021-11-06T13:46:00Z"}}
|
| size
| number | | The maximum number of elements returned in one page.
Default value is 20.
Maxium allowed value is 100.
|
| page
| number | | The (0-based) index of the page |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"_embedded":{"commands":[{"id":"21349765fe45652c8e126814c283a114","clientId":"mytenant_201541ad38a4495a96e2021c762b647f","tenantId":"mytenant","status":"CANCELED","updatedAt":"2011-08-12T20:17:46.384Z"},{"id":"21349765fe45652c8e126814c283a114","clientId":"mytenant_201541ad38a4495a96e2021c762b647f","tenantId":"mytenant","status":"FAILED","updatedAt":"2011-08-12T20:17:46.384Z"}]},"page":{"size":44042410,"totalElements":-2953,"totalPages":-23376268,"number":3421920},"_links":{"self":{"href":"dolor"},"first":{"href":"id en"},"prev":{"href":"incididunt ullamco"},"next":{"href":"esse magna cul"},"last":{"href":"quis qui"}}}