For the given process, returns a list of called process definitions corresponding to the CalledProcessDefinition interface in the engine. The list contains all process definitions that are referenced statically by call activities in the given process. This endpoint does not resolve process definitions that are referenced with expressions. Each called process definition contains a list of call activity ids, which specifies the call activities that are calling that process. This endpoint does not resolve references to case definitions.

Method

GET /process-definition/{id}/static-called-process-definitions

Parameters

Path Parameters

Name	Description
id	The id of the process definition.

Result

A JSON Array of objects corresponding to the CalledProcessDefinition interface in the engine. The Array can be empty, if the endpoint cannot resolve the called process(es) because the reference is an expression which is resolved by the engine during runtime of the calling process. Each called process definition object has the following properties:

Name	Type	Description
id	String	The id of the process definition.
key	String	The key of the process definition, i.e., the id of the BPMN 2.0 XML process definition.
category	String	The category of the process definition.
description	String	The description of the process definition.
name	String	The name of the process definition.
version	Number	The version of the process definition that the engine assigned to it.
resource	String	The file name of the process definition.
deploymentId	String	The deployment id of the process definition.
diagram	String	The file name of the process definition diagram, if it exists.
suspended	Boolean	A flag indicating whether the definition is suspended or not.
tenantId	String	The tenant id of the process definition.
versionTag	String	The version tag of the process definition.
historyTimeToLive	Number	History time to live value of the process definition. Is used within History cleanup.
startableInTasklist	Boolean	A flag indicating whether the process definition is startable in Tasklist or not.
calledFromActivityIds	Array	Ids of the CallActivities which call this process.
callingProcessDefinitionId	String	The id of the calling process definition

Response Codes

Code	Media type	Description
200	application/json	Request successful.
404	application/json	Process definition with given key does not exist. See the Introduction for the error response format.

Examples

Request

GET /process-definition/aProcessDefinitionId/static-called-process-definitions

Response

[
  {
    "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
  }
]