Skip to content
Bpanda
English
Esc
↑↓navigate↵open⌘Jpreview

List the full model of a single version by ID.

List the full model of a single version by ID. Get the full process model of one process version. Without processVersionId the most relevant version the caller may see is served, which is the currently valid one if there is one.

Security: Any user holding a Bpanda licence for the process space, restricted to the versions the caller may see: an owner, whitelistee, Manager or Designer reaches every version, everyone else only published ones. Workflow diagrams are exempt from that restriction. Blacklisted callers and hidden processes are rejected. An owner, reviewer or optional reviewer of a review of the requested processVersionId, active or closed, may read that version all the same unless blacklisted.

GET/v1/warehouses/{warehouseId}/processes/{processId}
Authorization
AuthorizationBearer token (JWT) · headerrequired
BpmLicenseAPI key · headerrequired
Path parameters
warehouseIdstringrequired

ID of warehouse

processIdstringrequired

ID of process

Query parameters
processVersionIdinteger<int32>

ID of process version

Responses
200

Process content information

collaboratingProcessesSPMProcess[]required
Show properties
Array of SPMProcess
Circular reference to SPMProcess.
collaborationSPMCollaboration
Show properties
idstringrequired
modelToolIdstringrequired
createdAtstring<date-time>
datasSPMData[]required
Show properties
Array of SPMData
descriptionsDescription[]required
Show properties
Array of Description
textFormattedText[]required
titlestringrequired
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
Show properties
Array of SPMNLSProperty
namestringrequired
valuestringrequired
valueTypestringrequired
descriptionsDescription[]required
Show properties
Array of Description
textFormattedText[]required
Show properties
Array of FormattedText
formatTextFormatrequired
Allowed:BBCodeHTMLPlainText
textstringrequired
titlestringrequired
eventsSPMEvent[]required
Show properties
Array of SPMEvent
descriptionsDescription[]required
Show properties
Array of Description
textFormattedText[]required
titlestringrequired
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
Show properties
Array of SPMNLSProperty
namestringrequired
valuestringrequired
valueTypestringrequired
hashstringrequired
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
langstringrequired
metaProcessMeta
Show properties
changeSummarystring
publicProcessVersionLabelstring
publicProcessVersionNrstring
validityValidity
Show properties
fromstringrequired
untilstringrequired
validityStateValidityStaterequired
Allowed:GONEINVALIDNEXTPREVIOUSUNKNOWNUPCOMINGVALID
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
Show properties
Array of SPMNLSProperty
namestringrequired
valuestringrequired
valueTypestringrequired
nodesSPMNode[]required
Show properties
Array of SPMNode
boundaryIdsstring[]required
calledIdstring
calledModelToolIdstring
consumeIdsstring[]required
defaultTransitionIdstring
descriptionsDescription[]required
Show properties
Array of Description
textFormattedText[]required
titlestringrequired
eventIdsstring[]required
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
Show properties
Array of SPMNLSProperty
namestringrequired
valuestringrequired
valueTypestringrequired
produceIdsstring[]required
roleIdsstring[]required
optionsSPMOption[]required
Show properties
Array of SPMOption
descriptionsDescription[]required
Show properties
Array of Description
textFormattedText[]required
titlestringrequired
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
Show properties
Array of SPMNLSProperty
namestringrequired
valuestringrequired
valueTypestringrequired
processVersionNrinteger<int32>required
rolesSPMRole[]required
Show properties
Array of SPMRole
descriptionsDescription[]required
Show properties
Array of Description
textFormattedText[]required
titlestringrequired
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
Show properties
Array of SPMNLSProperty
namestringrequired
valuestringrequired
valueTypestringrequired
subProcessesSPMSubProcess[]required
Show properties
Array of SPMSubProcess
datasSPMData[]required
Show properties
Array of SPMData
descriptionsDescription[]required
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
descriptionsDescription[]required
Show properties
Array of Description
textFormattedText[]required
titlestringrequired
eventsSPMEvent[]required
Show properties
Array of SPMEvent
descriptionsDescription[]required
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
idstringrequired
isCollapsedbooleanrequired
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
Show properties
Array of SPMNLSProperty
namestringrequired
valuestringrequired
valueTypestringrequired
nodesSPMNode[]required
Show properties
Array of SPMNode
boundaryIdsstring[]required
calledIdstring
calledModelToolIdstring
consumeIdsstring[]required
defaultTransitionIdstring
descriptionsDescription[]required
eventIdsstring[]required
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
produceIdsstring[]required
roleIdsstring[]required
optionsSPMOption[]required
Show properties
Array of SPMOption
descriptionsDescription[]required
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
rolesSPMRole[]required
Show properties
Array of SPMRole
descriptionsDescription[]required
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
subProcessesSPMSubProcess[]required
Show properties
Array of SPMSubProcess
Circular reference to SPMSubProcess.
transitionsSPMTransition[]required
Show properties
Array of SPMTransition
descriptionsDescription[]required
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
optionIdstring
srcIdstringrequired
trgIdstringrequired
svgIdstring
transitionsSPMTransition[]required
Show properties
Array of SPMTransition
descriptionsDescription[]required
Show properties
Array of Description
textFormattedText[]required
titlestringrequired
idstringrequired
kindSPMKindrequired
Allowed:ACTIVITYBOUNDARYCALLCANCELEVENTCOLLABORATIONCOMPENSATEEVENTCONDITIONALEVENTDATADATAINPUTDATAOUTPUTDATASTOREDECISIONENDERROREVENTESCALATIONEVENTEVENTLINKEVENTMESSAGEEVENTMESSAGEFLOWPARALLELPARTICIPANTPROCESSRECEIVEROLESENDSIGNALEVENTSTARTSTORESUBPROCESSTERMINATEEVENTTIMEREVENTTRANSITION
modelToolIdstringrequired
nlsPropertiesSPMNLSProperty[]required
Show properties
Array of SPMNLSProperty
namestringrequired
valuestringrequired
valueTypestringrequired
optionIdstring
srcIdstringrequired
trgIdstringrequired
403

