Alfresco Index of All Web Scripts
Alfresco Community v3.2.0 (2039)
319 Web Scripts

Back to Web Scripts Home

Package: /org/alfresco

Web Scripts Home
GET /alfresco/service/
GET /alfresco/service/index
---
Web Scripts Home
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Lifecycle:internal
Id:org/alfresco/index.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/index.get.desc.xml

Web Script Maintenance
POST /alfresco/service/index?reset={reset?}
POST /alfresco/service/?reset={reset?}
---
Maintain index of Web Scripts
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Lifecycle:internal
Id:org/alfresco/index.post
Descriptor:classpath:alfresco/webscripts/org/alfresco/index.post.desc.xml

All Web Scripts Index
GET /alfresco/service/index/all?package={package?}&url={url?}&family={family?}
GET /alfresco/service/index/all.mediawiki?package={package?}&url={url?}&family={family?}
---
Retrieve an index of all Web Scripts
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Lifecycle:internal
Id:org/alfresco/indexall.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/indexall.get.desc.xml

Failed Web Scripts Index
GET /alfresco/service/index/failures
---
Retrieve an index of all failed Web Scripts
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Lifecycle:internal
Id:org/alfresco/indexfailures.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/indexfailures.get.desc.xml

Web Script Family Index
GET /alfresco/service/index/family/{family}
---
Provide an index of Web Scripts for the specified family
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Lifecycle:internal
Id:org/alfresco/indexfamily.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/indexfamily.get.desc.xml

Web Script Lifecycle Index
GET /alfresco/service/index/lifecycle/{lifecycle}
---
Provide an index of Web Scripts in the various lifecycle states
none
This web script is not part of a lifecycle.
sample
This web script is a sample and is not intended for production use.
draft
This method may be incomplete, experimental or still subject to change.
public_api
This method is part of the Alfresco public api and should be stable and well tested.
draft_public_api
This method is intended to eventually become part of the public api but is incomplete or still subject to change.
deprecated
This method should be avoided. It may be removed in future versions of Alfresco.
internal
This script is for Alfresco use only. This script should not be relied upon between versions. It is likely to change.
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Lifecycle:internal
Id:org/alfresco/indexlifecycle.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/indexlifecycle.get.desc.xml

Web Script Package Index
GET /alfresco/service/index/package/{package}
---
Provide an index of Web Scripts for the specified Web Script package
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Id:org/alfresco/indexpackage.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/indexpackage.get.desc.xml

Web Script URI Index
GET /alfresco/service/index/uri/{uri}
---
Provide an index of Web Scripts for the specified Web Script URI
---
Authentication:none
Transaction:none
Format Style:argument
Default Format:html
Id:org/alfresco/indexuri.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/indexuri.get.desc.xml

Javascript Debugger
GET /alfresco/service/api/javascript/debugger
---
Javascript Debugger
---
Authentication:admin
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/jsdebugger.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/jsdebugger.get.desc.xml

Javascript Debugger Maintenance
POST /alfresco/service/api/javascript/debugger?active={active?}
---
Javascript Debugger Maintenance
---
Authentication:admin
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/jsdebugger.post
Descriptor:classpath:alfresco/webscripts/org/alfresco/jsdebugger.post.desc.xml

Web Script Description
GET /alfresco/service/description/{serviceId}
---
Retrieve description document for identified Web Script
---
Authentication:none
Transaction:none
Format Style:argument
Default Format:html
Id:org/alfresco/scriptdescription.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/scriptdescription.get.desc.xml

Display Web Script
GET /alfresco/service/script/{serviceId}
---
Full inspection of Web Script implementation - useful for diagnostics and download/upload
---
Authentication:admin
Transaction:required
Format Style:argument
Default Format:html
Id:org/alfresco/scriptdump.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/scriptdump.get.desc.xml

Web Script Installer Form
GET /alfresco/service/installer
---
Web Script Installer Form
---
Authentication:admin
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/scriptinstall.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/scriptinstall.get.desc.xml

Install Web Script
POST /alfresco/service/installer
---
Install Web Script
---
Authentication:admin
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/scriptinstall.post
Descriptor:classpath:alfresco/webscripts/org/alfresco/scriptinstall.post.desc.xml

Package: /org/alfresco/avm

Apply AVM Custom View
GET /alfresco/service/avm/applyavmcustomview
---
Simple UI to help apply a WebScript based custom view to an AVM folder
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/avm/applyavmcustomview.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/avm/applyavmcustomview.get.desc.xml

Apply AVM Custom View POST
POST /alfresco/service/avm/applyavmcustomview
---
Simple UI to help apply a WebScript based custom view to an AVM folder
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/avm/applyavmcustomview.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/avm/applyavmcustomview.post.desc.xml

Package: /org/alfresco/calendar

Retrieve Day Events
GET /alfresco/service/calendar/RetrieveDayEvents?d={requiredDate}&s={currentSpace}
---
Retrieve Day Events
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/calendar/RetrieveDayEvents.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/RetrieveDayEvents.get.desc.xml

Retrieve Event Defaults
GET /alfresco/service/calendar/RetrieveEventDefaults?s={spaceRef}
---
Retrieve Event Defaults
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/calendar/RetrieveEventDefaults.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/RetrieveEventDefaults.get.desc.xml

Retrieve Event Details
GET /alfresco/service/calendar/RetrieveEventDetails?e={eventId}
---
Retrieve Event Details
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/calendar/RetrieveEventDetails.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/RetrieveEventDetails.get.desc.xml

Retrieve Month Events
GET /alfresco/service/calendar/RetrieveMonthEvents?d={requiredDate}&s={currentSpace}
---
Retrieve Month Events
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/calendar/RetrieveMonthEvents.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/RetrieveMonthEvents.get.desc.xml

Retrieve Week Events
GET /alfresco/service/calendar/RetrieveWeekEvents?d={requiredDate}&s={currentSpace}
---
Retrieve Week Events
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/calendar/RetrieveWeekEvents.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/RetrieveWeekEvents.get.desc.xml

Save Calendar Event
GET /alfresco/service/calendar/SaveCalendarEvent?what={whatEvent}&where={whereEvent}&desc={descriptionEvent}&color={colorEvent}&fd={fromDate}&ft={fromTime}&td={toDate}&tt={toTime}&e={eventId}&d={toDelete}&s={spaceRef}
---
Save Calendar Event
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/calendar/SaveCalendarEvent.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/SaveCalendarEvent.get.desc.xml

Calendar Subscriptions
POST /alfresco/service/calendar/calendarRemove
---
Calendar Subscriptions
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/calendar/calendarDelete.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/calendarDelete.post.desc.xml

Calendar Events
GET /alfresco/service/calendar/getCalendarEvents
---
Calendar Events
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/calendar/calendarEvents.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/calendarEvents.get.desc.xml

Calendar Subscriptions
GET /alfresco/service/calendar/calendarInit
---
Calendar Subscriptions
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/calendar/calendarInit.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/calendarInit.get.desc.xml

Calendar Subscriptions
POST /alfresco/service/calendar/calendarSubscriptions
---
Calendar Subscriptions
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/calendar/calendarSub.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/calendarSub.post.desc.xml

Calendar Subscriptions
GET /alfresco/service/calendar/getColor
---
Calendar Subscriptions
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/calendar/color.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/color.get.desc.xml

Calendar Subscriptions
POST /alfresco/service/calendar/setColor
---
Calendar Subscriptions
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/calendar/color.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/color.post.desc.xml

Event Listing
GET /alfresco/service/calendar/events/{nodeId}
---
List of all upcoming events
---
Authentication:guest
Transaction:required
Format Style:extension
Default Format:json
Id:org/alfresco/calendar/events.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/events.get.desc.xml

Calendar Feed
GET /alfresco/service/calendar/feed/{nodeId}
---
Calendar iCalendar feed
---
Authentication:guest
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/calendar/feed.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/calendar/feed.get.desc.xml

Package: /org/alfresco/cmis

CMIS Test Harness
POST /alfresco/service/api/cmis/test?url={serviceUrl}&user={user?}&validate={validate?}&trace={trace?}&tests={tests?}
---
Execute a series of tests against a CMIS server.

Inputs:

String url: CMIS service url of the repository to test
String user: username/password for authentication (HTTP BASIC Authentication)
boolean validate: true => validate repository responses against CMIS XSDs
boolean trace: true => trace request and response bodies String tests: names of tests to execute (use * in test name to represent wildcard) (Default: *)
---
Authentication:none
Transaction:none
Format Style:any
Default Format:text
Id:org/alfresco/cmis/test.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/cmis/test.post.desc.xml

Package: /org/alfresco/collaboration

Blog Custom View
GET /alfresco/service/collaboration/blogSpace?nodeRef={noderef}
---
Collaboration Blog Space view
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/blogSpace.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/blogSpace.get.desc.xml

Blog Summary
GET /alfresco/service/collaboration/blogSummary?nodeRef={noderef}
---
Collaboration Blog Summary
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/blogSummary.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/blogSummary.get.desc.xml

Calendar View
GET /alfresco/service/collaboration/calendar?nodeRef={noderef}
---
Collaboration Calendar Space view
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/calendar.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/calendar.get.desc.xml

Calendar Summary
GET /alfresco/service/collaboration/calendarSummary?nodeRef={noderef}
---
Collaboration Calendar Summary
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/calendarSummary.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/calendarSummary.get.desc.xml

Colleague Presence Custom View
GET /alfresco/service/collaboration/colleaguePresence?nodeRef={noderef}
---
Collaboration Colleague Presence view
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/colleaguePresence.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/colleaguePresence.get.desc.xml

DocLib Custom View
GET /alfresco/service/collaboration/docLibrary?nodeRef={noderef}
---
Collaboration Document Library view
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/docLibrary.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/docLibrary.get.desc.xml

Doc Summary
GET /alfresco/service/collaboration/docSummary?nodeRef={noderef}
---
Collaboration Doc Summary
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/docSummary.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/docSummary.get.desc.xml

Email Summary
GET /alfresco/service/collaboration/emailSummary?nodeRef={noderef}
---
Collaboration Email Summary
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/emailSummary.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/emailSummary.get.desc.xml

Forum Summary
GET /alfresco/service/collaboration/forumSummary?nodeRef={noderef}
---
Collaboration Forum Summary
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/forumSummary.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/forumSummary.get.desc.xml

Gallery Sample Data
GET /alfresco/service/collaboration/gallery/{noderef}
---
Returns data used to populate the Flex gallery sample.
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:xml
Id:org/alfresco/collaboration/gallery.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/gallery.get.desc.xml

Gallery Summary
GET /alfresco/service/collaboration/gallerySummary?nodeRef={noderef}
---
Collaboration Gallery Summary
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/gallerySummary.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/gallerySummary.get.desc.xml

Project Space Custom View
GET /alfresco/service/collaboration/projectSpace?nodeRef={noderef}
---
Collaboration Project Space Space view
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/projectSpace.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/projectSpace.get.desc.xml

Tagging Actions
GET /alfresco/service/collaboration/tagActions
---
Add and remove tags to nodes
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/tagActions.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/tagActions.get.desc.xml

Tagging Actions
POST /alfresco/service/collaboration/tagActions
---
Add and remove tags to nodes
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/tagActions.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/tagActions.post.desc.xml

Tagging Query
GET /alfresco/service/collaboration/tagQuery
---
Query tag usage
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/collaboration/tagQuery.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/tagQuery.get.desc.xml

Views the specified gallery
GET /alfresco/service/collaboration/gallery/view/{noderef}
---
Views the specified gallery.
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/collaboration/viewgallery.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/collaboration/viewgallery.get.desc.xml

Package: /org/alfresco/office

External caller page (Office Add-In)
GET /alfresco/service/office/callexternal?action={action?}&path={path?}&filename={filename?}
---
Temporary page for external calls
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/callexternal.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/callexternal.get.desc.xml

Document Actions (Office Add-In)
GET /alfresco/service/office/docActions
---
Used by the Office Add-In to perform actions on managed documents
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/docActions.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/docActions.get.desc.xml

Document Details (Office Add-In)
GET /alfresco/service/office/documentDetails?p={path?}
---
Generate the Office Add-In Document Details page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/documentDetails.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/documentDetails.get.desc.xml

Get Users (Office Add-In)
GET /alfresco/service/office/getUsers?s={searchTerm}
---
Used by the Office Add-In to query for users
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/getUsers.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/getUsers.get.desc.xml

My Alfresco (Office Add-In)
GET /alfresco/service/office/myAlfresco?p={path?}
---
Generate the Office Add-In My Alfresco page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/myAlfresco.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/myAlfresco.get.desc.xml

My Tasks (Office Add-In)
GET /alfresco/service/office/myTasks?p={path}
---
Generate the Office Add-In My Tasks page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/myTasks.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/myTasks.get.desc.xml

My Tasks Detail (Office Add-In)
GET /alfresco/service/office/myTasksDetail?t={taskId}
---
Generate the Office Add-In Task Detail page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/myTasksDetail.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/myTasksDetail.get.desc.xml

Navigation (Office Add-In)
GET /alfresco/service/office/navigation?p={path?}
---
Generate the Office Add-In Navigation page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/navigation.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/navigation.get.desc.xml

Search (Office Add-In)
GET /alfresco/service/office/search?p={path?}
---
Generate the Office Add-In Search page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/search.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/search.get.desc.xml

Search Results (Office Add-In)
GET /alfresco/service/office/searchResults?search={searchString?}&maxresults={maxresults?}
---
Generate the Office Add-In Search Results page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/searchResults.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/searchResults.get.desc.xml

Document Tags (Office Add-In)
GET /alfresco/service/office/tags?p={path?}
---
Generate the Office Add-In Tags page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/office/tags.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/office/tags.get.desc.xml

Package: /org/alfresco/portlets

Document List
GET /alfresco/service/ui/doclist?f={filter?}&p={path?}&q={query?}
GET /alfresco/service/ui/doclist.atom?f={filter?}&p={path?}&q={query?}
---
Generate the Document list portlet page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/portlets/doclist.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/portlets/doclist.get.desc.xml

Document List Panel
GET /alfresco/service/ui/doclistpanel?f={filter}&p={path}&h={home};q={query?}
---
Generate the inner panel for the Document List portlet page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/portlets/doclistpanel.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/portlets/doclistpanel.get.desc.xml

My Spaces
GET /alfresco/service/ui/myspaces?f={filter?}&p={path?}
---
Generate the My Spaces portlet page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/portlets/myspaces.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/portlets/myspaces.get.desc.xml

