Skip to main content

Query for tasks by search criteria

POST 
/tasks/query

Query for tasks by search criteria

Request​

Body

required

    pageToken string

    If set, returns results starting from the given pageToken.

    parentTaskId string

    If present matches Tasks with this parent Task ID. Note: this is mutually exclusive with all other query parameters, i.e., either provide parent Task ID, or any of the remaining parameters, but not both.

    statusFilter

    object

    status enum

    Status of the Task to filter by, inclusive.

    Possible values: [STATUS_INVALID, STATUS_CREATED, STATUS_SCHEDULED_IN_MANAGER, STATUS_SENT, STATUS_MACHINE_RECEIPT, STATUS_ACK, STATUS_WILCO, STATUS_EXECUTING, STATUS_WAITING_FOR_UPDATE, STATUS_DONE_OK, STATUS_DONE_NOT_OK, STATUS_REPLACED, STATUS_CANCEL_REQUESTED, STATUS_COMPLETE_REQUESTED, STATUS_VERSION_REJECTED]

    updateTimeRange

    object

    If provided, only provides Tasks updated within the time range.

    startTime Timestamp (string)

    Datetime string in ISO 8601 format.

    endTime Timestamp (string)

    Datetime string in ISO 8601 format.

Responses​

Task query was successful

Schema

    tasks object[]
    nextPageToken string

    Incomplete results can be detected by a non-empty nextPageToken field in the query results. In order to retrieve the next page, perform the exact same request as previously and append a pageToken field with the value of nextPageToken from the previous page. A new nextPageToken is provided on the following pages until all the results are retrieved.

Loading...