Skip to main content
GET
/
process-definition
/
{id}
/
static-called-process-definitions
Get Static Called Process Definitions
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-definition/{id}/static-called-process-definitions \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "ACalledProcess:1:1bbd4e83-f8f1-11eb-9344",
    "key": "ACalledProcess",
    "category": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    "description": null,
    "name": "ACalledProcess",
    "version": 1,
    "resource": "called-process.bpmn",
    "deploymentId": "1baa3baf-f8f1-11eb-9344-0e0bbdd53e42",
    "diagram": null,
    "suspended": false,
    "tenantId": null,
    "versionTag": null,
    "historyTimeToLive": null,
    "calledFromActivityIds": [
      "aCallActivityId"
    ],
    "callingProcessDefinitionId": "aProcessDefinitionId",
    "startableInTasklist": true
  },
  {
    "id": "AnotherCalledProcess:2:1bc2f3d5-f8f1-11eb-9344",
    "key": "AnotherCalledProcess",
    "category": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    "description": null,
    "name": "AnotherCalledProcess",
    "version": 2,
    "resource": "another-called-process.bpmn",
    "deploymentId": "1baa3baf-f8f1-11eb-9344-0e0bbdd53e42",
    "diagram": null,
    "suspended": false,
    "tenantId": null,
    "versionTag": null,
    "historyTimeToLive": null,
    "calledFromActivityIds": [
      "aSecondCallActivityId",
      "aThirdCallActivityId"
    ],
    "callingProcessDefinitionId": "aProcessDefinitionId",
    "startableInTasklist": true
  }
]

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The id of the process definition.

Response

Request successful.

calledFromActivityIds
string[] | null

Ids of the CallActivities which call this process.

callingProcessDefinitionId
string | null

The id of the calling process definition

id
string | null

The id of the process definition

key
string | null

The key of the process definition, i.e., the id of the BPMN 2.0 XML process definition.

category
string | null

The category of the process definition.

description
string | null

The description of the process definition.

name
string | null

The name of the process definition.

version
integer | null

The version of the process definition that the engine assigned to it.

resource
string | null

The file name of the process definition.

deploymentId
string | null

The deployment id of the process definition.

diagram
string | null

The file name of the process definition diagram, if it exists.

suspended
boolean | null

A flag indicating whether the definition is suspended or not.

tenantId
string | null

The tenant id of the process definition.

versionTag
string | null

The version tag of the process definition.

historyTimeToLive
integer | null

History time to live value of the process definition. Is used within History cleanup.

Required range: x >= 0
startableInTasklist
boolean | null

A flag indicating whether the process definition is startable in Tasklist or not.