updateDiagram

POST
Use dark colors for code blocksCopy
/{orgId}/{itemId}/diagrams/{diagramId}

Update an existing diagram

Update a diagram by diagramId. Once the diagram is updated, a new diagram version is automatically created. If the diagram version is not activated on update, it will be saved as a draft with a version number of -1. A draft version can be activated by updating the active parameter from false to true on the diagram. Once activated the existing draft version can be deleted by using the deleteDraft parameter. To keep a draft version set deleteDraft parameter to false. By default the deleteDraft parameter is set to true. The updates in the diagram will be saved only if it passes the validation. The adminBasic or adminAdvanced privilege is required to update a diagram.

WorkflowDiagram Parameters:

Parameter	Description	Data Type
deleteDraft	Optional. If false, the draft diagram version will not be deleted when a diagram is activated.	Boolean
diagram	Required. Parameters for the diagram to be updated. For parameter details, see Create a new workflow diagram	String

Query parameters

Name	Type	Required
`token`	`string`

Body parameters

Supported content types: application/json

Name	Type	Default value
`body`	`UpdateDiagramBody`	An object defining the diagram
`deleteDraft`	`boolean`
`diagram`	`object`
`» diagramId`	`string¦null`
`» diagramName`	`string`
`» description`	`string¦null`
`» active`	`boolean`
`» initialStepId`	`string¦null`
`» initialStepName`	`string¦null`
`» steps`	`[Step]`
`»» id`	`string`
`»» name`	`string`
`»» description`	`string¦null`
`»» stepTemplateId`	`string¦null`
`»» automatic`	`boolean`
`»» proceedNext`	`boolean`
`»» canSkip`	`boolean`
`»» position`	`string`
`»» shape`	`integer(int32)`
`»» color`	`string¦null`
`»» outlineColor`	`string¦null`
`»» labelColor`	`string¦null`
`»» action`	`StepAction`
`»»» actionType`	`string`
`»»» args`	`object¦null`
`»» paths`	`[StepPath]`
`»»» nextStep`	`string`
`»»» expression`	`string¦null`
`»»» label`	`string¦null`
`»»» assignedTo`	`string¦null`
`»»» points`	`[Point]`
`»»»» x`	`integer(int32)`
`»»»» y`	`integer(int32)`
`»»» ports`	`[string]`
`»»» assignedType`	`AssignedType`
`»»» status`	`string¦null`
`»»» notifications`	`[string]`
`»»» lineColor`	`string¦null`
`»»» labelColor`	`string¦null`
`»»» isAssignedToCustomExpression`	`boolean¦null`
`»»» forceGroupAssignment`	`boolean¦null`
`»» helpUrl`	`string¦null`
`»» helpText`	`string¦null`
`»» helpLink`	`string¦null`
`»» encodeHelpLink`	`boolean¦null`
`»» schedule`	`object`
`»»» scheduleType`	`string`
`»»» timeDuration`	`object`
`»»»» months`	`integer(int32)¦null`
`»»»» days`	`integer(int32)¦null`
`»»»» hours`	`integer(int32)¦null`
`»»»» minutes`	`integer(int32)¦null`
`»»»» offset`	`integer(int32)`
`»»» specificTime`	`object`
`»»»» type`	`string`
`»»»» dayOfWeek`	`integer(int32)¦null`
`»»»» dayOfMonth`	`integer(int32)¦null`
`»»»» month`	`integer(int32)¦null`
`»»»» hour`	`integer(int32)`
`»»»» minutes`	`integer(int32)`
`»»»» offset`	`integer(int32)`
`»»» expression`	`string¦null`
`» dataSources`	`[DataSourceDecentralized]`
`»» name`	`string`
`»» url`	`string`
`»» sourceType`	`string`
`» centralizedDataReferences`	`[AbstractCentralizedDataReference]`
`» annotations`	`[Annotation]`
`»» position`	`string`
`»» color`	`string¦null`
`»» outlineColor`	`string¦null`
`»» labelColor`	`string¦null`
`»» text`	`string`
`» displayGrid`	`boolean`
`» useCentralizedDataReferences`	`boolean`

body

An object defining the diagram

»»» assignedType

undefined

Default: Unassigned

Enumerated values

Unassigned

Click to copy

Group

Click to copy

User

Click to copy

»»» scheduleType

undefined

Enumerated values

Duration

Click to copy

SpecificTime

Click to copy

Expression

Click to copy

»»»» type

undefined

Enumerated values

HourOfDay

Click to copy

NumberOfDays

Click to copy

DayOfWeek

Click to copy

DayOfMonth

Click to copy

MonthOfYear

Click to copy

Path parameters

Name	Type	Required
`diagramId`	`string`
`orgId`	`string`
`itemId`	`string`

Examples

Request

Use dark colors for code blocksCopy
# You can also use wget
curl -X POST /{orgId}/{itemId}/diagrams/{diagramId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  --data '{"deleteDraft":true,"diagram":{"diagramId":"string","diagramName":"string","description":"string","active":true,"initialStepId":"string","initialStepName":"string","steps":[{"id":"string","name":"string","description":"string","stepTemplateId":"string","automatic":true,"proceedNext":true,"canSkip":true,"position":"string","shape":0,"color":"string","outlineColor":"string","labelColor":"string","action":{"actionType":"string","args":{}},"paths":[{"nextStep":"string","expression":"string","label":"string","assignedTo":"string","points":[{}],"ports":["string"],"assignedType":"Unassigned","status":"string","notifications":["string"],"lineColor":"string","labelColor":"string","isAssignedToCustomExpression":true,"forceGroupAssignment":true}],"helpUrl":"string","helpText":"string","helpLink":"string","encodeHelpLink":true,"schedule":{"scheduleType":"Duration","timeDuration":{"months":0,"days":0,"hours":0,"minutes":0,"offset":0},"specificTime":{"type":"[","dayOfWeek":0,"dayOfMonth":0,"month":0,"hour":0,"minutes":0,"offset":0},"expression":"string"}}],"dataSources":[{"name":"string","url":"string","sourceType":"string"}],"centralizedDataReferences":[{}],"annotations":[{"position":"string","color":"string","outlineColor":"string","labelColor":"string","text":"string"}],"displayGrid":true,"useCentralizedDataReferences":true}}'

Response

Status	Meaning	Description	Schema
`200`	OK	success	Success
`400`	Bad Request	invalid diagram	WorkflowJsonExceptionDTO