Uses of Class
org.alfresco.rest.framework.WebApiDescription

Packages that use WebApiDescription

Package	Description
org.alfresco.rest.api.networks
org.alfresco.rest.api.nodes
org.alfresco.rest.api.people
org.alfresco.rest.api.sites
org.alfresco.rest.api.tags
org.alfresco.rest.workflow.api.processdefinitions
org.alfresco.rest.workflow.api.processes
org.alfresco.rest.workflow.api.tasks

Uses of WebApiDescription in org.alfresco.rest.api.networks

Methods in org.alfresco.rest.api.networks with annotations of type WebApiDescription

Modifier and Type	Method and Description
Network	NetworksEntityResource.readById(String networkId, Parameters parameters)

Uses of WebApiDescription in org.alfresco.rest.api.nodes

Methods in org.alfresco.rest.api.nodes with annotations of type WebApiDescription

Modifier and Type	Method and Description
List<Comment>	NodeCommentsRelation.create(String nodeId, List<Comment> entity, Parameters parameters) Create a comment for the node given by nodeId.
List<NodeRating>	NodeRatingsRelation.create(String nodeId, List<NodeRating> ratingEntity, Parameters parameters) Create a rating for the node with id 'nodeId'.
List<Tag>	NodeTagsRelation.create(String nodeId, List<Tag> tagsToCreate, Parameters parameters) Add the tag to the node with id 'nodeId'.
void	NodeRatingsRelation.delete(String nodeId, String ratingSchemeId, Parameters parameters)
void	NodeTagsRelation.delete(String nodeId, String tagId, Parameters parameters)
void	NodeCommentsRelation.delete(String nodeId, String commentNodeId, Parameters parameters)
CollectionWithPagingInfo<NodeRating>	NodeRatingsRelation.readAll(String nodeId, Parameters parameters)
CollectionWithPagingInfo<Tag>	NodeTagsRelation.readAll(String nodeId, Parameters params)
CollectionWithPagingInfo<Comment>	NodeCommentsRelation.readAll(String nodeId, Parameters parameters) Returns a paged list of comments for the document/folder identified by nodeId, sorted chronologically with the newest first.
NodeRating	NodeRatingsRelation.readById(String nodeId, String ratingSchemeId, Parameters parameters) Returns the rating with id 'schemeName' for node with id 'nodeId'.
Comment	NodeCommentsRelation.update(String nodeId, Comment entity, Parameters parameters)

Uses of WebApiDescription in org.alfresco.rest.api.people

Methods in org.alfresco.rest.api.people with annotations of type WebApiDescription

Modifier and Type	Method and Description
List<Favourite>	PersonFavouritesRelation.create(String personId, List<Favourite> entity, Parameters parameters) Adds the given site as a favourite site for the user.
List<FavouriteSite>	PersonFavouriteSitesRelation.create(String personId, List<FavouriteSite> entity, Parameters parameters) Adds the given site as a favourite site for the user.
List<SiteMembershipRequest>	PersonSiteMembershipRequestsRelation.create(String personId, List<SiteMembershipRequest> invites, Parameters parameters)
void	PersonFavouriteSitesRelation.delete(String personId, String siteId, Parameters parameters)
void	PersonSiteMembershipRequestsRelation.delete(String personId, String siteId, Parameters parameters)
void	PersonFavouritesRelation.delete(String personId, String id, Parameters parameters)
CollectionWithPagingInfo<MemberOfSite>	PersonSitesRelation.readAll(String personId, Parameters parameters) List all the sites that the specified user has a explicit membership of.
CollectionWithPagingInfo<FavouriteSite>	PersonFavouriteSitesRelation.readAll(String personId, Parameters parameters) List the user's favourite sites.
CollectionWithPagingInfo<SiteMembershipRequest>	PersonSiteMembershipRequestsRelation.readAll(String personId, Parameters parameters)
CollectionWithPagingInfo<Preference>	PersonPreferencesRelation.readAll(String personId, Parameters parameters) Returns a paged list of preferences for the user personId.
CollectionWithPagingInfo<PersonNetwork>	PersonNetworksRelation.readAll(String personId, Parameters parameters)
CollectionWithPagingInfo<Activity>	PersonActivitiesRelation.readAll(String personId, Parameters parameters)
CollectionWithPagingInfo<Favourite>	PersonFavouritesRelation.readAll(String personId, Parameters parameters) List the user's favourites.
Person	PeopleEntityResource.readById(String personId, Parameters parameters) Get a person by userName.
MemberOfSite	PersonSitesRelation.readById(String personId, String siteId, Parameters parameters) Returns site membership information for personId in siteId.
FavouriteSite	PersonFavouriteSitesRelation.readById(String personId, String siteShortName, Parameters parameters) List the favourite site information for a specific site.
SiteMembershipRequest	PersonSiteMembershipRequestsRelation.readById(String personId, String siteId, Parameters parameters)
Preference	PersonPreferencesRelation.readById(String personId, String preferenceName, Parameters parameters) Returns information regarding the preference 'preferenceName' for user personId.
PersonNetwork	PersonNetworksRelation.readById(String personId, String networkId, Parameters parameters)
SiteMembershipRequest	PersonSiteMembershipRequestsRelation.update(String personId, SiteMembershipRequest siteInvite, Parameters parameters)

