/
[POST] /export

[POST] /export

/api/bpm/organizations/{id}/export

Description

This endpoint can be used to export a complete or partial workflow organization as a enaio proprietary XML file. The export can include a organizational data, report configurations, routing list templates and workflow process definitions with their families. The XML content is in a enaio native format which is not BPMN 2.0 compatible.

The id path parameter specifies the organization to export from. The request body controls what should be included in the export. All list parameters are optional - if omitted, that data is not exported. If reportConfigurations or routingListTemplates lists are provided, only the specified items are exported. An optional filename query parameter can be used to set the name of the downloaded file.

When exportingprocessDefinitions, each processDefinition requires an id and a parentId. The parentId of a processDefinition is its family and the family must be available in the list of the families send within the request. Each family is neasted in at least one project. Also the projects must be send within the request in the families list down to the root project. The root project must not be send in the list of families. Otherwise the export would be empty by enaio server. The Request Example below show this dependency: There is one processDefinition which has the parentId 4415524E71C0486C95B59AB59F1D77CA. In the list of the families this parentId is present as a id. The family itself has a parent with the parentId 083E4D3979DE4C38A252D99061236FF2 which refers a project. The project is also available inside the list of the families and has a parentId 52B18770BA69487FB2BA6A6636B9CD31. The project with the id 52B18770BA69487FB2BA6A6636B9CD31 is no longer specified in the families list. This is the root and it is forbidden to specify it in the list of the families. If there are multiple processDefintions, families or projects with the same parent the parent must only be specified once in the list of the families.

Required system role

R_WFEDIT_START (ID = 21)

Request
Method

POST

Request Optional Query Parameter

  • filename (String): Name of the downloaded XML file. Defaut: organization_export

Response
Format

JSON

Minimum Version

1.5.0

Request
Example

/api/bpm/organizations/0947CC57A9C24B3E8D1DC27BAE777CBE/export?filename=my_export

{ "organization": true, "reportConfigurations": [{ "id": "A1B2C3D4E5F6..." }], "routingListTemplates": [{ "id": "F6E5D4C3B2A1..." }], "families": [{ "id": "4415524E71C0486C95B59AB59F1D77CA", "parentId": "083E4D3979DE4C38A252D99061236FF2" },{ "id": "083E4D3979DE4C38A252D99061236FF2", "parentId": "52B18770BA69487FB2BA6A6636B9CD31" }], "processDefinitions": [{ "id": "C13688BA71F644B2878DFFB64F29D6C6", "parentId": "4415524E71C0486C95B59AB59F1D77CA" }] }

 

Result
Example

Returns the export as an XML file download (Content-Type: application/xml). The content of the file depends on the requested data and the organization structure.