Virima API Specification - HardwareAssetService Services

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

Contents

1 getAllHardwareAssets GET Interface
2 addNewHardwareProperty POST Interface
3 edithardwareGroup POST Interface
4 getHardwareGroup GET Interface
5 getHardwareProperties GET Interface
6 getHardware GET Interface
7 getAllHardwareITAMProperties GET Interface
8 editHardwareForNewLogic POST Interface
9 saveStockRoom POST Interface
10 deleteAllHardware POST Interface

getAllHardwareAssets GET Interface

Method: GET

Relative URL: hardware-asset/get

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
hardwareAssetList	ValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":166669335,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":1140295080,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":1669347204,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

addNewHardwareProperty POST Interface

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

Method: POST

Relative URL: hardware-asset/add-new-hardware-property

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
template	AddNewHarwareProperty

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

ADDNEWHARDWAREPROPERTY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "propertyName":"?",
   "propertyGroup":"?",
   "uniqueId":"?",
   "propertyType":"?",
   "propertyStyle":"?",
   "isDependent":?,
   "isMandatory":?,
   "isMultiple":?,
   "possibleValues":"?",
   "dependsOn":"?",
   "module":"?",
   "linkTo":"?",
   "isVisible":?,
   "columnName":"?",
   "defaultColumn":?,
   "uiOrder":?,
   "dbClassName":"?",
   "usedBy":"?",
   "isCorrelator":?
}

Example Response:

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

edithardwareGroup POST Interface

Method: POST

Relative URL: hardware-asset/edit-hardware-group

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	HardwareGroup

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITHARDWAREGROUP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "groupName":"?",
   "uiOrder":?
}

Example Response:

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

getHardwareGroup GET Interface

Method: GET

Relative URL: hardware-asset/get-hardware-group

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

getHardwareProperties GET Interface

Method: GET

Relative URL: hardware-asset/get-hardware-prop

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

getHardware GET Interface

Description: Service to get the particular incident details.

Method: GET

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

getAllHardwareITAMProperties GET 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: GET

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

editHardwareForNewLogic POST Interface

Method: POST

Relative URL: hardware-asset/edit-hardware-for-newlogic

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:

EDITHARDWAREFORNEWLOGIC 
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":311738109,
   "response":"?"
}

saveStockRoom POST Interface

Description: service to save stockroom details

Method: POST

Relative URL: hardware-asset/save-stockroom

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
stockroom	HardwareStock

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVESTOCKROOM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "stockId":"?",
   "hardwareId":"?",
}

Example Response:

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

deleteAllHardware POST Interface

Method: POST

Relative URL: hardware-asset/delete-multiple-hardware/hardware-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEALLHARDWARE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":1968645900,
         "flag":?
      }   ]
}

Example Response:

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