Sync API for Risk Assessment - Action and Finding Endpoints
Sync API for Risk Assessment - Action and Finding Endpoints
1. Post API For Getting Event Data - Findings
1.1 API End Point
Web Request Method: POST
URL: api/sync/Findings/GetById
1.2 Parameters
{Id: 7A7E29BB-939A-427A-BE74-2431700EA69B }
1.3 Response
Post API for getting Event Data
{
"Finding": {
"FindingID": "7a7e29bb-939a-427a-be74-2431700ea69b",
"AuditQuestionID": "0ee88b0f-3e5d-4b23-8964-335ccbabef2b",
"GroupID": null,
"AuditeeID": "411e0db4-51b5-4165-8645-4210cac83188",
"NonComplianceText": "Finding 1 Mobile",
"Comment": null,
"LikelihoodCode": 5,
"ConsequenceCode": 5,
"TargetLikelihoodCode": 2,
"TargetConsequenceCode": 2,
"NonComplianceDate": "2024-09-25T13:59:39Z",
"NonComplianceCategoryID": 2807,
"UserID": 21347,
"NonComplianceID": null,
"CompanyID": 1225,
"NonComplianceClientIndex": "54",
"Longitude": null,
"Latitude": null,
"X": null,
"Y": null,
"Z": null,
"PotentialLoss": null,
"StatusCode": 3,
"RRLikelihoodCode": 3,
"RRConsequenceCode": 3,
"OldTargetLikelihoodCode": -1,
"OldTargetConsequenceCode": -1,
"OldRRLikelihoodCode": -1,
"OldRRConsequenceCode": -1,
"OldLikelihoodCode": -1,
"OldConsequenceCode": -1,
"CreatedDateTime": "2024-09-27T09:45:11.92Z",
"ModifiedDateTime": "2024-09-27T09:45:11.92Z",
"IsConfidential": false,
"QuestionID": 532004,
"IsDeleted": false
},
"Attachments": [],
"Hyperlinks": [],
"CustomFields": [],
"Comments": [],
"FindingConfidentialUsers": [],
"Controls": []
}
1.4 Changes
Added the parameter "Controls []" to the response.
This will contain the details of all the Control objects linked to the requested Finding
2. Post API For Getting Event Data - Actions
2.1 API End Point
Web Request Method: POST
URL: api/sync/Actions/GetById
2.2 Parameters
{Id: 51A6EEAF-896F-44DF-906C-62D8B1E2048A }
2.3 Response
Post API for getting Event Data
{
"Action": {
"ActionID": "51a6eeaf-896f-44df-906c-62d8b1e2048a",
"ParentActionID": null,
"AuditQuestionID": "0ee88b0f-3e5d-4b23-8964-335ccbabef2b",
"FindingID": null,
"LicenseID": null,
"CreatedByUserID": 21347,
"CreatedDateTime": "2024-09-25T13:59:39Z",
"ResponsibleFilterJobTitleID": null,
"ResponsibleFilterSpecificRoleID": null,
"ResponsibleUserID": 21347,
"PrevResponsibleUserID": null,
"ActionWorkflowID": "d4a9139e-0983-4726-8773-98006876dcb2",
"ActionStatusCode": 1,
"Pending": null,
"GroupID": null,
"AuditeeID": "411e0db4-51b5-4165-8645-4210cac83188",
"DueDate": "2024-09-26T21:59:59Z",
"ActionText": "Action A1 Mobile",
"CompletedByUserID": null,
"CompletedDateTime": null,
"RequestExtensionByUserID": null,
"RequestExtensionDateTime": null,
"RequestTransitionByUserID": null,
"RequestTransitionID": null,
"RequestTransitionData": null,
"ApprovedByUserID": null,
"ApprovedDateTime": null,
"ActionCategoryID": 2511,
"ActionPriorityID": null,
"ObligationComplianceStatus": 0,
"ActionValue": null,
"CarbonCopyEmail": "",
"Progress": 0,
"AttachmentRequered": false,
"Latitude": null,
"Longitude": null,
"IsConfidential": false,
"ActionClientUniqueID": "249",
"ModifiedDateTime": "2024-09-27T09:47:50.197Z",
"ScheduleTaskID": null,
"EventID": "2024092510.0",
"QuestionID": 532004,
"OriginalDueDate": "2024-09-26T21:59:59Z",
"VerifiedByUserID": null,
"VerifiedDateTime": null,
"CompanyID": 0,
"ResidualRiskCode": 0,
"RRLikelihoodCode": 0,
"RRConsequenceCode": 0,
"Seq": null,
"X": null,
"Y": null,
"Z": null,
"LocalTimezoneOffset": 0.0,
"Changes": null,
"IsNew": false,
"NeedToSendRequestExtensionNotification": false,
"IsDeleted": false,
"CanCompleteActionByWorkflowCriteria": true,
"ReduceRiskControlID": "18810a19-660a-4fdf-961f-78ca75fb8330"
},
"Attachments": [],
"Hyperlinks": [],
"CustomFields": [],
"Comments": [],
"ObligationActionLinks": []
}
2.4 Changes
Added the parameter "ReduceRiskControlID" to the response.
This will contain the ID of the Control object that the requested Action is linked to.