ATataccama
Workflows

List workflows

List the processing workflows in your environment, most recently started first.

Filter by status (for example, RUNNING or FAILED), by type (for example, DQ-JOB for DQ monitor processings), or by name. Use the urn of a listed workflow to retrieve, poll, or cancel it.

The response contains a data array with up to size workflows, and a meta object with the prev and next pagination cursors. A cursor is null when there are no further pages in that direction.

get/processing/v1/workflows

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 workflows to return per page.

statusstring
Example:FAILED

Filter by workflow status (for example, RUNNING or FAILED).

typestring
Example:DQ-JOB

Filter by workflow type (for example, DQ-JOB for DQ monitor processings).

namestring
Example:CUSTOMERS / Primary Monitor

Filter by workflow name (for example, CUSTOMERS / Primary Monitor).

sortstring

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

Response

Paginated list of processing workflows.

Example response

{
  "data": [
    {
      "urn": "urn:ata:acme-corp:processing:workflow:123e4567-e89b-12d3-a456-426614174000",
      "type": "DQ-JOB",
      "name": "CUSTOMERS / Primary Monitor",
      "owner": "jane.doe",
      "status": "PENDING",
      "errors": [
        {
          "job": "urn:ata:acme-corp:processing:job:123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }
  ]
}

Changes

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