Uses of Annotation Type
org.alfresco.rest.framework.WebApiDescription
Packages that use WebApiDescription
Package
Description
-
Uses of WebApiDescription in org.alfresco.rest.api.actions
Methods in org.alfresco.rest.api.actions with annotations of type WebApiDescriptionModifier and TypeMethodDescriptionActionExecutionsEntityResource.create
(List<Action> entity, Parameters parameters) 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 WebApiDescriptionModifier and TypeMethodDescriptionvoid
AuditApplicationsAuditEntriesRelation.delete
(String auditAppId, String auditEntryId, Parameters parameters) void
AuditApplicationsAuditEntriesRelation.deleteSet
(String auditAppId, Parameters parameters) AuditApplicationsAuditEntriesRelation.readAll
(String auditAppId, Parameters parameters) AuditApplicationsEntityResource.readAll
(Parameters parameters) AuditApplicationsAuditEntriesRelation.readById
(String auditAppId, String auditEntryId, Parameters parameters) AuditApplicationsEntityResource.readById
(String auditAppId, Parameters parameters) 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 WebApiDescriptionModifier and TypeMethodDescriptionAuthenticationTicketsEntityResource.create
(List<LoginTicket> entity, Parameters parameters) void
AuthenticationTicketsEntityResource.delete
(String me, Parameters parameters, WithResponse withResponse) 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 WebApiDescriptionModifier and TypeMethodDescriptionCustomModelAspectsRelation.create
(String modelName, List<CustomAspect> aspects, Parameters parameters) CustomModelConstraintRelation.create
(String modelName, List<CustomModelConstraint> constraints, Parameters parameters) CustomModelDownloadRelation.create
(String modelName, List<CustomModelDownload> download, Parameters parameters) CustomModelEntityResource.create
(List<CustomModel> entity, Parameters parameters) 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) CustomModelAspectsRelation.readAll
(String modelName, Parameters parameters) CustomModelConstraintRelation.readAll
(String modelName, Parameters parameters) CustomModelEntityResource.readAll
(Parameters parameters) CustomModelTypesRelation.readAll
(String modelName, Parameters parameters) CustomModelAspectsRelation.readById
(String modelName, String aspectName, Parameters parameters) CustomModelConstraintRelation.readById
(String modelName, String constraintName, Parameters parameters) CustomModelEntityResource.readById
(String modelName, Parameters parameters) CustomModelTypesRelation.readById
(String modelName, String typeName, Parameters parameters) CustomModelAspectsRelation.update
(String modelName, CustomAspect aspect, Parameters parameters) CustomModelEntityResource.update
(String modelName, CustomModel entity, Parameters parameters) 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 WebApiDescriptionModifier and TypeMethodDescriptionDownloadsEntityResource.create
(List<Download> entity, Parameters parameters) void
DownloadsEntityResource.delete
(String nodeId, Parameters parameters) 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 WebApiDescriptionModifier and TypeMethodDescriptionGroupMembersRelation.create
(String groupId, List<GroupMember> entity, Parameters params) GroupsEntityResource.create
(List<Group> entity, Parameters parameters) 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/ GroupMembersRelation.readAll
(String groupId, Parameters params) GroupsEntityResource.readAll
(Parameters params) SiteGroupsRelation.readAll
(String siteId, Parameters parameters) Returns a paged list of all the groups of the site 'siteId'.GroupsEntityResource.readById
(String groupId, Parameters parameters) SiteGroupsRelation.readById
(String siteId, String groupId, Parameters parameters) Returns site membership information for groupId in siteId.GroupsEntityResource.update
(String groupId, Group group, Parameters parameters) 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 WebApiDescriptionModifier and TypeMethodDescriptionModulePackagesEntityResource.readAll
(Parameters parameters) 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 WebApiDescriptionModifier and TypeMethodDescriptionNetworksEntityResource.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 WebApiDescriptionModifier and TypeMethodDescriptionNodesEntityResource.copyById
(String nodeId, NodeTarget target, Parameters parameters, WithResponse withResponse) NodeChildrenRelation.create
(String parentFolderNodeId, List<Node> nodeInfos, Parameters parameters) Create one or more nodes (folder or empty file) below parent folder.NodeChildrenRelation.create
(String parentFolderNodeId, org.springframework.extensions.webscripts.servlet.FormData formData, Parameters parameters, WithResponse withResponse) NodeCommentsRelation.create
(String nodeId, List<Comment> entity, Parameters parameters) Create a comment for the node given by nodeId.NodeRatingsRelation.create
(String nodeId, List<NodeRating> ratingEntity, Parameters parameters) Create a rating for the node with id 'nodeId'.NodeRenditionsRelation.create
(String nodeId, List<Rendition> entity, Parameters parameters) NodeRuleSetLinksRelation.create
(String nodeId, List<RuleSetLink> ruleSetLinksBody, Parameters parameters) NodeRulesRelation.create
(String folderNodeId, List<Rule> ruleList, Parameters parameters) Create one or more rules inside a given folder and rule set.NodeSecondaryChildrenRelation.create
(String parentNodeId, List<AssocChild> entities, Parameters parameters) NodeTagsRelation.create
(String nodeId, List<Tag> tagsToCreate, Parameters parameters) Add the tag to the node with id 'nodeId'.NodeTargetsRelation.create
(String sourceNodeId, List<AssocTarget> entities, Parameters parameters) 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
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.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) NodesEntityResource.lock
(String nodeId, LockInfo lockInfo, Parameters parameters, WithResponse withResponse) NodesEntityResource.moveById
(String nodeId, NodeTarget target, Parameters parameters, WithResponse withResponse) NodeAuditEntriesRelation.readAll
(String nodeId, Parameters parameters) NodeChildrenRelation.readAll
(String parentFolderNodeId, Parameters parameters) List folder children - returns a filtered/sorted/paged list of nodes that are immediate children of the parent folderNodeCommentsRelation.readAll
(String nodeId, Parameters parameters) Returns a paged list of comments for the document/folder identified by nodeId, sorted chronologically with the newest first.NodeParentsRelation.readAll
(String childNodeId, Parameters parameters) List child node's parent(s) based on (parent ->) child associations.NodeRatingsRelation.readAll
(String nodeId, Parameters parameters) NodeRuleSetsRelation.readAll
(String folderNodeId, Parameters parameters) List rule sets for given folder.NodeRulesRelation.readAll
(String folderNodeId, Parameters parameters) List folder rules for given folder node's and rule set's IDs as a page.NodeSecondaryChildrenRelation.readAll
(String parentNodeId, Parameters parameters) List secondary children onlyNodeSourcesRelation.readAll
(String targetNodeId, Parameters parameters) List sourcesNodeTagsRelation.readAll
(String nodeId, Parameters params) NodeTargetsRelation.readAll
(String sourceNodeId, Parameters parameters) List targetsNodeVersionsRelation.readAll
(String nodeId, Parameters parameters) List version historyNodeRatingsRelation.readById
(String nodeId, String ratingSchemeId, Parameters parameters) Returns the rating with id 'schemeName' for node with id 'nodeId'.NodeRuleSetsRelation.readById
(String folderNodeId, String ruleSetId, Parameters parameters) Get single folder rule for given node's, rule set's and rule's IDs.NodeRuleSettingsRelation.readById
(String folderId, String ruleSettingKey, Parameters parameters) Get the given configuration value for the specified folder.NodeRulesRelation.readById
(String folderNodeId, String ruleSetId, Parameters parameters) Get single folder rule for given node's, rule set's and rule's IDs.NodesEntityResource.readById
(String nodeId, Parameters parameters) Returns information regarding the node 'nodeId' - folder or documentNodeStorageInfoRelation.readById
(String nodeId, String contentPropName, Parameters parameters) NodeVersionsRelation.readById
(String nodeId, String versionId, Parameters parameters) NodeVersionsStorageInfoRelation.readById
(String nodeId, String versionId, Parameters parameters) NodeRenditionsRelation.readProperty
(String nodeId, String renditionId, Parameters parameters) NodesEntityResource.readProperty
(String fileNodeId, Parameters parameters) Download contentNodeVersionRenditionsRelation.readProperty
(String nodeId, String versionId, Parameters parameters) 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) NodeRenditionsRelation.requestContentDirectUrl
(String nodeId, String renditionId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse) NodesEntityResource.requestContentDirectUrl
(String nodeId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse) NodeVersionRenditionsRelation.requestContentDirectUrl
(String nodeId, String versionId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse) 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) NodeVersionsRelation.revertById
(String nodeId, String versionId, VersionOptions versionOptions, Parameters parameters, WithResponse withResponse) NodesEntityResource.unlock
(String nodeId, Void ignore, Parameters parameters, WithResponse withResponse) NodeCommentsRelation.update
(String nodeId, Comment entity, Parameters parameters) NodeRuleSettingsRelation.update
(String folderId, RuleSetting ruleSetting, Parameters parameters) Set the value of a rule setting for the specified folder.NodeRulesRelation.update
(String folderNodeId, Rule rule, Parameters parameters) Update the specified folder rule.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.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 WebApiDescriptionModifier and TypeMethodDescriptionPeopleEntityResource.create
(List<Person> persons, Parameters parameters) PersonFavouriteSitesRelation.create
(String personId, List<FavouriteSite> entity, Parameters parameters) Adds the given site as a favourite site for the user.PersonFavouritesRelation.create
(String personId, List<Favourite> entity, Parameters parameters) Adds the given site as a favourite site for the user.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 contentPeopleEntityResource.readAll
(Parameters params) PersonActivitiesRelation.readAll
(String personId, Parameters parameters) PersonFavouriteSitesRelation.readAll
(String personId, Parameters parameters) List the user's favourite sites.PersonFavouritesRelation.readAll
(String personId, Parameters parameters) List the user's favourites.PersonNetworksRelation.readAll
(String personId, Parameters parameters) PersonPreferencesRelation.readAll
(String personId, Parameters parameters) Returns a paged list of preferences for the user personId.PersonSiteMembershipRequestsRelation.readAll
(String personId, Parameters parameters) PersonSitesRelation.readAll
(String personId, Parameters parameters) List all the sites that the specified user has a explicit membership of.PeopleEntityResource.readById
(String personId, Parameters parameters) Get a person by userName.PersonFavouriteSitesRelation.readById
(String personId, String siteShortName, Parameters parameters) List the favourite site information for a specific site.PersonNetworksRelation.readById
(String personId, String networkId, Parameters parameters) PersonPreferencesRelation.readById
(String personId, String preferenceName, Parameters parameters) Returns information regarding the preference 'preferenceName' for user personId.PersonSiteMembershipRequestsRelation.readById
(String personId, String siteId, Parameters parameters) PersonSitesRelation.readById
(String personId, String siteId, Parameters parameters) Returns site membership information for personId in siteId.PeopleEntityResource.readProperty
(String personId, Parameters parameters) Download avatar image contentvoid
PeopleEntityResource.requestPasswordReset
(String personId, Client client, Parameters parameters, WithResponse withResponse) Deprecated.void
PeopleEntityResource.resetPassword
(String personId, PasswordReset passwordReset, Parameters parameters, WithResponse withResponse) Deprecated.PeopleEntityResource.update
(String personId, Person person, Parameters parameters) PersonSiteMembershipRequestsRelation.update
(String personId, SiteMembershipRequest siteInvite, Parameters parameters) 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 WebApiDescriptionModifier and TypeMethodDescriptionProbeEntityResource.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 WebApiDescriptionModifier and TypeMethodDescriptionCollectionWithPagingInfo<? extends Object>
QueriesEntityResource.readById
(String queryId, Parameters parameters) -
Uses of WebApiDescription in org.alfresco.rest.api.sites
Methods in org.alfresco.rest.api.sites with annotations of type WebApiDescriptionModifier and TypeMethodDescriptionvoid
SiteMembershipRequestsRelation.approve
(String siteId, String invitationId, SiteMembershipApproval siteMembershipApproval, Parameters parameters, WithResponse withResponse) SiteEntityResource.create
(List<Site> entity, Parameters parameters) Create the given site.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. SiteContainersRelation.readAll
(String siteId, Parameters parameters) Returns information regarding the top level containers for site 'siteId'.SiteEntityResource.readAll
(Parameters parameters) Returns a paged list of all sites in the current tenant.SiteMembersRelation.readAll
(String siteId, Parameters parameters) Returns a paged list of all the members of the site 'siteId'.SiteContainersRelation.readById
(String siteId, String containerId, Parameters parameters) Returns information regarding the top level container 'containerId' for site 'siteId'.SiteEntityResource.readById
(String siteId, Parameters parameters) Returns information regarding the site 'siteId'.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) SiteEntityResource.update
(String siteId, Site site, Parameters parameters) Update the given site.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 WebApiDescriptionModifier and TypeMethodDescriptionSiteMembershipRequestEntityResource.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 WebApiDescriptionModifier and TypeMethodDescriptionTagsEntityResource.readAll
(Parameters parameters) Returns a paged list of all currently used tags in the store workspace://SpacesStore for the current tenant.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 WebApiDescriptionModifier and TypeMethodDescriptionTrashcanRenditionsRelation.readAll
(String nodeId, Parameters parameters) TrashcanRenditionsRelation.readById
(String nodeId, String renditionId, Parameters parameters) TrashcanEntityResource.readProperty
(String nodeId, Parameters parameters) TrashcanRenditionsRelation.readProperty
(String nodeId, String renditionId, Parameters parameters) TrashcanEntityResource.requestContentDirectUrl
(String originalNodeId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse) TrashcanRenditionsRelation.requestContentDirectUrl
(String originalNodeId, String renditionId, DirectAccessUrlRequest directAccessUrlRequest, Parameters parameters, WithResponse withResponse) 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 WebApiDescriptionModifier and TypeMethodDescriptionProcessDefinitionsRestEntityResource.readAll
(Parameters params) StartFormModelRelation.readAll
(String definitionId, Parameters parameters) List the tasks candidate users and groups.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 WebApiDescriptionModifier and TypeMethodDescriptionProcessesRestEntityResource.create
(List<ProcessInfo> entity, Parameters parameters) 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.ProcessActivitiesRelation.readAll
(String processId, Parameters parameters) List the activities.ProcessesRestEntityResource.readAll
(Parameters params) ProcessItemsRelation.readAll
(String processId, Parameters parameters) List the attached items.ProcessTasksRelation.readAll
(String processId, Parameters parameters) List the tasks.ProcessVariablesRelation.readAll
(String processId, Parameters parameters) List the variables.ProcessesRestEntityResource.readProperty
(String entityId, Parameters parameters) 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 WebApiDescriptionModifier and TypeMethodDescriptionTaskVariablesRelation.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.TaskCandidatesRelation.readAll
(String taskId, Parameters parameters) List the tasks candidate users and groups.TaskItemsRelation.readAll
(String taskId, Parameters parameters) List the attached items.TasksRestEntityResource.readAll
(Parameters params) TaskVariablesRelation.readAll
(String taskId, Parameters parameters) List the tasks variables.TaskVariablesRelation.update
(String taskId, TaskVariable entity, Parameters parameters) Update a task variable.