Uses of WebApiDescription in org.alfresco.rest.api.sites

Methods in org.alfresco.rest.api.sites with annotations of type WebApiDescription

Modifier and Type	Method and Description
List<SiteMember>	SiteMembersRelation.create(String siteId, List<SiteMember> siteMembers, Parameters parameters) POST sites//members Adds personId as a member of site siteId.
void	SiteMembersRelation.delete(String siteId, String personId, Parameters parameters) DELETE sites//members/ Removes personId as a member of site siteId.
CollectionWithPagingInfo<Site>	SiteEntityResource.readAll(Parameters parameters) Returns a paged list of all sites in the current tenant.
CollectionWithPagingInfo<SiteContainer>	SiteContainersRelation.readAll(String siteId, Parameters parameters) Returns information regarding the top level containers for site 'siteId'.
CollectionWithPagingInfo<SiteMember>	SiteMembersRelation.readAll(String siteId, Parameters parameters) Returns a paged list of all the members of the site 'siteId'.
Site	SiteEntityResource.readById(String siteId, Parameters parameters) Returns information regarding the site 'siteId'.
SiteContainer	SiteContainersRelation.readById(String siteId, String containerId, Parameters parameters) Returns information regarding the top level container 'containerId' for site 'siteId'.
SiteMember	SiteMembersRelation.readById(String siteId, String personId, Parameters parameters) Returns site membership information for personId in siteId.
SiteMember	SiteMembersRelation.update(String siteId, SiteMember siteMember, Parameters parameters) PUT sites//members Updates the membership of personId in the site (of which personId must be an existing member).

Uses of WebApiDescription in org.alfresco.rest.api.tags

Methods in org.alfresco.rest.api.tags with annotations of type WebApiDescription

Modifier and Type	Method and Description
CollectionWithPagingInfo<Tag>	TagsEntityResource.readAll(Parameters parameters) Returns a paged list of all currently used tags in the store workspace://SpacesStore for the current tenant.
Tag	TagsEntityResource.update(String id, Tag entity, Parameters parameters)

Uses of WebApiDescription in org.alfresco.rest.workflow.api.processdefinitions

Methods in org.alfresco.rest.workflow.api.processdefinitions with annotations of type WebApiDescription

Modifier and Type	Method and Description
CollectionWithPagingInfo<ProcessDefinition>	ProcessDefinitionsRestEntityResource.readAll(Parameters params)
CollectionWithPagingInfo<FormModelElement>	StartFormModelRelation.readAll(String definitionId, Parameters parameters) List the tasks candidate users and groups.
BinaryResource	ProcessDefinitionsRestEntityResource.readProperty(String id, Parameters parameters)

Uses of WebApiDescription in org.alfresco.rest.workflow.api.processes

Methods in org.alfresco.rest.workflow.api.processes with annotations of type WebApiDescription

Modifier and Type	Method and Description
List<ProcessInfo>	ProcessesRestEntityResource.create(List<ProcessInfo> entity, Parameters parameters)
List<Variable>	ProcessVariablesRelation.create(String processId, List<Variable> variables, Parameters parameters) Creates or updates multiple variables.
void	ProcessVariablesRelation.delete(String processId, String id, Parameters parameters) Delete a variable.
CollectionWithPagingInfo<ProcessInfo>	ProcessesRestEntityResource.readAll(Parameters params)
CollectionWithPagingInfo<Task>	ProcessTasksRelation.readAll(String processId, Parameters parameters) List the tasks.
CollectionWithPagingInfo<Variable>	ProcessVariablesRelation.readAll(String processId, Parameters parameters) List the variables.
CollectionWithPagingInfo<Activity>	ProcessActivitiesRelation.readAll(String processId, Parameters parameters) List the activities.
CollectionWithPagingInfo<Item>	ProcessItemsRelation.readAll(String processId, Parameters parameters) List the attached items.
BinaryResource	ProcessesRestEntityResource.readProperty(String entityId, Parameters parameters)
Variable	ProcessVariablesRelation.update(String processId, Variable entity, Parameters parameters) Update a variable.

Uses of WebApiDescription in org.alfresco.rest.workflow.api.tasks

Methods in org.alfresco.rest.workflow.api.tasks with annotations of type WebApiDescription

Modifier and Type	Method and Description
List<TaskVariable>	TaskVariablesRelation.create(String taskId, List<TaskVariable> variables, Parameters parameters) Creates or updates multiple task variables.
void	TaskVariablesRelation.delete(String entityResourceId, String id, Parameters parameters) Delete a task variable.
CollectionWithPagingInfo<Task>	TasksRestEntityResource.readAll(Parameters params)
CollectionWithPagingInfo<TaskCandidate>	TaskCandidatesRelation.readAll(String taskId, Parameters parameters) List the tasks candidate users and groups.
CollectionWithPagingInfo<TaskVariable>	TaskVariablesRelation.readAll(String taskId, Parameters parameters) List the tasks variables.
CollectionWithPagingInfo<Item>	TaskItemsRelation.readAll(String taskId, Parameters parameters) List the attached items.
TaskVariable	TaskVariablesRelation.update(String taskId, TaskVariable entity, Parameters parameters) Update a task variable.