Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Export revisions effected by the user identified by userId = 1 during the time period March 1 (startDate) to March 15 (endDate). The exported list should include the list of modified record attributes/properties during each revision. The exported file contains the list of revisions arranged in reverse chronological order i.e. the latest revision at the top and ancient revision at the bottom of the file. 

Note: Request entities and OpenSpecimen Record Types relations added at the end of page.

URL
/openspecimen/rest/ng/audit/export-revisions
Method
POST
Body


Expand
titleRequest: Single User


Code Block
{
  "startDate": 1551398400000,
  "endDate": 1552608000000,
  "userId": 1,
  "includeModifiedProps": true,
  "entities": ["Participant", "ParticipantMedicalIdentifier", "CollectionProtocolRegistration", "ParticipantExtension"]
}



Expand
titleRequest: Multiple Users


Code Block
languagejs
{
  "startDate": 1551398400000,
  "endDate": 1552608000000,
  "userIds": [1, 2, 3],
  "includeModifiedProps": true,
  "entities": ["Participant", "ParticipantMedicalIdentifier", "CollectionProtocolRegistration", "ParticipantExtension"]
}



...

ParameterDescription
startDateStart date of the interval for which the revisions list is queried. If not specified, startDate = endDate - 30 days 
endDateEnd date of the interval for which the revisions list is queried. If not specified endDate = end of today.
userIdRestrict the exported list to revisions effected by the user identified by userId. Optional parameter.
userIdsRestrict the exported list to revisions effected by the users identified by the list of userIds. Optional parameter. (Supported from v6.3)
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 ShipmentSpecimen.

This parameter was added in v6.1.RC5.

includeModifiedPropsSpecifies whether the exported list should include modified attributes list for each revision.

...

Revision IDRevision TimeUserUser Email IDOperationRecord TypeRecord

Change Log

16987909 Jul 2019 15:26John Doejohn.doe@openspecimen.orgEditSpecimen244004
16987909 Jul 2019 15:26John Doejohn.doe@openspecimen.orgAddStorage Container Position295354


The below table explains request entities and OpenSpecimen record type relation details.

Request EntitiesOpenSpecimen Record Type
SpecimenList
Carts
Specimen
Specimen
SpecimenExternalIdentifier
Specimen External Identifier
Visit
Visit
CollectionProtocolRegistration
Collection Protocol Registration
Participant
Participant
ParticipantMedicalIdentifier
Participant Medical Identifier
StorageContainerPosition
Container Position
ShipmentSpecimen
Shipment Specimen
Shipment
Shipment
User
User
StorageContainer
Storage Container
CollectionProtocol
Collection Protocol
SpecimenRequirement
Specimen Requirement
CollectionProtocolEvent
Collection Protocol Event
CollectionProtocolSite
CP Site
DistributionOrderItem
Distribution Order Items
DistributionOrder
Distribution Order
ContainerType
Container Type
Role
Role
RoleAccessControl
Role Access List
DistributionProtocol

Distribution Protocol

ResourceInstanceOp
Access List Operation
CpConsentTier
CP Consent
Institute
Institute
SubjectRole
User Role
Site
Site
ShipmentContainer
Shipment Container
DpRequirement
DP Requirement
FormContextBean
Form Association
CpSpecimenLabelPrintSetting
CP Specimen Label Print Setting
DpDistributionSite
DP Site