My Spaces Panel
GET /alfresco/service/ui/myspacespanel?f={filter}&p={path}&h={home}
---
Generate the inner panel for the My Spaces portlet page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/portlets/myspacespanel.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/portlets/myspacespanel.get.desc.xml

My Tasks
GET /alfresco/service/ui/mytasks?f={filter?}
---
Generate the My Tasks portlet page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/portlets/mytasks.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/portlets/mytasks.get.desc.xml

My Tasks Panel
GET /alfresco/service/ui/mytaskspanel?f={filter?}
---
Generate the Generate the inner panel for the My Tasks portlet page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/portlets/mytaskspanel.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/portlets/mytaskspanel.get.desc.xml

My Web Modified Files
GET /alfresco/service/ui/mywebfiles
---
Generate the My Web Modified Files portlet page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/portlets/mywebfiles.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/portlets/mywebfiles.get.desc.xml

My Web Forms
GET /alfresco/service/ui/mywebforms
---
Generate the My Web Forms portlet page
---
Authentication:user
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/portlets/mywebforms.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/portlets/mywebforms.get.desc.xml

Package: /org/alfresco/repository

Login
GET /alfresco/service/api/login?u={username}&pw={password?}
---
Login and establish a ticket.
Input
u
cleartext username (must be URL encoded)
pw
cleartext password (must be URL encoded)

Returns the new authentication ticket.
---
Authentication:none
Transaction:required
Format Style:any
Default Format:xml
Lifecycle:public_api
Id:org/alfresco/repository/login.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/login.get.desc.xml

Login (POST)
POST /alfresco/service/api/login
---
Login and establish a ticket.
Input
JSON Data Object.
username
cleartext username
password
cleartext password

Returns the new authentication ticket.
---
Authentication:none
Transaction:required
Format Style:any
Default Format:json
Lifecycle:public_api
Id:org/alfresco/repository/login.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/login.post.desc.xml

Logout
DELETE /alfresco/service/api/login/ticket/{ticket}
---
Logout, Delete Login Ticket.
After the user has logged out the ticket is no longer valid and subsequent attempts to use it will fail.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:xml
Lifecycle:public_api
Id:org/alfresco/repository/loginticket.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/loginticket.delete.desc.xml

Validate Login Ticket
GET /alfresco/service/api/login/ticket/{ticket}
---
Validates the specified ticket is still valid.
The ticket may be invalid, or expired, or the user may have been locked out.
For security reasons this script will not validate the ticket of another user.
  • If the ticket is valid retuns, STATUS_SUCCESS (200)
  • If the ticket is not valid return, STATUS_NOT_FOUND (404)
  • If the ticket does not belong to the current user, STATUS_NOT_FOUND (404)
---
Authentication:user
Transaction:required
Format Style:any
Default Format:xml
Lifecycle:public_api
Id:org/alfresco/repository/loginticket.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/loginticket.get.desc.xml

Repository AtomPub Service Document (getRepositoryInfo)
GET /alfresco/service/api/repository
GET /alfresco/service/api/cmis
---
This service is used to retrieve information about the CMIS repository and the capabilities it supports.

Outputs:

ID repositoryId: Repository Id (same as input)
String repositoryName: Repository name
URI repositoryURI: URI for this repository
String repositoryDescription: Description of this repository
ID rootFolderId: Root folder Id
String vendorName: Repository vendor name
String productName: Repository product name
String productVersion: Product Version Information
String cmisVersionsSupported: Version of CMIS standard supported.
XML repositorySpecificInformation: Repository-specific information

Capabilities:

boolean capabilityMultifiling
boolean capabilitiyUnfiling
Boolean capabilityVersionSpecificFiling
Boolean capabilityPWCUpdatable
Boolean capabilityAllVersionsSearchable
Boolean capabilityPWCSearchable
Enum capabilityJoin: nojoin, inneronly, innerAndouter
Enum capabilityFulltext: nofulltext, fulltextonly, fulltextandstructured
<Array> relatedRepositories
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atom
Id:org/alfresco/repository/repository.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/repository.get.desc.xml

Touch
GET /alfresco/service/touch
---
SSO authentication touch point - return a simple 200 OK status
---
Authentication:guest
Transaction:none
Format Style:argument
Default Format:Determined at run-time
Id:org/alfresco/repository/touch.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/touch.get.desc.xml

Package: /org/alfresco/repository/activities

Activity Type Template
GET /alfresco/service/api/activities/template/{path}
GET /alfresco/service/api/activities/template/{path}?format=text
---
Get the activity type template.
---
Authentication:admin
Transaction:required
Format Style:argument
Default Format:text
Id:org/alfresco/repository/activities/template.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/template.get.desc.xml

Activity Template Paths
GET /alfresco/service/api/activities/templates
GET /alfresco/service/api/activities/templates?format=json
GET /alfresco/service/api/activities/templates/{path}
GET /alfresco/service/api/activities/templates/{path}?format=json
---
Get a collection of the template paths.
---
Authentication:admin
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/activities/templates.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/templates.get.desc.xml

Package: /org/alfresco/repository/activities/feed

Activities Site Feed Web Script
GET /alfresco/service/api/activities/feed/site/{siteId}
GET /alfresco/service/api/activities/feed/site/{siteId}?format=atomfeed
GET /alfresco/service/api/activities/feed/site/{siteId}?format=json
GET /alfresco/service/api/activities/feed/site/{siteId}?format=rss
---
Allow currently logged in user to get feed for specified site (if private site then user must be a member or an admin user)
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:atomfeed
Id:org/alfresco/repository/activities/feed/sitefeed.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/sitefeed.get.desc.xml

Activities Admin User Feed Web Script
GET /alfresco/service/api/activities/feed/user/{userId}
GET /alfresco/service/api/activities/feed/user/{userId}?format=atomfeed
GET /alfresco/service/api/activities/feed/user/{userId}?format=json
GET /alfresco/service/api/activities/feed/user/{userId}?s={siteId}
GET /alfresco/service/api/activities/feed/user/{userId}?s={siteId}&format=atomfeed
GET /alfresco/service/api/activities/feed/user/{userId}?s={siteId}&format=json
GET /alfresco/service/api/activities/feed/user/{userId}?s={siteId?}&exclUser={false?}&exclOthers={false?}
GET /alfresco/service/api/activities/feed/user/{userId}?s={siteId?}&exclUser={false?}&exclOthers={false?}&format=atomfeed
GET /alfresco/service/api/activities/feed/user/{userId}?s={siteId?}&exclUser={false?}&exclOthers={false?}&format=json
---
Allow admin to get feed for a specified user
---
Authentication:admin
Transaction:required
Format Style:argument
Default Format:atomfeed
Id:org/alfresco/repository/activities/feed/userfeed-admin.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/userfeed-admin.get.desc.xml

Activities User Feed Web Script
GET /alfresco/service/api/activities/feed/user
GET /alfresco/service/api/activities/feed/user?format=atomfeed
GET /alfresco/service/api/activities/feed/user?format=json
GET /alfresco/service/api/activities/feed/user?s={siteId?}
GET /alfresco/service/api/activities/feed/user?s={siteId?}&format=atomfeed
GET /alfresco/service/api/activities/feed/user?s={siteId?}&format=json
GET /alfresco/service/api/activities/feed/user?s={siteId?}&exclUser={false?}&exclOthers={false?}
GET /alfresco/service/api/activities/feed/user?s={siteId?}&exclUser={false?}&exclOthers={false?}&format=atomfeed
GET /alfresco/service/api/activities/feed/user?s={siteId?}&exclUser={false?}&exclOthers={false?}&format=json
---
Allow currently logged in user to get their feed
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomfeed
Id:org/alfresco/repository/activities/feed/userfeed.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/userfeed.get.desc.xml

Package: /org/alfresco/repository/activities/feed/control

Activity User Feed Controls
DELETE /alfresco/service/api/activities/feed/control?s={siteId}&a={appToolId}
DELETE /alfresco/service/api/activities/feed/control?s={siteId}&a={appToolId}&format=json
---
Unset activity feed control (opt-out) for currently logged in user.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/activities/feed/control/userfeed-control.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/control/userfeed-control.delete.desc.xml

Activity User Feed Controls
POST /alfresco/service/api/activities/feed/control
POST /alfresco/service/api/activities/feed/control?format=json
---
Set activity feed control (opt-out) for currently logged in user.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/activities/feed/control/userfeed-control.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/control/userfeed-control.post.desc.xml

Activity User Feed Controls
GET /alfresco/service/api/activities/feed/controls
GET /alfresco/service/api/activities/feed/controls?format=json
---
Get the activity feed controls (opt-outs) for currently logged in user.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/activities/feed/control/userfeed-controls.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/control/userfeed-controls.get.desc.xml

Package: /org/alfresco/repository/blogs/blog

Blog
GET /alfresco/service/api/blog/site/{site}/{container}/{path}
GET /alfresco/service/api/blog/site/{site}/{container}
GET /alfresco/service/api/blog/node/{store_type}/{store_id}/{id}
---
Get the blog information
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/blog/blog.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/blog/blog.get.desc.xml

Blog
PUT /alfresco/service/api/blog/site/{site}/{container}/{path}
PUT /alfresco/service/api/blog/site/{site}/{container}
PUT /alfresco/service/api/blog/node/{store_type}/{store_id}/{id}
---
Updates a blog
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/blog/blog.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/blog/blog.put.desc.xml

Package: /org/alfresco/repository/blogs/post

Blog post publishing
POST /alfresco/service/api/blog/post/site/{site}/{container}/{path}/publishing
POST /alfresco/service/api/blog/post/node/{store_type}/{store_id}/{id}/publishing
---
Performs external blog publishing functions on a blog post
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/post/blog-post-publishing.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/post/blog-post-publishing.post.desc.xml

Blog post
DELETE /alfresco/service/api/blog/post/site/{site}/{container}/{path}
DELETE /alfresco/service/api/blog/post/node/{store_type}/{store_id}/{id}
---
Delete a blog post
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/post/blog-post.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/post/blog-post.delete.desc.xml

Blogs
GET /alfresco/service/api/blog/post/site/{site}/{container}/{path}
GET /alfresco/service/api/blog/post/node/{store_type}/{store_id}/{id}
---
Get all blogs
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/post/blog-post.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/post/blog-post.get.desc.xml

Blog post
PUT /alfresco/service/api/blog/post/site/{site}/{container}/{path}
PUT /alfresco/service/api/blog/post/node/{store_type}/{store_id}/{id}
---
Updates a blog post
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/post/blog-post.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/post/blog-post.put.desc.xml

Package: /org/alfresco/repository/blogs/posts

Blog posts
GET /alfresco/service/api/blog/site/{site}/{container}/{path}/posts/mydrafts
GET /alfresco/service/api/blog/site/{site}/{container}/posts/mydrafts
GET /alfresco/service/api/blog/node/{store_type}/{store_id}/{id}/posts/mydrafts
---
Get all posts for a blog
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/posts/blog-posts-mydrafts.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts-mydrafts.get.desc.xml

Blog posts
GET /alfresco/service/api/blog/site/{site}/{container}/{path}/posts/mypublished
GET /alfresco/service/api/blog/site/{site}/{container}/posts/mypublished
GET /alfresco/service/api/blog/node/{store_type}/{store_id}/{id}/posts/mypublished
---
Get all posts for a blog
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/posts/blog-posts-mypublished.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts-mypublished.get.desc.xml

Blog posts
GET /alfresco/service/api/blog/site/{site}/{container}/{path}/posts/new?numdays={numdays}
GET /alfresco/service/api/blog/site/{site}/{container}/posts/new?numdays={numdays}
GET /alfresco/service/api/blog/node/{store_type}/{store_id}/{id}/posts/new?numdays={numdays}
---
Get all posts for a blog
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/posts/blog-posts-new.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts-new.get.desc.xml

Blog posts per month
GET /alfresco/service/api/blog/site/{site}/{container}/{path}/postspermonth
GET /alfresco/service/api/blog/site/{site}/{container}/postspermonth
GET /alfresco/service/api/blog/node/{store_type}/{store_id}/{id}/postspermonth
---
Get all months for which there are blog posts plus the number of posts in each
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/posts/blog-posts-per-month.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts-per-month.get.desc.xml

Blog posts
GET /alfresco/service/api/blog/site/{site}/{container}/{path}/posts/publishedext
GET /alfresco/service/api/blog/site/{site}/{container}/posts/publishedext
GET /alfresco/service/api/blog/node/{store_type}/{store_id}/{id}/posts/publishedext
---
Get all posts for a blog
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/posts/blog-posts-publishedext.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts-publishedext.get.desc.xml

Blog posts
GET /alfresco/service/api/blog/site/{site}/{container}/{path}/posts
GET /alfresco/service/api/blog/site/{site}/{container}/posts
GET /alfresco/service/api/blog/node/{store_type}/{store_id}/{id}/posts
---
Get all posts for a blog
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/posts/blog-posts.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts.get.desc.xml

Blog posts
POST /alfresco/service/api/blog/site/{site}/{container}/{path}/posts
POST /alfresco/service/api/blog/site/{site}/{container}/posts
POST /alfresco/service/api/blog/node/{store_type}/{store_id}/{id}/posts
---
Creates a new blog post
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/blogs/posts/blog-posts.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts.post.desc.xml

Package: /org/alfresco/repository/comments

Comment
DELETE /alfresco/service/api/comment/node/{store_type}/{store_id}/{id}
---
Delete a comment
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/comments/comment.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/comments/comment.delete.desc.xml

Comment
GET /alfresco/service/api/comment/node/{store_type}/{store_id}/{id}
---
Get the data for a comment
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/comments/comment.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/comments/comment.get.desc.xml

Comment
PUT /alfresco/service/api/comment/node/{store_type}/{store_id}/{id}
---
Updates a comment
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/comments/comment.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/comments/comment.put.desc.xml

Comments
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/comments
---
Get all comments for a node
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/comments/comments.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/comments/comments.get.desc.xml

Comments
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/comments
---
Add a new comment to a node
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/comments/comments.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/comments/comments.post.desc.xml

Package: /org/alfresco/repository/dictionary

Get Association Definitions
GET /alfresco/service/api/classes/{classname}/association/{assocname}
---
Get the collection of association definitions
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/dictionary/getassociationdef.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getassociationdef.get.desc.xml

Get Association Definitions
GET /alfresco/service/api/classes/{classname}/associations?af={associationFilter?}&nsp={namespacePrefix?}&n={name?}
---
Get the collection of association definitions for a given classname
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/dictionary/getassociationdefs.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getassociationdefs.get.desc.xml

