BpmnExport

Method summary

GET /scr/api/BpmnExport/[ZIP_FILE_NAME.zip]

Description

Use this method to export IBM Blueworks Live process diagrams to BPMN 2.0 format.

Resource information

Requirements	Description
Response format	ZIP
Requires authentication	Yes. The user who makes the request must be an administrative editor.
Supports OAuth 2 client credentials	Yes using a User Service ID containing Artifact Reporting Category
Rate limited	Not yet

Parameters

Name	Location	Description	Required	Type
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
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
from	Query	The date is in the YYYY-MM-DD format. The user can use this parameter to filter out processes that were modified before this date. This date is in the timezone set by the user preferences. If the user timezone isn't set, the API uses the default server timezone.	No	String
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

Response

Data from the compressed file.

Example input

This example demonstrates an export from MyAccount of all active processes that have diagrams and that were modified on or after 1 December 2011.

• Using User Service ID OAuth 2 client credentials:

  curl -H "Authorization: Bearer access_token" 
     "https://your_server_url/scr/api/BpmnExport/Backup.zip?account=MyAccount&from=2011-12-01" -o Backup.zip

• Using Service ID OAuth 2 client credentials with user context:

  curl -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/BpmnExport/Backup.zip?account=MyAccount&from=2011-12-01" -o Backup.zip

Example output

ZIP file with process diagrams.

Response properties

None.

Response messages

HTTP code	Reason
200	The request was completed successfully.
401	The user isn't authorized to make the request.
404	The specified process diagrams were not found.