Get Tasks History for Tenant
Get tasks for the specified tenant.
TTL
Time to live (TTL) for history records is a maximum of 30 days from the last status update.
Get Tasks History for Tenant
Returns tasks for the specified tenant with the following statuses:
CANCELED
, COMPLETED
,
COMPLETED_WITH_ERRORS
, or FAILED
.
Requests
Name | Required | Details |
---|---|---|
max |
No | Positive Integer value to identify the maximum number of tasks to
return in a response. Default is 50 . |
offset |
No | Positive Integer value to identify starting what element in the
result set should be returned in a response. Can be used to organize
pagination in combination with the max parameter.
Default is 0 . |
entityTypes |
No | String array to filter tasks by entityType . |
type |
No |
String value to filter tasks by |
createdBy |
No | String value to filter tasks by initiator. |
status |
No | Enum value to filter tasks by status. Available values:
CANCELED , COMPLETED ,
FAILED , and
COMPLETED_WITH_ERRORS . |
orderBy |
No | Enum value to sort tasks by the field. Available values:
STATUS (ascending order: CANCELLED ,
COMPLETED , FAILED ,
COMPLETED_WITH_ERRORS ),
CREATED_BY , CREATED_TIME ,
START_TIME , TASK_TYPE
(alphabetical order). Default is START_TIME . |
ascending |
No | Boolean value to set sort direction. Default is
false . |
Response
An array of completed tasks for the tenant.