Get Child Association Definitions
GET /alfresco/service/api/classes/{classname}/childassociation/{assocname}
---
Get the collection of child association definitions
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/dictionary/getchildassoc.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getchildassoc.get.desc.xml

Get Child Assocation Definitions
GET /alfresco/service/api/classes/{classname}/childassociations
---
Get the collection of child association definitions for a given classname
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/dictionary/getchildassocs.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getchildassocs.get.desc.xml

Get Class Definitions
GET /alfresco/service/api/classes?cf={classFilter?}&nsp={namespacePrefix?}&n={name?}
---
Get the collection of class definitions - parameters classfilter , namespaceprefix and name
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/dictionary/getclassdetail.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getclassdetail.get.desc.xml

Get Class Definitions
GET /alfresco/service/api/classes/{className}
---
Get the collection of class definitions for a given classname
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/dictionary/getclassdetails.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getclassdetails.get.desc.xml

Get Property Definitions
GET /alfresco/service/api/classes/{classname}/properties?nsp={namespacePrefix?}&n={name?}
---
Get the collection of property definitions
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/dictionary/getproperties.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getproperties.get.desc.xml

Get Property Definitions
GET /alfresco/service/api/classes/{classname}/property/{propname}
---
Get the collection of property definitions for a given classname and property name
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/dictionary/getproperty.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getproperty.get.desc.xml

Get Sub Class Definitions
GET /alfresco/service/api/classes/{classname}/subclasses?r={recursive?}&nsp={namespacePrefix?}&n={name?}
---
Get the collection of sub classes definitions - parameters r=> recursive, classfilter , namespaceprefix and name
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/dictionary/getsubclassesdef.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getsubclassesdef.get.desc.xml

Package: /org/alfresco/repository/discussions/forum

Forum posts
GET /alfresco/service/api/forum/site/{site}/{container}/{path}/posts/hot
GET /alfresco/service/api/forum/site/{site}/{container}/posts/hot
GET /alfresco/service/api/forum/node/{store_type}/{store_id}/{id}/posts/hot
---
Get the new forum posts
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/discussions/forum/forum-posts-hot.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/forum/forum-posts-hot.get.desc.xml

Forum my posts
GET /alfresco/service/api/forum/site/{site}/{container}/{path}/posts/myposts
GET /alfresco/service/api/forum/site/{site}/{container}/posts/myposts
GET /alfresco/service/api/forum/node/{store_type}/{store_id}/{id}/posts/myposts
---
Get the forum posts created by the current user
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/discussions/forum/forum-posts-mine.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/forum/forum-posts-mine.get.desc.xml

Forum posts
GET /alfresco/service/api/forum/site/{site}/{container}/{path}/posts/new?numdays={numdays}
GET /alfresco/service/api/forum/site/{site}/{container}/posts/new?numdays={numdays}
GET /alfresco/service/api/forum/node/{store_type}/{store_id}/{id}/posts/new?numdays={numdays}
---
Get the new forum posts
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/discussions/forum/forum-posts-new.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/forum/forum-posts-new.get.desc.xml

Forum posts
GET /alfresco/service/api/forum/site/{site}/{container}/{path}/posts
GET /alfresco/service/api/forum/site/{site}/{container}/posts
GET /alfresco/service/api/forum/node/{store_type}/{store_id}/{id}/posts
---
Get the forum posts
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/discussions/forum/forum-posts.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/forum/forum-posts.get.desc.xml

Forum posts
POST /alfresco/service/api/forum/site/{site}/{container}/{path}/posts
POST /alfresco/service/api/forum/site/{site}/{container}/posts
POST /alfresco/service/api/forum/node/{store_type}/{store_id}/{id}/posts
---
Adds a post to a forum
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/discussions/forum/forum-posts.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/forum/forum-posts.post.desc.xml

Package: /org/alfresco/repository/discussions/posts

Forum post replies
GET /alfresco/service/api/forum/post/site/{site}/{container}/{path}/replies
GET /alfresco/service/api/forum/post/node/{store_type}/{store_id}/{id}/replies
---
Get the forum posts
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/discussions/posts/forum-post-replies.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/posts/forum-post-replies.get.desc.xml

Forum post replies
POST /alfresco/service/api/forum/post/node/{store_type}/{store_id}/{id}/replies
---
Adds a reply to a post
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/discussions/posts/forum-post-replies.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/posts/forum-post-replies.post.desc.xml

Topic
DELETE /alfresco/service/api/forum/post/site/{site}/{container}/{path}
DELETE /alfresco/service/api/forum/post/node/{store_type}/{store_id}/{id}
---
Delete a topic
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/discussions/posts/forum-post.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/posts/forum-post.delete.desc.xml

Topic
GET /alfresco/service/api/forum/post/site/{site}/{container}/{path}
GET /alfresco/service/api/forum/post/node/{store_type}/{store_id}/{id}
---
Get the details for a topic
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/discussions/posts/forum-post.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/posts/forum-post.get.desc.xml

Topic
PUT /alfresco/service/api/forum/post/site/{site}/{container}/{path}
PUT /alfresco/service/api/forum/post/node/{store_type}/{store_id}/{id}
---
Update a topic
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/discussions/posts/forum-post.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/posts/forum-post.put.desc.xml

Package: /org/alfresco/repository/forms

Form Persistence
POST /alfresco/service/api/{item_kind}/{item_id}/formprocessor
---
Handles the submission of a form, data can be POSTed as JSON, multipart/form-data or x-www-form-urlencoded
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:internal
Id:org/alfresco/repository/forms/form.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.desc.xml

Form Definitions
POST /alfresco/service/api/formdefinitions
---
Returns a form definition for the requested item.
The body of the post should be in the form
{
   "itemKind" : item kind,
   "itemId" : item id,
   "fields" : [fields],
   "force" : [force]
}
Returns the form model.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:internal
Id:org/alfresco/repository/forms/formdefinition.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/forms/formdefinition.post.desc.xml

PickerList
GET /alfresco/service/api/forms/picker/{type}/{store_type}/{store_id}/{id}/children
---
Service to return metadata of child items in a parent space to display in the object finder
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/forms/pickerchildren.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/forms/pickerchildren.get.desc.xml

PickerItems
POST /alfresco/service/api/forms/picker/items
---
Service to return metadata of multiple items to display in the object finder
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/forms/pickeritems.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/forms/pickeritems.post.desc.xml

Package: /org/alfresco/repository/groups

Remove an authority from a group.
DELETE /alfresco/service/api/groups/{shortGroupName}/children/{fullAuthorityName}
---
Remove an authority (USER or GROUP) from a group. A user will not be deleted by this method.
You must have "administrator" privileges to alter a group.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/children.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/children.delete.desc.xml

Get the list of child authorities for a group.
GET /alfresco/service/api/groups/{shortName}/children?authorityType={authorityType?}
---
Get a list of the child authorities of a group. This contains both people and groups.
The authorityType parameter can be used to specify to return authorities of the given type. Valid values are GROUP and USER.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/children.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/children.get.desc.xml

Add group or user to a group
POST /alfresco/service/api/groups/{shortName}/children/{fullAuthorityName}
---
Add a group or user to a group. Will create a sub group if one does not already exist with the fullAuthorityName.
You must have "administrator" privileges to modify groups.
If the authority is for a group and doe not exist then it is created.
Returns Status_Created if a new group is created, else Status_OK. If Status_Created returns the new sub group, else returns the group.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/children.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/children.post.desc.xml

Get the details of a group
GET /alfresco/service/api/groups/{shortName}
---
Get the details of a group.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/group.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/group.get.desc.xml

Update the details of a group
PUT /alfresco/service/api/groups/{shortName}
---
Update the details of a group.
you must have "administrator" privileges to change the name of a group.
The following properties may be updated.
displayName
The display name
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/group.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/group.put.desc.xml

Delete a group.
DELETE /alfresco/service/api/groups/{shortName}
---
Delete a group and all its dependents.
You must have "administrator" privileges to delete a group.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/groups.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/groups.delete.desc.xml

List groups
GET /alfresco/service/api/groups?shortNameFilter={shortNameFilter?}&zone={zone?}
---
Search for groups.
Parameters
  • If the optional shortNameFilter parameter is set then returns those groups with a partial match on shortName. You can use the pattern matching characters * to match zero or more characters or ? to match one character.
  • If the optional zone parameter is set then only returns groups with are in the specified zone, else returns groups from all zones.

Returns an Array of groups in JSON format.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/groups.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/groups.get.desc.xml

Get the list of child authorities for a group.
GET /alfresco/service/api/groups/{shortName}/parents?level={level?}
---
Get a list of the parent authorities of a group.
The optional level attribute can be "ALL" in which case all parents are returned.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/parent.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/parent.get.desc.xml

Delete a root group.
DELETE /alfresco/service/api/rootgroups/{shortName}
---
Delete a root group and all its dependents.
You must have "administrator" privileges to delete a group.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/rootgroups.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/rootgroups.delete.desc.xml

List all root groups
GET /alfresco/service/api/rootgroups?shortNameFilter={shortNameFilter?}&zone={zone?}
---
List all root groups.
If the optional zone parameter is set to 'true' then returns root groups from the specified zone. If not specified will return groups from all zones.
If the optional shortNameFilter parameter is set then returns those root groups with a partial match on shortName. The shortname filter can contain the wild card characters * and ? but these must be url encoded for this script.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/rootgroups.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/rootgroups.get.desc.xml

Add a rootgroup
POST /alfresco/service/api/rootgroups/{shortName}
---
Add a root group.
You must have "administrator" privileges to add a root group.
Returns STATUS_CREATED if a new group is created.
If the group already exists returns BAD_REQUEST. The following properties may be specified for the new root group.
displayName
The display name
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/groups/rootgroups.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/groups/rootgroups.post.desc.xml

Package: /org/alfresco/repository/imap

IMAP Server Status
GET /alfresco/service/imap/servstatus
---
This script return status of IMAP server (enabled/diabled)
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/repository/imap/imap-enabled.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/imap/imap-enabled.get.desc.xml

IMAP Workflow Handler
GET /alfresco/service/imap/start-workflow?alfTicket={ticket}&nodeRefId={id}&workflowType={wt}&assignTo={at}&workflowDueDateDay={ddd}&workflowDueDateMonth={ddm}&workflowDueDateYear={ddy}&description={desc}
---
This webscript starts a different workflows. It have used in the IMAP email body links. (The optional feature is the reply email with a report.)
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/repository/imap/start-workflow.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/imap/start-workflow.get.desc.xml

Package: /org/alfresco/repository/invitation

List Invitations
GET /alfresco/service/api/invitations?inviteeUserName={inviteeUserName?}&invitationType={invitationType?}&resourceType={resourceType?}
---
Get a collecton of a invitations.
With no parameters, returns all open invitations (which could be a large number).
With inviteeUserName, returns all open invitations for this invitee.
With invitationType, returns invitations of the specified type (Either NOMINATED or MODERATED).
With resourceType, returns invitations of the specified type (WEB_SITE only at the moment).
Returns a JSON array of Invitations.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/invitation/invitations.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/invitation/invitations.get.desc.xml

Package: /org/alfresco/repository/invite

Invite by ticket
GET /alfresco/service/api/invite/{inviteId}/{inviteTicket}
GET /alfresco/service/api/invite/{inviteId}/{inviteTicket}?inviteeUserName={inviteeUserName?}
---
Returns invite information for a given inviteId and inviteTicket. No authentication is required
---
Authentication:none
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/invite/invite-by-ticket.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/invite/invite-by-ticket.get.desc.xml

Invite
GET /alfresco/service/api/invite/start?inviteeFirstName={inviteeFirstName}&inviteeLastName={inviteeLastName}&inviteeEmail={inviteeEmailAddress}&inviteeUserName={inviteeUserName?}&siteShortName={siteShortName}&inviteeSiteRole={inviteeSiteRole}&serverPath={serverPath}&acceptUrl={acceptUrl}&rejectUrl={rejectUrl}
GET /alfresco/service/api/invite/cancel?inviteId={inviteId}
---
Processes Inviter actions ('start' or 'cancel' invite)
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:deprecated
Id:org/alfresco/repository/invite/invite.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/invite/invite.get.desc.xml

Invite accept
PUT /alfresco/service/api/invite/{inviteId}/{inviteTicket}/{action}
---
Accepts an invite
---
Authentication:none
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/invite/inviteresponse.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/invite/inviteresponse.put.desc.xml

Invites
GET /alfresco/service/api/invites?inviterUserName={inviterUserName?}&inviteeUserName={inviteeUserName?}&siteShortName={siteShortName?}
GET /alfresco/service/api/invites?inviteId={inviteId}
---
Returns pending invites filtered by Inviter user name, Invitee user name & Site short name
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:deprecated
Id:org/alfresco/repository/invite/invites.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/invite/invites.get.desc.xml

Package: /org/alfresco/repository/links

Link delete
POST /alfresco/service/api/links/delete/site/{site}/{container}
---
Delete a link
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/links/links-delete.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/links/links-delete.post.desc.xml

Links
GET /alfresco/service/api/links/site/{site}/{container}
---
Get all links
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/links/links.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/links/links.get.desc.xml

post
POST /alfresco/service/api/links/site/{site}/{container}/posts
---
post
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/links/links.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/links/links.post.desc.xml

Link update
PUT /alfresco/service/api/links/site/{site}/{container}/{path}
---
Updates a link
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/links/links.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/links/links.put.desc.xml

Package: /org/alfresco/repository/links/link

Links
GET /alfresco/service/api/links/link/site/{site}/{container}/{path}
---
Get all links
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/links/link/link.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/links/link/link.get.desc.xml

Package: /org/alfresco/repository/metadata

Node Metadata Retrieval Service
GET /alfresco/service/api/metadata
---
Node Metadata Retrieval Service
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/metadata/metadata.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/metadata/metadata.get.desc.xml

Node Metadata Storage Service
POST /alfresco/service/api/metadata/node/{store_type}/{store_id}/{id}
---
Node Metadata Storage Service
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/metadata/metadata.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/metadata/metadata.post.desc.xml

Package: /org/alfresco/repository/person

Update User Password
POST /alfresco/service/api/person/changepassword/{userName}
---
Update the password of a current user - can only be executed for the current user or by an admin to update any user.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/person/changepassword.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/person/changepassword.post.desc.xml

Get People
GET /alfresco/service/api/people?filter={filterQuery?}
---
Get collection of people stored in the repository. This can optionally be filtered according to some given filter query string
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/person/people.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/person/people.get.desc.xml

