Import and Export

This API allows users to import and export artifacts related to SAP Signavio Process Manager.

Prerequisites

Before using the API, you must obtain an authentication token. Refer to Authentication for further guidance. Once you have the token, include it in all requests by adding an x-signavio-id request header with the token as the header's value.

Requests

When importing or exporting, requests are generally sent to endpoints of the following format: 
https://{baseUrl}/spm/v1/{resourceType}/{resourceId}/{representation}

  • resourceType: The type of resource being imported or exported, for example model or revision.

  • resourceId: The unique identifier of the resource.

  • representation: The type of representation the resource is being imported or exported as, for example png or bpmn_2_0_xml.

Some exceptions to this format exist. Refer to the API Reference or the API documentation on the SAP Business Accelerator Hub for a comprehensive description of the available endpoints.

The base URL is region-specific. The available regions are:
Region Base URL

Australia

api.au.signavio.cloud.sap

Canada

api.ca.signavio.cloud.sap

EU

api.eu.signavio.cloud.sap

Japan

api.jp.signavio.cloud.sap

Singapore

api.sgp.signavio.cloud.sap

South Korea

api.kr.signavio.cloud.sap

USA

api.us.signavio.cloud.sap

Importing and Exporting Models

Import and export functionality is available for a variety of formats, including:

  • PNG

  • SVG

  • JSON

  • BPMN XML

  • DMN XML

To export the latest version of a model (also called the head revision), set resourceType to model and provide the model's ID as resourceId.

To export a specific version of a model, set resourceType to revision and provide the revision's ID as resourceId.

Responses

For a complete description of all response types per endpoint, refer to the API Reference or the API Documentation on the SAP Business Accelerator Hub. This includes responses to successful operations as well as potential errors.

Related Information