Virima API Specification - IncidentService Services

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

Contents

1 saveIncidentCategoryPic GET Interface
2 addIncident POST Interface
3 editIncident POST Interface
4 cloneIncident GET Interface
5 reOpenIncident POST Interface
6 getDefaultTemplate GET Interface
7 getAllProperties POST Interface
8 addNewProperty POST Interface
9 getDefaultProperties GET Interface
10 getIncident GET Interface
11 getIncidentProperties GET Interface
12 getLatestIncidents GET Interface
13 getIncidentSearchRecords POST Interface
14 getProcedureFromIncident GET Interface
15 createProblem GET Interface
16 createKnowledge GET Interface
17 addIncidentForServiceCatalogItem POST Interface
18 cancelRequest GET Interface
19 changeState POST Interface
20 getStates GET Interface
21 saveCustomStates POST Interface
22 getTaskStatus GET Interface
23 incidentBulkUpdates POST Interface
24 editBulkIncidents POST Interface
25 getAssigneeAutoFillValues POST Interface
26 getExistingProperties POST Interface

saveIncidentCategoryPic GET Interface

Method: GET

Relative URL: incident/save-incident-category-pic/image-name/incident-category-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

addIncident POST Interface

Description: Service to create incidents. This service is a POST service which takes parameter of type EditValuesArray. It creates an incident and stores audit record for that incident. It also schedules the incident based on the timescale defined by the client and the current state to check for any Service Level Agreement(SLA) violations.

Method: POST

Relative URL: incident/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
editValuesArray	EditValuesArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDINCIDENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "customerId":"?",
   "mspClientId":"?",
   "module":"?",
   "workflowId":?,
   "templateName":"?",
   "templateId":"?",
   "selectedTemplate":"?",
   "accessRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "isTemplate":?,
   "isMultiple":?,
   "archive":?,
   "currentAssigneeRole":"?",
   "isIncident":?,
   "moving":?,
   "createdFromTask":?,
   "checkSession":?,
   "loggedInUserId":?,
   "createdFromEntity":"?",
   "createdFromEntityId":?,
   "privatePropertyList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "privatePropertyRoleList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "timescale":[
      {
         "responseTime":"?",
         "resolutionTime":"?",
         "firstLevelSupport":"?",
         "secondLevelSupport":"?",
         "thirdLevelSupport":"?",
         "timescaleNotifications":[
            {
               "customTimeScale":?,
               "action":"?",
               "timing":"?",
               "minutes":"?",
               "module":"?",
            }         ]
      }   ],
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ],
   "totalTimeSpent":?,
   "userEmailId":"?",
   "fromSACM":?,
   "copyId":"?",
   "isCopiedByPrimaryCustomer":?,
   "mspIncidentId":"?",
   "idList":[
      {
         "flag":?
      }   ],
   "isImport":?,
   "isBulkUpdate":?
}

Example Response:

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

editIncident POST Interface

Description: Service to edit incidents. This service is a POST service which takes parameter of type EditValuesArray. It updates an incident and stores audit record for that incident. It re-schedules the incident based on the timescale defined by the client, if any state change is done, to check for any Service Level Agreement(SLA) violations.

Method: POST

Relative URL: incident/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
editValuesArray	EditValuesArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITINCIDENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "customerId":"?",
   "mspClientId":"?",
   "module":"?",
   "workflowId":?,
   "templateName":"?",
   "templateId":"?",
   "selectedTemplate":"?",
   "accessRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "isTemplate":?,
   "isMultiple":?,
   "archive":?,
   "currentAssigneeRole":"?",
   "isIncident":?,
   "moving":?,
   "createdFromTask":?,
   "checkSession":?,
   "loggedInUserId":?,
   "createdFromEntity":"?",
   "createdFromEntityId":?,
   "privatePropertyList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "privatePropertyRoleList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "timescale":[
      {
         "responseTime":"?",
         "resolutionTime":"?",
         "firstLevelSupport":"?",
         "secondLevelSupport":"?",
         "thirdLevelSupport":"?",
         "timescaleNotifications":[
            {
               "customTimeScale":?,
               "action":"?",
               "timing":"?",
               "minutes":"?",
               "module":"?",
            }         ]
      }   ],
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ],
   "totalTimeSpent":?,
   "userEmailId":"?",
   "fromSACM":?,
   "copyId":"?",
   "isCopiedByPrimaryCustomer":?,
   "mspIncidentId":"?",
   "idList":[
      {
         "flag":?
      }   ],
   "isImport":?,
   "isBulkUpdate":?
}

Example Response:

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

cloneIncident GET Interface

Description: Service to clone an existing incident. This service is a GET service which takes incident id as parameter. It clones the incident with given id by creating a new incident and storing audit record for the cloned incident. It also schedules the cloned incident based on the timescale defined by the client and the current state to check for any Service Level Agreement(SLA) violations.

