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

Packages that use WebApiDescription

Package	Description
org.alfresco.rest.api.authentications
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.queries
org.alfresco.rest.api.quicksharelinks
org.alfresco.rest.api.sites
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.authentications

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

Modifier and Type	Method and 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.cmm

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

Modifier and Type	Method and Description
List<CustomModel>	CustomModelEntityResource.create(List<CustomModel> entity, Parameters parameters)
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<CustomType>	CustomModelTypesRelation.create(String modelName, List<CustomType> types, Parameters parameters)
void	CustomModelEntityResource.delete(String modelName, Parameters parameters)
void	CustomModelTypesRelation.delete(String modelName, String typeName, Parameters parameters)
void	CustomModelAspectsRelation.delete(String modelName, String aspectName, Parameters parameters)
CollectionWithPagingInfo<CustomModel>	CustomModelEntityResource.readAll(Parameters parameters)
CollectionWithPagingInfo<CustomType>	CustomModelTypesRelation.readAll(String modelName, Parameters parameters)
CollectionWithPagingInfo<CustomModelConstraint>	CustomModelConstraintRelation.readAll(String modelName, Parameters parameters)
CollectionWithPagingInfo<CustomAspect>	CustomModelAspectsRelation.readAll(String modelName, Parameters parameters)
CustomModel	CustomModelEntityResource.readById(String modelName, Parameters parameters)
CustomType	CustomModelTypesRelation.readById(String modelName, String typeName, Parameters parameters)
CustomModelConstraint	CustomModelConstraintRelation.readById(String modelName, String constraintName, Parameters parameters)
CustomAspect	CustomModelAspectsRelation.readById(String modelName, String aspectName, 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 and 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 and Description
List<Group>	GroupsEntityResource.create(List<Group> entity, Parameters parameters)
List<GroupMember>	GroupMembersRelation.create(String groupId, List<GroupMember> entity, Parameters params)
void	GroupsEntityResource.delete(String groupId, Parameters parameters)
void	GroupMembersRelation.delete(String entityResourceId, String id, Parameters parameters)
CollectionWithPagingInfo<Group>	GroupsEntityResource.readAll(Parameters params)
CollectionWithPagingInfo<GroupMember>	GroupMembersRelation.readAll(String groupId, Parameters params)
Group	GroupsEntityResource.readById(String groupId, Parameters parameters)
Group	GroupsEntityResource.update(String groupId, Group group, Parameters parameters)

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 and 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 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
Node	NodesEntityResource.copyById(String nodeId, NodeTarget target, Parameters parameters, WithResponse withResponse)
Node	NodeChildrenRelation.create(String parentFolderNodeId, org.springframework.extensions.webscripts.servlet.FormData formData, Parameters parameters, WithResponse withResponse)
List<AssocChild>	NodeSecondaryChildrenRelation.create(String parentNodeId, List<AssocChild> entities, Parameters parameters)
List<AssocTarget>	NodeTargetsRelation.create(String sourceNodeId, List<AssocTarget> entities, Parameters parameters)
List<Comment>	NodeCommentsRelation.create(String nodeId, List<Comment> entity, Parameters parameters) Create a comment for the node given by nodeId.
List<Node>	NodeChildrenRelation.create(String parentFolderNodeId, List<Node> nodeInfos, Parameters parameters) Create one or more nodes (folder or empty file) below parent folder.
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<Tag>	NodeTagsRelation.create(String nodeId, List<Tag> tagsToCreate, Parameters parameters) Add the tag to the node with id 'nodeId'.
void	NodesEntityResource.delete(String nodeId, Parameters parameters) Delete the given node.
void	NodeRatingsRelation.delete(String nodeId, String ratingSchemeId, Parameters parameters)
void	NodeCommentsRelation.delete(String nodeId, String commentNodeId, Parameters parameters)
void	NodeTagsRelation.delete(String nodeId, String tagId, Parameters parameters)
void	NodeVersionsRelation.delete(String nodeId, String versionId, Parameters parameters)
void	NodeSecondaryChildrenRelation.delete(String parentNodeId, String childNodeId, Parameters parameters)
void	NodeTargetsRelation.delete(String sourceNodeId, String targetNodeId, 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<NodeRating>	NodeRatingsRelation.readAll(String nodeId, Parameters parameters)
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<Tag>	NodeTagsRelation.readAll(String nodeId, Parameters params)
CollectionWithPagingInfo<Node>	NodeVersionsRelation.readAll(String nodeId, Parameters parameters) List version history
CollectionWithPagingInfo<Node>	NodeSecondaryChildrenRelation.readAll(String parentNodeId, Parameters parameters) List secondary children only
CollectionWithPagingInfo<Node>	NodeSourcesRelation.readAll(String targetNodeId, Parameters parameters) List sources
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<Node>	NodeParentsRelation.readAll(String childNodeId, Parameters parameters) List child node's parent(s) based on (parent ->) child associations.
CollectionWithPagingInfo<Node>	NodeTargetsRelation.readAll(String sourceNodeId, Parameters parameters) List targets
Node	NodesEntityResource.readById(String nodeId, Parameters parameters) Returns information regarding the node 'nodeId' - folder or document
NodeRating	NodeRatingsRelation.readById(String nodeId, String ratingSchemeId, Parameters parameters) Returns the rating with id 'schemeName' for node with id 'nodeId'.
Node	NodeVersionsRelation.readById(String nodeId, String versionId, Parameters parameters)
BinaryResource	NodesEntityResource.readProperty(String fileNodeId, Parameters parameters) Download content
BinaryResource	NodeVersionsRelation.readProperty(String nodeId, String versionId, Parameters parameters)
BinaryResource	NodeRenditionsRelation.readProperty(String nodeId, String renditionId, Parameters parameters)
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 and Description
List<Person>	PeopleEntityResource.create(List<Person> persons, Parameters parameters)
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	PersonFavouritesRelation.delete(String personId, String id, Parameters parameters)
void	PersonFavouriteSitesRelation.delete(String personId, String siteId, Parameters parameters)
void	PersonSiteMembershipRequestsRelation.delete(String personId, String siteId, Parameters parameters)
CollectionWithPagingInfo<Person>	PeopleEntityResource.readAll(Parameters params)
CollectionWithPagingInfo<Preference>	PersonPreferencesRelation.readAll(String personId, Parameters parameters) Returns a paged list of preferences for the user personId.
CollectionWithPagingInfo<Activity>	PersonActivitiesRelation.readAll(String personId, Parameters parameters)
CollectionWithPagingInfo<Favourite>	PersonFavouritesRelation.readAll(String personId, Parameters parameters) List the user's favourites.
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<PersonNetwork>	PersonNetworksRelation.readAll(String personId, Parameters parameters)
CollectionWithPagingInfo<SiteMembershipRequest>	PersonSiteMembershipRequestsRelation.readAll(String personId, Parameters parameters)
Person	PeopleEntityResource.readById(String personId, Parameters parameters) Get a person by userName.
Preference	PersonPreferencesRelation.readById(String personId, String preferenceName, Parameters parameters) Returns information regarding the preference 'preferenceName' for user personId.
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.
PersonNetwork	PersonNetworksRelation.readById(String personId, String networkId, Parameters parameters)
SiteMembershipRequest	PersonSiteMembershipRequestsRelation.readById(String personId, String siteId, Parameters parameters)
void	PeopleEntityResource.requestPasswordReset(String personId, Client client, Parameters parameters, WithResponse withResponse)
void	PeopleEntityResource.resetPassword(String personId, PasswordReset passwordReset, Parameters parameters, WithResponse withResponse)
Person	PeopleEntityResource.update(String personId, Person person, Parameters parameters)
SiteMembershipRequest	PersonSiteMembershipRequestsRelation.update(String personId, SiteMembershipRequest siteInvite, Parameters parameters)

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 and 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 and 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.sites

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

Modifier and Type	Method and Description
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<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'.
CollectionWithPagingInfo<SiteContainer>	SiteContainersRelation.readAll(String siteId, Parameters parameters) Returns information regarding the top level containers 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.
SiteContainer	SiteContainersRelation.readById(String siteId, String containerId, Parameters parameters) Returns information regarding the top level container 'containerId' for site '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).
Site	SiteEntityResource.update(String siteId, Site site, Parameters parameters) Update the given site.

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.api.trashcan

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

Modifier and Type	Method and Description
Node	TrashcanEntityResource.restoreDeletedNode(String nodeId, Void ignored, 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 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<Activity>	ProcessActivitiesRelation.readAll(String processId, Parameters parameters) List the activities.
CollectionWithPagingInfo<Item>	ProcessItemsRelation.readAll(String processId, Parameters parameters) List the attached items.
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 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.