• TS SDK
  • Help
  • Introduction to Web API
  • Authorization
  • Data types
  • Public API
    • Managing apps
      • Create app item (POST)
      • Edit app item (POST)
      • Get app item by ID (POST)
      • Get app item by ID (GET)
      • Get app list (GET)
      • Get app status (GET)
      • Get list of app items (GET)
      • Get list of app items (POST)
      • Set app item status (POST)
    • Managing business processes
      • Get list of process instances (GET)
      • Get list of process instances (POST)
      • Get list of process instances for target (GET)
      • Get list of process instances for target (POST)
      • Get process instance by ID (GET)
      • Get process instance by ID (POST)
      • Start process by template ID (POST)
    • Managing files
      • File upload (POST)
      • Get file download link by file ID (GET)
      • Get file download link by file ID (POST)
      • Loading file to the directory (POST)
      • Moving file to directory (POST)
    • Managing users
      • Get list of users (POST)
      • Get user list (GET)
  • OpenAPI specification

Get process instance by ID

Request

POST /pub/v1/bpm/instance/{id}/get

Path parameters

Parameter name Value Description Additional
id uuid

Process instance ID

Required

Authorization

This request requires the use of one of following authorisation methods: API key

Response

The following HTTP status codes may be returned.

Status code Description Resource
200 OK

Model of a process instance.

Model of a process instance (Get process instance by ID)
  • TS SDK
  • Help