Nodes
Get all Node Descriptors
Gets all Node descriptors of a Flow. A descriptor defines a node type, its capabilities, appearance, and behavior in the Flow Chart. The descriptor acts as a blueprint for creating Nodes.
get/v2.0/flows/{flowId}/chart/descriptors
Request
- Base URLhttps://api-trial.cognigy.ai/testing
- Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- or API key in header x-cxone-authorization
- or OAuth 2Authorization code/auth/oauth2/authorizePasswordToken URL/auth/oauth2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
flowIdstring required
The unique identifier for the Flow.
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 an array of Node descriptors.
Example response
{
"items": [
{
"appearance": {
"textColor": "none",
"contrastTextColor": "none",
"color": "none"
},
"tokens": [
{
"label": "word count",
"script": "ci.text.split(' ').length",
"type": "input"
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.