COcognigy
Nodes

Get a Node

Gets a Node from a Flow.

get/v2.0/flows/{flowId}/chart/nodes/{nodeId}

Request

Path parameters

flowIdstring required

The unique identifier for the Flow.

nodeIdstring required

The Id of the Node

Query parameters

preferredLocaleIdstring

The unique identifier for the Locale for the response.

includeConversionMetadataboolean

Whether to include conversion metadata in the response. False by default. WIll be available in future releases.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Returns the Node configuartion successfully.

typestring

Type of the Node

extensionstring
labelstring

Replaces the default name of the Node displayed in the Flow Editor.

commentstring

Adds additional information about Nodes, for example, a specific of the Node.

isEntryPointboolean
isDisabledboolean
configobject
localeReferencestring
analyticsLabelstring
_idstring
conversionMetadataobject

Optional conversion metadata included when includeConversionMetadata=true

Example response

{
  "type": "if",
  "extension": "@cognigy/basic-nodes",
  "label": "A new Node",
  "comment": "this is a very important node",
  "commentColor": "#ff8a80",
  "config": {
    "condition": {
      "type": "rule",
      "condition": "",
      "rule": {
        "left": "1",
        "operand": "gt",
        "right": "2"
      }
    }
  },
  "localeReference": "63bd8ebb648e6e739f1bbd82",
  "analyticsLabel": "condition",
  "mock": {
    "code": "console.log('Hello, world!');"
  },
  "conversionMetadata": {
    "fieldName1": "updated",
    "fieldName2": "removed"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.