Get all delivery jobs

GET {{baseUrl}}/deliveryJobs?filter=<string>&size=20&page=0

Get all delivery jobs

Request Params

KeyDatatypeRequiredDescription
filterstringJSON 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":


{ &quot;name&quot;: &quot;test&quot; }

{ &quot;name&quot;: { &quot;startsWith&quot; : &quot;test&quot; }}

Unencoded example filter value to fetch all delivery jobs based on createdAt:

{&quot;createdAt&quot;: {&quot;between&quot;: &quot;[2021-11-06T13:46:00Z, 2021-11-11T13:46:00Z]&quot;}}

{&quot;createdAt&quot;: {&quot;after&quot;: &quot;2021-11-06T13:46:00Z&quot;}}

{&quot;createdAt&quot;: {&quot;before&quot;: &quot;2021-11-06T13:46:00Z&quot;}}

Unencoded example filter value to fetch all delivery jobs based on createdBy:

{&quot;createdBy&quot;: {&quot;contains&quot;: &quot;test&quot;}}

{&quot;createdBy&quot;: {&quot;endsWith&quot;: &quot;test&quot;}}

Unencoded example filter value to fetch all delivery jobs based on clientIds: Search all delivery jobs which has client id like mytenant_mqttagentv1

{&quot;clientIds&quot;: {&quot;contains&quot;: &quot;mytenant_mqttagentv1&quot;}}

Search all delivery jobs which exactly matches client id mytenant_mqttagentv1

{&quot;clientIds&quot;: {&quot;in&quot;: [ &quot;mytenant_mqttagentv1&quot;]}}

Search all delivery jobs which exactly matches any client id from list mytenant_mqttagentv1 and mytenant_mqttagentv2

{&quot;clientIds&quot;: {&quot;in&quot;: [ &quot;mytenant_mqttagentv1&quot;, &quot;mytenant_mqttagentv2&quot; ]}}

| | 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

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;_embedded&quot;:{&quot;deliveryJobs&quot;:[{&quot;id&quot;:&quot;21349765fe45652c8e126814c283a114&quot;,&quot;name&quot;:&quot;firmware update&quot;,&quot;clientIds&quot;:[&quot;mytenant_201541ad38a4495a96e2021c762b647f&quot;,&quot;mytenant_201541ad38a4495a96e2021c762b647f&quot;],&quot;status&quot;:&quot;CANCELED&quot;,&quot;createdAt&quot;:&quot;2011-08-12T20:17:46.384Z&quot;,&quot;createdBy&quot;:&quot;user&#39;s email address&quot;},{&quot;id&quot;:&quot;21349765fe45652c8e126814c283a114&quot;,&quot;name&quot;:&quot;firmware update&quot;,&quot;clientIds&quot;:[&quot;mytenant_201541ad38a4495a96e2021c762b647f&quot;,&quot;mytenant_201541ad38a4495a96e2021c762b647f&quot;],&quot;status&quot;:&quot;CANCELED&quot;,&quot;createdAt&quot;:&quot;2011-08-12T20:17:46.384Z&quot;,&quot;createdBy&quot;:&quot;user&#39;s email address&quot;}]},&quot;page&quot;:{&quot;size&quot;:-72621358,&quot;totalElements&quot;:-64560210,&quot;totalPages&quot;:72235858,&quot;number&quot;:-32246281},&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;irure&quot;},&quot;first&quot;:{&quot;href&quot;:&quot;eu deserunt dolor magna&quot;},&quot;prev&quot;:{&quot;href&quot;:&quot;ut occ&quot;},&quot;next&quot;:{&quot;href&quot;:&quot;adipisicing Excepteur veniam qui&quot;},&quot;last&quot;:{&quot;href&quot;:&quot;adipisicing nulla&quot;}}}