Virima API Specification - RiskMangaementService Services

The requests documented in this section are directed to RiskMangaementService resources, which represent User addRisk, archiveRisk, editRisk,getAllRiskRecords, getHistory, getRiskProperties,getRiskFilterRecord, getRiskCount, addRiskDashborad,getRiskDashborad, wildCardSearchRisk, getRecordsFromIdsRisk, exportRisk, exportRiskSearch-- as called by a partner or directly by a webapp using the API..

Contents

1 addRisk POST Interface
2 archiveRisk POST Interface
3 editRisk POST Interface
4 associateRiskWithChange POST Interface
5 editRiskScore POST Interface
6 getRiskScore GET Interface

addRisk POST Interface

addRiskService(POST) is called when user is trying to add risk using user credential.

Checks for mandatory fields(name,owner,project,risk type,status,probability,impact)
The risk score is calculated if all the mandatory fields are filled.
else throws an error

Method: POST

Relative URL: risk-management/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
risk	AddRisk

Response Structure:

Field Name	Type	Description
response	RecordID

Example Request:

ADDRISK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "additionalInfo":"?",
   "description":"?",
   "name":"?",
   "impact":"?",
   "mitigationStrategy":"?",
   "ownerId":?,
   "probability":"?",
   "source":"?",
   "status":"?",
   "strategies":"?",
   "trend":"?",
   "trigger":"?",
   "type":"?",
   "impacts":"?",
}

Example Response:

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

archiveRisk POST Interface

archiveRiskService(POST) is called when user wants to delete risk Record.

It checks for RecordId that the user wants to delete.

If Id is found, then the record is deleted.

else it throws an error

Method: POST

Relative URL: risk-management/archive

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
deleteRequest	DeleteRequest

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ARCHIVERISK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordId":?,
   "scanId":?,
   "entity":"?",
   "isParser":"?"
}

Example Response:

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

editRisk POST Interface

editRiskService(POST) is called when user wants to edit the risk Record.

The Id of the Record the user wants to edit is checked.

If Id is found, then the record can be edited.

else it throws an error

Any field can be edited by the user, if the record with id is found.

Method: POST

Relative URL: risk-management/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
risk	Risk

Response Structure:

Field Name	Type	Description
risk	Risk

Example Request:

EDITRISK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "score":?,
   "createdOn":?,
   "lastModifiedOn":?,
   "additionalInfo":"?",
   "description":"?",
   "impact":"?",
   "impacts":"?",
   "mitigationStrategy":"?",
   "probability":"?",
   "project":[
      {
         "id":428847156,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "changes":[
      {
         "id":4467429,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "source":"?",
   "status":"?",
   "strategies":"?",
   "trend":"?",
   "trigger":"?",
   "type":"?",
   "name":"?",
   "archive":?,
   "owner": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "id":1233742582,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?"
}

Example Response:

{
   "id":2147483647,
   "score":?,
   "createdOn":?,
   "lastModifiedOn":?,
   "additionalInfo":"?",
   "description":"?",
   "impact":"?",
   "impacts":"?",
   "mitigationStrategy":"?",
   "probability":"?",
   "project":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "changes":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "source":"?",
   "status":"?",
   "strategies":"?",
   "trend":"?",
   "trigger":"?",
   "type":"?",
   "name":"?",
   "archive":?,
   "owner": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "id":944930439,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?"
}

associateRiskWithChange POST Interface

Associate or deassociate risks with change

Method: POST

Relative URL: risk-management/change-risk-association/action

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
list	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

editRiskScore POST Interface

Edit Risk score configuration

Method: POST

Relative URL: risk-management/edit-risk-score

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
list	RiskScoreList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITRISKSCORE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "riskScores":[
      {
         "id":2147483647,
         "score":?,
         "probability":"?",
         "impact":"?"
      }   ]
}

Example Response:

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

getRiskScore GET Interface

Get Risk score configuration

Method: GET

Relative URL: risk-management/get-risk-score

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