Virima API Specification - ContractService Services

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

Contents

1 createKnowledge GET Interface
2 addNewContractProperty POST Interface
3 editContractGroup POST Interface
4 getContractGroup GET Interface
5 getContractProperties GET Interface
6 deleteRecords DELETE Interface
7 getContract GET Interface
8 getAllContractITAMProperties GET Interface
9 editContractForNewLogic POST Interface

createKnowledge GET Interface

Method: GET

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

addNewContractProperty POST Interface

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

Method: POST

Relative URL: contract/add-new-contract-property

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
template	AddNewITAMProperty

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

ADDNEWCONTRACTPROPERTY 
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":"?",
   "isCorrelator":?,
   "usedBy":"?"
}

Example Response:

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

editContractGroup POST Interface

Method: POST

Relative URL: contract/edit-contract-group

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ContractGroup

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

getContractGroup GET Interface

Method: GET

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

getContractProperties GET Interface

Method: GET

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

deleteRecords DELETE Interface

Method: DELETE

Relative URL: contract/delete-records

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:

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

Example Response:

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

getContract GET Interface

Description: Service to get the particular incident details.

Method: GET

Relative URL: contract/get-contract/contract-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getAllContractITAMProperties 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: contract/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":385149961,
   "response":"?"
}

editContractForNewLogic POST Interface

Method: POST

Relative URL: contract/edit-contract-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:

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