exportWorkflowConfiguration

Export a Workflow Manager configuration file

Exports a new Workflow Manager configuration (.wmc) file based on the indicated item. This file can be used with the import endpoint to update other item configurations. Configurations from Workflow items with a server that is on a more recent version will not import due to incompatability. If includeOtherConfiguration is set to false, the exported file only includes the individual configuration. If includeOtherConfiguration is undefined, it defaults to true. If includeOtherConfiguration is set to true, the configuration file includes the version, job templates, diagrams, roles, role-group associations, lookup tables, charts and queries, templates, and user settings of the indicated item. Encrypted settings must have a passphrase defined. If no passphrase is specified, encrypted keys will be exported without the values. The adminAdvanced privilege is required.

Body:

Body parameter

1
2
3
4
5
6
7
8
9
10
{
  "jobTemplateIds": [
    "string"
  ],
  "diagramIds": [
    "string"
  ],
  "includeOtherConfiguration": true,
  "passphrase": "string"
}

Query parameters

Path parameters

Examples

Request

1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/admin/{itemId}/export \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/octet-stream' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

400 Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "error": {
    "message": "string",
    "type": "string",
    "details": [
      {
        "path": "string",
        "errors": [
          "string"
        ]
      }
    ]
  }
}