Skip to content

getDiagram

GET
Use dark colors for code blocksCopy
1
/{orgId}/{itemId}/diagrams/{diagramId}
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: Starting at 11.3, helpUrl is a deprecated property. Use helpLink to reference the help resource configured with the step.

Query parameters

NameTypeRequired
tokenstring¦null

Path parameters

NameTypeRequired
diagramIdstring
orgIdstring
itemIdstring

Response status

StatusMeaningDescriptionSchema
200OK

success

Diagram
404Not Found

error

WorkflowExceptionDTO

Examples

Request

Use dark colors for code blocksCopy
1
2
3
# You can also use wget
curl -X GET /{orgId}/{itemId}/diagrams/{diagramId} \
  -H 'Authorization: Bearer <YOUR_TOKEN>'

Response

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
{
  "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
}

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