Uses of Annotation Interface
org.alfresco.rest.framework.WebApiDescription

Packages that use WebApiDescription

Package	Description
org.alfresco.rest.api.actions
org.alfresco.rest.api.audit
org.alfresco.rest.api.authentications
org.alfresco.rest.api.categories
org.alfresco.rest.api.cmm
org.alfresco.rest.api.downloads
org.alfresco.rest.api.groups
org.alfresco.rest.api.modules
org.alfresco.rest.api.networks
org.alfresco.rest.api.nodes
org.alfresco.rest.api.people
org.alfresco.rest.api.probes
org.alfresco.rest.api.queries
org.alfresco.rest.api.quicksharelinks
org.alfresco.rest.api.rules
org.alfresco.rest.api.sites
org.alfresco.rest.api.sitesmembershipsrequests
org.alfresco.rest.api.tags
org.alfresco.rest.api.trashcan
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.actions

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

Modifier and Type	Method	Description
List<Action>	ActionExecutionsEntityResource.create(List<Action> entity, Parameters parameters)
ActionParameterConstraint	ActionConstraintsEntityResource.readById(String constraintName, Parameters parameters)
ActionParameterConstraint	ActionParameterConstraintsEntityResource.readById(String constraintName, Parameters parameters)

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

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

Modifier and Type	Method	Description
void	AuditApplicationsAuditEntriesRelation.delete(String auditAppId, String auditEntryId, Parameters parameters)
void	AuditApplicationsAuditEntriesRelation.deleteSet(String auditAppId, Parameters parameters)
CollectionWithPagingInfo<AuditEntry>	AuditApplicationsAuditEntriesRelation.readAll(String auditAppId, Parameters parameters)
CollectionWithPagingInfo<AuditApp>	AuditApplicationsEntityResource.readAll(Parameters parameters)
AuditEntry	AuditApplicationsAuditEntriesRelation.readById(String auditAppId, String auditEntryId, Parameters parameters)
AuditApp	AuditApplicationsEntityResource.readById(String auditAppId, Parameters parameters)
AuditApp	AuditApplicationsEntityResource.update(String auditAppId, AuditApp auditApp, Parameters parameters)

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

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

Modifier and Type	Method	Description
List<LoginTicket>	AuthenticationTicketsEntityResource.create(List<LoginTicket> entity, Parameters parameters)
void	AuthenticationTicketsEntityResource.delete(String me, Parameters parameters, WithResponse withResponse)
LoginTicket	AuthenticationTicketsEntityResource.readById(String me, Parameters parameters, WithResponse withResponse)

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

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

Modifier and Type	Method	Description
List<Category>	NodesCategoryLinksRelation.create(String nodeId, List<Category> categoryLinks, Parameters parameters)	POST /nodes/{nodeId}/category-links
List<Category>	SubcategoriesRelation.create(String parentCategoryId, List<Category> categoryList, Parameters parameters)	POST /categories/{categoryId}/subcategories
void	CategoriesEntityResource.delete(String id, Parameters parameters)	DELETE /categories/{categoryId}
void	NodesCategoryLinksRelation.delete(String nodeId, String categoryId, Parameters parameters)	DELETE /nodes/{nodeId}/category-links/{categoryId}
CollectionWithPagingInfo<Category>	NodesCategoryLinksRelation.readAll(String nodeId, Parameters parameters)	GET /nodes/{nodeId}/category-links
CollectionWithPagingInfo<Category>	SubcategoriesRelation.readAll(String parentCategoryId, Parameters parameters)	GET /categories/{categoryId}/subcategories
Category	CategoriesEntityResource.readById(String id, Parameters parameters)	GET /categories/{categoryId}
Category	CategoriesEntityResource.update(String id, Category categoryModel, Parameters parameters)	PUT /categories/{categoryId}

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

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

