/
[GET] /{id}

[GET] /{id}

/api/bpm/organizations/{id}

Description

To retrieve information about the organization to display its structure. Returns all objects that make up the organization structure. For each object id, name and type are returned as required fields. Their properties and children are optional. Children are referenced by their id. If calling ‘withProcesses’ is set to true, only objects with at least one running process are returned. In this case, properties and children will not be returned.

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

GET

Request Query Parameter

  • withProcesses (Boolean): If the parameter is true, then only objects that have running processes are returned. Default: false.

  • properties (Boolean): If the parameter is set to true, then for each object its properties are returned. Default: false. Ignored if withProcesses is true.

  • children (Boolean): If the parameter is set to true, then for each object its children are returned. Default: false. Ignored if withProcesses is true.

Response
Format

JSON

Minimum Version

1.0.0

Request
Example

/api/bpm/organizations/0947CC57A9C24B3E8D1DC27BAE777CBE

/api/bpm/organizations/0947CC57A9C24B3E8D1DC27BAE777CBE?properties=true&children=true

Result
Example

{ "objects": [{ "id": "ECFCB04C280C4EC6A9FB32C748D47A4E", "type": "Person", "name": "root", "properties": { "UserId": { "value": "41F8F07F25044A3D95BAACCACB7833D0" }, "active": { "value": "1" }, "Login": { "value": "root" }, "personalnr": { "value": "1" } }, "children": [] }, { "id": "914FC91A55D542F79D8ED1BADDE1AFE6", "type": "Wurzel", "name": "Wurzel", "properties": { "Name": { "value": "User" } }, "children": [ { "id": "04AB367D5B03459D9757407273515E30" }, { "id": "76A95835243B430E85CC0D06A7AB57EE" }, { "id": "92B25680D035458EA6C08B1E703418D0" }, { "id": "0B3221875B8D4708AF1CB4C269DF7C9F" }, { "id": "727A6EA824B543668A4CF56B3EDD98A9" }, { "id": "B0632197C1FF4FA4BED1B54111F4951B" }, { "id": "025F24B1F2834D68BBBC7C6A7DBD0862" } ] }] }