/api/bpm/routing-lists/templates

Description

To retrieve all routing list ad hoc templates visible to the currently logged-in user. This includes all public templates and all private templates owned by the logged-in user. Optionally, an organization id can be sent if templates for a non-active organization should be retrieved. By default, the active organization will be used.

Each template contains a routing list with task groups and tasks. A task can have assigned users or roles (usersAndRoles) and optionally a timer. If usersAndRoles is null, no user or role is assigned to the task. If timerDuration is null, no timer is set.

If a property is not present in the response, it means its value is null — either it was not set or it was empty.

The scope property indicates whether the template is publicly visible to all users or private:

Value	Description
PUBLIC	The template is visible to all users
PRIVATE	The template is only visible to its owner

The timerDurationType property has the following values:

Value	Description
NONE	No timer is set
RELATIVE	Timer duration is relative (in seconds)
ABSOLUTE	Timer duration is absolute

Request
Method

GET

Request Optional Query Parameters

organizationId (String): The id of the organization for which the templates should be retrieved. If not provided, the active organization will be used.

Response
Format

JSON

Minimum Version

1.5.0

Request
Example

/api/bpm/routing-lists/templates

/api/bpm/routing-lists/templates?organizationId=E0E8AF5991A5401E81DA65AD43D1AC24

Result
Example when active processes are returned

{
    "objects": [
        {
            "id": "2E9F8FBF56E446AEBA5C5B66712AC38A",
            "name": "besonders",
            "scope": "PUBLIC",
            "routingList": {
                "id": "931E96E300AA4F5086EFC46602013274",
                "expandable": true,
                "taskGroups": [
                    {
                        "number": 0,
                        "expandable": true,
                        "tasks": [
                            {
                                "id": "6D575420E5924CF58872BEBC1A3FDE8B",
                                "name": "DisplayName",
                                "taskDefinitionId": "EBA50D7D32C640F5B0358C383F495F9B",
                                "taskDefinitionName": "DisplayName",
                                "remark": "Please review the document",
                                "timerId": "7898DB53EECB418FB80AE3601461942E",
                                "timerName": "Mahnfrist 2",
                                "timerDuration": 172715,
                                "timerDurationType": "RELATIVE",
                                "changeable": true,
                                "deleteable": false,
                                "usersAndRoles": [
                                    { "id": "BE2C9475A0E84700BBD45C7C8B2AECF5" },
                                    { "id": "727A6EA824B543668A4CF56B3EDD98A9" }
                                ]
                            },
                            {
                                "id": "01F63129B4014B09836CCA232E55DD97",
                                "name": "DisplayName",
                                "taskDefinitionId": "EBA50D7D32C640F5B0358C383F495F9B",
                                "taskDefinitionName": "DisplayName",
                                "timerDurationType": "NONE",
                                "changeable": true,
                                "deleteable": false,
                                "usersAndRoles": [
                                    { "id": "BE2C9475A0E84700BBD45C7C8B2AECF5" },
                                    { "id": "727A6EA824B543668A4CF56B3EDD98A9" }
                                ]
                            }
                        ]
                    }
                ]
            }
        }
    ],
    "numItems": 1,
    "hasMoreItems": false,
    "totalNumItems": 1
}

[GET] /templates

/api/bpm/routing-lists/templates