Modifier and Type	Method	Description
List<CustomAspect>	CustomModelAspectsRelation.create(String modelName, List<CustomAspect> aspects, Parameters parameters)
List<CustomModelConstraint>	CustomModelConstraintRelation.create(String modelName, List<CustomModelConstraint> constraints, Parameters parameters)
List<CustomModelDownload>	CustomModelDownloadRelation.create(String modelName, List<CustomModelDownload> download, Parameters parameters)
List<CustomModel>	CustomModelEntityResource.create(List<CustomModel> entity, Parameters parameters)
List<CustomType>	CustomModelTypesRelation.create(String modelName, List<CustomType> types, Parameters parameters)
void	CustomModelAspectsRelation.delete(String modelName, String aspectName, Parameters parameters)
void	CustomModelEntityResource.delete(String modelName, Parameters parameters)
void	CustomModelTypesRelation.delete(String modelName, String typeName, Parameters parameters)
CollectionWithPagingInfo<CustomAspect>	CustomModelAspectsRelation.readAll(String modelName, Parameters parameters)
CollectionWithPagingInfo<CustomModelConstraint>	CustomModelConstraintRelation.readAll(String modelName, Parameters parameters)
CollectionWithPagingInfo<CustomModel>	CustomModelEntityResource.readAll(Parameters parameters)
CollectionWithPagingInfo<CustomType>	CustomModelTypesRelation.readAll(String modelName, Parameters parameters)
CustomAspect	CustomModelAspectsRelation.readById(String modelName, String aspectName, Parameters parameters)
CustomModelConstraint	CustomModelConstraintRelation.readById(String modelName, String constraintName, Parameters parameters)
CustomModel	CustomModelEntityResource.readById(String modelName, Parameters parameters)
CustomType	CustomModelTypesRelation.readById(String modelName, String typeName, Parameters parameters)
CustomAspect	CustomModelAspectsRelation.update(String modelName, CustomAspect aspect, Parameters parameters)
CustomModel	CustomModelEntityResource.update(String modelName, CustomModel entity, Parameters parameters)
CustomType	CustomModelTypesRelation.update(String modelName, CustomType type, Parameters parameters)

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

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

Modifier and Type	Method	Description
List<Download>	DownloadsEntityResource.create(List<Download> entity, Parameters parameters)
void	DownloadsEntityResource.delete(String nodeId, Parameters parameters)
Download	DownloadsEntityResource.readById(String nodeId, Parameters parameters)

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

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

Modifier and Type	Method	Description
List<GroupMember>	GroupMembersRelation.create(String groupId, List<GroupMember> entity, Parameters params)
List<Group>	GroupsEntityResource.create(List<Group> entity, Parameters parameters)
List<SiteGroup>	SiteGroupsRelation.create(String siteId, List<SiteGroup> siteMembers, Parameters parameters)	POST sites//group-members
void	GroupMembersRelation.delete(String entityResourceId, String id, Parameters parameters)
void	GroupsEntityResource.delete(String groupId, Parameters parameters)
void	SiteGroupsRelation.delete(String siteId, String groupId, Parameters parameters)	DELETE sites//group-members/
CollectionWithPagingInfo<GroupMember>	GroupMembersRelation.readAll(String groupId, Parameters params)
CollectionWithPagingInfo<Group>	GroupsEntityResource.readAll(Parameters params)
CollectionWithPagingInfo<SiteGroup>	SiteGroupsRelation.readAll(String siteId, Parameters parameters)	Returns a paged list of all the groups of the site 'siteId'.
Group	GroupsEntityResource.readById(String groupId, Parameters parameters)
SiteGroup	SiteGroupsRelation.readById(String siteId, String groupId, Parameters parameters)	Returns site membership information for groupId in siteId.
Group	GroupsEntityResource.update(String groupId, Group group, Parameters parameters)
SiteGroup	SiteGroupsRelation.update(String siteId, SiteGroup groupMember, Parameters parameters)	PUT sites//group-members/

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

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

