The Open API specification for Synapse is now available for download!

Download Open API Spec

RestrictionInformationResponse

org.sagebionetworks.repo.model.RestrictionInformationResponse

The information about restriction level on a restrict-able object.

Field Type Description
objectId INTEGER The id of the restrictable object
restrictionLevel RestrictionLevel
hasUnmetAccessRequirement BOOLEAN True if user has at least one unmet access requirement on this restrict-able object; false otherwise.
isUserDataContributor BOOLEAN True if the user is considered a data contributor, e.g. has update and delete permissions on the data. Applies only to ENTITY restrictable objects.
restrictionDetails ARRAY<RestrictionFulfillment> The list of restriction fulfillment information for each access requirement that applies to the restrictable object.