List workflow tasks

GET

/workflows/tasks

GET

/workflows/tasks

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.workflows.get_workflows_tasks()

200response

{
  "data": [
    {
      "action_type": "If",
      "call_type": "SOAP",
      "data": {
        "Callout": {
          "RequestBody": {
            "queryString": "Select Id From Contact Where LastName = 'Drew' AND FirstName = 'Nancy' AND  WorkEmail = 'nancy@xyz.com'"
          },
          "RequestHeaders": {
            "Content-Type": "application/json"
          },
          "ResponseBody": {
            "message": "An unexpected error occurred\n"
          },
          "ResponseCode": 500,
          "ResponseHeaders": {
            "cache-control": [
              "max-age=0, no-cache, no-store"
            ],
            "connection": [
              "close"
            ],
            "content-type": [
              "text/plain; charset=UTF-8"
            ],
            "date": [
              "Thu, 19 Sep 2019 12:35:43 GMT"
            ],
            "expires": [
              "Thu, 19 Sep 2019 12:35:43 GMT"
            ],
            "pragma": [
              "no-cache"
            ],
            "server": [
              "kong/0.9.9"
            ],
            "x-n": [
              "S"
            ]
          },
          "URL": "https://rest.apisandbox.zuora.com/v1/action/query"
        },
        "Files": {
          "XML_52881.xml": {
            "name": "JSONData_xslt.xml",
            "object_class": "Workflow",
            "size": 0.011725425720214844
          }
        },
        "Tasks": {
          "Previous": {
            "ErrorClass": "WorkflowError::Callout",
            "ErrorReason": "Callout response was 500 after 1 tries.",
            "Id": 2770,
            "Status": "Error"
          }
        },
        "Workflow": {
          "ExecutionDate": "2019-09-19",
          "ExecutionDateTime": "2019-09-19T12:35:37",
          "LastRunDate": "2019-09-19",
          "LastRunDateTime": "2019-09-19T12:34:41",
          "WorkflowRunUser": "test-user"
        }
      },
      "end_time": "2019-09-19T12:35:43.942Z",
      "id": 2771,
      "instance": true,
      "name": "If",
      "original_task_id": 2582,
      "original_workflow_id": 416,
      "parameters": {
        "if_clause": "{% if 0 > 1 %}\r\nTrue\r\n{% else %}\r\nFalse\r\n{% endif %}",
        "strict_variables": "true"
      },
      "start_time": "2019-09-19T12:35:43.857Z",
      "status": "Success",
      "tags": [],
      "workflow_id": 476
    }
  ],
  "pagination": {
    "next_page": "https://rest.zuora.com/workflows/tasks?page=2&page_length=1",
    "page": 1,
    "page_length": 1
  }
}

Retrieves a list of workflow tasks available in your Zuora tenant.

User Access Permission

You must be assigned the Workflow View Access permission to run this operation.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Content-EncodingstringOptional

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Org-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user’s accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Query parameters

idstringOptional

If specified, the operation retrieves the task that is with specified id.

namestringOptional

If specified, the operation retrieves tasks that is in the specified name.

instancebooleanOptional

If set to true, the operation retrieves workflows that have the scheduled trigger enabled. If set to false, the operation retrieves workflows that have the scheduled trigger disabled. If not specfied, the operation will not use this filter.

action_typestringOptional

If specified, the operation retrieves tasks that is the specified type.

objectstringOptional

If specified, the operation retrieves tasks with the specified object.

object_idstringOptional

If specified, the operation retrieves tasks with the specified object id.

call_typestringOptional

If specified, the operation retrieves tasks with the specified api call type used.

workflow_idstringOptional

If specified, the operation retrieves tasks that for the specified workflow id.

tagslist of stringsOptional

If specified, the operation retrieves tasks that with the specified filter tags. Use the following syntax to specify multiple tags: tags[]=tag_value_1&tags[]=tag_value_2.

Note: All the workflow tasks that have any of the specified tags will be listed in the response body.

pageintegerOptionalDefaults to 1

If you want to retrieve only the workflows on a specific page, you can specify the page number in the query.

page_lengthintegerOptionalDefaults to 20

The number of workflow tasks shown in a single call. If the page parameter is not specified, the operation will return only the first page of results. If there are multiple pages of results, use it with the page parameter to get the results on subsequent pages. The maximum value is 100.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

datalist of objectsOptional

The list of tasks retrieved.

paginationobjectOptional

An object containing pagination information for the list of tasks returned by the API.