Update the specified clinical workflow element

patch/workflows/{workflowId}/elementdefinitions/{elementId}

Updates the specified clinical workflow element with the values specified.

Request Samples

Response Samples

1{
2 "value": {
3 "version": 1,
4 "workflowId": "319d8eb4-ea1b-493b-8ccd-c5c110481b94",
5 "elementId": "WF5471E2F8-1E26-47F6-ABC8-BD55F855F2B8",
6 "elementName": "UserTask1",
7 "elementType": "USER_TASK",
8 "type": "USERTASK",
9 "description": "A test description"
10 }
11}

Path Parameters

NameTypeRequiredDescription
elementId
string
true

The unique identifier for the clinical workflow element.

workflowId
string
true

The unique identifier for the clinical workflow.

Request Body

The values to set for the specified clinical workflow element.

Details for the clinical workflow definition elements and the associated clinical setup data

NameTypeRequiredDescription
workflowId
string
false

The clinical workflow id

elementId
string
false

Unique identifier for the clinical workflow element in the clinical workflow definition.

elementName
string
false

The name of the element in the clinical workflow definition.

elementType
string
false

The display type of the element.

Allowed values:
USER_TASKTIMER_INTERMEDIATE_CATCH_EVENTSIGNAL_INTERMEDIATE_CATCH_EVENTNOTIFICATION_TASKSYSTEM_JOB_EXECSYSTEM_JOB_EXEC_NO_WAIT
type
string
false

The functional type of the element.

Allowed values:
USERTASKNOTIFICATIONTIMEREVENTSIGNALEVENTJOBTASK
description
string
false

The element description from the clinical workflow definition. Note: Can be overridden for user tasks.

version
integer<int32>
false

The object version.

Responses

StatusMeaningDescription
200OK

OK - the clinical workflow element was updated successfully.

Schema
400Bad Request

Bad Request

404Not Found

The clinical workflow or element could not be found.