Record audits track record events such as when and how a record was created, moved, deleted, and more.
Obtain your API Access Token or pull the Risk Cloud Postman Collection to get started.
Retrieve Record Audits Endpoint
The Record Audits API offers the following Retrieve Record Audits endpoint which returns an iterable page of all record audits in a given timeframe.
The endpoint is available to all users with a build entitlement.
This endpoint has the following optional query parameters for additional filtering.
| Query Parameter | Description |
|---|---|
minCreated | A timestamp measured in milliseconds since the Unix epoch where, if provided, the response will only contain records audits that have been modified since the given timestamp. |
maxCreated | A timestamp measured in milliseconds since the Unix epoch where, if provided, the response will only contain records audits that have been modified since the given timestamp. |
workflow | The unique ID of a workflow where, if provided, the response will only contain record audits from the identified workflow. |
page | The zero-indexed page number (must not be less than 0, defaults to 0). |
size | The size of the page and maximum number of items to be returned (must not be less than 1, defaults to 20). |
Use Cases
Get Workflow ID
To request all record audits in a workflow, use the workflow query parameter with the ID of the workflow.
The workflow ID can be obtained from either your Risk Cloud web app environment directly or from the Risk Cloud API.
Get Workflow ID (Web App Environment)
The workflow ID can be located within your Risk Cloud web app environment in the following location:
- Navigate to Build > Applications
- Search for and open the application containing the workflow
- Open the edit gear icon (⚙) on the workflow to open the Workflow Editor
- The workflow ID can be found under the Workflow ID label in the editor window
Get Workflow ID (Risk Cloud API)
The workflow ID can be located via the Retrieve Workflows endpoint, specifically in the id property of workflow objects returned in the content property of the response.
Retrieve Record Audits
Once the Workflow ID and timestamps are determined, the following request can be made to return all of the given workflow’s record audits in the specified timeframe.
Response
The response contains all the record audits, along with additional contextual information for each audit such as the step, audit type, and user. The auditType property can have any of the following values.
CreatedAuditCopiedAuditLinkingAuditLinkedAuditUnlinkedAuditDeletedAuditMovedAuditAssignedAuditSecondaryAssignedAuditSecondaryUnassignedAuditPreservedAuditUnassignedAudit
A sample output is shown below.
{
"content": [
{
"id": "abcd1234",
"active": true,
"created": 1710426007818,
"updated": null,
"record": {
"id": "efgh5678",
"active": true,
"created": 1710426006820,
"updated": null,
"state": "LIVE",
"sequenceId": 22,
"status": "IN_PROGRESS",
"name": "",
"viewableTitle": "",
"initialStateEndStep": false,
"workflowDueDate": null,
"recordType": "RECORD",
"isPublic": false
},
"source": {
"id": "ijkl9012",
"active": true,
"created": 1696954275470,
"updated": 1702410681371,
"stepType": "ORIGIN",
"name": "Default Origin",
"priority": 1,
"userGroupOperationType": "FULL_ACCESS",
"xpos": 55,
"ypos": 55,
"isPublic": true,
"commentsEnabled": true,
"documentsEnabled": false,
"externalUserMfaRequired": false,
"uxriEnabled": true,
"sla": {
"enabled": false,
"duration": 0
},
"workflow": {
"id": "mnop3456",
"active": true,
"created": 1696954275551,
"updated": 1713881453125,
"name": "Item",
"recordPrefix": "Item",
"allowGroups": false,
"requireGroups": false,
"xpos": 147,
"ypos": 98,
"priority": 1,
"sla": {
"enabled": false,
"duration": 0
},
"allowAec": false,
"sequence": {
"id": "qrst7890",
"active": true,
"created": 1696954275485,
"updated": null
},
"application": null,
"userGroups": [],
"primaryField": null,
"workflowType": "WORKFLOW"
},
"assignableUserType": "APP_AND_EXTERNAL_USERS",
"end": false,
"chain": false,
"origin": true
},
"target": null,
"user": {
"status": "Active",
"id": "uvwx1234",
"active": true,
"created": 1677696956370,
"updated": 1713993694617,
"email": "[email protected]",
"company": null,
"imageUrl": null,
"imageS3Key": null,
"tier": "SECONDARY",
"pricingUserTier": "POWER",
"first": "First",
"last": "Last",
"mfaEnabled": false,
"mfaSetup": false,
"autoprovisioned": true,
"scimStatus": "Active",
"lastLogin": null,
"lastDeactivated": null,
"name": "First Last",
"locked": false,
"superUser": false,
"external": false,
"disabled": false,
"serviceAccount": false,
"empty": false,
"idOrTransientId": "uvwx1234",
"transientIdOrId": "uvwx1234"
},
"sourceUser": null,
"targetUser": {
"status": "Active",
"id": "uvwx1234",
"active": true,
"created": 1677696956370,
"updated": 1713993694617,
"email": "[email protected]",
"company": null,
"imageUrl": null,
"imageS3Key": null,
"tier": "SECONDARY",
"pricingUserTier": "POWER",
"first": "First",
"last": "Last",
"mfaEnabled": false,
"mfaSetup": false,
"autoprovisioned": true,
"scimStatus": "Active",
"lastLogin": null,
"lastDeactivated": null,
"name": "First Last",
"locked": false,
"superUser": false,
"external": false,
"disabled": false,
"serviceAccount": false,
"empty": false,
"idOrTransientId": "uvwx1234",
"transientIdOrId": "uvwx1234"
},
"fieldAudits": [],
"dueDate": null,
"stepDueDate": null,
"auditType": "CreatedAudit"
}
],
"pageable": {
"sort": {
"empty": true,
"sorted": false,
"unsorted": true
},
"offset": 0,
"pageSize": 20,
"pageNumber": 0,
"paged": true,
"unpaged": false
},
"last": true,
"totalElements": 1,
"totalPages": 1,
"size": 20,
"number": 0,
"sort": {
"empty": true,
"sorted": false,
"unsorted": true
},
"numberOfElements": 1,
"first": true,
"empty": false
}