[PUT] /{id}

[PUT] /{id}

/api/bpm/families/{id}

Description

Updates a family 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 updates. If property is ommited it will be set to default value. Mandatory property is name. Description is optional, but if not sent, the default is an empty field. If the type is FAMILY, two additional properties can be set:

  • priority - value in range 1-100 (50 if not set)

  • statistic - object containing user and role ids

Required Systemrole

R_WFEDIT_START (ID = 21)

Request
Method

PUT

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/D33F5097F6DF497CA066C2646C9D9BF0

Request
Example

{ "name": "Workflow Family", "description": "Test family", "priority": 50, "statistic": { "users": [{ "id": "11B18770BA69487FB2BA6A6636B9CD11" }], "roles": [{ "id": "22B18770BA69487FB2BA6A6636B9CD22" }] } }

Response codes

  • 204 - Success: The familiy has been successfully updated.

  • 400 - If the request is invalid.

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