A guide to the API endpoints that allow you to track field audits
This article details the endpoints for obtaining and exporting field audits.
User should have one of the following roles and access in order to view the endpoint results:
- Role with Admin All entitlement and in some cases access to the required entity
- Role with View All Fields entitlement with Read access to record
Field Audit
Find All Field Audit By Record Id
Retrieve all field audits based on record id.
| Required Path Parameter | Description |
|---|---|
recordId | The unique ID of a record where, if provided, the response will only contain field audits from the identified record. |
This endpoint has the following optional query parameters for additional filtering.
| Query Parameter | Description |
|---|---|
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). |
Result
A paginated response of all field audit results related to the record, containing the following info:
| Result Field | Description |
id | The unique ID of the field audit. |
fieldId | The unique ID of the field audit. |
fieldLabel | The label of the field, which is presented to end users for the field. |
fieldName | The name of the field, which is used to identify the field in the Build and Reports modules. |
created |
The created date of the field audit in epoch time in milliseconds ex. 1712168746685
|
recordId | The unique ID of the record. |
userName | The name of the creator. |
userEmail | The email of the creator. |
fieldValues | The list of field values. |
executorId | The unique ID of the executor. |
executorName | The name of the executor. |
executorType | The type of executor ex.USER_ACTION |
defaultValue | Is this value the default field value or not ex. false |
Get Most Recent Field Audit By Value Map
Retrieve the most recent field audit by value map.
| Required Path Parameter | Description |
valueMapId | The unique ID of a value map where, if provided, the response will only contain field audits from the identified value map. |
Result
A simplified field audit object response of the most recent field audit related to the value map, containing the following info:
| Result Field | Description |
id | The unique ID of the field audit. |
fieldId | The unique ID of the field. |
fieldLabel | The label of the field, which is presented to end users for the field. |
fieldName | The name of the field, which is used to identify the field in the Build and Reports modules. |
fieldType | The type of field ex. Common |
created | The created date of the field audit in epoch time in milliseconds ex. 1712168746685 |
recordId | The unique ID of the record. |
userId | The unique ID of the user. |
userName | The name of the user. |
userEmail | The email of the user. |
fieldValues | The list of field values. |
Field Audit Export
Export All Field Audit By Record Id
Export all field audits based on record id. Optionally, results can be ordered by pageable parameters and be within the specified min created date and max created date range.
| Required Path Parameter | Description |
recordId | The unique ID of a record where, if provided, the response will only contain field audits from the identified record. |
This endpoint has the following optional query parameters for additional filtering.
| Query Parameter | Description |
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). |
minCreated | The min created date in epoch time in milliseconds ex. oldest date lower bound 1711997926000 |
maxCreated | The max created date in epoch time in milliseconds ex. newest date upper bound 1712170726000 |
Result
A view containing all field audit results related to the record. This response can be saved as a csv, xlsx, txt, or other appropriate formats for later viewing.
Ex.
Created Date,Field Id,Field Label,Field Name,Field Type,Field Values,Record Id,User Email,User Name,Executor ID,Executor Name,Execution Type,Is Default Value
2024-04-03 18:25:53,LkTGrIvx,Select the date by which the record must be completed.,Due Date,DueDateFieldTransient,[1717261200000],bnWzIMRy,[email protected],LogicGate Administrator,gMLjJcmK,LogicGate Administrator,USER_ACTION,false
2024-04-03 18:25:47,3PvdkyZM,t,t,InfiniteTextField,[new 11],bnWzIMRy,[email protected],LogicGate Administrator,gMLjJcmK,LogicGate Administrator,USER_ACTION,false