export/process

Use this resource to export a specific revision of a process in BPMN 2.0 format.

Method summary

HTTP Method Path Description
GET /scr/api/export/process/{process_id}/{revision_id} Exports a specific revision of a process in BPMN 2.0 format.

GET /scr/api/export/process/{process_id}/{revision_id}

Description
Use this method to export a specific revision of a process in BPMN 2.0 format.
Resource information
Requirements Description
Response format ZIP
Requires authentication Yes. The user who requests the process export must be an editor for that process.
Supports OAuth 2 client credentials Yes using a User Service ID containing Artifact Reporting Category
Rate limited No
Parameters
Name Location Description Required Type
exportToSingleFile Query This parameter enables users to export the processes as a single BPMN 2.0 compliant XML file including the Diagram Interchange (DI) details. It provides model interchange compatibility with third-party BPMN tools. The default is false. No Boolean
includeDiagramInterchange Query Whether to include the BPMN2 Diagram Interchange (DI) in the export. The DI covers visual information such as node positioning and bounds, line ports, and labels. The default is false. No Boolean
process_id Path The ID of the exported process. Yes String
revision_id Path The ID of the exported revision. Yes String
X-On-Behalf-Of Header The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any. Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential. String
Response
The data from the process in BPMN 2.0 format including all of the linked processes for the requested process.
Example input
The following example shows how to export a revision with revision_id value 1300a1 and the process_id value 130024.
  • Using OAuth 2 client credentials:
    curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/export/process/130024/1300a1"
Example output
File data
Response properties
None
Response messages
HTTP code Reason
200

The request was completed successfully.
401

The user isn't authorized to make the request.
403 The user does not have access to the process. The process requires at least editor access.