Skip to content

getDiagrams

GET
Use dark colors for code blocksCopy
1
/{orgId}/{itemId}/diagrams
Get all diagrams

Get all the diagrams. Only the latest version is returned when a diagram has more than one version. Inactive diagram is returned when it is the only existing version of the diagram. The active and draft properties in the returned results indicate if the active or draft versions of the diagram exists.

Query parameters

NameTypeRequired
tokenstring¦null

Path parameters

NameTypeRequired
orgIdstring
itemIdstring

Response status

StatusMeaningDescriptionSchema
200OK

success

inline
404Not Found

error

WorkflowExceptionDTO

Response details

Status Code 200

DiagramDescriptions

NameTypeRequiredDescription
diagrams[WorkflowDiagramDescription]

Examples

Request

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

Response

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
  "diagrams": [
    {
      "diagramId": "string",
      "diagramName": "string",
      "description": "string",
      "active": true,
      "draft": true
    }
  ]
}

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