Get Policy Violation History
get
/iam/governance/selfservice/api/v1/policyviolations/{pvid}/history
Returns the policy violation history for the specified policy violation ID.
Request
Supported Media Types
- application/json
Path Parameters
-
pvid(required): string
Policy violation ID.
Query Parameters
-
fields: string
Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for attributes is "action, comment, severity, status". Nested entities cannot be filtered for example the "remediatorUser, remediatorRole" etc cannot be the attributes which can be returned.
-
q: string
Search filter to get subset of the records. SCIM filter is accepted. There should not be any spaces for attribute value. If you want to pass space in between attribute values then replace it with "::". The result can be filtered based on the severity OR any other attribute of the policy violation.
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
401 Response
Unauthorized
404 Response
Requested entity not found
500 Response
Internal Server Error
Default Response
Unexpected error
Examples
This example retrieves the history for a given policy violations. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/9118FD33CDD4454B916DA94DC2A9A2B8/history
Example of GET Response Body
The following example shows the contents of the response body in JSON format.
{
"policyviolationHistorylist": {
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/9118FD33
CDD4454B916DA94DC2A9A2B8/history?offset=1&limit=10"
},
{
"rel": "first",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/9118FD33
CDD4454B916DA94DC2A9A2B8/history?offset=1&limit=10"
}
],
"count": 5,
"hasMore": false,
"totalResult": -1,
"violationHistory": [
{
"cause": "name = Fraud Supervisor",
"ruleName": "rule1 fraud supervisor",
"actionDate": "2019-04-10T21:12:16Z",
"action": "policyviolationcause.action.activate",
"status": "policyviolationcause.status.active",
"user": "Internal User"
},
{
"actionDate": "2019-04-10T21:12:16Z",
"action": "policyviolation.action.create",
"status": "policyviolation.status.open",
"user": "Internal User"
},
{
"cause": "Organization Name = Vision",
"ruleName": "rule1 fraud supervisor",
"actionDate": "2019-04-10T21:12:16Z",
"action": "policyviolationcause.action.activate",
"status": "policyviolationcause.status.active",
"user": "Internal User"
},
{
"actionDate": "2019-04-10T21:12:22Z",
"user": "System Administrator"
},
{
"actionDate": "2019-04-10T21:12:22Z",
"action": "policyviolation.action.assign",
"status": "policyviolation.status.assigned",
"user": "System Administrator"
}
],
"assignedTo": {
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/users/16"
}
]
}
}
}