Virima API Specification - RequestAttributeService Services

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

Contents

1 addState POST Interface
2 editApprovalState POST Interface
3 addCategory POST Interface
4 addSubCategory POST Interface

addState POST Interface

Service to add/edit/delete an Incident State. In the post input if archive is false incident state will be deleted. id -1 will add a new state , and any other value of id will be an update to the current state. Edit or delete on a used state or default state is prohibitted.

Method: POST

Relative URL: request-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":1246865149,
   "response":"?"
}

editApprovalState POST Interface

Service to add/edit/delete an Request Approval State. In the post input if archive is false Request Approval State will be deleted. id -1 will add a new state , and any other value of id will be an update to the current state. Edit or delete on a used state or default state is prohibitted.

Method: POST

Relative URL: request-attribute/approvalstate-edit

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:

EDITAPPROVALSTATE 
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

Service to add/edit/delete an Request Categery. In the post input if archive is false Request Category will be deleted. id -1 will add a new Category , and any other value of id will be an update to the current Category. Edit or delete on a used Category or default Category is prohibitted.

Method: POST

Relative URL: request-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":"?"
}

addSubCategory POST Interface

Service to add/edit/delete an Request SubCategery. In the post input if archive is false Request SubCategory will be deleted. id -1 will add a new SubCategory , and any other value of id will be an update to the current SubCategory.

Method: POST

Relative URL: request-attribute/sub-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:

ADDSUBCATEGORY 
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":"?"
}