Virima API Specification - ServiceCatalog Services

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

Contents

1 editServiceCatalogItem POST Interface
2 saveCatalogPic GET Interface
3 saveCategoryPic GET Interface
4 addToCartServiceCatalogItem POST Interface
5 deleteCartItem POST Interface
6 getAllCartItems GET Interface
7 getAllServiceCatalogIcons GET Interface
8 editCategory POST Interface
9 editOrderItemLink POST Interface
10 editExecutionPlan POST Interface
11 editExecutionPlanTasks POST Interface
12 getAllServiceCatalogs GET Interface
13 getUserInformation GET Interface
14 canUserRequest GET Interface
15 getInputProperties GET Interface
16 editInputProperty POST Interface
17 associateUserInputWithCatalogItem POST Interface
18 getAllServiceCatalogItemsWithoutCategory GET Interface
19 editProductModels POST Interface
20 reportIssueOrsubmitReport POST Interface
21 editIncidentRequestProperty POST Interface
22 getInputPropertiesForCatalogType GET Interface
23 getMandatoryInputProperties GET Interface

editServiceCatalogItem POST Interface

Method: POST

Relative URL: service-catalog/edit-service-catalog

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
serviceCatalogItem	ServiceCatalogItem

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITSERVICECATALOGITEM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "displayOrder":?,
   "costCenter": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "price":"?",
   "recurringPrice":"?",
   "recurringPriceFrequency":"?",
   "availability":"?",
   "trackQuantity":"?",
   "availableQuantity":?,
   "omitPriceInCart":?,
   "active":?,
   "additionalCategories":"?",
   "vendor": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "category": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "orderItemLink": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "requestModel": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "incidentModel": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "model": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "executionPlan": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "approvalGroup": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "location": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdOn":?,
   "archive":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "uniqueId":"?",
   "s3Name":"?",
   "catalogType":"?",
   "inputProperties": {
         "ids":[
            {
               "scopeId":?,
               "width":"?",
               "flag":?,
               "calendar":"?"
            }         ]
      },
   "propertyInputs": {
         "module":"?",
         "property":[
            {
               "name":"?",
               "mandatory":?
            }         ]
      },
   "driveFileId":"?",
   "driveFileId16Px":"?",
   "driveFileId256Px":"?",
   "blueprint": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

Example Response:

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

saveCatalogPic GET Interface

Method: GET

Relative URL: service-catalog/save-catalog-pic/image-name/catalog-item-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":"?"
}

saveCategoryPic GET Interface

Method: GET

Relative URL: service-catalog/save-category-pic/image-name/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":"?"
}

addToCartServiceCatalogItem POST Interface

Method: POST

Relative URL: service-catalog/add-to-cart/item-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
userInput	StringClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDTOCARTSERVICECATALOGITEM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "stringobj":"?",
   "shortName":"?",
   "s3Name":"?",
   "uniqueId":"?",
   "lineType":"?",
}

Example Response:

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

deleteCartItem POST Interface

Method: POST

Relative URL: service-catalog/delete-cart-item

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cartItem	CartItem

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETECARTITEM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "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":"?"
}

getAllCartItems GET Interface

Method: GET

Relative URL: service-catalog/get-cart-service-catalog

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllServiceCatalogIcons GET Interface

Method: GET

Relative URL: service-catalog/get-service-catalog-icons

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

editCategory POST Interface

Method: POST

Relative URL: service-catalog/edit-catogery

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
category	Category

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITCATEGORY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "title":"?",
   "description":"?",
   "displayOrder":?,
   "active":?,
   "render":?,
   "parent": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "role": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "location": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdOn":?,
   "archive":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "uniqueId":"?",
   "s3Name":"?",
   "itemCount":?,
   "childCategories":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "driveFileId":"?",
   "driveFileId16Px":"?",
   "driveFileId256Px":"?"
}

Example Response:

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

editOrderItemLink POST Interface

Method: POST

Relative URL: service-catalog/edit-order-link

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
orderItemLink	OrderItemLink

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITORDERITEMLINK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "linkText":"?",
   "linkUrl":"?",
   "createdOn":?,
   "archive":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "uniqueId":"?"
}

Example Response:

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

editExecutionPlan POST Interface

Method: POST

Relative URL: service-catalog/edit-execution-plan

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
executionPlan	ExecutionPlan

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITEXECUTIONPLAN 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "totalDeliveryTime":"?",
   "createdOn":?,
   "archive":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "uniqueId":"?"
}

Example Response:

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

editExecutionPlanTasks POST Interface

Method: POST

Relative URL: service-catalog/edit-executionplan-tasks/entity-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
executionPlanTasks	ExecutionPlanTasks

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITEXECUTIONPLANTASKS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "totalDeliveryTime":"?",
   "orderTask":"?",
   "sla":"?",
   "instructions":"?",
   "notes":"?",
   "fulfillmentGroup": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "assignedTo": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdOn":?,
   "archive":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "uniqueId":"?"
}

Example Response:

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

getAllServiceCatalogs GET Interface

Method: GET

Relative URL: service-catalog/get-service-catalog

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

getUserInformation GET Interface

Method: GET

Relative URL: service-catalog/get-user-details/user-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":"?"
}

canUserRequest GET Interface

Method: GET

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

getInputProperties GET Interface

Method: GET

Relative URL: service-catalog/get-input-properties/item-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":"?"
}

editInputProperty POST Interface

Method: POST

Relative URL: service-catalog/edit-input-property

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
property	AddNewITSMProperty

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

associateUserInputWithCatalogItem POST Interface

Method: POST

Relative URL: service-catalog/associate-user-input-with-catalogitem/item-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
propertyList	ArrayOfId

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ASSOCIATEUSERINPUTWITHCATALOGITEM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "ids":[
      {
         "scopeId":?,
         "width":"?",
         "flag":?,
         "calendar":"?"
      }   ]
}

Example Response:

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

getAllServiceCatalogItemsWithoutCategory GET Interface

Method: GET

Relative URL: service-catalog/get-catalog-items-without-category

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

editProductModels POST Interface

Method: POST

Relative URL: service-catalog/edit-product-models/entity-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
productModels	ProductModels

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITPRODUCTMODELS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "modelNumber":"?",
   "modelCategories":"?",
   "createdOn":?,
   "archive":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "uniqueId":"?",
   "newVendor": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "module":"?"
}

Example Response:

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

reportIssueOrsubmitReport POST Interface

Method: POST

Relative URL: service-catalog/reportissue-or-submitreport/detail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
response	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

editIncidentRequestProperty POST Interface

Method: POST

Relative URL: service-catalog/edit-incident-request-property

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
property	PropertyArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITINCIDENTREQUESTPROPERTY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "module":"?",
   "property":[
      {
         "name":"?",
         "mandatory":?
      }   ]
}

Example Response:

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

getInputPropertiesForCatalogType GET Interface

Method: GET

Relative URL: service-catalog/get-input-properties-for-catalog/item-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":"?"
}

getMandatoryInputProperties GET Interface

Method: GET

Relative URL: service-catalog/get-mandatory-input-properties

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