Signavio Process Intelligence API

Overview

This API allows you to upload your data to Signavio Process Intelligence at a desired interval–either only once, or continuously on a regular basis. To upload your data, it must be .XES files, the standard process mining format. You can find out more about .XES formatting here.

Authorization

Authentication is done via OATH 2 tokens. To authenticate, navigate to the “Process data settings” page in Process Intelligence. Click the “API Access” tab. Click the “Create new token” button. It will generate an access token for you to copy and paste as a password. Include this access token in the authorization header.

Environments

We recommend using our production environment to test your API integration. Simply delete any data you upload to our server after the fact.

The URLs for our production environment are:

Endpoints

Upload XES file

POST {{pwx-data-url}}/g/api/pidata/subjects/{subject-slug}/upload/xes

This object lets you upload your files to Process Intelligence. It passes the file parameter (must be an .XES file).

Sample request:

curl -X POST \
https://editor.signavio.com/g/api/pidata/subjects/{subject1-1}/upload/xes \
-H 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzdmVuLndhZ25lci1ib3lzZW5Ac2lnbmF2aW8uY29tIiwiZ3VlIjpmYWxzZSwiaXNzIjoic2lnbmF2aW8iLCJldWkiOiIiLCJ0ZW4iOiJhMmYyYjZiZTJjMDg0ZmY5OTY4MGEyYWZhOGY3ZTJhOCIsImlhdCI6MTUzMDY4OTE2N30.vyglC53kP47nZaeQ9ZMwh4rqiQn4xh8_I8IbeGubDUg' \
-H 'cache-control: no-cache' \
-H 'content-type: multipart/form-data' \
-F file=@/xes_sample.xes

Status codes

Possible status codes
Status code Description
204 OK - Your .XES file was successfully uploaded and processed
400 File Missing - You haven’t attached a file
500 Application Error - Something went very wrong