Add Person
POST /alfresco/service/api/people
---
Adds a new person based on the details provided.
userName
mandatory - the user name for the new user
firstName
mandatory - the given Name
lastName
mandatory - the family name
email
mandatory - the email address
password
optional - the new user's password. If not specified then a value of "password" is used which should be changed as soon as possible.
---
Authentication:admin
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/person/people.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/person/people.post.desc.xml

Delete Person
DELETE /alfresco/service/api/people/{userName}
---
Delete a person.
---
Authentication:admin
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/person/person.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/person/person.delete.desc.xml

Get Person
GET /alfresco/service/api/people/{userName}
---
Get the details of a person.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/person/person.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/person/person.get.desc.xml

Update Person
PUT /alfresco/service/api/people/{userName}
---
Update the details of a person.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/person/person.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/person/person.put.desc.xml

Sites
GET /alfresco/service/api/people/{userid}/sites?size={pagesize?}&pos={position?}
---
Get a colleciton of the sites a person has an explicit member to.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/person/person.sites.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/person/person.sites.get.desc.xml

Package: /org/alfresco/repository/preference

Preferences
DELETE /alfresco/service/api/people/{userid}/preferences?pf={preferencefilter?}
---
Delete a users preferences
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/preference/preferences.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/preference/preferences.delete.desc.xml

Preferences
GET /alfresco/service/api/people/{userid}/preferences?pf={preferencefilter?}
---
Get the preferences for a user
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/preference/preferences.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/preference/preferences.get.desc.xml

Preferences
POST /alfresco/service/api/people/{userid}/preferences
---
Set a users preferences
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/preference/preferences.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/preference/preferences.post.desc.xml

Package: /org/alfresco/repository/rule

Get Action Definition
GET /alfresco/service/api/rules/actiondefs/{actionDefinitionName}
---
Get an action definition given its name
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/actiondef.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/actiondef.get.desc.xml

Get Action Definitions
GET /alfresco/service/api/rules/actiondefs
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/actiondefs
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/actiondefs
---
Get the collection of action definitions, optionally scoped by node reference or path
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/actiondefs.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/actiondefs.get.desc.xml

Add to Action Queue
POST /alfresco/service/api/actionqueue
---
Add an Action Queue Item to the Action Queue for execution
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/actionqueue.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/actionqueue.post.desc.xml

Get Condition Definition
GET /alfresco/service/api/rules/conditiondefs/{conditionDefinitionName}
---
Get a condition definition given its name
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/conditiondef.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/conditiondef.get.desc.xml

Get Condition Definitions
GET /alfresco/service/api/rules/conditiondefs
---
Get the collection of condition definitions
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/conditiondefs.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/conditiondefs.get.desc.xml

Delete Rule
DELETE /alfresco/service/api/rules/{store_type}/{store_id}/{rule_id}
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}/rules/{rule_id}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{id}/rules/{rule_id}
---
Delete the rule identified by the specified rule node id.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/rule.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rule.delete.desc.xml

Get Rule
GET /alfresco/service/api/rules/{store_type}/{store_id}/{rule_id}
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/rules/{rule_id}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/rules/{rule_id}
---
Get the rule identified by the specified rule node reference.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/rule.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rule.get.desc.xml

Put Rule
PUT /alfresco/service/api/rules/{store_type}/{store_id}/{rule_id}
PUT /alfresco/service/api/node/{store_type}/{store_id}/{id}/rules/{rule_id}
PUT /alfresco/service/api/path/{store_type}/{store_id}/{id}/rules/{rule_id}
---
Update the rule identified by the specified rule node reference.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/rule.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rule.put.desc.xml

Delete Rules
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}/rules
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{id}/rules
DELETE /alfresco/service/api/rules/appliedtonode/{store_type}/{store_id}/{id}
---
Delete the collection of rules which have been applied to the given rule owning node node.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/rules.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rules.delete.desc.xml

Get Rules
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/rules?includeInherited={includeInherited?}&ruleTypeName={ruleTypeName?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/rules?includeInherited={includeInherited?}&ruleTypeName={ruleTypeName?}
GET /alfresco/service/api/rules/appliedtonode/{store_type}/{store_id}/{id}?includeInherited={includeInherited?}&ruleTypeName={ruleTypeName?}
---
Get the collection of rules which have been applied to the given (actionable) node. If the optional 'includeInherited' parameter is not provided, then rules inherited from the given node's parents are included by default. If the optional 'ruleTypeName' parameter is provided, then only rules of that specific given rule type are returned
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/rules.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rules.get.desc.xml

Create Rule
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/rules
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/rules
POST /alfresco/service/api/rules/appliedtonode/{store_type}/{store_id}/{id}
---
Creates a rule in the rule collection associated with the given actionable node
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/rule/rules.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rules.post.desc.xml

Package: /org/alfresco/repository/search

Alfresco Keyword Search (OpenSearch Enabled)
GET /alfresco/service/api/search/keyword.html?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/search/keyword.html?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/api/search/keyword.atom?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/search/keyword.atom?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/api/search/keyword.rss?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/search/keyword.rss?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/api/search/keyword.portlet?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
---
Execute Keyword Search against Alfresco Repository (Company Home and below)
---
Authentication:guest
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/repository/search/keywordsearch.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/search/keywordsearch.get.desc.xml

Keyword Search Description
GET /alfresco/service/api/search/keyword/description.xml
GET /alfresco/service/search/keyword/description.xml
---
OpenSearch description document for Alfresco Repository keyword search
---
Authentication:none
Transaction:none
Format Style:argument
Default Format:opensearchdescription
Id:org/alfresco/repository/search/keywordsearchdescription.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/search/keywordsearchdescription.get.desc.xml

Alfresco Person Search (OpenSearch Enabled)
GET /alfresco/service/api/search/person.html?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/search/person.html?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/api/search/person.atom?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/search/person.atom?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/api/search/person.rss?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/search/person.rss?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
GET /alfresco/service/api/search/person.portlet?q={searchTerms}&p={startPage?}&c={count?}&l={language?}
---
Execute Person Search against Alfresco Repository
---
Authentication:guest
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/repository/search/personsearch.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/search/personsearch.get.desc.xml

Person Search Description
GET /alfresco/service/api/search/person/description.xml
GET /alfresco/service/search/person/description.xml
---
OpenSearch description document for Alfresco Repository person search
---
Authentication:none
Transaction:none
Format Style:argument
Default Format:opensearchdescription
Id:org/alfresco/repository/search/personsearchdescription.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/search/personsearchdescription.get.desc.xml

Issue ad-hoc query (query)
POST /alfresco/service/api/query
---
Queries the repository for queryable object based on properties or an optional full-text string. Relationship objects are not queryable. Content-streams are not returned as part of query.

Inputs:

String statement: Query statement
(Optional) Bool searchAllVersions: False (Default)
(Optional) Boolean includeAllowableActions: False (default)
(Optional) Enum includeRelationships: none (default), source, target, both
(Optional) int maxItems: 0 = Repository-default number of items (Default)
(Optional) int skipCount: 0 = Start at first position (Default)

Outputs:

Collection objectCollection - this collection represents a result table produced by the query statement. Typically each row of this table corresponds to an object, and each column corresponds to a property or a computed value as specified by the SELECT clause of the query statement. A CMIS SQL 1.0 query without JOIN always produces one object per row.
Bool hasMoreItems

Notes:

If SearchAllVersions is True, and CONTAINS() is used in the query, OperationNotSupported will be thrown if full-text search is not supported or if the repository does not have previous versions in the full-text index.
Returns set of objects from (skipCount, maxItems+skipCount)
If no “maxItems” value is provided, then the Repository will determine an appropriate number of items to return. How the Repository determines this value is repository-specific and opaque to CMIS.
If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for each result object in the output table as an additional multi-valued column containing computed values of type string, provided that each row in the output table indeed corresponds to one object (which is true for a CMIS SQL 1.0 query without JOIN).
If each row in the output table does not correspond to a specific object and “includeAllowableActions” is TRUE, then InvalidArgumentException will be thrown.
It is recommended that “includeAllowableActions” be used with query statements without JOIN, and that the Object ID property or “*” be included in the SELECT list.
"IncludeRelationships" indicates whether relationships are also returned for each returned object. If it is set to "source" or "target", relationships for which the returned object is a source, or respectively a target, will also be returned. If it is set to "both", relationships for which the returned object is either a source or a target will be returned. If it is set to "none", relationships are not returned.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomfeed
Id:org/alfresco/repository/search/query.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/search/query.post.desc.xml

Search Engines
GET /alfresco/service/api/search/engines?type={type?}
GET /alfresco/service/search/engines?type={type?}
GET /alfresco/service/api/search/engines.atom?type={type?}
GET /alfresco/service/search/engines.atom?type={type?}
---
Lists "search engines" registered with this Alfresco Repository
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Id:org/alfresco/repository/search/searchengines.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/search/searchengines.get.desc.xml

Proxied (OpenSearch) Search
GET /alfresco/service/api/search/engine/{engine}/{format}
GET /alfresco/service/search/engine/{engine}/{format}
---
Search engine proxy for issuing a search against a remote search engine
---
Authentication:none
Transaction:none
Format Style:any
Default Format:Determined at run-time
Id:org/alfresco/repository/search/searchproxy.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/search/searchproxy.get.desc.xml

Package: /org/alfresco/repository/site

Site
DELETE /alfresco/service/api/sites/{shortname}
---
Delete the details of a site.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/site/site.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.delete.desc.xml

Get Web Site
GET /alfresco/service/api/sites/{shortname}
---
Get the details of a web site. Returns 200, STATUS_OK on success.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/site.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.get.desc.xml

Update Web Site
PUT /alfresco/service/api/sites/{shortname}
---
Update the details of a site. The following properties may be updated.
title
the title of the web site
description
the description for the web site
visibility
the site visibility, one of (PUBLIC,MODERATED,PRIVATE)
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/site.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.put.desc.xml

Sites
GET /alfresco/service/api/sites?nf={namefilter?}&spf={sitepresetfilter?}&size={pagesize?}&pos={position?}
---
Get a colleciton of the sites in the repository. The collection can be filtered by name and/or site preset.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/site/sites.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/sites.get.desc.xml

Create Web Site
POST /alfresco/service/api/sites
---
Creates a new site based on the site preset and details provided.
The following properties may be set.
shortName
the shortName of the web site, mandatory, must be unique
sitePreset
the sitePreset
title
the title of the web site
description
the description for the web site
visibility
the site visibility, one of (PUBLIC,MODERATED,PRIVATE), defaults to PUBLIC
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/sites.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/sites.post.desc.xml

SitesQuery
POST /alfresco/service/api/sites/query
---
Queries the collection of sites.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/site/sites.query.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/sites.query.post.desc.xml

Package: /org/alfresco/repository/site/invitation

Cancel invitation
DELETE /alfresco/service/api/sites/{shortname}/invitations/{invitationId}
---
Cancel an open invitation.
Canceling an invitation immediatly stops the invitation, it is different to rejecting an invitation which will result in the invitation workflow continuing to a normal but rejected conclusion. In particular the approver or invitee are not notified if an invitation is canceled.
Only a site manager may cancel an nominated invitation.
A site manager or the invitee may cancel a moderated invitation.
Returns 200, STATUS_OK on success.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/invitation/invitation.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/invitation/invitation.delete.desc.xml

Get Invitation
GET /alfresco/service/api/sites/{shortname}/invitations/{inviteId}
---
Get a single web site invitation.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/invitation/invitation.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/invitation/invitation.get.desc.xml

Create invitation for web site
POST /alfresco/service/api/sites/{shortname}/invitations
---
Create a new invitation for this web site.
For a Nominated Invitation, where an existing site member nominates someone else who is possibly not yet an alfresco user to become a member of this web site.
For an existing user, the invitee is identified by inviteeUserName. For a user who does not have a userName a new account will be generated based upon inviteeFirstName, inviteeLastName and inviteeEmail
if inviteeUserName is specified then inviteeFirstName, inviteeLastName and inviteeEmail are ignored.
invitationType
mandatory - "NOMINATED"
inviteeFirstName
optional,
inviteeLastName
optional,
inviteeEmail
optional,
inviteeUserName
optional
serverPath
acceptURL
rejectURL
inviteeRoleName
mandatory what role to be given on this web site

For a Moderated Invitation, where an existing user wants to be made a member of a moderated web site.
invitationType
mandatory - "MODERATED"
inviteeUserName
optional who wants to be invited to this web site?
inviteeComments
mandatory (but can be blank) why do they want membership to this site ?
inviteeRoleName
mandatory what role to be given on this web site

Returns HTTPStatus.Created (201) if an invitation is created.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/invitation/invitation.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/invitation/invitation.post.desc.xml

List Invitations
GET /alfresco/service/api/sites/{shortname}/invitations?inviteeUserName={inviteeUserName?}&invitationType={invitationType?}
---
Get a collecton of a site web invitations.
With no parameters, returns all open invitations for this web site.
With inviteeUserName, returns all open invitations for this web site and invitee.
With invitationType, returns all open invitations of the specified type (Either NOMINATED or MODERATED).
Returns a JSON element
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/invitation/invitations.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/invitation/invitations.get.desc.xml

Package: /org/alfresco/repository/site/membership

Delete Web Site Membership
DELETE /alfresco/service/api/sites/{shortname}/memberships/{authorityname}
---
Delete membership from a web site.
'shortname' is the shortname of the web site, 'authorityname' is the full authority name for the membership.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/membership.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/membership.delete.desc.xml

Get Web Site Membership
GET /alfresco/service/api/sites/{shortname}/memberships/{authorityname}
---
Get the membership details for a user or group
'shortname' is the shortname of the web site, 'authorityname' is the full authority name for the membership.
Returns a membership or Status.NOT_FOUND(404)
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/membership.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/membership.get.desc.xml

Update Web Site Membership
PUT /alfresco/service/api/sites/{shortname}/memberships/{authorityname}
---
Update the membership role for a user or group
'shortname' is the shortname of the web site, 'authorityname' is the full authority name for the membership.
Required parameters,
role, mandatory String, the new role name for this membership.
person object, with userName property
OR group object, with fullName property
OR authority object, with fullName property
Returns: The new authority.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/membership.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/membership.put.desc.xml

List Web Site Memberships
GET /alfresco/service/api/sites/{shortname}/memberships?nf={namefilter?}&rf={rolefilter?}&size={pagesize?}&pos={position?}&authorityType={authorityType?}
---
Get a colleciton of a Web Site memberships.
'shortname' is the shortname of the web site
Parameters:
  • nf, Optional, namefilter
  • rf, Optional, rolefilter
  • size, Optional, page size
  • authorityType, Optional, returns either GROUP or USER authorities. If not specified returns all authorities.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/memberships.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/memberships.get.desc.xml

Add Web Site Membership
POST /alfresco/service/api/sites/{shortname}/memberships
---
Adds a new membership to the web site
'shortname' is the shortname of the web site, 'authorityname' is the full authority name for the membership. Required parameters,
role, mandatory String, the new role name for this membership.
person object, with userName property
OR group object, with fullName property
OR authority object, with fullName property
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/memberships.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/memberships.post.desc.xml

List Potential Web Site Memberss
GET /alfresco/service/api/sites/{shortname}/potentialmembers?filter={filter?}&maxResults={maxResults?}&authorityType={authorityType?}
---
Get a colleciton of People and/or Groups who are not yet Site members.
'shortname' is the shortname of the web site
Parameters:
  • filter, Optional, filter
  • maxResults, Optional, maximum resultset to return
  • authorityType, Optional, returns either GROUP or USER authorities. If not specified returns all authorities.
  • zone, Optional, specifies group zone if including groups in query.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/site/membership/potentialmembers.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/potentialmembers.get.desc.xml

Package: /org/alfresco/repository/site/roles

Roles
GET /alfresco/service/api/sites/{shortname}/roles
---
Get the authority roles of a site.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/repository/site/roles/roles.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/roles/roles.get.desc.xml

Package: /org/alfresco/repository/store

Retrieve Allowable Actions
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/permissions
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/permissions
---
Retrieve Allowable Actions
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:cmisallowableactions
Id:org/alfresco/repository/store/allowableactions.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/allowableactions.get.desc.xml

Checked-out Documents (getCheckedoutDocuments)
GET /alfresco/service/api/checkedout?folderId={folderId?}&includeDescendants={includeDescendants?}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
---
Gets the list of documents that are checked out that the user has access to. Most likely this will be the set of documents checked out by the user. Content-streams are not returned.

Inputs:

(Optional) ID folderId
(Optional) String filter specifying which properties to return.
(Optional) Boolean includeAllowableActions: False (default)
(Optional) Enum includeRelationships: none (default), source, target, both
(Optional) int maxItems: 0 = Repository-default number of items (Default)
(Optional) int skipCount: 0 (Default)

Outputs:

Result set specified by Filter
Bool hasMoreItems

Notes:

The documents will be returned in a repository-specific order.
The repository may include checked-out objects that the calling user has access to, but did not check out.
If folderId is specified, then the results MUST include only the children of that folder, NOT other descendants of the folder nor documents outside this tree.
If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for each document as part of the output.
"IncludeRelationships" indicates whether relationships are also returned for each returned object. If it is set to "source" or "target", relationships for which the returned object is a source, or respectively a target, will also be returned. If it is set to "both", relationships for which the returned object is either a source or a target will be returned. If it is set to "none", relationships are not returned.
If no “maxItems” value is provided, then the Repository will determine an appropriate number of items to return. How the Repository determines this value is repository-specific and opaque to CMIS.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomfeed
Id:org/alfresco/repository/store/checkedout.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/checkedout.get.desc.xml

Checkout a document (checkOut)
POST /alfresco/service/api/checkedout
---
Create a private working copy of the object, copies the metadata and optionally content. It is up to the repository to determine if updates to the current version (not PWC) and prior versions are allowed if checked-out.

Inputs:

ID documentId: ObjectID of Doc Version to checkout

Outputs:

ID documentId: ObjectID of Private Working Copy
Bool contentCopied

Notes:

It is repository-specific to determine the scope of visibility to the private working copy.
Other users not in the scope of checkout will see the public (pre-checkout) version while those in scope will be able to work on the checked-out version.
Copying content on checkout or not is repository-specific.
CheckOut() may remove update permission on prior versions.
CheckOut() on a non-document object will throw OperationNotSupportedException.
Some repositories may not support updating of private working copies and the updates MUST be supplied via checkIn().
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomentry
Id:org/alfresco/repository/store/checkedout.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/checkedout.post.desc.xml

Retrieve list of children (getChildren)
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/children?types={types}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/children?types={types}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
---
Gets the list of child objects contained in the specified folder. Only the filter-selected properties associated with each object are returned. The content-streams of documents are not returned.

For paging through the children (depth of 1) only use getChildren. For returning a tree of objects of a certain depth, use getDescendants.

For a repository that supports version-specific filing, this will return the version of the documents in the folder specified by the user filing the documents into the folder. Otherwise, the latest version of the documents will be returned.

Inputs:

ID folderId
(Optional) Enum type: Documents, Folders, Policies, Any (default)
(Optional) String filter: Filter specifying which properties to return.
(Optional) Boolean includeAllowableActions: False (default)
(Optional) Enum includeRelationships: none (default), source, target, both
(Optional) int maxItems: 0 = Repository-default number of items (Default)
(Optional) int skipCount: 0 = start (Default)
(Optional) String orderBy: must be a valid ORDER BY clause from the query grammer excluding ‘ORDER BY’. Example ‘name DESC’.

Outputs:

Result set specified by Filter of each child object in the specified folder
If maxItems > 0, Bool hasMoreItems

Notes:

Between invocations the order of the results may change due to repository state changing, i.e. skipCount might not show objects or more likely show an object twice (bottom of first page and top of second) when an object is added to the top of the list.
Ordering is repository-specific except the ordering MUST remain consistent across invocations, provided that the repository state has not changed.
When returning the results of a call where the caller specified “Any” type, the repository SHOULD return all folder objects first followed by other objects.
If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for each child object as part of the output.
"IncludeRelationships" indicates whether relationships are also returned for each returned object. If it is set to "source" or "target", relationships for which the returned object is a source, or respectively a target, will also be returned. If it is set to "both", relationships for which the returned object is either a source or a target will be returned. If it is set to "none", relationships are not returned.
If no “maxItems” value is provided, then the Repository will determine an appropriate number of items to return. How the Repository determines this value is repository-specific and opaque to CMIS.
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:atomfeed
Id:org/alfresco/repository/store/children.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/children.get.desc.xml

Create folder or document (createDocument, createFolder)
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/children
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/children
---
Creates a document object of the specified type, and optionally adds the document to a folder

Inputs:

ID typeId: Document type
Collection properties
(Optional) ID folderId: Parent folder for this new document
(Optional) ContentStream contentStream
(Optional) Enum versioningState: CheckedOut, CheckedInMinor, CheckedInMajor (Default)

Outputs:

ID objectId: Id of the created document object

The versioningState input is used to create a document in a checked-out state, or as a checked-in minor version, or as a checked-in major version. If created in a checked-out state, the object is a PWC and there is no corresponding "checked out document". (See the "Versioning" section.)
If the Document’s Object Type does not allow content-stream and a content-stream is provided, or if content-stream is required and a content-stream is not provided, throw ConstraintViolationException.
If a Folder is specified, and the Document’s Object Type is not one of the “Allowed_Child_Object_Types” for this Folder, throw ConstraintViolationException.
If unfiling is not supported and a Folder is not specified, throw FolderNotValidException.
Repositories MAY reject the createDocument request (by throwing ConstaintViolationException) if any of the Required properties specified in the Document’s Object Type are not set.
However, iF the repository does NOT reject the createDocument request in this case, the repository MUST leave the newly-created Document in a checked-out state, and MUST ensure that all required properties are set before the Document is checked in.


Creates a folder object of the specified type

Inputs:

ID typeId: Folder type
Collection properties
ID folderId: Parent folder for this new folder

Outputs:

ID objectId: Id of the created folder object

Notes:
If the to-be-created Folder’s Object Type is not one of the “Allowed_Child_Object_Types” for the parent Folder, throw ConstraintViolationException.
Root folder can not be created using this service.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomentry
Id:org/alfresco/repository/store/children.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/children.post.desc.xml

Content Delete (deleteContent)
DELETE /alfresco/service/api/node/content{property}/{store_type}/{store_id}/{id}
DELETE /alfresco/service/api/path/content{property}/{store_type}/{store_id}/{id}
DELETE /alfresco/service/api/avmpath/content{property}/{store_id}/{id}
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}
---
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:atomentry
Lifecycle:public_api
Id:org/alfresco/repository/store/content.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/content.delete.desc.xml

