GET
/{orgId}/{itemId}/diagrams/{diagramId}/{diagramVersion}/upgradedGet an upgraded version of a workflow diagram that uses data references. If the version number does not exist, an error saying the specific diagram version does not exist is returned. The adminBasic or adminAdvanced privilege is required to get an upgraded diagram.
Note: You can upgrade a diagram by placing the transformedDiagram JSON in the diagram parameter of updateDiagram.
Query parameters
| Name | Type | Required |
|---|---|---|
token | string¦null |
Path parameters
| Name | Type | Required |
|---|---|---|
diagram | string | |
diagram | integer | |
org | string | |
item | string |
Response status
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | success | UpgradedDiagramResponse |
| 404 | Not Found | error | WorkflowExceptionDTO |
Examples
Request
# You can also use wget
curl -X GET /{orgId}/{itemId}/diagrams/{diagramId}/{diagramVersion}/upgraded \
-H 'Authorization: Bearer <YOUR_TOKEN>'Response
{
"transformedDiagram": {
"diagramId": "string",
"diagramVersion": 0,
"diagramName": "string",
"description": "string",
"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": [
{
"x": 0,
"y": 0
}
],
"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": "HourOfDay",
"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
},
"modifiedStepIds": [
"string"
],
"failedStepIds": [
"string"
],
"modifiedDataSourceNames": [
"string"
],
"failedDataSourceNames": [
"string"
]
}