Virima API Specification - ReleaseManagementService Services

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

Contents

1 addRelease POST Interface
2 editRelease POST Interface
3 getDefaultModel GET Interface
4 getRelease GET Interface
5 getAllReleaseTemplates GET Interface
6 getLatestReleases GET Interface
7 editActivity POST Interface
8 editTask POST Interface
9 editPhase POST Interface
10 addClosureCode POST Interface
11 getCalendarView GET Interface
12 createKnowledge GET Interface
13 editReleaseState POST Interface
14 editActivityState POST Interface
15 editPhaseState POST Interface
16 getActivityStates GET Interface
17 getPhaseStates GET Interface
18 getHierarchy GET Interface

addRelease POST Interface

Method: POST

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

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

editRelease POST Interface

Method: POST

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

EDITRELEASE 
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":1692886652,
   "response":"?"
}

getDefaultModel GET Interface

Method: GET

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

getRelease GET Interface

Method: GET

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

getAllReleaseTemplates GET Interface

Method: GET

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

getLatestReleases GET Interface

Method: GET

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

editActivity POST Interface

Edit Release Activity

Method: POST

Relative URL: release/edit-activity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ReleasePojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITACTIVITY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "title":"?",
   "description":"?",
   "workNotes":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "startDate":?,
   "endDate":?,
   "priority":"?",
   "status":"?",
   "tasks":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "activities":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "assignee": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "groupAssignee": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "parentActivity": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "completed":?,
   "assiciated":?
}

Example Response:

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

editTask POST Interface

Edit Release task

Method: POST

Relative URL: release/edit-task

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ReleasePojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITTASK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "title":"?",
   "description":"?",
   "workNotes":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "startDate":?,
   "endDate":?,
   "priority":"?",
   "status":"?",
   "tasks":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "activities":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "assignee": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "groupAssignee": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "parentActivity": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "completed":?,
   "assiciated":?
}

Example Response:

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

editPhase POST Interface

Edit Release Phase

Method: POST

Relative URL: release/edit-phase

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ReleasePojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITPHASE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "title":"?",
   "description":"?",
   "workNotes":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "startDate":?,
   "endDate":?,
   "priority":"?",
   "status":"?",
   "tasks":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "activities":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "assignee": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "groupAssignee": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "parentActivity": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "completed":?,
   "assiciated":?
}

Example Response:

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

addClosureCode POST Interface

Method: POST

Relative URL: release/closure-code

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDCLOSURECODE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

getCalendarView GET Interface

Method: GET

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

createKnowledge GET Interface

Method: GET

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

editReleaseState POST Interface

Method: POST

Relative URL: release/state

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

EDITRELEASESTATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

editActivityState POST Interface

Method: POST

Relative URL: release/activity-state

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

EDITACTIVITYSTATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

editPhaseState POST Interface

Method: POST

Relative URL: release/phase-state

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

EDITPHASESTATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

getActivityStates GET Interface

Service that returns possible values release activity states .

Method: GET

Relative URL: release/get-activity-states

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

getPhaseStates GET Interface

Service that returns possible values for release phase states

Method: GET

Relative URL: release/get-phase-states

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getHierarchy GET Interface

Method: GET

Relative URL: release/get-hierarchy/ci-id/release-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":"?"
}