Get a diagram by diagramId
Get a diagram by diagramId. The first step in the diagram is returned with initialStepId and initialStepName. The diagram is allowed to have only one initial step. The initialStepId and initialStepName are returned for the first step in diagram.
Note: help is a deprecated property. Use help to reference the help resource configured with the step.
Query parameters
| Name | Type | Required |
|---|---|---|
| |
Path parameters
| Name | Type | Required |
|---|---|---|
| | |
| | |
| |
Examples
Request
# You can also use wget
curl -X GET /{orgId}/{itemId}/diagrams/{diagramId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'Response
200 Response
{
"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"
}
],
"annotations": [
{
"position": "string",
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"text": "string"
}
],
"displayGrid": true
}| Status | Meaning | Description | Schema |
|---|---|---|---|
| success | ||
| error |