Import a workflow version
Skip to content
v1 API
/
/
Import a workflow version

Import a workflow version

Request

Create a new workflow version under a workflow definition using the exported JSON document of an existing workflow version.

User Access Permission

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

Security
bearerAuth
Path
workflow_idintegerrequired

The unique id of the workflow definition to import a workflow version under.

Query
versionstringrequired

The version number of the new workflow version to import. Must be greater than any existing version numbers.

activateboolean

Indicates whether the imported version is an active version. Default to be false.

Headers
Idempotency-Keystring, <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

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-Encodingstring

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-Idstring, <= 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 (').

Bodyapplication/json
linkagesArray of objects(Linkage)
Example:
[
  {
    "source_workflow_id": 458,
    "source_task_id": null,
    "target_task_id": 1418,
    "linkage_type": "Finish"
  }
]
tasksArray of objects(Task)
Example:
[
  {
    "id": 1418,
    "name": "Checking the Approval Email",
    "parameters": { … },
    "action_type": "Approval",
    "object": "",
    "object_id": "",
    "call_type": "SOAP",
    "task_id": null,
    "concurrent_limit": 9999999,
    "tags": []
  }
]
workflowobject(detailed workflow)

A workflow.

Example:
{
  "id": 458,
  "name": "Checking Workflow",
  "description": "",
  "type": "Workflow::Setup",
  "ondemand_trigger": true,
  "callout_trigger": false,
  "scheduled_trigger": false,
  "interval": "",
  "timezone": "",
  "status": "Active",
  "version": "0.0.1"
}
{
  "workflow": {
    "id": 458,
    "name": "Checking Workflow",
    "description": "",
    "type": "Workflow::Setup",
    "ondemand_trigger": true,
    "callout_trigger": false,
    "scheduled_trigger": false,
    "interval": "",
    "timezone": "",
    "status": "Active",
    "version": "0.0.1"
  },
  "tasks": [
    { … }
  ],
  "linkages": [
    { … }
  ]
}

Responses

OK

Headers
Content-Encodingstring

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-Limitstring

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

RateLimit-Remainingnumber

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

RateLimit-Resetnumber

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

Zuora-Request-Idstring, = 36 characters

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

Zuora-Track-Idstring, <= 64 characters

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.

Bodyapplication/json
active_versionobject(workflow)

Information of the active version.

callTypestring

The call type of the active version.

This field is only returned for workflows that are configured as UI actions.

calloutTriggerboolean

Indicates whether the callout trigger is enabled for the retrieved workflow.

createdAtstring, (date-time)

The date and time when the workflow is created, in the YYYY-MM-DDThh:mm:ss.sssZ format.

descriptionstring

The description of the workflow definition.

idinteger

The unique ID of the workflow definition.

intervalstring or null

The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.

namestring

The name of the workflow definition.

ondemandTriggerboolean

Indicates whether the ondemand trigger is enabled for the workflow.

prioritystring

The priority of the active version.

scheduledTriggerboolean

Indicates whether the scheduled trigger is enabled for the workflow.

statusstring

The status of the workflow definition.

timezonestring or null

The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.

uiPagesobject

The UI pages that are configured for the active version.

This field is only returned for workflows that are configured as UI actions.

ui_page_rolesArray of strings

The roles that are allowed to access the UI pages of the workflow definition.

This field is only returned for workflows that are configured as UI actions.

updatedAtstring, (date-time)

The date and time when the workflow is updated the last time, in the YYYY-MM-DDThh:mm:ss.sssZ format.

zuora_org_idsArray of strings

The IDs of the organizations that the workflow definition belongs to.

Response
{
  "id": 3373,
  "name": "Checking Workflow",
  "description": "",
  "status": "Active",
  "ondemandTrigger": true,
  "calloutTrigger": false,
  "scheduledTrigger": false,
  "interval": "",
  "timezone": "",
  "createdAt": "2024-11-15T12:51:45.859+08:00",
  "updatedAt": "2024-11-15T12:51:45.859+08:00",
  "active_version": {
    "id": 3373,
    "description": "",
    "type": "Workflow::Setup",
    "version": "0.0.1",
    "status": "Inactive"
  }
}