...
| URL | /openspecimen/rest/ng/audit/export-revisions | ||
| Method | POST | ||
| Body |
|
Response
The response contains the file ID that can be used to download the exported revisions file.
...
| Parameter | Description |
|---|---|
| startDate | Start date of the interval for which the revisions list is queried. If not specified, startDate = endDate - 30 days |
| endDate | End date of the interval for which the revisions list is queried. If not specified endDate = end of today. |
| userId | Restrict the exported list to revisions effected by the user identified by userId. |
| entities | Optional parameter. Specifies the list of entities or record types whose revisions need to be exported. This is very useful when the requestor intends to review the revisions of only certain record types say Shipment and ShipmentItem. |
| includeModifiedProps | Specifies whether the exported list should include modified attributes list for each revision. |
Response parameters
| Parameter | Description |
|---|---|
| fileId | a) Unique file ID to use for downloading the exported revisions file. b) Null in case the export requires more than 30 seconds to finish. |
FAQ
Q1. What is the significance of "includeModifiedProps" value in the request?
The boolean property "includeModifiedProps" determines whether the exported revisions file includes the change log for each of the modified entities during the requested time interval or not.
Given below is an example of the CSV file created when includeModifiedProps = true. Notice the change log column, it includes the list of properties that got modified during the op along with their new values.
| Revision ID | Revision Time | User | User Email ID | Operation | Record Type | Record | Change Log |
|---|---|---|---|---|---|---|---|
| 169879 | 09 Jul 2019 15:26 | John Doe | john.doe@openspecimen.org | Edit | Specimen | 244004 | collectionStatus=Collected,createdOn=Tue Jul 09 15:26:00 IST 2019,position={id=295350} |
| 169879 | 09 Jul 2019 15:26 | John Doe | john.doe@openspecimen.org | Add | Storage Container Position | 295354 | blocked=false,container={id=514},occupyingSpecimen={id=244010},posOne=8,posOneOrdinal=8,posTwo=3,posTwoOrdinal=3 |
When includeModifiedProps = false, the generated CSV file is as below. Notice the change log column is empty. It goes without saying that generating this kind of file is much faster than the above one as the API has to do lesser work.
| Revision ID | Revision Time | User | User Email ID | Operation | Record Type | Record | Change Log |
|---|---|---|---|---|---|---|---|
| 169879 | 09 Jul 2019 15:26 | John Doe | john.doe@openspecimen.org | Edit | Specimen | 244004 | |
| 169879 | 09 Jul 2019 15:26 | John Doe | john.doe@openspecimen.org | Add | Storage Container Position | 295354 |