Jobs

List jobs

List the jobs of a workflow, typically to find the failed one, most recently submitted first.

Restrict the result to one workflow with the workflow parameter, typically combined with status=FAILED to find the failed job of a failed workflow. Omit workflow to list jobs across all workflows.

The response is paginated in the same way as the List workflows response.

get/processing/v1/jobs

Request

Query parameters

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response.

beforestring

Cursor for backward pagination. Use the value from meta.prev in the previous response.

sizeinteger

Number of jobs to return per page.

workflowstring uri

A URN identifying a processing workflow.

Format: urn:ata:{tenant}:processing:workflow:{uuid}

Example: urn:ata:acme-corp:processing:workflow:123e4567-e89b-12d3-a456-426614174000.

Example:urn:ata:acme-corp:processing:workflow:123e4567-e89b-12d3-a456-426614174000

Restricts the result to the jobs of the given workflow. Omit to list jobs across all workflows.

typestring

Filter by job type.

statusstring
Example:FAILED

Filter by job status (for example, FAILED).

namestring

Filter by job name.

sortstring

Comma-separated field names for sorting; prefix with a hyphen (-) for descending order. For example, sort=status,-finishedAt.

Response

Paginated list of processing jobs.

Example response

{
  "data": [
    {
      "urn": "urn:ata:acme-corp:processing:job:123e4567-e89b-12d3-a456-426614174000",
      "status": "PENDING"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.