Method: GET

Relative URL: incident/clone/incident-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":"?"
}

reOpenIncident POST Interface

Description: Service to re-open a closed or resolved incident. An incident can be re-opened if the reporter is not satisfied with the resolution or closure. It also schedules the re-opened incident based on the timescale defined by the client and the current state to check for any Service Level Agreement(SLA) violations.

Method: POST

Relative URL: incident/re-open/user-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
incidentDetails	DataInput

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

REOPENINCIDENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "dataValue":"?",
   "description":"?"
}

Example Response:

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

getDefaultTemplate GET Interface

Description: Service to get default incident model to create an incident.

Method: GET

Relative URL: incident/get-default-model

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getAllProperties POST Interface

Description: Service to get all properties of specified module. This is useful if we want to add new property to the specified module, which can be done while adding a model of the specified module.

Method: POST

Relative URL: incident/get-all-properties/module/model-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
ignoreProperties	ListOfString

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

GETALLPROPERTIES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "ignoreProperties":"?"
}

Example Response:

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

addNewProperty POST Interface

Description: Service to add new property to the specified module. This can be done while adding a model.

Method: POST

Relative URL: incident/add-new-property

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
template	AddNewITSMProperty

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

ADDNEWPROPERTY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "propertyName":"?",
   "propertyGroupName":"?",
   "propertyType":"?",
   "propertyStyle":"?",
   "isMandatory":?,
   "isMultiple":?,
   "possibleValues":"?",
   "dependsOn":"?",
   "module":"?",
   "linkTo":"?",
   "index":?,
   "columnName":"?",
   "usedBy":"?"
}

Example Response:

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

getDefaultProperties GET Interface

Description: Service to get default properties of the specified module to create a model.

Method: GET

Relative URL: incident/get-default-properties/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getIncident GET Interface

Description: Service to get the particular incident details.

Method: GET

Relative URL: incident/get-incident/incident-id/template-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getIncidentProperties GET Interface

Description: Service to get the all incident properties.

Method: GET

Relative URL: incident/get-incident-properties

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getLatestIncidents GET Interface

Description: Service to get latest incidents created.

Method: GET

Relative URL: incident/get-latest-incidents/search-key

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getIncidentSearchRecords POST Interface

Description: Service to get latest incidents, problems and known errors created based on the conditions specified.

Method: POST

Relative URL: incident/get-search-inc-records

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	SearchPojo

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

GETINCIDENTSEARCHRECORDS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "title":"?",
   "reporter":"?",
   "category":"?",
   "associatedCIs":"?",
   "module":"?",
   "topic":"?"
}

Example Response:

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

getProcedureFromIncident GET Interface

Description: Service to get the procedure to handle incident.

Method: GET

Relative URL: incident/get-procedure/model-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

createProblem GET Interface

Description: Service to create problem from incident page. It creates a problem and stores audit record for that problem. It also schedules the problem based on the timescale defined by the client and the current state to check for any Service Level Agreement(SLA) violations.

Method: GET

Relative URL: incident/create-problem/incident-id/template-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

createKnowledge GET Interface

Method: GET

Relative URL: incident/create-knowledge/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

addIncidentForServiceCatalogItem POST Interface

Description: Service to create requests from service catalog item. It creates a request and stores audit record for that request. It also schedules the request based on the timescale defined by the client and the current state to check for any Service Level Agreement(SLA) violations.

Method: POST

Relative URL: incident/add-service-catalog-item-incident

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
addRequestItemFromSC	AddRequestItemFromSC

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDINCIDENTFORSERVICECATALOGITEM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "modelId":?,
   "quantity":?,
   "catalogItemID":?,
   "description":"?",
   "userName":"?",
   "billedTo":?,
   "userInputDescription":"?",
   "isPasswordResetForLoggedInUser":?,
   "similarItems":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "inputDescription":"?"
}

Example Response:

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

cancelRequest GET Interface

Description: Service to cancel request if it is not fulfilled or closed.

Method: GET

Relative URL: incident/cancel-request/request-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

changeState POST Interface

Method: POST

Relative URL: incident/change-state

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
editValuesArray	EditValuesArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

CHANGESTATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "customerId":"?",
   "mspClientId":"?",
   "module":"?",
   "workflowId":?,
   "templateName":"?",
   "templateId":"?",
   "selectedTemplate":"?",
   "accessRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "isTemplate":?,
   "isMultiple":?,
   "archive":?,
   "currentAssigneeRole":"?",
   "isIncident":?,
   "moving":?,
   "createdFromTask":?,
   "checkSession":?,
   "loggedInUserId":?,
   "createdFromEntity":"?",
   "createdFromEntityId":?,
   "privatePropertyList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "privatePropertyRoleList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "timescale":[
      {
         "responseTime":"?",
         "resolutionTime":"?",
         "firstLevelSupport":"?",
         "secondLevelSupport":"?",
         "thirdLevelSupport":"?",
         "timescaleNotifications":[
            {
               "customTimeScale":?,
               "action":"?",
               "timing":"?",
               "minutes":"?",
               "module":"?",
            }         ]
      }   ],
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ],
   "totalTimeSpent":?,
   "userEmailId":"?",
   "fromSACM":?,
   "copyId":"?",
   "isCopiedByPrimaryCustomer":?,
   "mspIncidentId":"?",
   "idList":[
      {
         "flag":?
      }   ],
   "isImport":?,
   "isBulkUpdate":?
}

Example Response:

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

getStates GET Interface

Description: Service to get all possible state values

Method: GET

Relative URL: incident/get-states/model-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

saveCustomStates POST Interface

Description: Service to save custom state possible values for incident model. List of states in order and model id need to be passed as input

Method: POST

Relative URL: incident/save-custom-states

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
stateIdList	IntList

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

SAVECUSTOMSTATES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "value":[
      {
         "value":?
      }   ]
}

Example Response:

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

getTaskStatus GET Interface

Description: Service to get the procedure to handle incident.

Method: GET

Relative URL: incident/get-task-status

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

incidentBulkUpdates POST Interface

Method: POST

Relative URL: incident/incident-bulk-updates

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
editValuesArray	EditValuesArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

INCIDENTBULKUPDATES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "customerId":"?",
   "mspClientId":"?",
   "module":"?",
   "workflowId":?,
   "templateName":"?",
   "templateId":"?",
   "selectedTemplate":"?",
   "accessRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "isTemplate":?,
   "isMultiple":?,
   "archive":?,
   "currentAssigneeRole":"?",
   "isIncident":?,
   "moving":?,
   "createdFromTask":?,
   "checkSession":?,
   "loggedInUserId":?,
   "createdFromEntity":"?",
   "createdFromEntityId":?,
   "privatePropertyList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "privatePropertyRoleList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "timescale":[
      {
         "responseTime":"?",
         "resolutionTime":"?",
         "firstLevelSupport":"?",
         "secondLevelSupport":"?",
         "thirdLevelSupport":"?",
         "timescaleNotifications":[
            {
               "customTimeScale":?,
               "action":"?",
               "timing":"?",
               "minutes":"?",
               "module":"?",
            }         ]
      }   ],
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ],
   "totalTimeSpent":?,
   "userEmailId":"?",
   "fromSACM":?,
   "copyId":"?",
   "isCopiedByPrimaryCustomer":?,
   "mspIncidentId":"?",
   "idList":[
      {
         "flag":?
      }   ],
   "isImport":?,
   "isBulkUpdate":?
}

Example Response:

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

editBulkIncidents POST Interface

Method: POST

Relative URL: incident/edit-bulk

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
editValuesArray	EditValuesArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITBULKINCIDENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "customerId":"?",
   "mspClientId":"?",
   "module":"?",
   "workflowId":?,
   "templateName":"?",
   "templateId":"?",
   "selectedTemplate":"?",
   "accessRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "isTemplate":?,
   "isMultiple":?,
   "archive":?,
   "currentAssigneeRole":"?",
   "isIncident":?,
   "moving":?,
   "createdFromTask":?,
   "checkSession":?,
   "loggedInUserId":?,
   "createdFromEntity":"?",
   "createdFromEntityId":?,
   "privatePropertyList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "privatePropertyRoleList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "timescale":[
      {
         "responseTime":"?",
         "resolutionTime":"?",
         "firstLevelSupport":"?",
         "secondLevelSupport":"?",
         "thirdLevelSupport":"?",
         "timescaleNotifications":[
            {
               "customTimeScale":?,
               "action":"?",
               "timing":"?",
               "minutes":"?",
               "module":"?",
            }         ]
      }   ],
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ],
   "totalTimeSpent":?,
   "userEmailId":"?",
   "fromSACM":?,
   "copyId":"?",
   "isCopiedByPrimaryCustomer":?,
   "mspIncidentId":"?",
   "idList":[
      {
         "flag":?
      }   ],
   "isImport":?,
   "isBulkUpdate":?
}

Example Response:

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

getAssigneeAutoFillValues POST Interface

Method: POST

Relative URL: incident/get-assignee-autofill-values

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETASSIGNEEAUTOFILLVALUES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

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

getExistingProperties POST Interface

Method: POST

Relative URL: incident/get-existing-properties/module/model-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
ignoreProperties	ListOfString

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

GETEXISTINGPROPERTIES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "ignoreProperties":"?"
}

Example Response:

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