API - Interactive Flowchart

Description

These APIs are used to perform CRUD operations on interactive flowcharts.

Create

POST /channels/{icIdOrName}/flowcharts?sessionId={sessionId}

Request Parameters:

sessionId

Body Parameter – Content-Type: application/json

{
  "audienceName": "string",
  "flowchartName": "string",
  "flowchartNote": "string"
}

Output

Table 1. Response Codes
Success	200	Ok
Created	201	Created
Error	400	Bad Request
Server Error	500	Internal Server Error

Example: Content-Type: application/json

{
  "createBy": 2,
  "createDate": 1588098600000,
  "description": "description goes here",
  "displayName": "flowchart_api_1",
  "fileName": "Session_auth_test_14_flowchart_api_1.ses",
  "flowchartId": 755,
  "flowchartName": "flowchart_api_1",
  "sessionId": 14,
  "sessionName": "Session_auth_test",
  "audienceName": "Customer",
  "name": "flowchart_api_1",
  "retired": false
}

Get

GET /channels/{icIdOrName}/flowcharts/{flowchartIdOrName}/validation? sessionId={sessionId}

Input:

Deployed State: 
 10 - Not yet Deployed
 11 - Deployed
 12 - Undeployed
 13 - To be deployed
 14 - To be undeployed
Deployment State: 
 0 - Ready for Deployment
 1 - Ready for Deployment/UnDeployment 
 2 - Marked for Deployment
 3 - Marked for UnDeployment

Input

Query Paremeters:

sessionId

Output

Table 2. Response Codes
No Content	204	No Content
Error	400	Bad Request
Not Found	404	Not Found
Server Error	500	Internal Server Error

Example: Content-Type: application/json

{
  "state": 2,
  "deployedState": 10,
  "dirty": true,
  "lastProdDepTime": null,
  "lastMarkTime": 1588146541793
}

Update

PUT /channels/{icIdOrName}/flowcharts/{flowchartIdOrName}/deployments?sessionId={sessionId}

Notes:

Allowed values for parameter deployAction:

markDeploy - mark for deployment,

markUnDeploy - mark for undeployment

Input

Query parameters:

sessionId

Body parameter

Example: Content-Type: application/json

{
  "deployAction": "string"
}

Output

Table 3. Response Codes
Accepted	202	Accepted
Error	400	Bad Request
Server Error	500	Internal Server Error

Example: Content-Type: application/json

{
  "state": 2,
  "deployedState": 10,
  "dirty": true,
  "lastProdDepTime": null,
  "lastMarkTime": 1588146541793
}

Delete

DELETE /channels/{icIdOrName}/flowcharts/{flowchartIdOrName}/deployments?sessionId={sessionId}

Input

Query parameters

sessionId

Output

Table 4. Response Codes
No Content	204	No Content
Error	400	Bad Request
Server Error	500	Internal Server Error