Content Retrieval (getContent)
GET /alfresco/service/api/node/content{property}/{store_type}/{store_id}/{id}?a={attach?}
GET /alfresco/service/api/path/content{property}/{store_type}/{store_id}/{id}?a={attach?}
GET /alfresco/service/api/avmpath/content{property}/{store_id}/{id}?a={attach?}
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}?a={attach?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}?a={attach?}
---
The service returns the content-stream for a document. This is the only service that returns content-stream.

Inputs:

ID documentId: Document to return the content-stream
(Optional) Integer offset:
(Optional) Integer length:

Outputs:

Byte[] stream

Notes:

Some CMIS protocol bindings MAY choose not to explicitly implement a “getContentStream” method, in cases where the protocol itself provides built-in mechanisms for retrieving byte streams. (E.g. in the ATOM/REST binding, content streams may be retrieved via standard HTTP gets on an “edit-media” URL, rather than a CMIS-specific “getContentStream” URL). See Part II of the CMIS specification for additional details.
Each CMIS protocol binding will provide a way for fetching a sub-range within a content stream, in a manner appropriate to that protocol.
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:Determined at run-time
Lifecycle:public_api
Id:org/alfresco/repository/store/content.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/content.get.desc.xml

Content Write (setContent)
PUT /alfresco/service/api/node/content{property}/{store_type}/{store_id}/{id}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/path/content{property}/{store_type}/{store_id}/{id}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/avmpath/content{property}/{store_id}/{id}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}?overwriteFlag={overwriteFlag?}
---
TODO
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:text
Lifecycle:draft_public_api
Id:org/alfresco/repository/store/content.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/content.put.desc.xml

Delete tree (deleteTree)
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{id}/descendants?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
---
Deletes the tree rooted at specified folder (including that folder)

Inputs:

ID folderId
Enum unfileNonfolderObjects:
o Unfile – unfile all non-folder objects from folders in this tree. They may remain filed in other folders, or may become unfiled.
o DeleteSingleFiled – delete non-folder objects filed only in this tree, and unfile the others so they remain filed in other folders.
o Delete – delete all non-folder objects in this tree (Default)
(Optional) Bool continueOnFailure: False (Default)

Outputs:

Collection failedToDelete - List of object IDs that failed to delete (if continueOnFailure is FALSE, then single object ID)

Notes:

If a non-folder object is removed from the last folder it is filed in, it can continue to survive outside of the folder structure if the repository supports the “Unfiling” capabiliity.
If the specified folder is the Root Folder, throw OperationNotSupportedException.
If unfiling is not supported, throw OperationNotSupportedException if deleteTree is called with Unfile.
For repositories that support version-specific filing, this may delete some versions of a document but not necessarily all versions. For repositories that do not support version-specific filing, if a document is to be deleted, all versions are deleted.
This is not transactional.
o However, if DeleteSingleFiled is chosen, then having the objects unfiled is not sufficient if some objects fail to delete. The user MUST be able to re-issue command (recover) from the error by using the same tree.
Does not specify the order in which delete will happen
o However, any objects that are not deleted (e.g. because a previous object failed to delete), they MUST remain valid CMIS objects (including any applicable filing constraint for each object).
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomfeed
Id:org/alfresco/repository/store/descendants.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/descendants.delete.desc.xml

Retrieve tree of descendants (getDescendants)
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
---
Gets the list of descendant objects contained at one or more levels in the tree rooted at the specified folder. Only the filter-selected properties associated with each object are returned. The content-stream is not returned.

For paging through the children (depth of 1) only use getChildren. For returning a tree of objects of a certain depth, use getDescendants.

For a repository that supports version-specific filing, this will return the version of the documents in the folder specified by the user filing the documents into the folder. Otherwise, the latest version of the documents will be returned.

Inputs:

ID folderId
(Optional) Enum type: Documents, Folders, Policies, Any (default)
(Optional) Int depth: 1 this folder only (Default), … N folders deep, -1 for all levels
(Optional) String filter: Filter specifying which properties to return.
(Optional) Boolean includeAllowableActions: False (default)
(Optional) Enum includeRelationships: none (default), source, target, both
(Optional) String orderBy: must be a valid ORDER BY clause from the query grammer excluding ‘ORDER BY’. Example ‘name DESC’.

Outputs:

Result set specified by Filter of each descendant object in the specified folder
This result set will nest the contained objects

Notes:

The ordering and tree walk algorithm is repository-specific, but SHOULD be consistent.
This method will return all objects of the specified type in the specified depth.
If no type is specified, then objects of all types will be returned.
When returning the results of a call where the caller specified “Any” type, the repository SHOULD return, at each nesting level, all folder objects first followed by other objects.
If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for each descendant object as part of the output.
"IncludeRelationships" indicates whether relationships are also returned for each returned object. If it is set to "source" or "target", relationships for which the returned object is a source, or respectively a target, will also be returned. If it is set to "both", relationships for which the returned object is either a source or a target will be returned. If it is set to "none", relationships are not returned.
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:atomfeed
Id:org/alfresco/repository/store/descendants.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/descendants.get.desc.xml

Create folder or document (createDocument, createFolder)
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/descendants
---
Creates a document object of the specified type, and optionally adds the document to a folder

Inputs:

ID typeId: Document type
Collection properties
(Optional) ID folderId: Parent folder for this new document
(Optional) ContentStream contentStream
(Optional) Enum versioningState: CheckedOut, CheckedInMinor, CheckedInMajor (Default)

Outputs:

ID objectId: Id of the created document object

The versioningState input is used to create a document in a checked-out state, or as a checked-in minor version, or as a checked-in major version. If created in a checked-out state, the object is a PWC and there is no corresponding "checked out document". (See the "Versioning" section.)
If the Document’s Object Type does not allow content-stream and a content-stream is provided, or if content-stream is required and a content-stream is not provided, throw ConstraintViolationException.
If a Folder is specified, and the Document’s Object Type is not one of the “Allowed_Child_Object_Types” for this Folder, throw ConstraintViolationException.
If unfiling is not supported and a Folder is not specified, throw FolderNotValidException.
Repositories MAY reject the createDocument request (by throwing ConstaintViolationException) if any of the Required properties specified in the Document’s Object Type are not set.
However, iF the repository does NOT reject the createDocument request in this case, the repository MUST leave the newly-created Document in a checked-out state, and MUST ensure that all required properties are set before the Document is checked in.


