Get all delivery jobs
GET {{baseUrl}}/deliveryJobs?filter=<string>&size=20&page=0
Get all delivery jobs
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filter | string | JSON string describing filter operations performed on delivery jobs to be returned. The following fields and operations are supported |
Filter
name: eq, in, endsWith, startsWith, contains
createdAt: before, after, between
createdBy: eq, in, endsWith, startsWith, contains
clientIds: contains, in
Examples
Unencoded example filter value to fetch all delivery jobs for name "test":
{ "name": "test" }
{ "name": { "startsWith" : "test" }}
Unencoded example filter value to fetch all delivery jobs based on createdAt:
{"createdAt": {"between": "[2021-11-06T13:46:00Z, 2021-11-11T13:46:00Z]"}}
{"createdAt": {"after": "2021-11-06T13:46:00Z"}}
{"createdAt": {"before": "2021-11-06T13:46:00Z"}}
Unencoded example filter value to fetch all delivery jobs based on createdBy:
{"createdBy": {"contains": "test"}}
{"createdBy": {"endsWith": "test"}}
Unencoded example filter value to fetch all delivery jobs based on clientIds: Search all delivery jobs which has client id like mytenant_mqttagentv1
{"clientIds": {"contains": "mytenant_mqttagentv1"}}
Search all delivery jobs which exactly matches client id mytenant_mqttagentv1
{"clientIds": {"in": [ "mytenant_mqttagentv1"]}}
Search all delivery jobs which exactly matches any client id from list mytenant_mqttagentv1 and mytenant_mqttagentv2
{"clientIds": {"in": [ "mytenant_mqttagentv1", "mytenant_mqttagentv2" ]}}
|
| 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":{"deliveryJobs":[{"id":"21349765fe45652c8e126814c283a114","name":"firmware update","clientIds":["mytenant_201541ad38a4495a96e2021c762b647f","mytenant_201541ad38a4495a96e2021c762b647f"],"status":"CANCELED","createdAt":"2011-08-12T20:17:46.384Z","createdBy":"user's email address"},{"id":"21349765fe45652c8e126814c283a114","name":"firmware update","clientIds":["mytenant_201541ad38a4495a96e2021c762b647f","mytenant_201541ad38a4495a96e2021c762b647f"],"status":"CANCELED","createdAt":"2011-08-12T20:17:46.384Z","createdBy":"user's email address"}]},"page":{"size":-72621358,"totalElements":-64560210,"totalPages":72235858,"number":-32246281},"_links":{"self":{"href":"irure"},"first":{"href":"eu deserunt dolor magna"},"prev":{"href":"ut occ"},"next":{"href":"adipisicing Excepteur veniam qui"},"last":{"href":"adipisicing nulla"}}}