Get the Chart of specified Flow - Cognigy Documentation

GET

v2.0

flows

{flowId}

chart

Get the Chart of specified Flow

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "nodes": [
    {
      "_id": "<string>",
      "type": "if",
      "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "extension": "@cognigy/basic-nodes",
      "label": "A new Node",
      "analyticsLabel": "Step name",
      "comment": "this is a very important node",
      "commentColor": "#ff8a80",
      "isCollapsed": false,
      "isEntryPoint": false,
      "isDisabled": false
    }
  ],
  "relations": [
    {
      "_id": "<string>",
      "node": "<string>",
      "children": [
        "<string>"
      ],
      "next": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

api_key

string

query

required

Supply the API Key in the Url-Query

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

flowId

string

required

The Id of the Flow

Required string length: 24

Query Parameters

preferredLocaleId

string

Required string length: 24

Response

Returns Chart of the Flow

nodes

object[]

Show child attributes

relations

object[]

Show child attributes

Get all node descriptorsGet all Node Descriptors of a Chart.

⌘I

Get the Chart of specified Flow

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "nodes": [
    {
      "_id": "<string>",
      "type": "if",
      "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "extension": "@cognigy/basic-nodes",
      "label": "A new Node",
      "analyticsLabel": "Step name",
      "comment": "this is a very important node",
      "commentColor": "#ff8a80",
      "isCollapsed": false,
      "isEntryPoint": false,
      "isDisabled": false
    }
  ],
  "relations": [
    {
      "_id": "<string>",
      "node": "<string>",
      "children": [
        "<string>"
      ],
      "next": "<string>"
    }
  ]
}