Forbidden: insufficient permissions

string
404

Invalid process

string
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/processes/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY'
Response
{
  "collaboratingProcesses": [
    {}
  ],
  "collaboration": {
    "id": "string",
    "modelToolId": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "datas": [
    {
      "descriptions": [
        {
          "text": [
            {
              "format": "BBCode",
              "text": "string"
            }
          ],
          "title": "string"
        }
      ],
      "id": "string",
      "kind": "ACTIVITY",
      "modelToolId": "string",
      "nlsProperties": [
        {
          "name": "string",
          "value": "string",
          "valueType": "string"
        }
      ]
    }
  ],
  "descriptions": [
    {
      "text": [
        {
          "format": "BBCode",
          "text": "string"
        }
      ],
      "title": "string"
    }
  ],
  "events": [
    {
      "descriptions": [
        {
          "text": [
            {
              "format": "BBCode",
              "text": "string"
            }
          ],
          "title": "string"
        }
      ],
      "id": "string",
      "kind": "ACTIVITY",
      "modelToolId": "string",
      "nlsProperties": [
        {
          "name": "string",
          "value": "string",
          "valueType": "string"
        }
      ]
    }
  ],
  "hash": "string",
  "id": "string",
  "kind": "ACTIVITY",
  "lang": "string",
  "meta": {
    "changeSummary": "string",
    "publicProcessVersionLabel": "string",
    "publicProcessVersionNr": "string",
    "validity": {
      "from": "string",
      "until": "string"
    },
    "validityState": "GONE"
  },
  "modelToolId": "string",
  "nlsProperties": [
    {
      "name": "string",
      "value": "string",
      "valueType": "string"
    }
  ],
  "nodes": [
    {
      "boundaryIds": [
        "string"
      ],
      "calledId": "string",
      "calledModelToolId": "string",
      "consumeIds": [
        "string"
      ],
      "defaultTransitionId": "string",
      "descriptions": [
        {
          "text": [
            {
              "format": "BBCode",
              "text": "string"
            }
          ],
          "title": "string"
        }
      ],
      "eventIds": [
        "string"
      ],
      "id": "string",
      "kind": "ACTIVITY",
      "modelToolId": "string",
      "nlsProperties": [
        {
          "name": "string",
          "value": "string",
          "valueType": "string"
        }
      ],
      "produceIds": [
        "string"
      ],
      "roleIds": [
        "string"
      ]
    }
  ],
  "options": [
    {
      "descriptions": [
        {
          "text": [
            {
              "format": "BBCode",
              "text": "string"
            }
          ],
          "title": "string"
        }
      ],
      "id": "string",
      "kind": "ACTIVITY",
      "modelToolId": "string",
      "nlsProperties": [
        {
          "name": "string",
          "value": "string",
          "valueType": "string"
        }
      ]
    }
  ],
  "processVersionNr": 0,
  "roles": [
    {
      "descriptions": [
        {
          "text": [
            {
              "format": "BBCode",
              "text": "string"
            }
          ],
          "title": "string"
        }
      ],
      "id": "string",
      "kind": "ACTIVITY",
      "modelToolId": "string",
      "nlsProperties": [
        {
          "name": "string",
          "value": "string",
          "valueType": "string"
        }
      ]
    }
  ],
  "subProcesses": [
    {
      "datas": [
        {
          "descriptions": [
            {
              "text": [
                {
                  "format": "BBCode",
                  "text": "string"
                }
              ],
              "title": "string"
            }
          ],
          "id": "string",
          "kind": "ACTIVITY",
          "modelToolId": "string",
          "nlsProperties": [
            {
              "name": "string",
              "value": "string",
              "valueType": "string"
            }
          ]
        }
      ],
      "descriptions": [
        {
          "text": [
            {
              "format": "BBCode",
              "text": "string"
            }
          ],
          "title": "string"
        }
      ],
      "events": [
        {
          "descriptions": [
            {
              "text": [
                {
                  "format": "BBCode",
                  "text": "string"
                }
              ],
              "title": "string"
            }
          ],
          "id": "string",
          "kind": "ACTIVITY",
          "modelToolId": "string",
          "nlsProperties": [
            {
              "name": "string",
              "value": "string",
              "valueType": "string"
            }
          ]
        }
      ],
      "id": "string",
      "isCollapsed": true,
      "modelToolId": "string",
      "nlsProperties": [
        {
          "name": "string",
          "value": "string",
          "valueType": "string"
        }
      ],
      "nodes": [
        {
          "boundaryIds": [
            "string"
          ],
          "calledId": "string",
          "calledModelToolId": "string",
          "consumeIds": [
            "string"
          ],
          "defaultTransitionId": "string",
          "descriptions": [
            {
              "text": [
                {
                  "format": "BBCode",
                  "text": "string"
                }
              ],
              "title": "string"
            }
          ],
          "eventIds": [
            "string"
          ],
          "id": "string",
          "kind": "ACTIVITY",
          "modelToolId": "string",
          "nlsProperties": [
            {
              "name": "string",
              "value": "string",
              "valueType": "string"
            }
          ],
          "produceIds": [
            "string"
          ],
          "roleIds": [
            "string"
          ]
        }
      ],
      "options": [
        {
          "descriptions": [
            {
              "text": [
                {
                  "format": "BBCode",
                  "text": "string"
                }
              ],
              "title": "string"
            }
          ],
          "id": "string",
          "kind": "ACTIVITY",
          "modelToolId": "string",
          "nlsProperties": [
            {
              "name": "string",
              "value": "string",
              "valueType": "string"
            }
          ]
        }
      ],
      "roles": [
        {
          "descriptions": [
            {
              "text": [
                {
                  "format": "BBCode",
                  "text": "string"
                }
              ],
              "title": "string"
            }
          ],
          "id": "string",
          "kind": "ACTIVITY",
          "modelToolId": "string",
          "nlsProperties": [
            {
              "name": "string",
              "value": "string",
              "valueType": "string"
            }
          ]
        }
      ],
      "subProcesses": [
        {}
      ],
      "transitions": [
        {
          "descriptions": [
            {
              "text": [
                {
                  "format": "BBCode",
                  "text": "string"
                }
              ],
              "title": "string"
            }
          ],
          "id": "string",
          "kind": "ACTIVITY",
          "modelToolId": "string",
          "nlsProperties": [
            {
              "name": "string",
              "value": "string",
              "valueType": "string"
            }
          ],
          "optionId": "string",
          "srcId": "string",
          "trgId": "string"
        }
      ]
    }
  ],
  "svgId": "string",
  "transitions": [
    {
      "descriptions": [
        {
          "text": [
            {
              "format": "BBCode",
              "text": "string"
            }
          ],
          "title": "string"
        }
      ],
      "id": "string",
      "kind": "ACTIVITY",
      "modelToolId": "string",
      "nlsProperties": [
        {
          "name": "string",
          "value": "string",
          "valueType": "string"
        }
      ],
      "optionId": "string",
      "srcId": "string",
      "trgId": "string"
    }
  ]
}