Package org.alfresco.rest.requests

Class People

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

  • Constructor Details

    • People

      public People(org.alfresco.utility.model.UserModel person, RestWrapper restWrapper)

  • Method Details

    • getPerson

      public RestPersonModel getPerson()
      Retrieve details of a specific person using GET call on "people/{personId}"

    • updatePerson

      public RestPersonModel updatePerson(String putBody)
      Update a person properties using PUT call on "people/{personId}"

    • getPersonActivitiesUntilEntriesCountIs

      public RestActivityModelsCollection getPersonActivitiesUntilEntriesCountIs(int expectedNoOfEntries)
      Retrieve list of activities for a specific person using GET call on "people/{personId}/activities" Please note that it retries to get the list of activities several times before returning the empty list. The list of activities are not displayed as they are created.

    • getPersonActivities

      public RestActivityModelsCollection getPersonActivities()
      Retrieve list of activities for a specific person using GET call on "people/{personId}/activities" without retry

    • getPersonPreferences

      public RestPreferenceModelsCollection getPersonPreferences()
      Retrieve preferences of a specific person using GET call on "people/{personId}/preferences"

    • getSiteMembershipRequests

      public RestSiteMembershipRequestModelsCollection getSiteMembershipRequests()
      Retrieve the current site membership requests for a specific person using GET call on "/people/{personId}/site-membership-requests"

    • getFavoriteSites

      public RestSiteModelsCollection getFavoriteSites()
      Retrieve a specific person's favorite sites using GET call on "people/{personId}/favorite-sites"

    • addFavoriteSite

      public RestFavoriteSiteModel addFavoriteSite(org.alfresco.utility.model.SiteModel site)
      Add a favorite site for a specific person using POST call on "people/{personId}/favorite-sites"

    • getPersonPreferenceInformation

      public RestPreferenceModel getPersonPreferenceInformation(String preferenceName)
      Retrieve a specific preference of a specific person using GET call on "people/{personId}/preferences/{preferenceName}"

    • removeFavoriteSite

      public void removeFavoriteSite(org.alfresco.utility.model.SiteModel site)
      Remove a specific site from favorite sites list of a person using DELETE call on "people/{personId}/favorite-sites/{siteId}"

    • getFavoriteSite

      public RestSiteModel getFavoriteSite(org.alfresco.utility.model.SiteModel site)
      Returns information on favorite site siteId of person personId. GET call on "people/{personId}/favorite-sites/{siteId}"

    • deleteSiteMember

      public void deleteSiteMember(org.alfresco.utility.model.SiteModel site)
      Delete site member with DELETE call on "people/{personId}/sites/{siteId}"

    • addSiteMembershipRequest

      public RestSiteMembershipRequestModel addSiteMembershipRequest(String siteMembershipRequest)
      Add new site membership request using POST call on "people/{personId}/site-membership-requests"

    • addSiteMembershipRequest

      public RestSiteMembershipRequestModel addSiteMembershipRequest(org.alfresco.utility.model.SiteModel siteModel)
      Add new site membership request using POST call on "people/{personId}/site-membership-requests"

    • addSiteMembershipRequest

      public RestSiteMembershipRequestModel addSiteMembershipRequest(String message, org.alfresco.utility.model.SiteModel siteModel, String title)
      Add new site membership request using POST call on "people/{personId}/site-membership-requests"

    • getSitesMembershipInformation

      public RestSiteMembershipModelsCollection getSitesMembershipInformation()
      Get site membership information using GET call on "/people/{personId}/sites"

    • getSiteMembership

      public RestSiteEntry getSiteMembership(org.alfresco.utility.model.SiteModel site)
      Retrieve site membership information for a person using GET call on "people/{personId}/sites/{siteId}"

    • getSiteMembershipRequest

      public RestSiteMembershipRequestModel getSiteMembershipRequest(org.alfresco.utility.model.SiteModel site)
      Retrieve site membership request details for a person/site using GET call on "people/{personId}/site-membership-requests/{siteId}"

    • deleteSiteMembershipRequest

      public void deleteSiteMembershipRequest(org.alfresco.utility.model.SiteModel site) throws JsonToModelConversionException, EmptyJsonResponseException
      Delete site membership request with DELETE call on "/people/{personId}/site-membership-requests/{siteId}"
      Throws:
      JsonToModelConversionException
      EmptyJsonResponseException

    • updateSiteMembershipRequest

      public RestSiteMembershipRequestModel updateSiteMembershipRequest(org.alfresco.utility.model.SiteModel siteModel, String message)
      Update site membership request using PUT call on "people/{personId}/site-membership-requests/{siteId}"

    • getFavorite

      public RestPersonFavoritesModel getFavorite(String favoriteId)
      Retrieve favorite site for a specific user using GET call on "people/{personId}/favorites/{favoriteId}"

    • getFavorites

      public RestPersonFavoritesModelsCollection getFavorites()
      Retrieve specific favorites for a specific user using GET call on "people/{personId}/favorites"

    • addFolderToFavorites

      public RestPersonFavoritesModel addFolderToFavorites(org.alfresco.utility.model.FolderModel folderModel)
      Add a folder to favorites for a specific user using POST call on "people/{personId}/favorites"

    • addFileToFavorites

      public RestPersonFavoritesModel addFileToFavorites(org.alfresco.utility.model.FileModel fileModel)
      Add a folder to favorites for a specific user using POST call on "people/{personId}/favorites"

    • addSiteToFavorites

      public RestPersonFavoritesModel addSiteToFavorites(org.alfresco.utility.model.SiteModel siteModel)
      Add a site to favorites for a specific user using POST call on "people/{personId}/favorites"

    • deleteSiteFromFavorites

      public RestWrapper deleteSiteFromFavorites(org.alfresco.utility.model.SiteModel site)
      Delete site from favorites for a specific user using DELETE call on "people/{personId}/favorites/{favoriteId}"

    • deleteFolderFromFavorites

      public RestWrapper deleteFolderFromFavorites(org.alfresco.utility.model.FolderModel folderModel)
      Delete a folder from favorites for a specific user using DELETE call on "people/{personId}/favorites/{favoriteId}"

    • deleteFileFromFavorites

      public RestWrapper deleteFileFromFavorites(org.alfresco.utility.model.FileModel fileModel)
      Delete a file from favorites for a specific user using DELETE call on "people/{personId}/favorites/{favoriteId}"

    • getNetwork

      public RestNetworkModel getNetwork()
      Retrieve details of the current user network using GET call on "people/{personId}/networks/{networkId}"

    • getNetwork

      public RestNetworkModel getNetwork(org.alfresco.utility.model.UserModel tenant)
      Retrieve details of a specific network using GET call on "people/{personId}/networks/{networkId}"

    • getNetworks

      public RestNetworkModelsCollection getNetworks()
      Retrieve details of all networks related to the current person using GET call on "people/{personId}/networks"

    • getNetworks

      public RestNetworkModelsCollection getNetworks(org.alfresco.utility.model.UserModel tenant)
      Retrieve details of all networks related to a specific person using GET call on "people/{personId}/networks"

    • createPerson

      public RestPersonModel createPerson(RestPersonModel newPerson)
      Create new person with given newPerson details using POST call on "people"

    • downloadAvatarContent

      public RestResponse downloadAvatarContent()
      Get people avatar image using GET call on '/people/{personId}/avatar Please note that it retries to get the renditions response several times because on the alfresco server the rendition can take a while to be created.

    • resetAvatarImageRequest

      public void resetAvatarImageRequest() throws JsonToModelConversionException, EmptyJsonResponseException
      Delete avatar image with DELETE call on "/people/{personId}/avatar}"
      Throws:
      JsonToModelConversionException
      EmptyJsonResponseException

    • uploadAvatarContent

      public io.restassured.response.ValidatableResponse uploadAvatarContent(String fullServerUrL, File avatarFile)
      Update avatar image PUT call on 'people/{nodeId}/children

    • listGroupMemberships

      public RestGroupsModelsCollection listGroupMemberships()
      List group memberships for a person using GET on '/people/{personId}/groups

    • where

      public People.WhereClause where()