Modifier and Type	Method	Description
CollectionWithPagingInfo<ModulePackage>	ModulePackagesEntityResource.readAll(Parameters parameters)
ModulePackage	ModulePackagesEntityResource.readById(String modelName, Parameters parameters)

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	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	Description
Node	NodesEntityResource.copyById(String nodeId, NodeTarget target, Parameters parameters, WithResponse withResponse)
List<Node>	NodeChildrenRelation.create(String parentFolderNodeId, List<Node> nodeInfos, Parameters parameters)	Create one or more nodes (folder or empty file) below parent folder.
Node	NodeChildrenRelation.create(String parentFolderNodeId, org.springframework.extensions.webscripts.servlet.FormData formData, Parameters parameters, WithResponse withResponse)
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<Rendition>	NodeRenditionsRelation.create(String nodeId, List<Rendition> entity, Parameters parameters)
List<AssocChild>	NodeSecondaryChildrenRelation.create(String parentNodeId, List<AssocChild> entities, Parameters parameters)
List<Tag>	NodeTagsRelation.create(String nodeId, List<Tag> tagsToCreate, Parameters parameters)	Add the tag to the node with id 'nodeId'.
List<AssocTarget>	NodeTargetsRelation.create(String sourceNodeId, List<AssocTarget> entities, Parameters parameters)
List<Rendition>	NodeVersionRenditionsRelation.create(String nodeId, List<Rendition> entity, Parameters parameters)
void	NodeCommentsRelation.delete(String nodeId, String commentNodeId, Parameters parameters)
void	NodeRatingsRelation.delete(String nodeId, String ratingSchemeId, Parameters parameters)
void	NodeRenditionsRelation.delete(String nodeId, String renditionId, Parameters parameters)
void	NodeSecondaryChildrenRelation.delete(String parentNodeId, String childNodeId, Parameters parameters)
void	NodesEntityResource.delete(String nodeId, Parameters parameters)	Delete the given node.
void	NodeTagsRelation.delete(String nodeId, String tagId, Parameters parameters)
void	NodeTargetsRelation.delete(String sourceNodeId, String targetNodeId, Parameters parameters)
void	NodeVersionRenditionsRelation.delete(String nodeId, String versionId, Parameters parameters)
void	NodeVersionsRelation.delete(String nodeId, String versionId, Parameters parameters)
Node	NodesEntityResource.lock(String nodeId, LockInfo lockInfo, Parameters parameters, WithResponse withResponse)
Node	NodesEntityResource.moveById(String nodeId, NodeTarget target, Parameters parameters, WithResponse withResponse)
CollectionWithPagingInfo<AuditEntry>	NodeAuditEntriesRelation.readAll(String nodeId, Parameters parameters)
CollectionWithPagingInfo<Node>	NodeChildrenRelation.readAll(String parentFolderNodeId, Parameters parameters)	List folder children - returns a filtered/sorted/paged list of nodes that are immediate children of the parent folder
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.
CollectionWithPagingInfo<Node>	NodeParentsRelation.readAll(String childNodeId, Parameters parameters)	List child node's parent(s) based on (parent ->) child associations.
CollectionWithPagingInfo<NodeRating>	NodeRatingsRelation.readAll(String nodeId, Parameters parameters)
CollectionWithPagingInfo<Node>	NodeSecondaryChildrenRelation.readAll(String parentNodeId, Parameters parameters)	List secondary children only
CollectionWithPagingInfo<Node>	NodeSourcesRelation.readAll(String targetNodeId, Parameters parameters)	List sources
CollectionWithPagingInfo<Tag>	NodeTagsRelation.readAll(String nodeId, Parameters params)
CollectionWithPagingInfo<Node>	NodeTargetsRelation.readAll(String sourceNodeId, Parameters parameters)	List targets
CollectionWithPagingInfo<Node>	NodeVersionsRelation.readAll(String nodeId, Parameters parameters)	List version history
NodeRating	NodeRatingsRelation.readById(String nodeId, String ratingSchemeId, Parameters parameters)	Returns the rating with id 'schemeName' for node with id 'nodeId'.
Node	NodesEntityResource.readById(String nodeId, Parameters parameters)	Returns information regarding the node 'nodeId' - folder or document
ContentStorageInfo	NodeStorageInfoRelation.readById(String nodeId, String contentPropName, Parameters parameters)
Node	NodeVersionsRelation.readById(String nodeId, String versionId, Parameters parameters)
ContentStorageInfo	NodeVersionsStorageInfoRelation.readById(String nodeId, String versionId, Parameters parameters)
BinaryResource	NodeRenditionsRelation.readProperty(String nodeId, String renditionId, Parameters parameters)
BinaryResource	NodesEntityResource.readProperty(String fileNodeId, Parameters parameters)	Download content
BinaryResource	NodeVersionRenditionsRelation.readProperty(String nodeId, String versionId, Parameters parameters)
BinaryResource	NodeVersionsRelation.readProperty(String nodeId, String versionId, Parameters parameters)
void	NodeStorageInfoRelation.requestArchiveContent(String nodeId, String contentPropName, ArchiveContentRequest archiveContentRequest, Parameters parameters, WithResponse withResponse)
void	NodeVersionsStorageInfoRelation.requestArchiveContent(String nodeId, String versionId, ArchiveContentRequest archiveContentRequest, Parameters parameters, WithResponse withResponse)
DirectAccessUrl	NodeRenditionsRelation.requestContentDirectUrl(String nodeId, String renditionId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse)
DirectAccessUrl	NodesEntityResource.requestContentDirectUrl(String nodeId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse)
DirectAccessUrl	NodeVersionRenditionsRelation.requestContentDirectUrl(String nodeId, String versionId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse)
DirectAccessUrl	NodeVersionsRelation.requestContentDirectUrl(String nodeId, String versionId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse)
void	NodeStorageInfoRelation.requestRestoreContentFromArchive(String nodeId, String contentPropName, RestoreArchivedContentRequest restoreArchivedContentRequest, Parameters parameters, WithResponse withResponse)
void	NodeVersionsStorageInfoRelation.requestRestoreContentFromArchive(String nodeId, String versionId, RestoreArchivedContentRequest restoreArchivedContentRequest, Parameters parameters, WithResponse withResponse)
Node	NodeVersionsRelation.revertById(String nodeId, String versionId, VersionOptions versionOptions, Parameters parameters, WithResponse withResponse)
Node	NodesEntityResource.unlock(String nodeId, Void ignore, Parameters parameters, WithResponse withResponse)
Comment	NodeCommentsRelation.update(String nodeId, Comment entity, Parameters parameters)
Node	NodesEntityResource.update(String nodeId, Node nodeInfo, Parameters parameters)	Update info on the node 'nodeId' - folder or document Can update name (which is a "rename" and hence must be unique within the current parent folder) or update other properties.
Node	NodesEntityResource.updateProperty(String fileNodeId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters)	Upload new version of content This allow binary content update of an existing file/content node.

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	Description
List<Person>	PeopleEntityResource.create(List<Person> persons, Parameters parameters)
List<FavouriteSite>	PersonFavouriteSitesRelation.create(String personId, List<FavouriteSite> entity, Parameters parameters)	Adds the given site as a favourite site for the user.
List<Favourite>	PersonFavouritesRelation.create(String personId, List<Favourite> 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	PersonFavouritesRelation.delete(String personId, String id, Parameters parameters)
void	PersonSiteMembershipRequestsRelation.delete(String personId, String siteId, Parameters parameters)
void	PeopleEntityResource.deleteProperty(String personId, Parameters parameters)	Delete avatar image content
CollectionWithPagingInfo<Person>	PeopleEntityResource.readAll(Parameters params)
CollectionWithPagingInfo<Activity>	PersonActivitiesRelation.readAll(String personId, Parameters parameters)
CollectionWithPagingInfo<FavouriteSite>	PersonFavouriteSitesRelation.readAll(String personId, Parameters parameters)	List the user's favourite sites.
CollectionWithPagingInfo<Favourite>	PersonFavouritesRelation.readAll(String personId, Parameters parameters)	List the user's favourites.
CollectionWithPagingInfo<PersonNetwork>	PersonNetworksRelation.readAll(String personId, Parameters parameters)
CollectionWithPagingInfo<Preference>	PersonPreferencesRelation.readAll(String personId, Parameters parameters)	Returns a paged list of preferences for the user personId.
CollectionWithPagingInfo<SiteMembershipRequest>	PersonSiteMembershipRequestsRelation.readAll(String personId, Parameters parameters)
CollectionWithPagingInfo<MemberOfSite>	PersonSitesRelation.readAll(String personId, Parameters parameters)	List all the sites that the specified user has a explicit membership of.
Person	PeopleEntityResource.readById(String personId, Parameters parameters)	Get a person by userName.
FavouriteSite	PersonFavouriteSitesRelation.readById(String personId, String siteShortName, Parameters parameters)	List the favourite site information for a specific site.
PersonNetwork	PersonNetworksRelation.readById(String personId, String networkId, Parameters parameters)
Preference	PersonPreferencesRelation.readById(String personId, String preferenceName, Parameters parameters)	Returns information regarding the preference 'preferenceName' for user personId.
SiteMembershipRequest	PersonSiteMembershipRequestsRelation.readById(String personId, String siteId, Parameters parameters)
MemberOfSite	PersonSitesRelation.readById(String personId, String siteId, Parameters parameters)	Returns site membership information for personId in siteId.
BinaryResource	PeopleEntityResource.readProperty(String personId, Parameters parameters)	Download avatar image content
void	PeopleEntityResource.requestPasswordReset(String personId, Client client, Parameters parameters, WithResponse withResponse)	Deprecated.
void	PeopleEntityResource.resetPassword(String personId, PasswordReset passwordReset, Parameters parameters, WithResponse withResponse)	Deprecated.
Person	PeopleEntityResource.update(String personId, Person person, Parameters parameters)
SiteMembershipRequest	PersonSiteMembershipRequestsRelation.update(String personId, SiteMembershipRequest siteInvite, Parameters parameters)
Person	PeopleEntityResource.updateProperty(String personId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters)	Upload avatar image content

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

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

Modifier and Type	Method	Description
Probe	ProbeEntityResource.readById(String name, Parameters parameters)	Returns a status code of 200 for okay.

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

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

Modifier and Type	Method	Description
CollectionWithPagingInfo<? extends Object>	QueriesEntityResource.readById(String queryId, Parameters parameters)

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

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

Modifier and Type	Method	Description
List<QuickShareLink>	QuickShareLinkEntityResource.create(List<QuickShareLink> nodeIds, Parameters parameters)	Create quick share.
void	QuickShareLinkEntityResource.delete(String sharedId, Parameters parameters)	Delete the shared link.
void	QuickShareLinkEntityResource.email(String sharedId, QuickShareLinkEmailRequest emailRequest, Parameters parameters, WithResponse response)
CollectionWithPagingInfo<QuickShareLink>	QuickShareLinkEntityResource.readAll(Parameters parameters)	Find shared links
CollectionWithPagingInfo<Rendition>	QuickShareLinkRenditionsRelation.readAll(String sharedId, Parameters parameters)
QuickShareLink	QuickShareLinkEntityResource.readById(String sharedId, Parameters parameters)	Returns limited metadata regarding the shared (content) link.
Rendition	QuickShareLinkRenditionsRelation.readById(String entityResourceId, String id, Parameters parameters)
BinaryResource	QuickShareLinkEntityResource.readProperty(String sharedId, Parameters parameters)	Download content via shared link.
BinaryResource	QuickShareLinkRenditionsRelation.readProperty(String sharedId, String renditionId, Parameters parameters)

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

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

Modifier and Type	Method	Description
List<RuleSetLink>	NodeRuleSetLinksRelation.create(String nodeId, List<RuleSetLink> ruleSetLinksBody, Parameters parameters)
List<Rule>	NodeRulesRelation.create(String folderNodeId, List<Rule> ruleList, Parameters parameters)	Create one or more rules inside a given folder and rule set.
void	NodeRuleSetLinksRelation.delete(String folderNodeId, String ruleSetNodeId, Parameters parameters)	Remove link between a rule set and a folder for given rule set's and folder's node IDs.
void	NodeRulesRelation.delete(String folderNodeId, String ruleSetId, Parameters parameters)	Delete single folder rule for given node's, rule set's and rule's IDs.
CollectionWithPagingInfo<RuleSet>	NodeRuleSetsRelation.readAll(String folderNodeId, Parameters parameters)	List rule sets for given folder.
CollectionWithPagingInfo<Rule>	NodeRulesRelation.readAll(String folderNodeId, Parameters parameters)	List folder rules for given folder node's and rule set's IDs as a page.
RuleSet	NodeRuleSetsRelation.readById(String folderNodeId, String ruleSetId, Parameters parameters)	Get single folder rule for given node's, rule set's and rule's IDs.
RuleSetting	NodeRuleSettingsRelation.readById(String folderId, String ruleSettingKey, Parameters parameters)	Get the given configuration value for the specified folder.
Rule	NodeRulesRelation.readById(String folderNodeId, String ruleSetId, Parameters parameters)	Get single folder rule for given node's, rule set's and rule's IDs.
RuleSetting	NodeRuleSettingsRelation.update(String folderId, RuleSetting ruleSetting, Parameters parameters)	Set the value of a rule setting for the specified folder.
Rule	NodeRulesRelation.update(String folderNodeId, Rule rule, Parameters parameters)	Update the specified folder rule.

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	Description
void	SiteMembershipRequestsRelation.approve(String siteId, String invitationId, SiteMembershipApproval siteMembershipApproval, Parameters parameters, WithResponse withResponse)
List<Site>	SiteEntityResource.create(List<Site> entity, Parameters parameters)	Create the given site.
List<SiteMember>	SiteMembersRelation.create(String siteId, List<SiteMember> siteMembers, Parameters parameters)	POST sites//members Adds personId as a member of site siteId.
void	SiteEntityResource.delete(String siteId, Parameters parameters)	Delete the given site.
void	SiteMembersRelation.delete(String siteId, String personId, Parameters parameters)	DELETE sites//members/ Removes personId as a member of site siteId.
CollectionWithPagingInfo<SiteContainer>	SiteContainersRelation.readAll(String siteId, Parameters parameters)	Returns information regarding the top level containers for site 'siteId'.
CollectionWithPagingInfo<Site>	SiteEntityResource.readAll(Parameters parameters)	Returns a paged list of all sites in the current tenant.
CollectionWithPagingInfo<SiteMember>	SiteMembersRelation.readAll(String siteId, Parameters parameters)	Returns a paged list of all the members of the site 'siteId'.
SiteContainer	SiteContainersRelation.readById(String siteId, String containerId, Parameters parameters)	Returns information regarding the top level container 'containerId' for site 'siteId'.
Site	SiteEntityResource.readById(String siteId, Parameters parameters)	Returns information regarding the site 'siteId'.
SiteMember	SiteMembersRelation.readById(String siteId, String personId, Parameters parameters)	Returns site membership information for personId in siteId.
void	SiteMembershipRequestsRelation.reject(String siteId, String invitationId, SiteMembershipRejection siteMembershipRejection, Parameters parameters, WithResponse withResponse)
Site	SiteEntityResource.update(String siteId, Site site, Parameters parameters)	Update the given site.
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.sitesmembershipsrequests

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

Modifier and Type	Method	Description
CollectionWithPagingInfo<SiteMembershipRequest>	SiteMembershipRequestEntityResource.readAll(Parameters parameters)	Returns a paged list of all site membership request the user can action.

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	Description
List<Tag>	TagsEntityResource.create(List<Tag> tags, Parameters parameters)	POST /tags
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.api.trashcan

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

Modifier and Type	Method	Description
CollectionWithPagingInfo<Rendition>	TrashcanRenditionsRelation.readAll(String nodeId, Parameters parameters)
Rendition	TrashcanRenditionsRelation.readById(String nodeId, String renditionId, Parameters parameters)
BinaryResource	TrashcanEntityResource.readProperty(String nodeId, Parameters parameters)
BinaryResource	TrashcanRenditionsRelation.readProperty(String nodeId, String renditionId, Parameters parameters)
DirectAccessUrl	TrashcanEntityResource.requestContentDirectUrl(String originalNodeId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse)
DirectAccessUrl	TrashcanRenditionsRelation.requestContentDirectUrl(String originalNodeId, String renditionId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse)
Node	TrashcanEntityResource.restoreDeletedNode(String nodeId, NodeTargetAssoc nodeTargetAssoc, Parameters parameters, WithResponse withResponse)

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	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	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<Activity>	ProcessActivitiesRelation.readAll(String processId, Parameters parameters)	List the activities.
CollectionWithPagingInfo<ProcessInfo>	ProcessesRestEntityResource.readAll(Parameters params)
CollectionWithPagingInfo<Item>	ProcessItemsRelation.readAll(String processId, Parameters parameters)	List the attached items.
CollectionWithPagingInfo<Task>	ProcessTasksRelation.readAll(String processId, Parameters parameters)	List the tasks.
CollectionWithPagingInfo<Variable>	ProcessVariablesRelation.readAll(String processId, Parameters parameters)	List the variables.
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	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<TaskCandidate>	TaskCandidatesRelation.readAll(String taskId, Parameters parameters)	List the tasks candidate users and groups.
CollectionWithPagingInfo<Item>	TaskItemsRelation.readAll(String taskId, Parameters parameters)	List the attached items.
CollectionWithPagingInfo<Task>	TasksRestEntityResource.readAll(Parameters params)
CollectionWithPagingInfo<TaskVariable>	TaskVariablesRelation.readAll(String taskId, Parameters parameters)	List the tasks variables.
TaskVariable	TaskVariablesRelation.update(String taskId, TaskVariable entity, Parameters parameters)	Update a task variable.