org.phenotips.data.permissions.rest

Interface PermissionsResource

@Relation(value="https://phenotips.org/rel/permissions")
 @ParentResource(value=org.phenotips.data.rest.PatientResource.class)
public interface PermissionsResource

Resource for working with entity record's owners, visibility and collaborators. Entities are identified by entity record's internal PhenoTips identifier.

Since:

1.3M2

Version:

$Id: fa7c6ef9933894e4c3ac7712ecbc761b1d3f298d $

Method Summary

Modifier and Type	Method and Description
PermissionsRepresentation	getPermissions(String entityId, String entityType) Retrieves all permissions: owner, collaborators, visibility.
javax.ws.rs.core.Response	setPermissions(PermissionsRepresentation permissions, String entityId, String entityType) Overwrites all permissions: owner, collaborators, visibility.
javax.ws.rs.core.Response	updatePermissions(PermissionsRepresentation permissions, String entityId, String entityType) Update permissions: owner, collaborators, visibility.

Method Detail

getPermissions

PermissionsRepresentation getPermissions(String entityId,
                                         String entityType)

Retrieves all permissions: owner, collaborators, visibility. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to view the target entity record, an error is returned.

Parameters:

entityId - internal identifier of an entity record

entityType - the type of entity (either "patients" or "families")

Returns:

REST representation of the permissions of an entity record

setPermissions

javax.ws.rs.core.Response setPermissions(PermissionsRepresentation permissions,
                                         String entityId,
                                         String entityType)

Overwrites all permissions: owner, collaborators, visibility. All elements must be present in the input JSON. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to edit the target entity record, or if either element is missing, no change is performed and an error is returned. To remove all collaborators, an empty "collaborators": {"collaborators": []} JSON fragment must be sent.

Parameters:

permissions - must contain owner and visibility representations, and a list of collaborator representations

entityId - identifier of the entity whose permissions should be changed

entityType - the type of entity (either "patients" or "families")

Returns:

a status message

updatePermissions

@PATCH
javax.ws.rs.core.Response updatePermissions(PermissionsRepresentation permissions,
                                                   String entityId,
                                                   String entityType)

Update permissions: owner, collaborators, visibility. Not all elements must be present in the input JSON, the missing pieces will be left as-is. The submitted owner and visibility will be updated, but the submitted collaborators will be added to the existing list of collaborators. To remove an individual collaborator, send a DELETE request to the targeted CollaboratorResource, or PUT the full permissions without the collaborators to be removed. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to edit the target entity record, no change is performed and an error is returned.

Parameters:

permissions - may contain owner and visibility representations, and a list of collaborator representations

entityId - identifier of the entity whose permissions should be changed

entityType - the type of entity (either "patients" or "families")

Returns:

a status message