/api/bpm/families

Description

To retrieve all families for an organization. Optionally, an organizationId could be sent if families for the nonactive organization should be retrieved. By default, the active organization will be used.

For each family the id, name, description, userId, createTime, type are returned. From enaio 12.10 on there are also the properties parentId (represents the parent-child connection present between the different objects) and priority (only present if the type is FAMILY).

The type property has one of the following values:

enaio Server Number	BPM type constant
1	ROOT
2	PROJECT
3	FAMILY

Required Systemrole

R_WFADM_START (ID = 20) or R_WFEDIT_START (ID = 21)

Request
Method

GET

Request Optional Query Parameter

organizationId (String): The Id of the organization for which the families should be retrieved.

Response
Format

JSON

Minimum Version

1.4.0

Request
Example

/api/bpm/families

Result
Example

{
    "objects": [{
        "id": "52B18770BA69487FB2BA6A6636B9CD31",
        "name": "Workflowproject",
        "description": "The primary workflow project. All other projects are stored within this project.",
        "userId": "BF894230A0324FB887CDD732FCDDD61D",
        "createTime": "2019-11-18T16:03:57+01:00",
        "type": "ROOT"
    },{
        "id": "542B96C64ABE4E549F6C99CD3709A78B",
        "name": "UnitTest Workflows",
        "description": "Project for unit testing.",
        "userId": "BF894230A0324FB887CDD732FCDDD61D",
        "createTime": "2016-09-07T16:36:28+02:00",
        "type": "PROJECT",
        "parentId": "52B18770BA69487FB2BA6A6636B9CD31"
    },{
        "id": "D33F5097F6DF497CA066C2646C9D9BF0",
        "name": "ColumnRequiredTest",
        "description": "Test",
        "userId": "BF894230A0324FB887CDD732FCDDD61D",
        "createTime": "2020-08-03T13:28:00+02:00",
        "type": "FAMILY",
        "priority": 50,
        "parentId": "542B96C64ABE4E549F6C99CD3709A78B"
    }],
    "numItems": 3,
    "hasMoreItems": false,
    "totalNumItems": 3
}

Response codes

200 - Success: The families have been successfully returned.
400 - If the organizationId format is invalid.
403 - If the user does not have the required role.

[GET] /families

/api/bpm/families