Interface SitesApi
-
- All Implemented Interfaces:
@JvmSuppressWildcards() public interface SitesApi
-
-
Method Summary
Modifier and Type Method Description abstract UnitapproveSiteMembershipRequest(@Path(value = "siteId") String siteId, @Path(value = "inviteeId") String inviteeId, @Body() SiteMembershipApprovalBody siteMembershipApprovalBody)Approve a site membership request Approve a site membership request. abstract SiteEntrycreateSite(@Body() SiteBodyCreate siteBodyCreate, @Query(value = "skipConfiguration") Boolean skipConfiguration, @Query(value = "skipAddToFavorites") Boolean skipAddToFavorites, @Query(value = "fields") List<String> fields)Create a site Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract SiteGroupEntrycreateSiteGroupMembership(@Path(value = "siteId") String siteId, @Body() SiteMembershipBodyCreate siteMembershipBodyCreate, @Query(value = "fields") List<String> fields)Create a site membership for group Note: this endpoint is available in Alfresco 7.0.0 and newer versions. abstract SiteMemberEntrycreateSiteMembership(@Path(value = "siteId") String siteId, @Body() SiteMembershipBodyCreate siteMembershipBodyCreate, @Query(value = "fields") List<String> fields)Create a site membership Creates a site membership for person personId on site siteId. abstract SiteMembershipRequestEntrycreateSiteMembershipRequestForPerson(@Path(value = "personId") String personId, @Body() SiteMembershipRequestBodyCreate siteMembershipRequestBodyCreate, @Query(value = "fields") List<String> fields)Create a site membership request Create a site membership request for yourself on the site with the identifier of id, specified in the JSON body. abstract UnitdeleteSite(@Path(value = "siteId") String siteId, @Query(value = "permanent") Boolean permanent)Delete a site Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract UnitdeleteSiteGroupMembership(@Path(value = "siteId") String siteId, @Path(value = "groupId") String groupId)Delete a group membership for site Note: this endpoint is available in Alfresco 7.0.0 and newer versions. abstract UnitdeleteSiteMembership(@Path(value = "siteId") String siteId, @Path(value = "personId") String personId)Delete a site membership Deletes person personId as a member of site siteId. abstract UnitdeleteSiteMembershipForPerson(@Path(value = "personId") String personId, @Path(value = "siteId") String siteId)Delete a site membership Deletes person personId as a member of site siteId. abstract UnitdeleteSiteMembershipRequestForPerson(@Path(value = "personId") String personId, @Path(value = "siteId") String siteId)Delete a site membership request Deletes the site membership request to site siteId for person personId. abstract SiteEntrygetSite(@Path(value = "siteId") String siteId, @Query(value = "relations") List<String> relations, @Query(value = "fields") List<String> fields)Get a site Gets information for site siteId. abstract SiteContainerEntrygetSiteContainer(@Path(value = "siteId") String siteId, @Path(value = "containerId") String containerId, @Query(value = "fields") List<String> fields)Get a site container Gets information on the container containerId in site siteId. abstract SiteGroupEntrygetSiteGroupMembership(@Path(value = "siteId") String siteId, @Path(value = "groupId") String groupId, @Query(value = "fields") List<String> fields)Get information about site membership of group Note: this endpoint is available in Alfresco 7.0.0 and newer versions. abstract SiteMemberEntrygetSiteMembership(@Path(value = "siteId") String siteId, @Path(value = "personId") String personId, @Query(value = "fields") List<String> fields)Get a site membership Gets site membership information for person personId on site siteId. abstract SiteRoleEntrygetSiteMembershipForPerson(@Path(value = "personId") String personId, @Path(value = "siteId") String siteId)Get a site membership Gets site membership information for person personId on site siteId. abstract SiteMembershipRequestEntrygetSiteMembershipRequestForPerson(@Path(value = "personId") String personId, @Path(value = "siteId") String siteId, @Query(value = "fields") List<String> fields)Get a site membership request Gets the site membership request for site siteId for person personId, if one exists. abstract SiteMembershipRequestWithPersonPaginggetSiteMembershipRequests(@Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "where") String where, @Query(value = "fields") List<String> fields)Get site membership requests Get the list of site membership requests the user can action. abstract SiteContainerPaginglistSiteContainers(@Path(value = "siteId") String siteId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)List site containers Gets a list of containers for the site siteId. abstract SiteGroupPaginglistSiteGroups(@Path(value = "siteId") String siteId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)List group membership for site Note: this endpoint is available in Alfresco 7.0.0 and newer versions. abstract SiteMembershipRequestPaginglistSiteMembershipRequestsForPerson(@Path(value = "personId") String personId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)List site membership requests Gets a list of the current site membership requests for person personId. abstract SiteMemberPaginglistSiteMemberships(@Path(value = "siteId") String siteId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields, @Query(value = "where") String where)List site memberships Gets a list of site memberships for site siteId. abstract SiteRolePaginglistSiteMembershipsForPerson(@Path(value = "personId") String personId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "orderBy") List<String> orderBy, @Query(value = "relations") List<String> relations, @Query(value = "fields") List<String> fields, @Query(value = "where") String where)List site memberships Gets a list of site membership information for person personId. abstract SitePaginglistSites(@Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "orderBy") List<String> orderBy, @Query(value = "relations") List<String> relations, @Query(value = "fields") List<String> fields, @Query(value = "where") String where)List sites Gets a list of sites in this repository. abstract UnitrejectSiteMembershipRequest(@Path(value = "siteId") String siteId, @Path(value = "inviteeId") String inviteeId, @Body() SiteMembershipRejectionBody siteMembershipRejectionBody)Reject a site membership request Reject a site membership request. abstract SiteEntryupdateSite(@Path(value = "siteId") String siteId, @Body() SiteBodyUpdate siteBodyUpdate, @Query(value = "fields") List<String> fields)Update a site Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract SiteGroupEntryupdateSiteGroupMembership(@Path(value = "siteId") String siteId, @Path(value = "groupId") String groupId, @Body() SiteMembershipBodyUpdate siteMembershipBodyUpdate, @Query(value = "fields") List<String> fields)Update site membership of group Note: this endpoint is available in Alfresco 7.0.0 and newer versions. abstract SiteMemberEntryupdateSiteMembership(@Path(value = "siteId") String siteId, @Path(value = "personId") String personId, @Body() SiteMembershipBodyUpdate siteMembershipBodyUpdate, @Query(value = "fields") List<String> fields)Update a site membership Update the membership of person personId in site siteId. abstract SiteMembershipRequestEntryupdateSiteMembershipRequestForPerson(@Path(value = "personId") String personId, @Path(value = "siteId") String siteId, @Body() SiteMembershipRequestBodyUpdate siteMembershipRequestBodyUpdate, @Query(value = "fields") List<String> fields)Update a site membership request Updates the message for the site membership request to site siteId for person personId. -
-
Method Detail
-
approveSiteMembershipRequest
@Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/sites/{siteId}/site-membership-requests/{inviteeId}/approve") abstract Unit approveSiteMembershipRequest(@Path(value = "siteId") String siteId, @Path(value = "inviteeId") String inviteeId, @Body() SiteMembershipApprovalBody siteMembershipApprovalBody)Approve a site membership request Approve a site membership request. The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.inviteeId- The invitee user name.siteMembershipApprovalBody- Accepting a request to join, optionally, allows assignment of a role to the user.
-
createSite
@Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/sites") abstract SiteEntry createSite(@Body() SiteBodyCreate siteBodyCreate, @Query(value = "skipConfiguration") Boolean skipConfiguration, @Query(value = "skipAddToFavorites") Boolean skipAddToFavorites, @Query(value = "fields") List<String> fields)Create a site Note: this endpoint is available in Alfresco 5.2 and newer versions. Creates a default site with the given details. Unless explicitly specified, the site id will be generated from the site title. The site id must be unique and only contain alphanumeric and/or dash characters. Note: the id of a site cannot be updated once the site has been created. For example, to create a public site called \"Marketing\" the following body could be used:
``JSON { \"title\": \"Marketing\", \"visibility\": \"PUBLIC\" } ``The creation of the (surf) configuration files required by Share can be skipped via the skipConfiguration query parameter. Note: if skipped then such a site will not work within Share. The addition of the site to the user's site favorites can be skipped via the skipAddToFavorites query parameter. The creator will be added as a member with Site Manager role. When you create a site, a container called documentLibrary is created for you in the new site. This container is the root folder for content stored in the site. The endpoint is owned by defaultname service owner @param siteBodyCreate The site details (required) @param skipConfiguration Flag to indicate whether the Share-specific (surf) configuration files for the site should not be created. (optional, default to false) @param skipAddToFavorites Flag to indicate whether the site should not be added to the user's site favorites. (optional, default to false) @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)
-
createSiteGroupMembership
@Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/sites/{siteId}/group-members") abstract SiteGroupEntry createSiteGroupMembership(@Path(value = "siteId") String siteId, @Body() SiteMembershipBodyCreate siteMembershipBodyCreate, @Query(value = "fields") List<String> fields)Create a site membership for group Note: this endpoint is available in Alfresco 7.0.0 and newer versions. Creates a site membership for group groupId on site siteId. You can set the role to one of four types: * SiteConsumer * SiteCollaborator * SiteContributor * SiteManager Note: You can create more than one site membership by specifying a list of group in the JSON body like this:
``JSON [ { \"role\": \"SiteConsumer\", \"id\": \"authorityId\" }, { \"role\": \"SiteConsumer\", \"id\": \"authorityId\" } ] ``If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:``JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } } ``The endpoint is owned by defaultname service owner @param siteId The identifier of a site. (required) @param siteMembershipBodyCreate The group to add and their role (required) @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)
-
createSiteMembership
@Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/sites/{siteId}/members") abstract SiteMemberEntry createSiteMembership(@Path(value = "siteId") String siteId, @Body() SiteMembershipBodyCreate siteMembershipBodyCreate, @Query(value = "fields") List<String> fields)Create a site membership Creates a site membership for person personId on site siteId. You can set the role to one of four types: * SiteConsumer * SiteCollaborator * SiteContributor * SiteManager Note: You can create more than one site membership by specifying a list of people in the JSON body like this:
``JSON [ { \"role\": \"SiteConsumer\", \"id\": \"joe\" }, { \"role\": \"SiteConsumer\", \"id\": \"fred\" } ] ``If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:``JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } } ``The endpoint is owned by defaultname service owner @param siteId The identifier of a site. (required) @param siteMembershipBodyCreate The person to add and their role (required) @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)
-
createSiteMembershipRequestForPerson
@Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/people/{personId}/site-membership-requests") abstract SiteMembershipRequestEntry createSiteMembershipRequestForPerson(@Path(value = "personId") String personId, @Body() SiteMembershipRequestBodyCreate siteMembershipRequestBodyCreate, @Query(value = "fields") List<String> fields)Create a site membership request Create a site membership request for yourself on the site with the identifier of id, specified in the JSON body. The result of the request differs depending on the type of site. * For a public site, you join the site immediately as a SiteConsumer. * For a moderated site, your request is added to the site membership request list. The request waits for approval from the Site Manager. * You cannot request membership of a private site. Members are invited by the site administrator. You can use the
-me-string in place of<personId>to specify the currently authenticated user. Note: You can create site membership requests for more than one site by specifying a list of sites in the JSON body like this:``JSON [ { \"message\": \"Please can you add me\", \"id\": \"test-site-1\", \"title\": \"Request for test site 1\", }, { \"message\": \"Please can you add me\", \"id\": \"test-site-2\", \"title\": \"Request for test site 2\", } ] ``If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:``JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } } ``The endpoint is owned by defaultname service owner @param personId The identifier of a person. (required) @param siteMembershipRequestBodyCreate Site membership request details (required) @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)
-
deleteSite
@Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/sites/{siteId}") abstract Unit deleteSite(@Path(value = "siteId") String siteId, @Query(value = "permanent") Boolean permanent)Delete a site Note: this endpoint is available in Alfresco 5.2 and newer versions. Deletes the site with siteId. The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.permanent- Flag to indicate whether the site should be permanently deleted i.e.
-
deleteSiteGroupMembership
@Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/sites/{siteId}/group-members/{groupId}") abstract Unit deleteSiteGroupMembership(@Path(value = "siteId") String siteId, @Path(value = "groupId") String groupId)Delete a group membership for site Note: this endpoint is available in Alfresco 7.0.0 and newer versions. Deletes group groupId as a member of site siteId. The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.groupId- The identifier of a group.
-
deleteSiteMembership
@Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/sites/{siteId}/members/{personId}") abstract Unit deleteSiteMembership(@Path(value = "siteId") String siteId, @Path(value = "personId") String personId)Delete a site membership Deletes person personId as a member of site siteId. You can use the
-me-string in place of<personId>to specify the currently authenticated user. The endpoint is owned by defaultname service owner- Parameters:
siteId- The identifier of a site.personId- The identifier of a person.
-
deleteSiteMembershipForPerson
@Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/people/{personId}/sites/{siteId}") abstract Unit deleteSiteMembershipForPerson(@Path(value = "personId") String personId, @Path(value = "siteId") String siteId)Delete a site membership Deletes person personId as a member of site siteId. You can use the
-me-string in place of<personId>to specify the currently authenticated user. The endpoint is owned by defaultname service owner- Parameters:
personId- The identifier of a person.siteId- The identifier of a site.
-
deleteSiteMembershipRequestForPerson
@Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/people/{personId}/site-membership-requests/{siteId}") abstract Unit deleteSiteMembershipRequestForPerson(@Path(value = "personId") String personId, @Path(value = "siteId") String siteId)Delete a site membership request Deletes the site membership request to site siteId for person personId. You can use the
-me-string in place of<personId>to specify the currently authenticated user. The endpoint is owned by defaultname service owner- Parameters:
personId- The identifier of a person.siteId- The identifier of a site.
-
getSite
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/sites/{siteId}") abstract SiteEntry getSite(@Path(value = "siteId") String siteId, @Query(value = "relations") List<String> relations, @Query(value = "fields") List<String> fields)Get a site Gets information for site siteId. You can use the relations parameter to include one or more related entities in a single response and so reduce network traffic. The entity types in Alfresco are organized in a tree structure. The sites entity has two children, containers and members. The following relations parameter returns all the container and member objects related to the site siteId:
`` containers,members ``The endpoint is owned by defaultname service owner @param siteId The identifier of a site. (required) @param relations Use the relations parameter to include one or more related entities in a single response. (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)
-
getSiteContainer
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/sites/{siteId}/containers/{containerId}") abstract SiteContainerEntry getSiteContainer(@Path(value = "siteId") String siteId, @Path(value = "containerId") String containerId, @Query(value = "fields") List<String> fields)Get a site container Gets information on the container containerId in site siteId. The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.containerId- The unique identifier of a site container.fields- A list of field names.
-
getSiteGroupMembership
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/sites/{siteId}/group-members/{groupId}") abstract SiteGroupEntry getSiteGroupMembership(@Path(value = "siteId") String siteId, @Path(value = "groupId") String groupId, @Query(value = "fields") List<String> fields)Get information about site membership of group Note: this endpoint is available in Alfresco 7.0.0 and newer versions. Gets site membership information for group groupId on site siteId. The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.groupId- The identifier of a group.fields- A list of field names.
-
getSiteMembership
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/sites/{siteId}/members/{personId}") abstract SiteMemberEntry getSiteMembership(@Path(value = "siteId") String siteId, @Path(value = "personId") String personId, @Query(value = "fields") List<String> fields)Get a site membership Gets site membership information for person personId on site siteId. You can use the
-me-string in place of<personId>to specify the currently authenticated user. The endpoint is owned by defaultname service owner- Parameters:
siteId- The identifier of a site.personId- The identifier of a person.fields- A list of field names.
-
getSiteMembershipForPerson
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/people/{personId}/sites/{siteId}") abstract SiteRoleEntry getSiteMembershipForPerson(@Path(value = "personId") String personId, @Path(value = "siteId") String siteId)Get a site membership Gets site membership information for person personId on site siteId. You can use the
-me-string in place of<personId>to specify the currently authenticated user. The endpoint is owned by defaultname service owner- Parameters:
personId- The identifier of a person.siteId- The identifier of a site.
-
getSiteMembershipRequestForPerson
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/people/{personId}/site-membership-requests/{siteId}") abstract SiteMembershipRequestEntry getSiteMembershipRequestForPerson(@Path(value = "personId") String personId, @Path(value = "siteId") String siteId, @Query(value = "fields") List<String> fields)Get a site membership request Gets the site membership request for site siteId for person personId, if one exists. You can use the
-me-string in place of<personId>to specify the currently authenticated user. The endpoint is owned by defaultname service owner- Parameters:
personId- The identifier of a person.siteId- The identifier of a site.fields- A list of field names.
-
getSiteMembershipRequests
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/site-membership-requests") abstract SiteMembershipRequestWithPersonPaging getSiteMembershipRequests(@Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "where") String where, @Query(value = "fields") List<String> fields)Get site membership requests Get the list of site membership requests the user can action. You can use the where parameter to filter the returned site membership requests by siteId. For example:
`` (siteId=mySite) ``The where parameter can also be used to filter by personId. For example:`` where=(personId=person) ``This may be combined with the siteId filter, as shown below:`` where=(siteId=mySite AND personId=person)) ``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 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)
-
listSiteContainers
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/sites/{siteId}/containers") abstract SiteContainerPaging listSiteContainers(@Path(value = "siteId") String siteId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)List site containers Gets a list of containers for the site siteId. The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.skipCount- The number of entities that exist in the collection before those included in this list.maxItems- The maximum number of items to return in the list.fields- A list of field names.
-
listSiteGroups
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/sites/{siteId}/group-members") abstract SiteGroupPaging listSiteGroups(@Path(value = "siteId") String siteId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)List group membership for site Note: this endpoint is available in Alfresco 7.0.0 and newer versions. Gets a list of group membership for site siteId. The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.skipCount- The number of entities that exist in the collection before those included in this list.maxItems- The maximum number of items to return in the list.fields- A list of field names.
-
listSiteMembershipRequestsForPerson
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/people/{personId}/site-membership-requests") abstract SiteMembershipRequestPaging listSiteMembershipRequestsForPerson(@Path(value = "personId") String personId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)List site membership requests Gets a list of the current site membership requests for person personId. You can use the
-me-string in place of<personId>to specify the currently authenticated user. The endpoint is owned by defaultname service owner- Parameters:
personId- The identifier of a person.skipCount- The number of entities that exist in the collection before those included in this list.maxItems- The maximum number of items to return in the list.fields- A list of field names.
-
listSiteMemberships
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/sites/{siteId}/members") abstract SiteMemberPaging listSiteMemberships(@Path(value = "siteId") String siteId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields, @Query(value = "where") String where)List site memberships Gets a list of site memberships for site siteId. The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.skipCount- The number of entities that exist in the collection before those included in this list.maxItems- The maximum number of items to return in the list.fields- A list of field names.where- Optionally filter the list.
-
listSiteMembershipsForPerson
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/people/{personId}/sites") abstract SiteRolePaging listSiteMembershipsForPerson(@Path(value = "personId") String personId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "orderBy") List<String> orderBy, @Query(value = "relations") List<String> relations, @Query(value = "fields") List<String> fields, @Query(value = "where") String where)List site memberships Gets a list of site 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 where parameter to filter the returned sites by visibility or site preset. Example to filter by visibility, use any one of:`` (visibility='PRIVATE') (visibility='PUBLIC') (visibility='MODERATED') ``Example to filter by site preset:`` (preset='site-dashboard') ``The default sort order for the returned list is for sites to be sorted by ascending title. 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 * title * role 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 relations Use the relations parameter to include one or more related entities in a single response. (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) @param where A string to restrict the returned objects by using a predicate. (optional)
-
listSites
@Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/sites") abstract SitePaging listSites(@Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "orderBy") List<String> orderBy, @Query(value = "relations") List<String> relations, @Query(value = "fields") List<String> fields, @Query(value = "where") String where)List sites Gets a list of sites in this repository. You can use the where parameter to filter the returned sites by visibility or site preset. Example to filter by visibility, use any one of:
`` (visibility='PRIVATE') (visibility='PUBLIC') (visibility='MODERATED') ``Example to filter by site preset:`` (preset='site-dashboard') ``The default sort order for the returned list is for sites to be sorted by ascending title. 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 * title * description You can use the relations parameter to include one or more related entities in a single response and so reduce network traffic. The entity types in Alfresco are organized in a tree structure. The sites entity has two children, containers and members. The following relations parameter returns all the container and member objects related to each site:`` containers,members ``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 relations Use the relations parameter to include one or more related entities in a single response. (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) @param where A string to restrict the returned objects by using a predicate. (optional)
-
rejectSiteMembershipRequest
@Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/sites/{siteId}/site-membership-requests/{inviteeId}/reject") abstract Unit rejectSiteMembershipRequest(@Path(value = "siteId") String siteId, @Path(value = "inviteeId") String inviteeId, @Body() SiteMembershipRejectionBody siteMembershipRejectionBody)Reject a site membership request Reject a site membership request. The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.inviteeId- The invitee user name.siteMembershipRejectionBody- Rejecting a request to join, optionally, allows the inclusion of comment.
-
updateSite
@Headers(value = {"Content-Type: application/json"})@PUT(value = "alfresco/versions/1/sites/{siteId}") abstract SiteEntry updateSite(@Path(value = "siteId") String siteId, @Body() SiteBodyUpdate siteBodyUpdate, @Query(value = "fields") List<String> fields)Update a site Note: this endpoint is available in Alfresco 5.2 and newer versions. Update the details for the given site siteId. Site Manager or otherwise a (site) admin can update title, description or visibility. Note: the id of a site cannot be updated once the site has been created. The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.siteBodyUpdate- The site information to update.fields- A list of field names.
-
updateSiteGroupMembership
@Headers(value = {"Content-Type: application/json"})@PUT(value = "alfresco/versions/1/sites/{siteId}/group-members/{groupId}") abstract SiteGroupEntry updateSiteGroupMembership(@Path(value = "siteId") String siteId, @Path(value = "groupId") String groupId, @Body() SiteMembershipBodyUpdate siteMembershipBodyUpdate, @Query(value = "fields") List<String> fields)Update site membership of group Note: this endpoint is available in Alfresco 7.0.0 and newer versions. Update the membership of person groupId in site siteId. You can set the role to one of four types: * SiteConsumer * SiteCollaborator * SiteContributor * SiteManager The endpoint is owned by defaultname service owner
- Parameters:
siteId- The identifier of a site.groupId- The identifier of a group.siteMembershipBodyUpdate- The groupId new role (required)fields- A list of field names.
-
updateSiteMembership
@Headers(value = {"Content-Type: application/json"})@PUT(value = "alfresco/versions/1/sites/{siteId}/members/{personId}") abstract SiteMemberEntry updateSiteMembership(@Path(value = "siteId") String siteId, @Path(value = "personId") String personId, @Body() SiteMembershipBodyUpdate siteMembershipBodyUpdate, @Query(value = "fields") List<String> fields)Update a site membership Update the membership of person personId in site siteId. You can use the
-me-string in place of<personId>to specify the currently authenticated user. You can set the role to one of four types: * SiteConsumer * SiteCollaborator * SiteContributor * SiteManager The endpoint is owned by defaultname service owner- Parameters:
siteId- The identifier of a site.personId- The identifier of a person.siteMembershipBodyUpdate- The persons new role (required)fields- A list of field names.
-
updateSiteMembershipRequestForPerson
@Headers(value = {"Content-Type: application/json"})@PUT(value = "alfresco/versions/1/people/{personId}/site-membership-requests/{siteId}") abstract SiteMembershipRequestEntry updateSiteMembershipRequestForPerson(@Path(value = "personId") String personId, @Path(value = "siteId") String siteId, @Body() SiteMembershipRequestBodyUpdate siteMembershipRequestBodyUpdate, @Query(value = "fields") List<String> fields)Update a site membership request Updates the message for the site membership request to site siteId for person personId. You can use the
-me-string in place of<personId>to specify the currently authenticated user. The endpoint is owned by defaultname service owner- Parameters:
personId- The identifier of a person.siteId- The identifier of a site.siteMembershipRequestBodyUpdate- The new message to display (required)fields- A list of field names.
-
-
-
-