Virima API Specification - ChangeAttributeService Services

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

Contents

1 addType POST Interface
2 addRisk POST Interface
3 addClosureCode POST Interface
4 addClass POST Interface
5 addSubClass POST Interface
6 addStage POST Interface
7 addState POST Interface
8 addCategory POST Interface
9 addWorkflow POST Interface
10 configureWorkflow POST Interface
11 getStages GET Interface
12 getWorkflowConfiguration GET Interface
13 getStates GET Interface
14 getSubClasses GET Interface
15 getClassImages GET Interface
16 getWorkflows GET Interface

addType POST Interface

Method: POST

Relative URL: change-attribute/type

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDTYPE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

addRisk POST Interface

Method: POST

Relative URL: change-attribute/risk

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDRISK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

addClosureCode POST Interface

Method: POST

Relative URL: change-attribute/closure-code

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDCLOSURECODE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

addClass POST Interface

Method: POST

Relative URL: change-attribute/class

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDCLASS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

addSubClass POST Interface

Method: POST

Relative URL: change-attribute/sub-class

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDSUBCLASS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

addStage POST Interface

Method: POST

Relative URL: change-attribute/stage

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDSTAGE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

addState POST Interface

Method: POST

Relative URL: change-attribute/state

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDSTATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

addCategory POST Interface

Method: POST

Relative URL: change-attribute/category

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDCATEGORY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

addWorkflow POST Interface

Method: POST

Relative URL: change-attribute/workflow

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDWORKFLOW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

configureWorkflow POST Interface

Method: POST

Relative URL: change-attribute/configure-workflow

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ChangeWorkflow

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

CONFIGUREWORKFLOW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "workflowId":?,
   "currentStage":"?",
   "currentState":"?",
   "nextStage":"?",
   "nextState":"?",
   "currentRole":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "nextRole":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

getStages GET Interface

Method: GET

Relative URL: change-attribute/get-stages

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

Example Response:

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

getWorkflowConfiguration GET Interface

Method: GET

Relative URL: change-attribute/get-workflow-configuration/workflow-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

Example Response:

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

getStates GET Interface

Method: GET

Relative URL: change-attribute/get-states/stage-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

Example Response:

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

getSubClasses GET Interface

Method: GET

Relative URL: change-attribute/get-sub-classes/category-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

Example Response:

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

getClassImages GET Interface

Method: GET

Relative URL: change-attribute/get-images/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

Example Response:

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

getWorkflows GET Interface

Method: GET

Relative URL: change-attribute/get-workflows

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

Example Response:

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