org.phenotips.data.permissions.rest

Interface PrincipalsResource

@Unstable(value="New API introduced in 1.4")
 @Role
 @Relation(value="https://phenotips.org/rel/principals")
 @ParentResource(value=PermissionsResource.class)
public interface PrincipalsResource

Resource for retrieving information about principals that have access to the entity record, in bulk, where entity is identified by entity record's internal PhenoTips identifier.

Since:

1.4

Version:

$Id: d091512065e1dd8f6423997b92b5cc2d30d97142 $

Method Summary

Modifier and Type	Method and Description
PrincipalsRepresentation	getPrincipals(String entityType, String entityId) Retrieve information about users or groups that have any access to the entity record.

Method Detail

getPrincipals

PrincipalsRepresentation getPrincipals(String entityType,
                                       String entityId)

Retrieve information about users or groups that have any access to the entity record. 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:

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

entityId - internal identifier of a entity record

Returns:

REST representation of a collection of principals