Sign in
TaskWrapperDisplays

List TaskWrapperDisplays

GET many request to retrieve multiple objects.

get/api/v2/ui/taskwrapperdisplays

Query parameters

page[after]string byte

Pointer to paginate to retrieve the data after the object provided. Specify the base64 encoded JSON string in a uniquely identifiable manner (e.g. object IDs), i.e. by using one (primary) or two (primary and secondary) fields that allow for stable sorting.

Format: {"primary":{"someField": 123},"secondary":{"someOtherOptionalField": "Foo"}}

Example: {"primary":{"taskWrapperId": 123}} -> eyJwcmltYXJ5Ijp7InRhc2tXcmFwcGVySWQiOiAxMjN9fQ==

page[before]string byte

Pointer to paginate to retrieve the data before the object provided. Specify the base64 encoded JSON string in a uniquely identifiable manner (e.g. object IDs), i.e. by using one (primary) or two (primary and secondary) fields that allow for stable sorting.

Format: {"primary":{"someField": 123},"secondary":{"someOtherOptionalField": "Foo"}}

Example: {"primary":{"taskWrapperId": 123}} -> eyJwcmltYXJ5Ijp7InRhc2tXcmFwcGVySWQiOiAxMjN9fQ==

page[size]integer

Amout of data to retrieve inside a single page

filterobject

Filters results using a query. Every key is an attribute name optionally suffixed with a comparison operator, e.g. filter[taskWrapperId__gt]=200.

includestring[]

Relationships to include in the response, comma seperated. Possible options: tasks

aggregateobject

Aggregated fields to include by type (comma separated values). Possible options: taskwrapperdisplay: totalAssignedAgents, dispatched, searched, status, currentSpeed, estimatedTime, cprogress, timeSpent

Response

successful operation

Changes