Virima API Specification - WorkflowService Services

The requests documented in this section are directed to WorkflowService resources, which represent .

Contents

1 addWorkflow POST Interface
2 addNewWorkflow POST Interface
3 addNewGraphicalWorkflow POST Interface
4 getWorkflows GET Interface
5 getRunbook GET Interface
6 getProperties GET Interface
7 getAssociations POST Interface
8 getAllBlueprintAssociations GET Interface
9 getRunbookbyid GET Interface
10 getGraphicalWorkflows GET Interface
11 saveImageToTranstion GET Interface
12 applyWorkflowToExistingRecords GET Interface
13 getConditionTransition GET Interface
14 getWorkflowDetails GET Interface
15 saveSVG GET Interface
16 addGraphicalWorkflow POST Interface
17 getGraphicalData GET Interface
18 getWorkflowXML GET Interface

addWorkflow POST Interface

Method: POST

Relative URL: workflow/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
workflow	Workflow

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDWORKFLOW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "uniqueId":"?",
   "description":"?",
   "entity":"?",
   "order":"?",
   "applyOn":"?",
   "archive":?,
   "enable":?,
   "cascade":?,
   "actionType":"?",
   "targetModule":"?",
   "targetRecord": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "targetModel":?,
   "condition":[
      {
         "workflowId":"?",
         "operator": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "column":"?",
         "value":"?",
         "value1":"?",
         "condition":"?",
         "blockId":"?"
      }   ],
   "transition":[
      {
         "workflowId":"?",
         "column":"?",
         "value":"?",
         "roleType":"?",
         "mapToProperty":"?",
         "mapped":?,
         "triggered":?,
         "blockId":"?",
         "transitionBlockId":"?"
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "property":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "applyToAllExistingRecords":?,
   "status":"?",
   "graphicalData":"?",
   "ignoreids":"?",
   "selectedItems":"?",
   "isAllBlueprints":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addNewWorkflow POST Interface

Method: POST

Relative URL: workflow/add-new

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
workflow	WorkflowNew

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDNEWWORKFLOW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "archive":?,
   "cascade":?,
   "description":"?",
   "enable":?,
   "entity":"?",
   "name":"?",
   "order":"?",
   "applyOn":"?",
   "workflowBlockArray":[
      {
         "applyOn":"?",
         "user":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "property":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "role":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "group":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "department":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "workflowBlockCondition":[
            {
               "workflowId":"?",
               "column":"?",
               "value":"?",
               "value1":"?",
               "condition":"?",
               "blockId":"?"
            }         ],
         "workflowTransitionBlockArray":[
            {
               "actionType":"?",
               "targetModule":"?",
               "targetModel":?,
               "applyOn":"?",
               "blockId":"?",
               "runbookIds":"?",
            }         ]
      }   ],
   "graphicalData":"?",
   "associatedTemplateOrBlueprint":"?",
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "isAllBlueprints":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addNewGraphicalWorkflow POST Interface

Method: POST

Relative URL: workflow/add-new-graphical-workflow

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
workflow	WorkflowNew

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDNEWGRAPHICALWORKFLOW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "archive":?,
   "cascade":?,
   "description":"?",
   "enable":?,
   "entity":"?",
   "name":"?",
   "order":"?",
   "applyOn":"?",
   "workflowBlockArray":[
      {
         "applyOn":"?",
         "user":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "property":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "role":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "group":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "department":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "workflowBlockCondition":[
            {
               "workflowId":"?",
               "column":"?",
               "value":"?",
               "value1":"?",
               "condition":"?",
               "blockId":"?"
            }         ],
         "workflowTransitionBlockArray":[
            {
               "actionType":"?",
               "targetModule":"?",
               "targetModel":?,
               "applyOn":"?",
               "blockId":"?",
               "runbookIds":"?",
            }         ]
      }   ],
   "graphicalData":"?",
   "associatedTemplateOrBlueprint":"?",
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "isAllBlueprints":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getWorkflows GET Interface

Method: GET

Relative URL: workflow/get-workflows/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":1751798548,
   "response":"?"
}

getRunbook GET Interface

Method: GET

Relative URL: workflow/get-runbook/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getProperties GET Interface

Method: GET

Relative URL: workflow/get-properties/module/blueprint-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAssociations POST Interface

Method: POST

Relative URL: workflow/get-associations/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
workflow	Workflow

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETASSOCIATIONS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "uniqueId":"?",
   "description":"?",
   "entity":"?",
   "order":"?",
   "applyOn":"?",
   "archive":?,
   "enable":?,
   "cascade":?,
   "actionType":"?",
   "targetModule":"?",
   "targetRecord": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "targetModel":?,
   "condition":[
      {
         "workflowId":"?",
         "operator": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "column":"?",
         "value":"?",
         "value1":"?",
         "condition":"?",
         "blockId":"?"
      }   ],
   "transition":[
      {
         "workflowId":"?",
         "column":"?",
         "value":"?",
         "roleType":"?",
         "mapToProperty":"?",
         "mapped":?,
         "triggered":?,
         "blockId":"?",
         "transitionBlockId":"?"
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "property":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "applyToAllExistingRecords":?,
   "status":"?",
   "graphicalData":"?",
   "ignoreids":"?",
   "selectedItems":"?",
   "isAllBlueprints":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllBlueprintAssociations GET Interface

Method: GET

Relative URL: workflow/get-all-associations

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getRunbookbyid GET Interface

Method: GET

Relative URL: workflow/get-runbookby-id/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getGraphicalWorkflows GET Interface

Method: GET

Relative URL: workflow/get-graphical-workflows/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveImageToTranstion GET Interface

Method: GET

Relative URL: workflow/save-image-to-transition/work-flow-id/image

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

applyWorkflowToExistingRecords GET Interface

Method: GET

Relative URL: workflow/apply-workflow-to-existing-records/work-flow-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2029556922,
   "response":"?"
}

getConditionTransition GET Interface

Method: GET

Relative URL: workflow/get-condition-transition/workflow-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":1247619659,
   "response":"?"
}

getWorkflowDetails GET Interface

Method: GET

Relative URL: workflow/get-workflow-details/workflow-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":1907257041,
   "response":"?"
}

