Package org.alfresco.rest.requests

Class Site

java.lang.Object
org.alfresco.rest.requests.ModelRequest<Site>
org.alfresco.rest.requests.Site
public class Site extends ModelRequest<Site>
Declares all Rest API under the /sites path

  • Constructor Details

    • Site

      public Site(org.alfresco.utility.model.SiteModel site, RestWrapper restWrapper)

  • Method Details

    • getSite

      public RestSiteModel getSite()
      Retrieve one site using GET call on "sites/{siteId}"
      Returns:
      Throws:
      JsonToModelConversionException

    • getSiteWithRelations

      public List<Object> getSiteWithRelations()
      Retrieve one site using GET call on "sites/{siteId}" along with relations parameter
      Returns:
      Throws:
      JsonToModelConversionException

    • getSites

      public RestSiteModelsCollection getSites()
      Retrieve 100 sites (this is the default size when maxItems is not specified) from Alfresco using GET call on TestGroup.SITES
      Returns:
      Throws:
      JsonToModelConversionException

    • getSitesWithRelations

      public List<List<Object>> getSitesWithRelations()
      Retrieve sites using GET call on "sites/{siteId}" along with relations parameter
      Returns:
      Throws:
      JsonToModelConversionException

    • addPerson

      public RestSiteMemberModel addPerson(org.alfresco.utility.model.UserModel person)
      Add new site member using POST call on "/sites/{siteId}/members"
      Parameters:
      person - UserModel
      Returns:
      Throws:
      JsonToModelConversionException

    • getSiteMembers

      public RestSiteMemberModelsCollection getSiteMembers()
      Retrieve all members of a site using GET call on "sites/{siteId}/members"
      Returns:
      Throws:
      JsonToModelConversionException

    • getSiteMember

      public RestSiteMemberModel getSiteMember(org.alfresco.utility.model.UserModel user)
      Retrieve specific member of a site using GET call on "sites/{siteId}/members/{personId}"
      Parameters:
      user - A model containing the username to look for.
      Returns:
      Throws:
      JsonToModelConversionException

    • updateSiteMember

      public RestSiteMemberModel updateSiteMember(org.alfresco.utility.model.UserModel siteMember)
      Update site member role with PUT call on "sites/{siteId}/members/{personId}"
      Parameters:
      siteMember -
      Returns:
      Throws:
      JsonToModelConversionException

    • deleteSiteMember

      public void deleteSiteMember(org.alfresco.utility.model.UserModel person)
      Delete site member with DELETE call on "sites/{siteId}/members/{personId}"
      Parameters:
      person -

    • getSiteContainers

      public RestSiteContainerModelsCollection getSiteContainers()
      Retrieve all containers of a site using GET call on "sites/{siteId}/containers"
      Returns:
      Throws:
      JsonToModelConversionException

    • getSiteContainer

      public RestSiteContainerModel getSiteContainer(RestSiteContainerModel container)
      Retrieve specific container of a site using GET call on "sites/{siteId}/containers/{containerId}"
      Parameters:
      container - A model containing the folderId to look for.
      Returns:
      Throws:
      JsonToModelConversionException

    • getSiteContainer

      public RestSiteContainerModel getSiteContainer(String containerFolder)
      Retrieve specific container of a site using GET call on "sites/{siteId}/containers/{containerId}"
      Parameters:
      containerFolder - The id of the container to look for.
      Returns:
      Throws:
      JsonToModelConversionException

    • createSite

      public RestSiteModel createSite()
      Create a collaboration site
      Returns:
      the properties of the created site

    • updateSite

      public RestSiteModel updateSite(org.alfresco.utility.model.SiteModel site)
      Update a site: Site title, description, visibility can be updated Body: { "title": "string", "description": "string", "visibility": "PRIVATE" } Response: { "entry": { "id": "string", "guid": "string", "title": "string", "description": "string", "visibility": "PRIVATE", "preset": "string", "role": "SiteConsumer" } }
      Returns:
      the properties of an updated site

    • getSiteMemberships

      public RestSitePersonMembershipRequestModelsCollection getSiteMemberships()
      Get site membership requests by using GET /site-membership-requests
      Returns:
      site memberships

    • approveSiteMembership

      public RestResponse approveSiteMembership(org.alfresco.utility.model.UserModel siteMember)
      Approve a site membership request by using POST call on /sites/{siteId}/site-membership-requests/{inviteeId}/approve
      Parameters:
      siteMember -

    • rejectSiteMembership

      public RestResponse rejectSiteMembership(org.alfresco.utility.model.UserModel siteMember)
      Reject a site membership request by using POST call /sites/{siteId}/site-membership-requests/{inviteeId}/reject
      Parameters:
      siteMember -

    • getSiteGroups

      public RestSiteGroupModelsCollection getSiteGroups()
      Retrieve all group membership of a site using GET call on "sites/{siteId}/group-members"
      Returns:
      RestSiteGroupModelsCollection
      Throws:
      JsonToModelConversionException

    • addSiteGroup

      public RestSiteGroupModel addSiteGroup(String authorityId, org.alfresco.utility.constants.UserRole role)
      Add new site group membership using POST call on "sites/{siteId}/group-members"
      Parameters:
      authorityId - The authorityId of the group
      role - role to assign
      Returns:
      Throws:
      JsonToModelConversionException

    • getSiteGroup

      public RestSiteGroupModel getSiteGroup(String groupId)
      Retrieve specific group membership of a site using GET call on "sites/{siteId}/group-members/{groupId}"
      Parameters:
      groupId -
      Returns:
      RestSiteGroupModel

    • updateSiteGroup

      public RestSiteGroupModel updateSiteGroup(String groupId, org.alfresco.utility.constants.UserRole role)
      Update site group membership role with PUT call on "sites/{siteId}/group-members/{groupId}"
      Parameters:
      groupId -
      Returns:
      RestSiteGroupModel
      Throws:
      JsonToModelConversionException

    • deleteSiteGroup

      public void deleteSiteGroup(String groupId)
      Delete site group membership with DELETE call on "sites/{siteId}/group-members/{groupId}"
      Parameters:
      groupId -