Creates a folder object of the specified type

Inputs:

ID typeId: Folder type
Collection properties
ID folderId: Parent folder for this new folder

Outputs:

ID objectId: Id of the created folder object

Notes:
If the to-be-created Folder’s Object Type is not one of the “Allowed_Child_Object_Types” for the parent Folder, throw ConstraintViolationException.
Root folder can not be created using this service.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomentry
Id:org/alfresco/repository/store/descendants.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/descendants.post.desc.xml

Delete item (deleteObject)
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}?includeChildren={includeChildren?}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{id}?includeChildren={includeChildren?}
---
Deletes specified object

Inputs:

ID objectId

Notes:

If the object is a Folder with at least one child, throw ConstraintViolationException.
If the object is the Root Folder, throw OperationNotSupportedException.
When a filed object is deleted, it is removed from all folders it is filed in.
This service deletes a specific version of a document object. To delete all versions, use deleteAllVersions()
Deletion of a private working copy (checked out version) is the same as to cancel checkout.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomentry
Id:org/alfresco/repository/store/item.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.delete.desc.xml

Retrieve properties (getProperties)
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}?filter={filter?}&returnVersion={returnVersion?}&filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}?filter={filter?}&returnVersion={returnVersion?}&filter={filter?}&includeAllowableActions={includeAllowableActions?}
---
Returns the properties of an object, and optionally the operations that the user is allowed to perform on the object

Inputs:

ID objectId
(Optional) Enum returnVersion: This (Default), Latest, LatestMajor
(Optional) String filter: Filter for properties to be returned
(Optional) Boolean includeAllowableActions: False (default)
(Optional) Enum includeRelationships: none (default), source, target, both

Outputs:

Collection propertyCollection
Collection allowableActionCollection

Notes:

If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for the object as part of the output.
"IncludeRelationships" indicates whether relationships are also returned for the object. If it is set to "source" or "target", relationships for which the returned object is a source, or respectively a target, will also be returned. If it is set to "both", relationships for which the returned object is either a source or a target will be returned. If it is set to "none", relationships are not returned.
Does not return the content-stream of a document
PropertyCollection includes changeToken (if applicable to repository)
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:atomentry
Id:org/alfresco/repository/store/item.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.get.desc.xml

Update properties (updateProperties)
PATCH /alfresco/service/api/node/{store_type}/{store_id}/{id}
PATCH /alfresco/service/api/path/{store_type}/{store_id}/{id}
---
This service updates properties of the specified object. As per the data model, content-streams are not properties

Inputs:

ID objectId
(Optional) String changeToken
Collection propertyCollection - Subset list of Properties to update

Outputs:

ID objectId

Notes:

Preserves the ID of the object
Subset of properties: Properties not specified in this list are not changed
To remove a property, specify property with no value
If an attempt is made to update a read-only property, throw ConstraintViolationException.
If a ChangeToken is provided by the repository when the object is retrieved, the change token MUST be included as-is when calling updateProperties.
For Multi-Value properties, the whole list of values MUST be provided on every update.
Use getAllowableActions to identify whether older version specified by ID is updatable.
If this is a private working copy, some repositories may not support updates.
Because repositories MAY automatically create new Document Versions on a user’s behalf, the objectId returned may not match the one provided as an input to this method.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:atomentry
Id:org/alfresco/repository/store/item.patch
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.patch.desc.xml

Update properties (updateProperties)
PUT /alfresco/service/api/node/{store_type}/{store_id}/{id}
PUT /alfresco/service/api/path/{store_type}/{store_id}/{id}
---
This service updates properties of the specified object. As per the data model, content-streams are not properties

Inputs:

ID objectId
(Optional) String changeToken
Collection propertyCollection - Subset list of Properties to update

Outputs:

ID objectId

Notes:

Preserves the ID of the object
Subset of properties: Properties not specified in this list are not changed
To remove a property, specify property with no value
If an attempt is made to update a read-only property, throw ConstraintViolationException.
If a ChangeToken is provided by the repository when the object is retrieved, the change token MUST be included as-is when calling updateProperties.
For Multi-Value properties, the whole list of values MUST be provided on every update.
Use getAllowableActions to identify whether older version specified by ID is updatable.
If this is a private working copy, some repositories may not support updates.
Because repositories MAY automatically create new Document Versions on a user’s behalf, the objectId returned may not match the one provided as an input to this method.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:atomentry
Id:org/alfresco/repository/store/item.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.put.desc.xml

Retrieve Parent Folder (getFolderParent)
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/parent?returnToRoot={returnToRoot}&filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/parent?returnToRoot={returnToRoot}&filter={filter?}&includeAllowableActions={includeAllowableActions?}
---
Returns the parent folder object, and optionally all ancestor folder objects, above a specified folder object.

Inputs:

ID folderId: Source folder to get the parent or ancestors of
(Optional) String filter: Property filter specifying which properties to return.
(Optional) Boolean includeAllowableActions: False (default)
(Optional) Enum includeRelationships: none (default), source, target, both
(Optional) Bool returnToRoot: If false, return only the immediate parent of the folder. If true, return an ordered list of all ancestor folders from the specified folder to the root folder. Default=False

Outputs:

ResultSet resultSet of folders
Parent Folder ID + Specified properties
Can be a list of folders

Notes:

Output is ordered by ancestry, closest to specified folder first. However XML clients may not always respect ordering. For that reason repositories SHOULD always include the parent and the ObjectID property in the filter to allow re-ordering if necessary.
No parent folder is returned if the specified folder is the root folder.
If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for each parent or ancestor folder as part of the output.
"IncludeRelationships" indicates whether relationships are also returned for each returned object. If it is set to "source" or "target", relationships for which the returned object is a source, or respectively a target, will also be returned. If it is set to "both", relationships for which the returned object is either a source or a target will be returned. If it is set to "none", relationships are not returned.
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:atomfeed
Id:org/alfresco/repository/store/parent.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/parent.get.desc.xml

Retrieve Parent Folders (getObjectParents)
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}
---
Returns the parent folders for the specified non-folder, fileable object

Inputs:

ID objectId: ID of a non-folder, fileable object.
(Optional) String filter: filter specifying which properties to return.
(Optional) Boolean includeAllowableActions: False (default)
(Optional) Enum includeRelationships: none (default), source, target, both

Outputs:

ResultSet resultSet - Set of folders containing the object.

Notes:

Order is repository-specific
It is suggested that the parent and the ObjectId properties are included in the filter to allow re-ordering if necessary.
If “includeAllowableActions” is TRUE, the repository will return the allowable actions for the current user for each parent folder as part of the output.
"IncludeRelationships" indicates whether relationships are also returned for each returned object. If it is set to "source" or "target", relationships for which the returned object is a source, or respectively a target, will also be returned. If it is set to "both", relationships for which the returned object is either a source or a target will be returned. If it is set to "none", relationships are not returned.
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:atomfeed
Id:org/alfresco/repository/store/parents.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/parents.get.desc.xml

Cancel Checkout (cancelCheckout)
DELETE /alfresco/service/api/pwc/{store_type}/{store_id}/{id}
---
Reverses the effect of a check-out. Removes the private working copy of the checked-out document object, allowing other documents in the version series to be checked out again.

Inputs:

ID documentId: ObjectId of Private Working Copy (ID returned on CheckOut)

Notes:

It is repository specific on who can cancel a checkout (user, admin, larger group, etc)
Throws OperationNotSupportedException if the object is not checked out
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomentry
Id:org/alfresco/repository/store/pwc.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/pwc.delete.desc.xml

Retrieve properties of PWC
GET /alfresco/service/api/pwc/{store_type}/{store_id}/{id}?filter={filter?}
---
Retrieves the properties of a private working copy
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:atomentry
Id:org/alfresco/repository/store/pwc.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/pwc.get.desc.xml

Checkin Private Working Copy (checkin)
PATCH /alfresco/service/api/pwc/{store_type}/{store_id}/{id}?checkinComment={checkinComment?}&major={major?}&checkin={checkin?}
---
Makes the private working copy the current version of the document.

Inputs:

ID documentId: ObjectId of the private working copy
Optional) Boolean major: True (Default)
(Optional) Property bag
(Optional) ContentStream stream
(Optional) String CheckinComment

Outputs:

ID documentId: ID for the new version of the document.

Notes:

It is left to the repository to determine who can check-in a document.
CheckinComment is persisted if specified.
For repositories that do not support updating private working copies, all updates MUST be set on the check-in service.
If Document is not checked out, throw OperationNotSupportedException.
If the Document has “Content_Stream_Allowed” set to FALSE, and a call is made to checkIn that includes a content-stream, throw ConstraintViolationException.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomentry
Id:org/alfresco/repository/store/pwc.patch
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/pwc.patch.desc.xml

Checkin Private Working Copy (checkin)
PUT /alfresco/service/api/pwc/{store_type}/{store_id}/{id}?checkinComment={checkinComment?}&major={major?}&checkin={checkin?}
---
Makes the private working copy the current version of the document.

Inputs:

ID documentId: ObjectId of the private working copy
Optional) Boolean major: True (Default)
(Optional) Property bag
(Optional) ContentStream stream
(Optional) String CheckinComment

Outputs:

ID documentId: ID for the new version of the document.

Notes:

It is left to the repository to determine who can check-in a document.
CheckinComment is persisted if specified.
For repositories that do not support updating private working copies, all updates MUST be set on the check-in service.
If Document is not checked out, throw OperationNotSupportedException.
If the Document has “Content_Stream_Allowed” set to FALSE, and a call is made to checkIn that includes a content-stream, throw ConstraintViolationException.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomentry
Id:org/alfresco/repository/store/pwc.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/pwc.put.desc.xml

Delete relationship (deleteRelationship)
DELETE /alfresco/service/api/rel/{store_type}/{store_id}/{id}/type/{rel_type}/target/{target_store_type}/{target_store_id}/{target_id}
---
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomentry
Id:org/alfresco/repository/store/relationship.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/relationship.delete.desc.xml

Retrieve relationship (getProperties)
GET /alfresco/service/api/rel/{store_type}/{store_id}/{id}/type/{rel_type}/target/{target_store_type}/{target_store_id}/{target_id}?filter={filter?}&includeAllowableActions={includeAllowableActions?}
---
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:atomentry
Id:org/alfresco/repository/store/relationship.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/relationship.get.desc.xml

Retrieve list of relationships (getRelationships)
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/rels?filter={filter?}&relationshipType={relationshipType?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&direction={direction?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/rels?filter={filter?}&relationshipType={relationshipType?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&direction={direction?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
---
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:atomfeed
Id:org/alfresco/repository/store/relationships.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/relationships.get.desc.xml

Create relationship (createRelationship)
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/rels
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/rels
---
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:atomentry
Id:org/alfresco/repository/store/relationships.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/relationships.post.desc.xml

Remote AVM Store
DELETE /alfresco/service/remotestore/{method}/{path}
---
Remote service mirroring the Store interface - to an AVM store
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:Determined at run-time
Id:org/alfresco/repository/store/remoteavm.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/remoteavm.delete.desc.xml

Remote AVM Store
GET /alfresco/service/remotestore/{method}
GET /alfresco/service/remotestore/{method}/{path}
GET /alfresco/service/remotestore/{method}/s/{store}
GET /alfresco/service/remotestore/{method}/s/{store}/{path}
GET /alfresco/service/remotestore/{method}/s/{store}/w/{webapp}
GET /alfresco/service/remotestore/{method}/s/{store}/w/{webapp}/{path}
---
Remote service mirroring the Store interface - to an AVM store
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:Determined at run-time
Id:org/alfresco/repository/store/remoteavm.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/remoteavm.get.desc.xml

Remote AVM Store
POST /alfresco/service/remotestore/{method}/{path}
---
Remote service mirroring the Store interface - to an AVM store
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:Determined at run-time
Id:org/alfresco/repository/store/remoteavm.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/remoteavm.post.desc.xml

Retrieve a Type (getTypeDefinition)
GET /alfresco/service/api/type/{typeId}?includeInheritedProperties={includeInheritedProperties?}
---
Gets the definition for specified object type

Inputs:

ID typeId: Type Id

Outputs:

Collection typeAttributeCollection: Type attributes of an object type definition. See the “Object Type” section for a complete list of type attributes.
propertyDefinition: A list of property definitions. Each property definition consists of a collection of property attributes. See the “Object Type” section for a complete list of property attributes.

Notes:

canCreateInstances if false, the user MUST NOT be able to create instances of this particular type. If true, the user may be able to create instances.
When includeInheritedProperties is true, the repository SHOULD return all properties defined for the Object Type, including any properties inherited from its parent. If false, only Properties defined on the Object Type (but not its parent) SHOULD be returned.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomentry
Id:org/alfresco/repository/store/type.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/type.get.desc.xml

Retrieve list of child Types
GET /alfresco/service/api/type/{typeId}/children?includePropertyDefinitions={includePropertyDefinitions?}&skipCount={skipCount?}&maxItems={maxItems?}
---
Retrieve list of all child Types
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomfeed
Id:org/alfresco/repository/store/typechildren.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/typechildren.get.desc.xml

Retrieve list of descendant Types
GET /alfresco/service/api/type/{typeId}/descendants?includePropertyDefinitions={includePropertyDefinitions?}&skipCount={skipCount?}&maxItems={maxItems?}
---
Retrieve list of all descendant Types
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomfeed
Id:org/alfresco/repository/store/typedescendants.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/typedescendants.get.desc.xml

Retrieve list of all Types (getTypes)
GET /alfresco/service/api/types?type={type?}&includePropertyDefinitions={includePropertyDefinitions?}&skipCount={skipCount?}&maxItems={maxItems?}
---
Returns the list of all types in the repository.

Inputs:

(Optional) ID typeId: not set (default)
(Optional) Bool returnPropertyDefinitions: False (default)
(Optional) int maxItems: 0 = Repository-default number of items (Default)
(Optional) int skipCount: 0 = start (Default)

Outputs:

Result Set - List of types
Boolean hasMoreItems
The type attributes of each type will be returned
The property definitions of each type will be returned if returnPropertyDefinitions is TRUE.

Notes:

A repository may support a hierarchy of types but CMIS will return them as a flat list.
If provided, the input parameter “TypeId” specifies to only return the specific Object Type and its descendants. If not provided, all Object Types are to be returned.
If no “maxItems” value is provided, then the Repository will determine an appropriate number of items to return. How the Repository determines this value is repository-specific and opaque to CMIS.
If “returnPropertyDefinitions” is False, then the Repository will return only the “Attributes” of the Object Type Definition as specified in the “Object Type” section of the Data Model. Otherwise, property definitions will also be returned for each object type.
---
Authentication:user
Transaction:required
Format Style:any
Default Format:atomfeed
Id:org/alfresco/repository/store/types.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/types.get.desc.xml

Unfiled Documents
GET /alfresco/service/api/unfiled
---
Retrieve list of documents that are not in any folder
---
Authentication:guest
Transaction:required
Format Style:any
Default Format:atomfeed
Id:org/alfresco/repository/store/unfiled.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/unfiled.get.desc.xml

Retrieve all versions (getAllVersions)
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/versions?filter={filter?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/versions?filter={filter?}
---
Returns the list of all document versions for the specified version series, sorted by CREATION_DATE descending.

Inputs:

ID versionSeriesId: Version series Id

Outputs:

(Optional) String filter: Property Filter
Collection documentCollection - Set of objects containing Ids and specified properties

Notes:

Returns all versions the user can access including checked-out version and private working copy.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:atomfeed
Id:org/alfresco/repository/store/versions.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/store/versions.get.desc.xml

Package: /org/alfresco/repository/tagging

Get Node Tags
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/tags
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/tags
---
Get all the tags for a node
Returns STATUS_OK (200)
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/tagging/node.tags.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/node.tags.get.desc.xml

Add tag
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/tags
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/tags
---
Add one or more tags to the node
Input:
(mandatory) array of String
Returns the array of tags
Return STATUS_OK (200).
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/tagging/node.tags.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/node.tags.post.desc.xml

List all tags
GET /alfresco/service/api/tags/{store_type}/{store_id}?tf={tag_filter?}
---
Get the currently available tags for the specified store.
tag_filter
The optional tag filter limits the returned tags to those containing the filter.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/tagging/tags.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/tags.get.desc.xml

Get nodes for tag
GET /alfresco/service/api/tags/{store_type}/{store_id}/{tag}/nodes
---
Get the nodes which have a given tag
Return content
Array of
  • nodeRef
  • url

Return status: STATUS_OK, 200
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/tagging/tags.nodes.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/tags.nodes.get.desc.xml

Tagscope tags
GET /alfresco/service/api/tagscopes/node/{store_type}/{store_id}/{id}/tags
GET /alfresco/service/api/tagscopes/site/{site}/tags
GET /alfresco/service/api/tagscopes/site/{site}/{container}/tags
---
Get all tags of the nearest available tagscope
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/tagging/tagscope-tags.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/tagscope-tags.get.desc.xml

Package: /org/alfresco/repository/thumbnail

Thumbnails
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}/thumbnails/{thumbnailname}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}/thumbnails/{thumbnailname}
---
Delete a thumbnail for a content resource
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/thumbnail/thumbnail.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnail.delete.desc.xml

Thumbnails
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}/thumbnails/{thumbnailname}?c={queueforcecreate?}&ph={placeholder?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}/thumbnails/{thumbnailname}?c={queueforcecreate?}&ph={placeholder?}
---
Get a named thumbnail for a content resource
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:Determined at run-time
Id:org/alfresco/repository/thumbnail/thumbnail.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnail.get.desc.xml

Thumbnails
PUT /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}/thumbnails/{thumbnailname}
PUT /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}/thumbnails/{thumbnailname}
---
Update a thumbnail for a content resource
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/thumbnail/thumbnail.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnail.put.desc.xml

