Constructor Detail

Method Detail

• createGroup

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/groups") abstract GroupEntry createGroup(@Body() GroupBodyCreate groupBodyCreate, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> fields)

  Create a group Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Create a group. The group id must start with \"GROUP\\\". If this is omitted it will be added automatically. This format is also returned when listing groups or group memberships. It should be noted that the other group-related operations also expect the id to start with \"GROUP\\\". If one or more parentIds are specified then the group will be created and become a member of each of the specified parent groups. If no parentIds are specified then the group will be created as a root group. The group will be created in the APP.DEFAULT and AUTH.ALF zones. You must have admin rights to create a group. The endpoint is owned by defaultname service owner

  Parameters:

  groupBodyCreate - The group to create.

  include - Returns additional information about the group.

  fields - A list of field names.

• createGroupMembership

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/groups/{groupId}/members") abstract GroupMemberEntry createGroupMembership(@Path(value = "groupId") String groupId, @Body() GroupMembershipBodyCreate groupMembershipBodyCreate, @Query(value = "fields") List<String> fields)

  Create a group membership Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Create a group membership (for an existing person or group) within a group groupId. If the added group was previously a root group then it becomes a non-root group since it now has a parent. It is an error to specify an id that does not exist. You must have admin rights to create a group membership. The endpoint is owned by defaultname service owner

  Parameters:

  groupId - The identifier of a group.

  groupMembershipBodyCreate - The group membership to add (person or sub-group).

  fields - A list of field names.

• deleteGroup

  @Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/groups/{groupId}") abstract Unit deleteGroup(@Path(value = "groupId") String groupId, @Query(value = "cascade") Boolean cascade)

  Delete a group Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Delete group groupId. The option to cascade delete applies this recursively to any hierarchy of group members. In this case, removing a group member does not delete the person or sub-group itself. If a removed sub-group no longer has any parent groups then it becomes a root group. You must have admin rights to delete a group. The endpoint is owned by defaultname service owner

  Parameters:

  groupId - The identifier of a group.

  cascade - If true then the delete will be applied in cascade to sub-groups.

• deleteGroupMembership

  @Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/groups/{groupId}/members/{groupMemberId}") abstract Unit deleteGroupMembership(@Path(value = "groupId") String groupId, @Path(value = "groupMemberId") String groupMemberId)

  Delete a group membership Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Delete group member groupMemberId (person or sub-group) from group groupId. Removing a group member does not delete the person or sub-group itself. If a removed sub-group no longer has any parent groups then it becomes a root group. You must have admin rights to delete a group membership. The endpoint is owned by defaultname service owner

  Parameters:

  groupId - The identifier of a group.

  groupMemberId - The identifier of a person or group.

• getGroup

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/groups/{groupId}") abstract GroupEntry getGroup(@Path(value = "groupId") String groupId, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> fields)

  Get group details Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Get details for group groupId. You can use the include parameter to return additional information. The endpoint is owned by defaultname service owner

  Parameters:

  groupId - The identifier of a group.

  include - Returns additional information about the group.

  fields - A list of field names.

• listGroupMemberships

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/groups/{groupId}/members") abstract GroupMemberPaging listGroupMemberships(@Path(value = "groupId") String groupId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "orderBy") List<String> orderBy, @Query(value = "where") String where, @Query(value = "fields") List<String> fields)

  List memberships of a group Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Gets a list of the group memberships for the group groupId. You can use the where parameter to filter the returned groups by memberType. Example to filter by memberType, use any one of: `` (memberType='GROUP') (memberType='PERSON') `` The default sort order for the returned list is for group members to be sorted by ascending displayName. You can override the default by using the orderBy parameter. You can specify one of the following fields in the orderBy parameter: * id * displayName The endpoint is owned by defaultname service owner @param groupId The identifier of a group. (required) @param skipCount The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (optional, default to 0) @param maxItems The maximum number of items to return in the list. If not supplied then the default value is 100. (optional, default to 100) @param orderBy A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field. (optional) @param where A string to restrict the returned objects by using a predicate. (optional) @param fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter. (optional)

