Export a workflow version

GET

/workflows/:workflow_id/export

GET

/workflows/:workflow_id/export

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.workflows.get_workflow_export(
    workflow_id=1,
)

{
  "linkages": [
    {
      "linkage_type": "Start",
      "source_workflow_id": 286,
      "target_task_id": 849
    }
  ],
  "tasks": [
    {
      "action_type": "Callout",
      "call_type": "SOAP",
      "concurrent_limit": 9999999,
      "id": 849,
      "name": "Call Echo",
      "parameters": {
        "authorization": {
          "type": "none"
        },
        "body_type": "raw",
        "datas": [
          {
            "key": "",
            "value": ""
          }
        ],
        "headers": [
          {
            "key": "",
            "value": ""
          }
        ],
        "include_response_code": "true",
        "method": "GET",
        "raw_body": "",
        "retry_rules": {
          "current_retry_count": "0",
          "retry_count": "0",
          "retry_window": "30"
        },
        "strict_variables": "true",
        "url": "http://scooterlabs.com/echo",
        "validate_response": "false",
        "validation": {
          "status_codes": [
            "",
            "200"
          ],
          "zuora_call": "false"
        },
        "validation_scheme": ""
      },
      "tags": [
        ""
      ],
      "assignment": [],
      "css": {
        "left": "470px",
        "top": "160px"
      },
      "iterate_row_reference": null,
      "object_batched_reference": null,
      "priority": "Medium",
      "process_id": null
    }
  ],
  "workflow": {
    "description": "",
    "id": 286,
    "name": "Call Echo",
    "type": "Workflow::Setup",
    "version": "0.0.1",
    "call_type": null,
    "callout_trigger": true,
    "css": {
      "left": "30px",
      "top": "40px"
    },
    "data": {},
    "delete_ttl": 60,
    "finished_at": null,
    "notifications": {},
    "ondemand_trigger": true,
    "original_workflow_id": null,
    "parameters": {},
    "priority": "Medium",
    "scheduled_trigger": false,
    "started_at": null,
    "status": null,
    "sync_trigger": false,
    "task_summary": {}
  }
}

Exports a workflow version into a JSON file. This file can be used to create a copy of this workflow version.

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.

Path parameters

workflow_idintegerRequired

The ID of the workflow definition to export.

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.

Query parameters

versionstringOptional

Default result is the active version of the workflow definition. Version number and 'latest' can be used to export a specific version of the workflow definition.

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

linkageslist of objectsOptional

taskslist of objectsOptional

workflowobjectOptional

A workflow.

Errors

400

Bad Request Error

404

Not Found Error