Virima API Specification - RequestService Services

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

Contents

1 saveRequestCategoryPic GET Interface
2 addRequest POST Interface
3 editRequest POST Interface
4 cloneRequest GET Interface
5 reOpenRequest POST Interface
6 getDefaultModel GET Interface
7 getRequest GET Interface
8 getAllRequestTemplates GET Interface
9 getLatestRequests GET Interface
10 addRequestForServiceCatalogItem POST Interface
11 addRequestForCartServiceCatalogItem POST Interface
12 cancelRequest GET Interface
13 getRequestSearchRecords POST Interface
14 createKnowledge GET Interface

saveRequestCategoryPic GET Interface

Method: GET

Relative URL: request/save-request-category-pic/image-name/request-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":2147483647,
   "response":"?"
}

addRequest POST Interface

Description: Service to create requests. This service is a POST service which takes parameter of type EditValuesArray. 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: request/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:

ADDREQUEST 
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":683211149,
   "response":"?"
}

editRequest POST Interface

Description: Service to edit requests. This service is a POST service which takes parameter of type EditValuesArray. It updates a request and stores audit record for that request. It re-schedules the request 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: request/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:

EDITREQUEST 
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":1604572511,
   "response":"?"
}

cloneRequest GET Interface

Description: Service to clone an existing request. This service is a GET service which takes request id as parameter. It clones the request with given id by creating a new request and storing audit record for the cloned request. It also schedules the cloned request 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: request/clone/request-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":"?"
}

reOpenRequest POST Interface

Description: Service to re-open a closed or fulfilled request. An request can be re-opened if the requester is not satisfied with the fulfillment or closure. It also schedules the re-opened 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: request/re-open/user-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
requestDetails	DataInput

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getDefaultModel GET Interface

Description: Service to get default request model to create a request.

Method: GET

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

getRequest GET Interface

Description: Service to get the particular request details.

Method: GET

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

getAllRequestTemplates GET Interface

Description: Service to get all the request models while creating a request. client can choose the model from drop-down and the details of that model will be loaded.

Method: GET

Relative URL: request/get-all-request-templates

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

getLatestRequests GET Interface

Description: Service to get latest requests created.

Method: GET

Relative URL: request/get-latest-requests/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":"?"
}

addRequestForServiceCatalogItem 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: request/add-service-catalog-item-request

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:

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

addRequestForCartServiceCatalogItem POST Interface

Description: Service to create requests from cart 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: request/add-cart-item-request

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
addCartArrayRequest	CartItemsArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDREQUESTFORCARTSERVICECATALOGITEM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "description":"?",
   "billedTo":?,
   "cartItem":[
      {
         "name":"?",
         "modelId":?,
         "catalogItemID":?,
         "price":"?",
         "availableQuantity":?,
         "itemcount":?,
         "archive":?,
         "availability":"?",
         "trackQuantity":"?",
         "s3Name":"?",
         "category": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "vendor": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "role":[
            {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "driveFileId":"?"
      }   ]
}

Example Response:

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

cancelRequest GET Interface

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

Method: GET

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

getRequestSearchRecords POST Interface

Method: POST

Relative URL: request/get-search-req-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:

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

Example Response:

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

createKnowledge GET Interface

Method: GET

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