saveSVG GET Interface

Method: GET

Relative URL: workflow/save-svg/svg-data

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":844607396,
   "response":"?"
}

addGraphicalWorkflow POST Interface

Method: POST

Relative URL: workflow/add-graphical-workflow

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
workflow	ArrayOfWorkflows

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDGRAPHICALWORKFLOW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "workflow":[
      {
         "name":"?",
         "uniqueId":"?",
         "description":"?",
         "entity":"?",
         "order":"?",
         "applyOn":"?",
         "archive":?,
         "enable":?,
         "cascade":?,
         "actionType":"?",
         "targetModule":"?",
         "targetRecord": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetModel":?,
         "condition":[
            {
               "workflowId":"?",
               "column":"?",
               "value":"?",
               "value1":"?",
               "condition":"?",
               "blockId":"?"
            }         ],
         "transition":[
            {
               "workflowId":"?",
               "column":"?",
               "value":"?",
               "roleType":"?",
               "mapToProperty":"?",
               "mapped":?,
               "triggered":?,
               "blockId":"?",
               "transitionBlockId":"?"
            }         ],
         "user":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "property":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "role":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "group":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "department":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "createdOn":?,
         "lastModifiedOn":?,
         "lastModifiedBy": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "applyToAllExistingRecords":?,
         "status":"?",
         "graphicalData":"?",
         "ignoreids":"?",
         "selectedItems":"?",
         "isAllBlueprints":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getGraphicalData GET Interface

Method: GET

Relative URL: workflow/get-graphical-data/workflow-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getWorkflowXML GET Interface

Method: GET

Relative URL: workflow/get-workflow-xml/workflow-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}