Start exporting a Workflow Manager configuration file asynchronously
Starts exporting 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 include is set to false, the exported file only includes the individual configuration. If include is undefined, it defaults to true.
If include 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.
An export ID is returned to retrieve the configuration file. Use the exportId endpoint to retrieve the file.
Body:
| Parameter | Description | Data Type |
|---|---|---|
| jobTemplateIds | Optional. The job template(s) to be exported. If job template is exported, the associated diagram must be included to be exported. | Array |
| diagramIds | Optional. The diagram(s) to be exported. If not defined, all diagrams are exported. If defined as empty, no diagram is exported. | Array |
| includeOtherConfiguration | Optional. If true other configurations are exported including templates, User defined settings, shared searches, shared queries, email settings etc. | Boolean |
| passphrase | Optional. If exporting encrypted user defined settings, define a passphrase. If no passphrase is specified, the keys for encrypted user defined settings will be exported without their values. | String |
Body parameter
{
"jobTemplateIds": [
"string"
],
"diagramIds": [
"string"
],
"includeOtherConfiguration": true,
"passphrase": "string"
}Query parameters
| Name | Type | Required |
|---|---|---|
| |
Path parameters
| Name | Type | Required |
|---|---|---|
| | |
| |
Examples
Request
# You can also use wget
curl -X POST /{orgId}/admin/{itemId}/exportAsync \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'Response
200 Response
{
"exportId": "string"
}| Status | Meaning | Description | Schema |
|---|---|---|---|
| The export ID | Inline | |
| error |
Response details
Status Code 200
ExportAsyncResponse
| Name | Type | Required | Description |
|---|---|---|---|
| | The export ID |