This documentation provides comprehensive access to the full range of functionalities offered by the NP6 platform through a standardized RESTful interface.
If you have any questions or need assistance, please contact our support team at https://support.chapsvision.com.
Data used to create the workflow
The workflow's script settings
The workflow's listeners
The workflow's capping definition
The workflow's nodes
curl -i -X POST \
https://api-cm.np6.com/scripting/workflows \
-H 'Content-Type: application/json' \
-H 'X-Key: string' \
-d '{
"id": 0,
"name": "string",
"description": "string",
"state": 0,
"creationDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z",
"scripting": {
"version": "string"
},
"settings": {},
"listeners": [
{
"id": "string",
"name": "string",
"description": "string",
"event": {
"type": "string"
},
"handler": "string"
}
],
"capping": [
{
"key": {
"type": "string"
},
"increment": 0,
"threshold": 0,
"period": {
"type": "string"
},
"nodes": [
"string"
]
}
],
"nodes": [
{
"type": "string"
}
],
"tasks": [
{
"id": "string",
"name": "string",
"description": "string",
"schedulers": [
{
"type": "string"
}
],
"provider": {
"type": "string"
},
"handler": "string"
}
]
}'The created workflow
The workflow's script settings
The workflow's listeners
The workflow's capping definition
The workflow's nodes
{ "id": 0, "name": "string", "description": "string", "state": 0, "creationDate": "2019-08-24T14:15:22Z", "updateDate": "2019-08-24T14:15:22Z", "scripting": { "version": "string" }, "settings": {}, "listeners": [ { "id": "string", "name": "string", "description": "string", "event": { "type": "string" }, "handler": "string" } ], "capping": [ { "key": { "type": "string" }, "increment": 0, "threshold": 0, "period": { "type": "string" }, "nodes": [ "string" ] } ], "nodes": [ { "type": "string" } ], "tasks": [ { "id": "string", "name": "string", "description": "string", "schedulers": [ { "type": "string" } ], "provider": { "type": "string" }, "handler": "string" } ] }
curl -i -X GET \
'https://api-cm.np6.com/scripting/workflows/{id}/listeners' \
-H 'X-Key: string'[ { "id": "string", "name": "string", "description": "string", "event": { "type": "string" }, "handler": "string" } ]
Data used to update listeners of the workflow
The listener's event
curl -i -X PUT \
'https://api-cm.np6.com/scripting/workflows/{id}/listeners' \
-H 'Content-Type: application/json' \
-H 'X-Key: string' \
-d '[
{
"id": "string",
"name": "string",
"description": "string",
"event": {
"type": "string"
},
"handler": "string"
}
]'[ { "id": "string", "name": "string", "description": "string", "event": { "type": "string" }, "handler": "string" } ]