• listGroupMembershipsForPerson

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/people/{personId}/groups") abstract GroupPaging listGroupMembershipsForPerson(@Path(value = "personId") String personId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "orderBy") List<String> orderBy, @Query(value = "include") List<String> include, @Query(value = "where") String where, @Query(value = "fields") List<String> fields)

  List group memberships Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Gets a list of group membership information for person personId. You can use the -me- string in place of <personId> to specify the currently authenticated user. You can use the include parameter to return additional information. You can use the where parameter to filter the returned groups by isRoot. For example, the following where clause will return just the root groups: `` (isRoot=true) `` The where parameter can also be used to filter by zone. This may be combined with isRoot to narrow a result set even further. For example, the following where clause will only return groups belonging to the MY.ZONE zone. `` where=(zones in ('MY.ZONE')) `` This may be combined with the isRoot filter, as shown below: `` where=(isRoot=false AND zones in ('MY.ZONE')) `` Note: restrictions include * AND is the only supported operator when combining isRoot and zones filters * Only one zone is supported by the filter * The quoted zone name must be placed in parenthesis — a 400 error will result if these are omitted. The default sort order for the returned list is for groups to be sorted by ascending displayName. You can override the default by using the orderBy parameter. You can specify one or more of the following fields in the orderBy parameter: * id * displayName The endpoint is owned by defaultname service owner @param personId The identifier of a person. (required) @param skipCount The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (optional, default to 0) @param maxItems The maximum number of items to return in the list. If not supplied then the default value is 100. (optional, default to 100) @param orderBy A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field. (optional) @param include Returns additional information about the group. The following optional fields can be requested: * parentIds * zones (optional) @param where A string to restrict the returned objects by using a predicate. (optional) @param fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter. (optional)

• listGroups

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/groups") abstract GroupPaging listGroups(@Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "orderBy") List<String> orderBy, @Query(value = "include") List<String> include, @Query(value = "where") String where, @Query(value = "fields") List<String> fields)

  List groups Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Gets a list of groups. You can use the include parameter to return additional information. You can use the where parameter to filter the returned groups by isRoot. For example, the following where clause will return just the root groups: `` (isRoot=true) `` The where parameter can also be used to filter by zone and displayName. They may be combined with isRoot to narrow a result set even further. For example, the following where clause will only return groups belonging to the MY.ZONE zone. `` where=(zones in ('MY.ZONE')) `` This may be combined with the isRoot filter, as shown below: `` where=(isRoot=false AND zones in ('MY.ZONE')) `` The following where clause will only return groups with displayName MY.GROUP.NAME. `` where=(displayName in ('MY.GROUP.NAME')) `` This may be combined with the isRoot and zones filter, as shown below: `` where=(isRoot=false AND displayName in ('MY.GROUP.NAME')) `` `` where=(zones in ('MY.ZONE') AND displayName in ('MY.GROUP.NAME')) `` `` where=(isRoot=false AND zones in ('MY.ZONE') AND displayName in ('MY.GROUP.NAME')) `` Note: restrictions include * AND is the only supported operator when combining isRoot, zones and displayName filters * Only one zone is supported by the filter * Only one displayName is supported by the filter * The quoted zone name and displayName must be placed in parenthesis — a 400 error will result if these are omitted. The default sort order for the returned list is for groups to be sorted by ascending displayName. You can override the default by using the orderBy parameter. You can specify one of the following fields in the orderBy parameter: * id * displayName The endpoint is owned by defaultname service owner @param skipCount The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (optional, default to 0) @param maxItems The maximum number of items to return in the list. If not supplied then the default value is 100. (optional, default to 100) @param orderBy A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field. (optional) @param include Returns additional information about the group. The following optional fields can be requested: * parentIds * zones (optional) @param where A string to restrict the returned objects by using a predicate. (optional) @param fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter. (optional)

• updateGroup

  @Headers(value = {"Content-Type: application/json"})@PUT(value = "alfresco/versions/1/groups/{groupId}") abstract GroupEntry updateGroup(@Path(value = "groupId") String groupId, @Body() GroupBodyUpdate groupBodyUpdate, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> fields)

  Update group details Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Update details (displayName) for group groupId. You must have admin rights to update a group. The endpoint is owned by defaultname service owner

  Parameters:

  groupId - The identifier of a group.

  groupBodyUpdate - The group information to update.

  include - Returns additional information about the group.

  fields - A list of field names.