Virima API Specification - GroupProbeService Services
The requests documented in this section are directed to
GroupProbeService 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..
archiveGroupProbe 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: group-probe/archive
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Request Structure:
Field Name | Type | Description |
---|
groupProbeId | RecordID | |
Response Structure:
Field Name | Type | Description |
---|
response | Response | |
Example Request:
ARCHIVEGROUPPROBE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"recordId":"?"
}
Example Response:
{
"id":2147483647,
"response":"?"
}
editGroupProbe 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: group-probe/edit
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Request Structure:
Field Name | Type | Description |
---|
groupProbe | GroupProbe | |
Response Structure:
Field Name | Type | Description |
---|
response | Response | |
Example Request:
EDITGROUPPROBE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"name":"?",
"description":"?",
"scriptText":"?",
"archive":?,
"uniqueId":"?"
}
Example Response:
{
"id":2147483647,
"response":"?"
}