getDiagrams

Click to copy

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

token

string

Path parameters

NameTypeRequired

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
# You can also use wget
curl -X GET /{orgId}/{itemId}/diagrams \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 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
    }
  ]
}
StatusMeaningDescriptionSchema

200

OK

success

Inline

404

Not Found

error

WorkflowExceptionDTO

Response details

Status Code 200

DiagramDescriptions

NameTypeRequired

diagrams

diagramId

string

diagramName

string

description

string¦null

active

boolean

draft

boolean

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