Virima API Specification - ITSMChangeService Services

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

addChange POST Interface

Method: POST

Relative URL: itsm-change/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:

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

editChange POST Interface

Method: POST

Relative URL: itsm-change/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:

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

saveCICategoryPic GET Interface

Method: GET

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

getDefaultModel GET Interface

Method: GET

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

getChange GET Interface

Method: GET

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

getAllChangeTemplates GET Interface

Method: GET

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

getLatestChanges GET Interface

Method: GET

Relative URL: itsm-change/get-latest-changes/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":"?"
}

getCalendarView GET Interface

Method: GET

Relative URL: itsm-change/calendar-view

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

saveCIOutage POST Interface

Method: POST

Relative URL: itsm-change/add-outage

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ChangeCIOutageArray

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

SAVECIOUTAGE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "changeId":?,
   "outage":[
      {
         "ciId":?,
         "description":"?",
         "outageStart":?,
         "outageEnd":?,
         "ci": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "change": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "archive":?
      }   ]
}

Example Response:

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

getCIOutages GET Interface

Method: GET

Relative URL: itsm-change/get-outage/change-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getOutageCalendarView GET Interface

Method: GET

Relative URL: itsm-change/outage-calendar-view

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

getCategories GET Interface

Method: GET

Relative URL: itsm-change/get-categories

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

getSubCategories GET Interface

Method: GET

Relative URL: itsm-change/get-sub-categories

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

saveRFC POST Interface

Method: POST

Relative URL: itsm-change/proposal

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ChangeProposal

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

SAVERFC 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "title":"?",
   "detail":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "category":"?",
   "subCategory":"?",
   "urgency":"?",
   "state":"?",
   "approvalState":"?",
   "approvalNotes":"?",
   "riskAssessment":"?",
   "requirementDocument":"?",
   "businessCase":"?",
   "analysis":"?",
   "design":"?",
   "proposalStart":?,
   "proposalEnd":?,
   "archive":?,
   "associatedCI": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "proposedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "assignee": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "changeModel": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "project": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "associatedCIs":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedProblems":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedKnownErrors":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedIncidents":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedRequests":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedReleases":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedKnowledges":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedChanges":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedDemands":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedAvailabilities":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedAlerts":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedEvents":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "associatedServiceCatalogItems":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "totalTimeSpent":?
}

Example Response:

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

saveChangeCABMeeting POST Interface

Method: POST

Relative URL: itsm-change/meeting

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ChangeCABMeeting

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

SAVECHANGECABMEETING 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "title":"?",
   "minutesOfMeeting":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "location": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "changeId":"?",
   "meetingDate":?,
   "members":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "cabHost": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

Example Response:

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

getSimilarItems POST Interface

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

Method: POST

Relative URL: itsm-change/get-search-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:

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

Example Response:

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

getChangePolicy GET Interface

Description: Service to get the change policy.

Method: GET

Relative URL: itsm-change/get-policy/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":1735724257,
   "response":"?"
}

editReview POST Interface

Description: Service to edit review.

Method: POST

Relative URL: itsm-change/edit-review

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
review	ChangeReview

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

EDITREVIEW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "description":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "id":808826088,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "change": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "document": {
         "id":2147483647,
         "fileId":?,
         "fileName":"?"
      },
   "archive":?
}

Example Response:

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

getReviews GET Interface

Description: Service to get reviews for a change.

Method: GET

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

createKnowledge GET Interface

Method: GET

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

getRisks GET Interface

Method: GET

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