ThumbnailsDefinitions
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}/thumbnaildefinitions
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}/thumbnaildefinitions
---
Get the thumbnails definitions for a content resource
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/thumbnail/thumbnaildefinitions.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnaildefinitions.get.desc.xml

Thumbnails
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}/thumbnails
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}/thumbnails
---
Get the thumbnails for a content resource
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/thumbnail/thumbnails.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnails.get.desc.xml

Thumbnails
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}/thumbnails?as={async?}
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}/thumbnails?as={async?}
---
Create a new thumbnail for a content resource
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/thumbnail/thumbnails.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnails.post.desc.xml

Package: /org/alfresco/repository/upload

File Upload
POST /alfresco/service/api/upload
---
Upload file content and meta-data into repository.
HTML form data
  • filedata, (mandatory) HTML type file
  • siteid
  • containerid
  • uploaddirectory
  • updatenoderef
  • filename
  • description
  • contenttype
  • majorversion
  • overwrite
  • thumbnails

Return content
  • nodeRef

Return status: STATUS_OK (200)
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Lifecycle:public_api
Id:org/alfresco/repository/upload/upload.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/upload/upload.post.desc.xml

Package: /org/alfresco/repository/version

Revert Version Info
POST /alfresco/service/api/revert
---
Revert Version Info
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/version/revert.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/version/revert.post.desc.xml

Node Version Info
GET /alfresco/service/api/version
---
Node Version Info
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/version/version.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/version/version.get.desc.xml

Package: /org/alfresco/repository/wcm

Delete Web Project
DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}
---
Delete a single WCM web project and its contents,
webprojectref specifies which project to delete and will have been returned by a prior call to get, create or list web project.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/webproject.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.delete.desc.xml

Get Web Project
GET /alfresco/service/api/wcm/webprojects/{webprojectref}
---
Get a single WCM web project in JSON format.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/webproject.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.get.desc.xml

Create Web Project
POST /alfresco/service/api/wcm/webprojects
---
Create (POST) a single WCM web project.
The following fields are required in the body of the request:
name
Human readable name for the web project.
title
Human readable title for the web project.
dnsName
The name of the web project which will become part of the URL. Should be short and unique.

The following fields are optional:
description
description about the web project

Returns 201, STATUS_CREATED on success. The body of the return will contain the new Web Project.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/webproject.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.post.desc.xml

Update Web Project
PUT /alfresco/service/api/wcm/webprojects/{webprojectref}
---
Update a single WCM web project
webprojectref is the unique reference returned by an earlier call to list, get or create web project
The following fields are may be updated in the body of the request:
  • name
  • title
  • description
  • isTemplate

      • Returns 200 STATUS_OK, the body of the return will contain the updated web project.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/webproject.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.put.desc.xml

Web Projects
GET /alfresco/service/api/wcm/webprojects?userName={userName?}
GET /alfresco/service/api/wcm/webprojects
---
Get a list of the WCM Web projects.
userName is an optional argument that if specified then only those web projects for the specified user are returned else all web projects are returned.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/webprojects.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webprojects.get.desc.xml

Package: /org/alfresco/repository/wcm/membership

Delete Web Project Membership
DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships/{username}
---
Delete (uninvite) the membership for a user.
Please note that the user's sandboxes are deleted even if they have unsubmitted content.
Returns 200, STATUS_OK on success.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/membership/membership.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/membership.delete.desc.xml

Get Membership
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships/{username}
---
Get the webproject membership details for a user
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/membership/membership.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/membership.get.desc.xml

List Memberships
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships
---
Get the collection of a web project memberships for a web project.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/membership/memberships.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/memberships.get.desc.xml

Add user to web project
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships
---
Adds a new membership to the web project. After calling this method the user will be able to access the specified web project.
Input
role
The role that the person should have
person
Details of the person.

Returns 200, STATUS_OK
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/membership/memberships.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/memberships.post.desc.xml

Package: /org/alfresco/repository/wcm/sandbox

Delete Sandbox
DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxRef}
---
Deletes a WCM sandbox and all its contents.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/sandbox.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandbox.delete.desc.xml

Get Web Project Sandbox
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}
---
Get details of single sandbox of a web project. Return 
 data: sandboxref name creator createdDate.iso8601 storeNames" : [ ] isAuthorSandbox isStagingSandbox url
Returns STATUS_OK, 200
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/sandbox.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandbox.get.desc.xml

Create user sandbox
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes
---
Create (POST) a new author sandbox for a user.
The following fields are required in the body of the request:
  • userName

Returns STATUS_CREATED,201 on success.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/sandbox.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandbox.post.desc.xml

Web Project Sandboxes
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes?userName={userName?}
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes
---
Get a collection of a web project sandboxes.
If userName is specified then returns the sandboxes for the specified user.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/sandboxes.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandboxes.get.desc.xml

Package: /org/alfresco/repository/wcm/sandbox/Asset

Delete the specified asset.
DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
---
Delete the specified asset.
If the optional webApp argument is specified then the path is relative to the webapp e.g. /index.htm
If webApp is not specified then the path is will be absolute e.g. /www/avm_webapps/ROOT/index.htm
Returns STATUS_OK(200) for success.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/asset.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.delete.desc.xml

Get the details of the specified asset within the specified web project and sandbox.
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
---
Get the details of the specified asset.
If the asset is a folder, includes the children of that folder.
If the asset is a file, gives the size of the file.
If the optional webApp argument is specified then returns the asset relative to that web app e.g. /index.htm
If webApp is not specified then the path is will be absolute e.g. /www/avm_webapps/ROOT/index.htm
Return STATUS_OK, 200
Output - The asset in JSON format data: path, the full path of the asset. name, the name of the asset creator createdDate, iso8601, modifier modifiedDate, iso8601, isLocked, boolean isFile, boolean isFolder, boolean isDeleted, boolean children, JSON array, only present for folder fileSize, numeric, only present for files
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/asset.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.get.desc.xml

Create a new WCM asset.
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
---
Create a new WCM Asset in the specified path and sandbox.
If the optional webApp argument is specified then the path is relative to the webapp.
If webApp is not specified then the path is will be absolute e.g. /www/avm_webapps/ROOT
JSON Input values
name
mandatory name of this asset
type
mandatory "file" or "folder"
content/dt>
optional, string content of the new file, this is a convenience method, normally content is added via the file upload which gives greater control over the content.
JSON Return value: 
 data:The newly created asset in JSON format.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/asset.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.post.desc.xml

Update a WCM asset.
PUT /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
PUT /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
---
Update a WCM Asset, you can rename or move an asset.
JSON Input properties
name
optional rename this file or folder to this new name
path
optional move this file or folder to this path. The destination folder must already exist.

JSON Return data:
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/asset.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.put.desc.xml

Get modified assets within the specified sandbox.
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/modified
GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/modified?webApp={webApp?}
---
Get the modified (added, deleted, updated) details of an asset within an author's sandbox.
If a folder has been added then only the folders's properties are returned (not folder plus assets within that new folder).
If the optional webApp argument is specified then returns the modified assets within that web app.
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/modified.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/modified.get.desc.xml

Revert modified assets within the specified author sandbox.
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/reverter
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/reverter?webApp={webApp?}
---
Revert the modified (added, deleted, updated) assets contained within an author's sandbox.
If the optional webApp argument is specified then reverts the modified assets within that web app.
JSON data fileds
all
boolean is this submit all? (optional)
assets
array, of JSON objects containing a path property (optional). If the "all" option is true then this parameter is ignored
paths
array, of String paths. If the "all" option is true then this parameter is ignored
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/revert.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/revert.post.desc.xml

Submit modified assets from within the specified author sandbox.
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/submitter
POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/submitter?webApp={webApp?}
---
Submit the modified (added, deleted, updated) assets contained within an author's sandbox.
If the optional webApp argument is specified then submits the modified assets within that web app.
JSON data fileds
label
string label for this submission (mandatory)
comment
string comment for this submission (mandatory)
all
boolean is this submit all? (optional)
assets
array, of JSON objects containing a path property (optional). If the "all" option is true then this parameter is ignored
paths
array, of String paths. If the "all" option is true then this parameter is ignored
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Lifecycle:draft_public_api
Id:org/alfresco/repository/wcm/sandbox/Asset/submit.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/submit.post.desc.xml

Package: /org/alfresco/repository/workflow

End Workflow Task
POST /alfresco/service/api/workflow/task/end/{taskId}/{transitionId}
POST /alfresco/service/api/workflow/task/end/{taskId}
---
Ends a task for an in-flight workflow with the passed-in transition or the default
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/repository/workflow/end-task.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/repository/workflow/end-task.post.desc.xml

Package: /org/alfresco/sample

AVM Browse Sample
GET /alfresco/service/sample/avm/path/{storeid}/{path}
---
Sample demonstrating the listing of AVM folder contents
---
Authentication:admin
Transaction:required
Format Style:argument
Default Format:html
Id:org/alfresco/sample/avmbrowse.get
Descriptor:workspace://SpacesStore/app:company_home/app:dictionary/cm:webscripts/org/alfresco/sample/avmbrowse.get.desc.xml

AVM Stores Sample
GET /alfresco/service/sample/avm/stores
---
Sample demonstrating the listing of AVM stores
---
Authentication:admin
Transaction:required
Format Style:any
Default Format:html
Id:org/alfresco/sample/avmstores.get
Descriptor:workspace://SpacesStore/app:company_home/app:dictionary/cm:webscripts/org/alfresco/sample/avmstores.get.desc.xml

Blog Search Sample
GET /alfresco/service/sample/blog/search?q={searchTerm}
GET /alfresco/service/sample/blog/search.atom?q={searchTerm}
GET /alfresco/service/sample/b/s?q={searchTerm}
GET /alfresco/service/sample/b/s.atom?q={searchTerm}
---
Sample that finds all blog entries whose content contains the specified search term
---
Authentication:guest
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/sample/blogsearch.get
Descriptor:workspace://SpacesStore/app:company_home/app:dictionary/cm:webscripts/org/alfresco/sample/blogsearch.get.desc.xml

Category Search Sample
GET /alfresco/service/sample/blog/category/{category}
---
Sample that finds all blog entries tagged with specified categories
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:html
Id:org/alfresco/sample/categorysearch.get
Descriptor:workspace://SpacesStore/app:company_home/app:dictionary/cm:webscripts/org/alfresco/sample/categorysearch.get.desc.xml

Folder Listing Sample
GET /alfresco/service/sample/folder/{path}
---
Sample demonstrating the listing of folder contents
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:html
Id:org/alfresco/sample/folder.get
Descriptor:workspace://SpacesStore/app:company_home/app:dictionary/cm:webscripts/org/alfresco/sample/folder.get.desc.xml

Package: /org/alfresco/slingshot/calendar

deleteevent
DELETE /alfresco/service/calendar/event/{siteid}/{eventname}
---
Event Action - Delete event
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/calendar/event.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/calendar/event.delete.desc.xml

eventdetails
GET /alfresco/service/calendar/event/{siteid}/{eventname}
---
Event Action - Display event details
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/calendar/event.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/calendar/event.get.desc.xml

