Export a workflow version

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.

SecuritybearerAuth
Request
path Parameters
workflow_id
required
integer

The ID of the workflow definition to export.

query Parameters
version
string

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.

header Parameters
Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

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-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Responses
200

OK

400

The input of version is invalid.

404

Workflow version is not found.

get/workflows/{workflow_id}/export
Request samples 
Response samples 
application/json
{
  • "linkages": [
    ],
  • "tasks": [
    ],
  • "workflow": {
    }
}