updateDiagram

POST
1
/{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:

ParameterDescriptionData Type
deleteDraftOptional. If false, the draft diagram version will not be deleted when a diagram is activated.Boolean
diagramRequired. Parameters for the diagram to be updated. For parameter details, see Create a new workflow diagramString

Query parameters

NameTypeRequired

token

string

Body parameters

Supported content types: application/json

NameTypeRequiredDefault valueDescription

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

»» 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

»»» actionType

string

»»» args

object¦null

»» paths

»»» nextStep

string

»»» expression

string¦null

»»» label

string¦null

»»» assignedTo

string¦null

»»» points

»»»» x

integer(int32)

»»»» y

integer(int32)

»»» ports

[string]

»»» 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

string

»»» timeDuration

object

»»»» months

integer(int32)¦null

»»»» days

integer(int32)¦null

»»»» hours

integer(int32)¦null

»»»» minutes

integer(int32)¦null

»»»» offset

integer(int32)

»»» specificTime

object

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

»» name

string

»» url

string

»» sourceType

string

» centralizedDataReferences

» annotations

»» 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
Group
User

»»» scheduleType

undefined

Enumerated values
Duration
SpecificTime
Expression

»»»» type

undefined

Enumerated values
HourOfDay
NumberOfDays
DayOfWeek
DayOfMonth
MonthOfYear

Path parameters

NameTypeRequired

diagramId

string

orgId

string

itemId

string

Examples

Request

1
2
3
4
5
6
# 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

StatusMeaningDescriptionSchema

200

OK

success

Success

400

Bad Request

invalid diagram

WorkflowJsonExceptionDTO

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close