Package org.alfresco.rest.requests

Class Site

  • public class Site
extends ModelRequest<Site>
    Declares all Rest API under the /sites path

    • Constructor Detail

      • Site

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

    • Method Detail

      • getSiteWithRelations

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

      • getSitesWithRelations

        public java.util.List<java.util.List<java.lang.Object>> getSitesWithRelations()
        Retrieve sites using GET call on "sites/{siteId}" along with relations parameter
        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 -

      • getSiteContainer

        public RestSiteContainerModel getSiteContainer​(java.lang.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()
                         throws java.lang.Exception
        Create a collaboration site
        Returns:
        the properties of the created site
        Throws:
        java.lang.Exception

      • updateSite

        public RestSiteModel updateSite​(org.alfresco.utility.model.SiteModel site)
                         throws java.lang.Exception
        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
        Throws:
        java.lang.Exception

      • 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 -