/
[POST] /families

[POST] /families

/api/bpm/families

Description

Creates new families in an organization. By default, the active organization will be used. Optionally, an organizationId could be sent if families in the nonactive organization should be created.

Request body consists of a family object that need to be created. Mandatory properties are name, parentId and type (PROJECT or FAMILY). Description is optional. If the type is FAMILY 2 additional optional properties can be set:

  • priority - value in range 1-100 (default is 50)

  • statistic - object containing user and role ids

Required Systemrole

R_WFEDIT_START (ID = 21)

Request
Method

POST

Request Optional Query Parameter

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

Response
Format

JSON

Minimum Version

BPM Service: 1.4.0
enaio Server: 12.10

Request
Example

/api/bpm/families

Request
Example

{ "objects": [{ "name": "Workflow Project", "description": "Test project", "type": "PROJECT", "parentId": "52B18770BA69487FB2BA6A6636B9CD31" },{ "name": "Workflow Family", "description": "Test family", "type": "FAMILY", "parentId": "542B96C64ABE4E549F6C99CD3709A78B", "priority": 50, "statistic": { "users": [{ "id": "11B18770BA69487FB2BA6A6636B9CD11" }], "roles": [{ "id": "22B18770BA69487FB2BA6A6636B9CD22" }] } }] }

Response
Example

{ "objects": [{ "id": "542B96C64ABE4E549F6C99CD3709A78B", "name": "Workflow Project", "description": "Test project", "type": "PROJECT", "parentId": "52B18770BA69487FB2BA6A6636B9CD31" },{ "id": "D33F5097F6DF497CA066C2646C9D9BF0", "name": "Workflow Family", "description": "Test family", "type": "FAMILY", "parentId": "542B96C64ABE4E549F6C99CD3709A78B", "priority": 50, "statistic": { "users": [{ "id": "11B18770BA69487FB2BA6A6636B9CD11" }], "roles": [{ "id": "22B18770BA69487FB2BA6A6636B9CD22" }] } }] }

Response codes

  • 200 - Success: The families have been successfully created.

  • 400 - If the request is invalid.

  • 403 - If the user does not have the required role.