Create Calendar Event
POST /alfresco/service/calendar/create
---
Creates a Calendar Event
---
Authentication:user
Transaction:required
Format Style:extension
Default Format:html
Id:org/alfresco/slingshot/calendar/event.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/calendar/event.post.desc.xml

Update Calendar Event
PUT /alfresco/service/calendar/event/{siteid}/{eventname}
---
Updates an existing Calendar Event
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/calendar/event.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/calendar/event.put.desc.xml

Event Listing
GET /alfresco/service/calendar/eventList
---
List of all upcoming events for a site
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/calendar/eventList.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/calendar/eventList.get.desc.xml

userevents
GET /alfresco/service/calendar/events/user
GET /alfresco/service/calendar/events/{site}/user
---
Lists all of the events for all the sites the user belongs to
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/calendar/userevents.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/calendar/userevents.get.desc.xml

Package: /org/alfresco/slingshot/dashlets

my-content
GET /alfresco/service/slingshot/dashlets/my-contents
---
Content I'm Editing Dashlet Data Webscript
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/slingshot/dashlets/my-contents.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/dashlets/my-contents.get.desc.xml

my-tasks
GET /alfresco/service/slingshot/dashlets/my-tasks?filter={filter?}&date={date?}
---
My Tasks Dashlet Data Webscript
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/slingshot/dashlets/my-tasks.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/dashlets/my-tasks.get.desc.xml

Package: /org/alfresco/slingshot/documentlibrary

activity
POST /alfresco/service/slingshot/doclib/activity
---
Document List Component - activity data webscript
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/activity.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/activity.post.desc.xml

aspects
GET /alfresco/service/slingshot/doclib/aspects/node/{store_type}/{store_id}/{id}
---
Document List Component - aspects query
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/aspects.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/aspects.get.desc.xml

container
GET /alfresco/service/slingshot/doclib/container/{site}/{container}
---
Document List Component - container query
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/container.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/container.get.desc.xml

doclist
GET /alfresco/service/slingshot/doclib/doclist/node/{store_type}/{store_id}/{id}
GET /alfresco/service/slingshot/doclib/doclist/{type}/site/{site}/{container}/{path}
GET /alfresco/service/slingshot/doclib/doclist/{type}/site/{site}/{container}
GET /alfresco/service/slingshot/doclib/doclist/{type}/node/{store_type}/{store_id}/{id}/{path}
GET /alfresco/service/slingshot/doclib/doclist/{type}/node/{store_type}/{store_id}/{id}
---
Document List Component - doclist data webscript
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/doclist.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/doclist.get.desc.xml

images
GET /alfresco/service/slingshot/doclib/images/site/{site}/{container}/{path}
GET /alfresco/service/slingshot/doclib/images/site/{site}/{container}
---
Images List Component - images data webscript
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/images.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/images.get.desc.xml

treenode
GET /alfresco/service/slingshot/doclib/treenode/site/{site}/{container}/{path}
GET /alfresco/service/slingshot/doclib/treenode/site/{site}/{container}
GET /alfresco/service/slingshot/doclib/treenode/node/{store_type}/{store_id}/{id}/{path}
GET /alfresco/service/slingshot/doclib/treenode/node/{store_type}/{store_id}/{id}
---
Document List Component - treenode data webscript
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/treenode.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/treenode.get.desc.xml

type
POST /alfresco/service/slingshot/doclib/type/node/{store_type}/{store_id}/{id}
---
Document List Component - type submit
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/type.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/type.post.desc.xml

types
GET /alfresco/service/slingshot/doclib/types/node/{store_type}/{store_id}/{id}
---
Document List Component - types query
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/types.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/types.get.desc.xml

Package: /org/alfresco/slingshot/documentlibrary/action

aspects
POST /alfresco/service/slingshot/doclib/action/aspects/node/{store_type}/{store_id}/{id}
---
Document List Component - aspects submit
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/aspects.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/aspects.post.desc.xml

assign-workflow
POST /alfresco/service/slingshot/doclib/action/assign-workflow
---
Document List Action - Assign Workflow
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/assign-workflow.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/assign-workflow.post.desc.xml

cancel-checkout
POST /alfresco/service/slingshot/doclib/action/cancel-checkout/site/{site}/{container}/{path}
POST /alfresco/service/slingshot/doclib/action/cancel-checkout/node/{store_type}/{store_id}/{id}
---
Document List Action - Cancel check-out for file
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/cancel-checkout.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/cancel-checkout.post.desc.xml

checkin
POST /alfresco/service/slingshot/doclib/action/checkin/site/{site}/{container}/{path}
POST /alfresco/service/slingshot/doclib/action/checkin/node/{store_type}/{store_id}/{id}
---
Document List Action - Check-in file
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/checkin.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/checkin.post.desc.xml

checkout
POST /alfresco/service/slingshot/doclib/action/checkout/site/{site}/{container}/{path}
POST /alfresco/service/slingshot/doclib/action/checkout/node/{store_type}/{store_id}/{id}
---
Document List Action - Check-out file
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/checkout.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/checkout.post.desc.xml

copy-to
POST /alfresco/service/slingshot/doclib/action/copy-to/site/{site}/{container}/{path}
POST /alfresco/service/slingshot/doclib/action/copy-to/site/{site}/{container}
POST /alfresco/service/slingshot/doclib/action/copy-to/node/{store_type}/{store_id}/{id}/{path}
POST /alfresco/service/slingshot/doclib/action/copy-to/node/{store_type}/{store_id}/{id}
---
Document List Action - Copy multiple files
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/copy-to.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/copy-to.post.desc.xml

file
DELETE /alfresco/service/slingshot/doclib/action/file/site/{site}/{container}/{path}
DELETE /alfresco/service/slingshot/doclib/action/folder/site/{site}/{container}/{path}
DELETE /alfresco/service/slingshot/doclib/action/file/node/{store_type}/{store_id}/{id}
DELETE /alfresco/service/slingshot/doclib/action/folder/node/{store_type}/{store_id}/{id}
---
Document List Action - Delete file
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/file.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/file.delete.desc.xml

files
DELETE /alfresco/service/slingshot/doclib/action/files
DELETE /alfresco/service/slingshot/doclib/action/folders
---
Document List Action - Delete multiple files
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/files.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/files.delete.desc.xml

folder
POST /alfresco/service/slingshot/doclib/action/folder/site/{site}/{container}
POST /alfresco/service/slingshot/doclib/action/folder/site/{site}/{container}/{path}
---
Document List Action - Create folder
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/folder.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/folder.post.desc.xml

move-to
POST /alfresco/service/slingshot/doclib/action/move-to/site/{site}/{container}/{path}
POST /alfresco/service/slingshot/doclib/action/move-to/site/{site}/{container}
POST /alfresco/service/slingshot/doclib/action/move-to/node/{store_type}/{store_id}/{id}/{path}
POST /alfresco/service/slingshot/doclib/action/move-to/node/{store_type}/{store_id}/{id}
---
Document List Action - Move multiple files
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/move-to.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/move-to.post.desc.xml

permissions
POST /alfresco/service/slingshot/doclib/action/permissions/{operation}/site/{site}
---
Document List Action - set permissions
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/documentlibrary/action/permissions.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/action/permissions.post.desc.xml

Package: /org/alfresco/slingshot/profile

Reset Avatar image
PUT /alfresco/service/slingshot/profile/resetavatar/{userName}
---
User Profile - Reset Avatar image for a user
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/profile/resetavatar.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/profile/resetavatar.put.desc.xml

Avatar Upload
POST /alfresco/service/slingshot/profile/uploadavatar
---
Upload avatar file content and apply to person preferences
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/slingshot/profile/uploadavatar.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/profile/uploadavatar.post.desc.xml

Last edited user contents
GET /alfresco/service/slingshot/profile/usercontents
---
Last edited user contents
---
Authentication:guest
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/slingshot/profile/usercontents.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/profile/usercontents.get.desc.xml

User Profile
POST /alfresco/service/slingshot/profile/userprofile
---
User Profile POST for update
---
Authentication:user
Transaction:required
Format Style:any
Default Format:json
Id:org/alfresco/slingshot/profile/userprofile.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/profile/userprofile.post.desc.xml

Package: /org/alfresco/slingshot/search

search
GET /alfresco/service/slingshot/search?term={term}&site={site?}&container={container?}
---
Site Search Component Data Webscript
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/search/search.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/search/search.get.desc.xml

Package: /org/alfresco/slingshot/wiki

movewikipage
POST /alfresco/service/slingshot/wiki/page/{siteId}/{pageTitle}
---
Wiki - Page details
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/wiki/move.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/wiki/move.post.desc.xml

wikidelete
DELETE /alfresco/service/slingshot/wiki/page/{siteId}/{pageTitle}
---
Wiki - Deletes page
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/wiki/page.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/wiki/page.delete.desc.xml

wikipage
GET /alfresco/service/slingshot/wiki/page/{siteId}/{pageTitle}
---
Wiki - Page details
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/wiki/page.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/wiki/page.get.desc.xml

wikipage
PUT /alfresco/service/slingshot/wiki/page/{siteId}/{pageTitle}
---
Wiki - Page details
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/wiki/page.put
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/wiki/page.put.desc.xml

wikipage
GET /alfresco/service/slingshot/wiki/pages/{siteId}
---
Wiki - Page details
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/slingshot/wiki/pagelist.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/wiki/pagelist.get.desc.xml

wikipage
GET /alfresco/service/slingshot/wiki/version/{siteId}/{pageTitle}/{versionId}
---
Wiki - Page details
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:mediawiki
Id:org/alfresco/slingshot/wiki/version.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/slingshot/wiki/version.get.desc.xml

Package: /org/alfresco/test

Echo atom entry title
POST /alfresco/service/test/atomentry
---
Echo title from atom entry request
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Id:org/alfresco/test/atomentry.post
Descriptor:classpath:alfresco/webscripts/org/alfresco/test/atomentry.post.desc.xml

Test Bogus Request Types
POST /alfresco/service/test/bogus
---
Ensure that format extensions used for .js scripts have a registered FormatReader
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Id:org/alfresco/test/bogustest.post
Descriptor:classpath:alfresco/webscripts/org/alfresco/test/bogustest.post.desc.xml

Test client atom api
GET /alfresco/service/sample/cmis/folder/{id}
---
Parse atom feed
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Id:org/alfresco/test/cmisfolder.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/test/cmisfolder.get.desc.xml

CMIS Repository
GET /alfresco/service/sample/cmis/repo?service={serviceUrl?}
---
Sample Surf component using CMIS Service document
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Id:org/alfresco/test/cmisrepo.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/test/cmisrepo.get.desc.xml

x-www-form-urlencoded post
POST /alfresco/service/test/encodedpost
---
Extracts parameters, decodes them and echoes as simple string
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Id:org/alfresco/test/encodedsubmit.post
Descriptor:classpath:alfresco/webscripts/org/alfresco/test/encodedsubmit.post.desc.xml

Unit Test for exception handling
GET /alfresco/service/test/exception
---
Ensure appropriate status template is used for response
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:html
Id:org/alfresco/test/exception.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/test/exception.get.desc.xml

Echo JSON Request
POST /alfresco/service/test/jsonecho
---
Echo postCode from JSON Request
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Id:org/alfresco/test/jsonecho.post
Descriptor:classpath:alfresco/webscripts/org/alfresco/test/jsonecho.post.desc.xml

Echo Request Body
PUT /alfresco/service/test/requestbody
---
Echo Request Body
---
Authentication:none
Transaction:none
Format Style:any
Default Format:html
Id:org/alfresco/test/requestbody.put
Descriptor:classpath:alfresco/webscripts/org/alfresco/test/requestbody.put.desc.xml

Unit Test for Run As Function
GET /alfresco/service/test/runas
---
Echo the name of the effective user
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:html
Id:org/alfresco/test/runas.get
Descriptor:classpath:alfresco/webscripts/org/alfresco/test/runas.get.desc.xml

Package: /org/alfresco/vti

Vti WebScript placeholder
GET /alfresco/service/api/vti/{dummy}
GET /alfresco/service/api/vti
---
This script is a placeholder so the Share DocLib can query the Vti Server parameters without throwing an HTTP 404 error.
---
Authentication:none
Transaction:required
Format Style:argument
Default Format:json
Id:org/alfresco/vti/vti.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/vti/vti.get.desc.xml

Package: /org/alfresco/webframework

AVM Metadata Retrieval Service
GET /alfresco/service/webframework/avm/metadata/{storeId}/{webappId}/{path}
---
AVM Metadata Retrieval Service
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:html
Id:org/alfresco/webframework/avm-metadata.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/webframework/avm-metadata.get.desc.xml

Web Framework AVM Store
DELETE /alfresco/service/avmstore/{method}/{path}
---
Remote service mirroring the Store interface - to an AVM store
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:Determined at run-time
Id:org/alfresco/webframework/avmstore.delete
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/webframework/avmstore.delete.desc.xml

Web Framework AVM Store
GET /alfresco/service/avmstore/{method}
GET /alfresco/service/avmstore/{method}/{path}
GET /alfresco/service/avmstore/{method}/s/{store}
GET /alfresco/service/avmstore/{method}/s/{store}/{path}
GET /alfresco/service/avmstore/{method}/s/{store}/w/{webapp}
GET /alfresco/service/avmstore/{method}/s/{store}/w/{webapp}/{path}
---
Remote service mirroring the Store interface - to an AVM store
---
Authentication:guest
Transaction:required
Format Style:argument
Default Format:Determined at run-time
Id:org/alfresco/webframework/avmstore.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/webframework/avmstore.get.desc.xml

Web Framework AVM Store
POST /alfresco/service/avmstore/{method}/{path}
---
Remote service mirroring the Store interface - to an AVM store
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:Determined at run-time
Id:org/alfresco/webframework/avmstore.post
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/webframework/avmstore.post.desc.xml

JSF Redirection Handler
GET /alfresco/service/webframework/redirect/jsf-client/{command}/{objectType}/{storeType}/{storeId}/{nodeId}
GET /alfresco/service/webframework/redirect/jsf-client/{command}/{objectType}/{id}
---
JSF Redirection Handler
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:html
Id:org/alfresco/webframework/jsf-client-redirect.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/webframework/jsf-client-redirect.get.desc.xml

Content Metadata Retrieval Service
GET /alfresco/service/webframework/content/metadata
---
Content Metadata Retrieval Service
---
Authentication:user
Transaction:required
Format Style:argument
Default Format:html
Id:org/alfresco/webframework/metadata.get
Descriptor:classpath:alfresco/templates/webscripts/org/alfresco/webframework/metadata.get.desc.xml