Repository RESTful API Reference

From alfrescowiki

Jump to: navigation, search

Back to Alfresco Labs 3.


Contents

Introduction

Welcome to the reference documentation for the Alfresco Repository Public RESTful API - Labs v3.0.0 (Stable 1526).

This document was generated on 31-Mar-2009 13:56:32 via the Alfresco Repository URI...

http://<host>:<port>/alfresco/service/index/all.mediawiki?url=/api&desc=Public


Web Script Reference

This section provides reference information for each Web Script, organized by Web Script Package.

Documentation for each Web Script includes:

  • Short Name
  • Description
  • Available URI templates
  • Default response format
  • How to specify an alternative response
  • Authentication requirements
  • Transaction requirements
  • Location of Web Script description document


Package: /org/alfresco

Javascript Debugger

Javascript Debugger.

GET /alfresco/service/api/javascript/debugger

Requirements:

  • Default Format: html
  • Authentication: admin
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/jsdebugger.get
  • Description: classpath:alfresco/webscripts/org/alfresco/jsdebugger.get.desc.xml

Javascript Debugger Maintenance

Javascript Debugger Maintenance.

POST /alfresco/service/api/javascript/debugger?active={active?}

Requirements:

  • Default Format: html
  • Authentication: admin
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/jsdebugger.post
  • Description: classpath:alfresco/webscripts/org/alfresco/jsdebugger.post.desc.xml

Package: /org/alfresco/cmis

CMIS Test Harness

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)
String args: Enum url, headers or both - dictates how arguments are passed to services (Default: url)
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: *)
.

POST /alfresco/service/api/cmis/test?url={serviceUrl}&user={user?}&args={args?}&validate={validate?}&trace={trace?}&tests={tests?}

Requirements:

  • Default Format: text
  • Authentication: none
  • Transaction: none
  • Format Style: any

Definition:

  • Id: org/alfresco/cmis/test.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/cmis/test.post.desc.xml

Package: /org/alfresco/repository

Login

Login and establish a ticket.
Input

u</dt>
cleartext username (must be URL encoded)</dd>
pw</dt>
cleartext password (must be URL encoded)</dd>

Returns the new authentication ticket.

GET /alfresco/service/api/login?u={username}&pw={password?}

Requirements:

  • Default Format: xml
  • Authentication: none
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/login.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/login.get.desc.xml

Example:

  • Demonstration of how to call this from a POJO
    • JSON Input
       {
           "username" : "myuser",
           "password" : "mypassword"
       }
    • POJO to call the service
       @POST
       @Consumes("application/x-www-form-urlencoded")
       @Produces("application/json")
       @Path("/login")
       public String doLogin(MultivaluedMap<String, String> getParams) throws HttpException, IOException {
      	    HttpClientParams params = createClientParams(getParams);
      	    HttpClient client = buildClient(params.getParameter("username"), params.getParameter("password"));
      
           //replace the host name and port with the your host and port.
      	    PostMethod method = new PostMethod("http://<hostname>:<port>/alfresco/service/api/login");
      		
      	    String input = "{ \"username\" : \"" + params.getParameter("username") +"\", \"password\" : \"" + params.getParameter("password") +"\" }";
      	    method.setRequestEntity(new StringRequestEntity(input,"application/json", null));
      	    int statusCode = client.executeMethod(method);
      
      	    if (statusCode != HttpStatus.SC_OK) {
      		System.err.println("Method failed: " + method.getStatusLine());
      	    } 
      	    return method.getResponseBodyAsString();
       }

Login (POST)

Login and establish a ticket.
Input
JSON Data Object.

username</dt>
cleartext username</dd>
password</dt>
cleartext password</dd>

Returns the new authentication ticket.

POST /alfresco/service/api/login

Requirements:

  • Default Format: json
  • Authentication: none
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/login.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/login.post.desc.xml

Sample post data:

   {
     "username" : "admin",
     "password" : "mypassword"
   }

Logout

Logout, Delete Login Ticket.
After the user has logged out the ticket is no longer valid and subsequent attempts to use it will fail.

DELETE /alfresco/service/api/login/ticket/{ticket}

Requirements:

  • Default Format: xml
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/loginticket.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/loginticket.delete.desc.xml

Notes:

  • User authentication (as mentioned above) means here: "Normal" http user authentication using username and password. If you are using Java, this means using PasswordAuthentication class.
  • And Default Format here means Default output format (no input parameters via POST allowed here).

Validate Login 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)
.
GET /alfresco/service/api/login/ticket/{ticket}

Requirements:

  • Default Format: xml
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/loginticket.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/loginticket.get.desc.xml

Repository AtomPub Service Document (getRepositoryInfo)

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.

GET /alfresco/service/api/repository
GET /alfresco/service/api/cmis

Requirements:

  • Default Format: atom
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/repository.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/repository.get.desc.xml

Package: /org/alfresco/repository/activities

Activity Type Template

Get the activity type template.

GET /alfresco/service/api/activities/template/{path}
GET /alfresco/service/api/activities/template/{path}?format=text

Requirements:

  • Default Format: text
  • Authentication: admin
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/activities/template.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/template.get.desc.xml

Activity Template Paths

Get a collection of the 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

Requirements:

  • Default Format: json
  • Authentication: admin
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/activities/templates.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/templates.get.desc.xml

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

Activities Site Feed Web Script

Allow currently logged in user to get feed for specified site (if private site then user must be a member or an admin user).

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

Requirements:

  • Default Format: atomfeed
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/activities/feed/sitefeed.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/sitefeed.get.desc.xml

Activities Admin User Feed Web Script

Allow admin to get feed for a specified user.

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}?format=rss
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}&format=rss

Requirements:

  • Default Format: atomfeed
  • Authentication: admin
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/activities/feed/userfeed-admin.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/userfeed-admin.get.desc.xml

Activities User Feed Web Script

Allow currently logged in user to get their feed.

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?format=rss
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}&format=rss

Requirements:

  • Default Format: atomfeed
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/activities/feed/userfeed.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/userfeed.get.desc.xml

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

Activity User Feed Controls

Unset activity feed control (opt-out) for currently logged in user.

DELETE /alfresco/service/api/activities/feed/control?s={siteId}&a={appToolId}
DELETE /alfresco/service/api/activities/feed/control?s={siteId}&a={appToolId}&format=json

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/activities/feed/control/userfeed-control.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/control/userfeed-control.delete.desc.xml

Activity User Feed Controls

Set activity feed control (opt-out) for currently logged in user.

POST /alfresco/service/api/activities/feed/control
POST /alfresco/service/api/activities/feed/control?format=json

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/activities/feed/control/userfeed-control.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/control/userfeed-control.post.desc.xml

Activity User Feed Controls

Get the activity feed controls (opt-outs) for currently logged in user.

GET /alfresco/service/api/activities/feed/controls
GET /alfresco/service/api/activities/feed/controls?format=json

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/activities/feed/control/userfeed-controls.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/activities/feed/control/userfeed-controls.get.desc.xml

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

Blog

Get the blog information.

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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/blog/blog.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/blog/blog.get.desc.xml

Blog

Updates a 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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/blog/blog.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/blog/blog.put.desc.xml

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

Blog post publishing

Performs external blog publishing functions on a blog post.

POST /alfresco/service/api/blog/post/site/{site}/{container}/{path}/publishing
POST /alfresco/service/api/blog/post/node/{store_type}/{store_id}/{id}/publishing

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/post/blog-post-publishing.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/post/blog-post-publishing.post.desc.xml

Blog post

Delete a blog post.

DELETE /alfresco/service/api/blog/post/site/{site}/{container}/{path}
DELETE /alfresco/service/api/blog/post/node/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/post/blog-post.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/post/blog-post.delete.desc.xml

Blogs

Get all blogs.

GET /alfresco/service/api/blog/post/site/{site}/{container}/{path}
GET /alfresco/service/api/blog/post/node/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/post/blog-post.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/post/blog-post.get.desc.xml

Blog post

Updates a blog post.

PUT /alfresco/service/api/blog/post/site/{site}/{container}/{path}
PUT /alfresco/service/api/blog/post/node/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/post/blog-post.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/post/blog-post.put.desc.xml

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

Blog posts

Get all posts for a blog.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/posts/blog-posts-mydrafts.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts-mydrafts.get.desc.xml

Blog posts

Get all posts for a blog.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/posts/blog-posts-mypublished.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts-mypublished.get.desc.xml

Blog posts

Get all posts for a blog.

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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/posts/blog-posts-new.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts-new.get.desc.xml

Blog posts per month

Get all months for which there are blog posts plus the number of posts in each.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/posts/blog-posts-per-month.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts-per-month.get.desc.xml

Blog posts

Get all posts for a blog.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/posts/blog-posts-publishedext.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts-publishedext.get.desc.xml

Blog posts

Get all posts for a blog.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/posts/blog-posts.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts.get.desc.xml

Blog posts

Creates a new blog post.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/blogs/posts/blog-posts.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/blogs/posts/blog-posts.post.desc.xml

Package: /org/alfresco/repository/comments

Comment

Delete a comment.

DELETE /alfresco/service/api/comment/node/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/comments/comment.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/comments/comment.delete.desc.xml

Comment

Get the data for a comment.

GET /alfresco/service/api/comment/node/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/comments/comment.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/comments/comment.get.desc.xml

Comment

Updates a comment.

PUT /alfresco/service/api/comment/node/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/comments/comment.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/comments/comment.put.desc.xml

Comments

Get all comments for a node.

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/comments

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/comments/comments.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/comments/comments.get.desc.xml

Comments

Add a new comment to a node.

POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/comments

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/comments/comments.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/comments/comments.post.desc.xml

Package: /org/alfresco/repository/dictionary

Get Association Definitions

Get the collection of association definitions.

GET /alfresco/service/api/classes/{classname}/association/{assocname}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/dictionary/getassociationdef.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getassociationdef.get.desc.xml

Get Association Definitions

Get the collection of association definitions for a given classname.

GET /alfresco/service/api/classes/{classname}/associations?af={associationFilter?}&nsp={namespacePrefix?}&n={name?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/dictionary/getassociationdefs.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getassociationdefs.get.desc.xml

Get Child Association Definitions

NOTE: removed in V3.3.

Get the collection of child association definitions.

GET /alfresco/service/api/classes/{classname}/childassociation/{assocname}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/dictionary/getchildassoc.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getchildassoc.get.desc.xml

Get Child Assocation Definitions

NOTE: removed in V3.3.

Get the collection of child association definitions for a given classname.

GET /alfresco/service/api/classes/{classname}/childassociations

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/dictionary/getchildassocs.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getchildassocs.get.desc.xml

Get Class Definitions

Get the collection of class definitions - parameters classfilter , namespaceprefix and name.

GET /alfresco/service/api/classes?cf={classFilter?}&nsp={namespacePrefix?}&n={name?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/dictionary/getclassdetail.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getclassdetail.get.desc.xml

Get Class Definitions

Get the collection of class definitions for a given classname.

GET /alfresco/service/api/classes/{className}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/dictionary/getclassdetails.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getclassdetails.get.desc.xml

Get Property Definitions

Get the collection of property definitions.

GET /alfresco/service/api/classes/{classname}/properties?nsp={namespacePrefix?}&n={name?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/dictionary/getproperties.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getproperties.get.desc.xml

Get Property Definitions

Get the collection of property definitions for a given classname and property name.

GET /alfresco/service/api/classes/{classname}/property/{propname}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/dictionary/getproperty.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getproperty.get.desc.xml

Get Sub Class Definitions

Get the collection of sub classes definitions - parameters r=> recursive, classfilter , namespaceprefix and name.

GET /alfresco/service/api/classes/{classname}/subclasses?r={recursive?}&nsp={namespacePrefix?}&n={name?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/dictionary/getsubclassesdef.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/dictionary/getsubclassesdef.get.desc.xml

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

Forum posts

Get the new 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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/discussions/forum/forum-posts-hot.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/forum/forum-posts-hot.get.desc.xml

Forum my posts

Get the forum posts created by the current user.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/discussions/forum/forum-posts-mine.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/forum/forum-posts-mine.get.desc.xml

Forum posts

Get the new 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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/discussions/forum/forum-posts-new.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/forum/forum-posts-new.get.desc.xml

Forum posts

Get the 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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/discussions/forum/forum-posts.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/forum/forum-posts.get.desc.xml

Forum posts

Adds a post to a forum.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/discussions/forum/forum-posts.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/forum/forum-posts.post.desc.xml

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

Forum post replies

Get the forum posts.

GET /alfresco/service/api/forum/post/site/{site}/{container}/{path}/replies
GET /alfresco/service/api/forum/post/node/{store_type}/{store_id}/{id}/replies

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/discussions/posts/forum-post-replies.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/posts/forum-post-replies.get.desc.xml

Forum post replies

Adds a reply to a post.

POST /alfresco/service/api/forum/post/node/{store_type}/{store_id}/{id}/replies

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/discussions/posts/forum-post-replies.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/posts/forum-post-replies.post.desc.xml

Topic

Delete a topic.

DELETE /alfresco/service/api/forum/post/site/{site}/{container}/{path}
DELETE /alfresco/service/api/forum/post/node/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/discussions/posts/forum-post.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/posts/forum-post.delete.desc.xml

Topic

Get the details for a topic.

GET /alfresco/service/api/forum/post/site/{site}/{container}/{path}
GET /alfresco/service/api/forum/post/node/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/discussions/posts/forum-post.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/posts/forum-post.get.desc.xml

Topic

Update a topic.

PUT /alfresco/service/api/forum/post/site/{site}/{container}/{path}
PUT /alfresco/service/api/forum/post/node/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/discussions/posts/forum-post.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/discussions/posts/forum-post.put.desc.xml

Package: /org/alfresco/repository/invite

Invite by ticket

Returns invite information for a given inviteId and inviteTicket. No authentication is required.

GET /alfresco/service/api/invite/{inviteId}/{inviteTicket}

Requirements:

  • Default Format: json
  • Authentication: none
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/invite/invite-by-ticket.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/invite/invite-by-ticket.get.desc.xml

Invite

Processes Inviter actions ('start' or 'cancel' 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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/invite/invite.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/invite/invite.get.desc.xml

Invite accept

Accepts an invite.

PUT /alfresco/service/api/invite/{inviteId}/{inviteTicket}/{action}

Requirements:

  • Default Format: json
  • Authentication: none
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/invite/inviteresponse.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/invite/inviteresponse.put.desc.xml

Invites

Returns pending invites filtered by Inviter user name, Invitee user name & Site short name.

GET /alfresco/service/api/invites?inviterUserName={inviterUserName?}&inviteeUserName={inviteeUserName?}&siteShortName={siteShortName?}
GET /alfresco/service/api/invites?inviteId={inviteId}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/invite/invites.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/invite/invites.get.desc.xml

Package: /org/alfresco/repository/links

Link delete

Delete a link.

POST /alfresco/service/api/links/delete/site/{site}/{container}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/links/links-delete.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/links/links-delete.post.desc.xml

Links

Get all links.

GET /alfresco/service/api/links/site/{site}/{container}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/links/links.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/links/links.get.desc.xml

post

post.

POST /alfresco/service/api/links/site/{site}/{container}/posts

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/links/links.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/links/links.post.desc.xml

Link update

Updates a link.

PUT /alfresco/service/api/links/site/{site}/{container}/{path}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/links/links.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/links/links.put.desc.xml

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

Links

Get all links.

GET /alfresco/service/api/links/link/site/{site}/{container}/{path}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/links/link/link.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/links/link/link.get.desc.xml

Package: /org/alfresco/repository/metadata

Node Metadata Retrieval Service

Node Metadata Retrieval Service.

GET /alfresco/service/api/metadata

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/metadata/metadata.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/metadata/metadata.get.desc.xml

Node Metadata Storage Service

Node Metadata Storage Service.

POST /alfresco/service/api/metadata/node/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/metadata/metadata.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/metadata/metadata.post.desc.xml

Package: /org/alfresco/repository/person

Update User Password

Update the password of a current user - can only be executed for the current user or by an admin to update any user.

POST /alfresco/service/api/person/changepassword/{userName}

Inputs:

  • UserName String userName
  • Old Password String oldpw
  • New Password String newpw


Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/person/changepassword.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/person/changepassword.post.desc.xml

Get People

Get collection of people stored in the repository. This can optionally be filtered according to some given filter query string.

GET /alfresco/service/api/people?filter={filterQuery?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/person/people.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/person/people.get.desc.xml

Add Person

Adds a new person based on the details provided.

POST /alfresco/service/api/people

Requirements:

  • Default Format: json
  • Authentication: admin
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/person/people.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/person/people.post.desc.xml

Delete Person

Delete a person.

DELETE /alfresco/service/api/people/{userName}

Requirements:

  • Default Format: json
  • Authentication: admin
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/person/person.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/person/person.delete.desc.xml

Get Person

Get the details of a person.

GET /alfresco/service/api/people/{userName}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/person/person.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/person/person.get.desc.xml

Update Person

Update the details of a person.

PUT /alfresco/service/api/people/{userName}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/person/person.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/person/person.put.desc.xml

Sites

Get a colleciton of the sites a person has an explicit member to.

GET /alfresco/service/api/people/{userid}/sites?size={pagesize?}&pos={position?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/person/person.sites.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/person/person.sites.get.desc.xml

Package: /org/alfresco/repository/preference

Preferences

Delete a users preferences.

DELETE /alfresco/service/api/people/{userid}/preferences?pf={preferencefilter?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/preference/preferences.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/preference/preferences.delete.desc.xml

Preferences

Get the preferences for a user.

GET /alfresco/service/api/people/{userid}/preferences?pf={preferencefilter?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/preference/preferences.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/preference/preferences.get.desc.xml

Preferences

Set a users preferences.

POST /alfresco/service/api/people/{userid}/preferences

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/preference/preferences.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/preference/preferences.post.desc.xml

Package: /org/alfresco/repository/rule

Get Action Definition

Get an action definition given its name.

GET /alfresco/service/api/rules/actiondefs/{actionDefinitionName}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/actiondef.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/actiondef.get.desc.xml

Get Action Definitions

Get the collection of action definitions, optionally scoped by node reference or path.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/actiondefs.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/actiondefs.get.desc.xml

Add to Action Queue

Add an Action Queue Item to the Action Queue for execution.

POST /alfresco/service/api/actionqueue

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/actionqueue.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/actionqueue.post.desc.xml

Get Condition Definition

Get a condition definition given its name.

GET /alfresco/service/api/rules/conditiondefs/{conditionDefinitionName}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/conditiondef.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/conditiondef.get.desc.xml

Get Condition Definitions

Get the collection of condition definitions.

GET /alfresco/service/api/rules/conditiondefs

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/conditiondefs.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/conditiondefs.get.desc.xml

Delete Rule

Delete the rule identified by the specified rule node id.

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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/rule.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rule.delete.desc.xml

Get Rule

Get the rule identified by the specified rule node reference.

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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/rule.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rule.get.desc.xml

Put Rule

Update the rule identified by the specified rule node reference.

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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/rule.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rule.put.desc.xml

Delete Rules

Delete the collection of rules which have been applied to the given rule owning node node.

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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/rules.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rules.delete.desc.xml

Get Rules

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.

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?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/rules.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rules.get.desc.xml

Create Rule

Creates a rule in the rule collection associated with the given actionable node.

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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/rule/rules.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/rule/rules.post.desc.xml

Package: /org/alfresco/repository/search

Issue ad-hoc query (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.
.

POST /alfresco/service/api/query

Requirements:

  • Default Format: atomfeed
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/search/query.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/search/query.post.desc.xml

Package: /org/alfresco/repository/site

Site

Delete the details of a site.

DELETE /alfresco/service/api/sites/{shortname}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/site/site.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.delete.desc.xml

Site

Get the details of a site.

GET /alfresco/service/api/sites/{shortname}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/site/site.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.get.desc.xml

Site

Update the details of a site.

PUT /alfresco/service/api/sites/{shortname}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/site/site.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/site.put.desc.xml

Sites

Get a colleciton of the sites in the repository. The collection can be filtered by name and/or site preset.

GET /alfresco/service/api/sites?nf={namefilter?}&spf={sitepresetfilter?}&size={pagesize?}&pos={position?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/site/sites.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/sites.get.desc.xml

Sites

Creates a new site based on the site preset and details provided.

POST /alfresco/service/api/sites

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/site/sites.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/sites.post.desc.xml

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

Membership

Get the membership details for a user.

DELETE /alfresco/service/api/sites/{shortname}/memberships/{username}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/site/membership/membership.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/membership.delete.desc.xml

Membership

Get the membership details for a user.

GET /alfresco/service/api/sites/{shortname}/memberships/{username}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/site/membership/membership.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/membership.get.desc.xml

Membership

Get the membership details for a user.

PUT /alfresco/service/api/sites/{shortname}/memberships/{username}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/site/membership/membership.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/membership.put.desc.xml

Memberships

Get a colleciton of a sites memberships.

GET /alfresco/service/api/sites/{shortname}/memberships?nf={namefilter?}&rf={rolefilter?}&size={pagesize?}&pos={position?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/site/membership/memberships.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/memberships.get.desc.xml

Memberships

Adds a new membership to the site.

POST /alfresco/service/api/sites/{shortname}/memberships

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/site/membership/memberships.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/membership/memberships.post.desc.xml

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

Roles

Get the authority roles of a site.

GET /alfresco/service/api/sites/{shortname}/roles

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/site/roles/roles.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/site/roles/roles.get.desc.xml

Package: /org/alfresco/repository/store

Checked-out Documents (getCheckedoutDocuments)

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

GET /alfresco/service/api/checkedout?folderId={folderId?}&includeDescendants={includeDescendants?}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}

Requirements:

  • Default Format: atomfeed
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/checkedout.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/checkedout.get.desc.xml

Checkout a document (checkOut)

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().
.

POST /alfresco/service/api/checkedout

Requirements:

  • Default Format: atomentry
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/checkedout.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/checkedout.post.desc.xml

Retrieve list of children (getChildren)

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

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/children?types={types}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/children?types={types}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}

Requirements:

  • Default Format: atomfeed
  • Authentication: guest
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/store/children.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/children.get.desc.xml

Create folder or document (createDocument, createFolder)

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

POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/children
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/children

Requirements:

  • Default Format: atomentry
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/children.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/children.post.desc.xml

Content Retrieval (getContent)

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

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?}

Requirements:

  • Default Format: Determined at run-time
  • Authentication: guest
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/store/content.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/content.get.desc.xml

Delete tree (deleteTree)

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).
.

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}

Requirements:

  • Default Format: atomfeed
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/descendants.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/descendants.delete.desc.xml

Retrieve tree of descendants (getDescendants)

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.

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants?types={types}&filter={filter?}&depth={depth?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/descendants?types={types}&filter={filter?}&depth={depth?}

Requirements:

  • Default Format: atomfeed
  • Authentication: guest
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/store/descendants.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/descendants.get.desc.xml

Create folder or document (createDocument, createFolder)

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

POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/descendants

Requirements:

  • Default Format: atomentry
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/descendants.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/descendants.post.desc.xml

Delete item (deleteObject)

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

DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}?includeChildren={includeChildren?}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{id}?includeChildren={includeChildren?}

Requirements:

  • Default Format: atomentry
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/item.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.delete.desc.xml

Retrieve properties (getProperties)

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)
.

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}?filter={filter?}&returnVersion={returnVersion?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}?filter={filter?}&returnVersion={returnVersion?}

Requirements:

  • Default Format: atomentry
  • Authentication: guest
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/store/item.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.get.desc.xml

Update properties (updateProperties)

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

PUT /alfresco/service/api/node/{store_type}/{store_id}/{id}
PUT /alfresco/service/api/path/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: atomentry
  • Authentication: user
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/store/item.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/item.put.desc.xml

Retrieve Parent Folder (getFolderParent)

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

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/parent?returnToRoot={returnToRoot}&filter={filter?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/parent?returnToRoot={returnToRoot}&filter={filter?}

Requirements:

  • Default Format: atomfeed
  • Authentication: guest
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/store/parent.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/parent.get.desc.xml

Retrieve Parent Folders (getObjectParents)

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

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/parents?filter={filter?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/parents?filter={filter?}

Requirements:

  • Default Format: atomfeed
  • Authentication: guest
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/store/parents.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/parents.get.desc.xml

Cancel Checkout (cancelCheckout)

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
.

DELETE /alfresco/service/api/pwc/{store_type}/{store_id}/{id}

Requirements:

  • Default Format: atomentry
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/pwc.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/pwc.delete.desc.xml

Retrieve properties of PWC

Retrieves the properties of a private working copy.

GET /alfresco/service/api/pwc/{store_type}/{store_id}/{id}?filter={filter?}

Requirements:

  • Default Format: atomentry
  • Authentication: user
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/store/pwc.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/pwc.get.desc.xml

Checkin Private Working Copy (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.
.

PUT /alfresco/service/api/pwc/{store_type}/{store_id}/{id}?checkinComment={checkinComment?}&major={major?}&checkin={checkin?}

Requirements:

  • Default Format: atomentry
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/pwc.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/pwc.put.desc.xml

Retrieve a Type (getTypeDefinition)

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.
<Array> 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.

GET /alfresco/service/api/type/{typeId}?includeInheritedProperties={includeInheritedProperties?}

Requirements:

  • Default Format: atomentry
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/type.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/type.get.desc.xml

Retrieve list of child Types

Retrieve list of all child Types.

GET /alfresco/service/api/type/{typeId}/children?includePropertyDefinitions={includePropertyDefinitions?}&skipCount={skipCount?}&maxItems={maxItems?}

Requirements:

  • Default Format: atomfeed
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/typechildren.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/typechildren.get.desc.xml

Retrieve list of descendant Types

Retrieve list of all descendant Types.

GET /alfresco/service/api/type/{typeId}/descendants?includePropertyDefinitions={includePropertyDefinitions?}&skipCount={skipCount?}&maxItems={maxItems?}

Requirements:

  • Default Format: atomfeed
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/typedescendants.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/typedescendants.get.desc.xml

Retrieve list of all Types (getTypes)

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.

GET /alfresco/service/api/types?type={type?}&includePropertyDefinitions={includePropertyDefinitions?}&skipCount={skipCount?}&maxItems={maxItems?}

Requirements:

  • Default Format: atomfeed
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/types.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/types.get.desc.xml

Unfiled Documents

Retrieve list of documents that are not in any folder.

GET /alfresco/service/api/unfiled

Requirements:

  • Default Format: atomfeed
  • Authentication: guest
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/store/unfiled.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/unfiled.get.desc.xml

Retrieve all versions (getAllVersions)

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

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?}

Requirements:

  • Default Format: atomfeed
  • Authentication: user
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/store/versions.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/versions.get.desc.xml

Package: /org/alfresco/repository/tagging

Get Node Tags

Get all the tags for a node
Returns STATUS_OK (200).

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/tags
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/tags

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/tagging/node.tags.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/node.tags.get.desc.xml

Add tag

Add one or more tags to the node
Input:
(mandatory) array of String
Returns the array of tags
Return STATUS_OK (200).

POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/tags
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/tags

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/tagging/node.tags.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/node.tags.post.desc.xml

List all tags

Get the currently available tags for the specified store.

tag_filter</dt>
The optional tag filter limits the returned tags to those containing the filter. </dd>
.

GET /alfresco/service/api/tags/{store_type}/{store_id}?tf={tag_filter?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/tagging/tags.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/tags.get.desc.xml

Get nodes for tag

Get the nodes which have a given tag
Return content
Array of
  • nodeRef
  • url

Return status: STATUS_OK, 200.
GET /alfresco/service/api/tags/{store_type}/{store_id}/{tag}/nodes

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/tagging/tags.nodes.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/tags.nodes.get.desc.xml

Tagscope tags

Get all tags of the nearest available tagscope.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/tagging/tagscope-tags.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/tagging/tagscope-tags.get.desc.xml

Package: /org/alfresco/repository/thumbnail

Thumbnails

Delete a thumbnail for a content resource.

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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/thumbnail/thumbnail.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnail.delete.desc.xml

Thumbnails

Get a named thumbnail for a content resource.

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}/thumbnails/{thumbnailname}?qc={queuecreate?}&fc={forcecreate?}&ph={placeholder?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}/thumbnails/{thumbnailname}?qc={queuecreate?}&fc={forcecreate?}&ph={placeholder?}

Requirements:

  • Default Format: Determined at run-time
  • Authentication: user
  • Transaction: required
  • Format Style: argument

Definition:

  • Id: org/alfresco/repository/thumbnail/thumbnail.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnail.get.desc.xml

Thumbnails

Update a thumbnail for a content resource.

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}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/thumbnail/thumbnail.put
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnail.put.desc.xml

ThumbnailsDefinitions

Get the thumbnails definitions for a content resource.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/thumbnail/thumbnaildefinitions.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnaildefinitions.get.desc.xml

Thumbnails

Get the thumbnails for a content resource.

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

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/thumbnail/thumbnails.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnails.get.desc.xml

Thumbnails

Create a new thumbnail for a content resource.

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?}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/thumbnail/thumbnails.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/thumbnail/thumbnails.post.desc.xml

Package: /org/alfresco/repository/upload

File 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).
POST /alfresco/service/api/upload

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/upload/upload.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/upload/upload.post.desc.xml

Package: /org/alfresco/repository/version

Revert Version Info

Revert Version Info.

POST /alfresco/service/api/revert

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/version/revert.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/version/revert.post.desc.xml

Node Version Info

Node Version Info.

GET /alfresco/service/api/version

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/version/version.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/version/version.get.desc.xml

Package: /org/alfresco/repository/wcm

Delete Web Project

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.

DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/wcm/webproject.delete
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.delete.desc.xml

Get Web Project

Get a single WCM web project in JSON format.

GET /alfresco/service/api/wcm/webprojects/{webprojectref}

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/wcm/webproject.get
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.get.desc.xml

Create Web Project

Create (POST) a single WCM web project.
The following fields are required in the body of the request:

name</dt>
Human readable name for the web project.</dd>
title</dt>
Human readable title for the web project.</dd>
dnsName</dt>
The name of the web project which will become part of the URL. Should be short and unique.</dd>

The following fields are optional:
description</dt>
description about the web project</dd>

Returns 201, STATUS_CREATED on success. The body of the return will contain the new Web Project.

POST /alfresco/service/api/wcm/webprojects

Requirements:

  • Default Format: json
  • Authentication: user
  • Transaction: required
  • Format Style: any

Definition:

  • Id: org/alfresco/repository/wcm/webproject.post
  • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.post.desc.xml

Update Web Project

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.
      PUT /alfresco/service/api/wcm/webprojects/{webprojectref}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/webproject.put
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webproject.put.desc.xml

      Web Projects

      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.

      GET /alfresco/service/api/wcm/webprojects?userName={userName?}
      GET /alfresco/service/api/wcm/webprojects
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/webprojects.get
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/webprojects.get.desc.xml

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

      Delete Web Project Membership

      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.

      DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships/{username}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/membership/membership.delete
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/membership.delete.desc.xml

      Get Membership

      Get the webproject membership details for a user.

      GET /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships/{username}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/membership/membership.get
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/membership.get.desc.xml

      List Memberships

      Get the collection of a web project memberships for a web project.

      GET /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/membership/memberships.get
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/memberships.get.desc.xml

      Add user to web project

      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</dt>
      The role that the person should have</dd>
      person</dt>
      Details of the person.</dd>

      Returns 200, STATUS_OK.

      POST /alfresco/service/api/wcm/webprojects/{webprojectref}/memberships
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/membership/memberships.post
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/membership/memberships.post.desc.xml

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

      Delete Sandbox

      Deletes a WCM sandbox and all its contents.

      DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxRef}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/sandbox.delete
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandbox.delete.desc.xml

      Get Web Project Sandbox

      Get details of single sandbox of a web project. Return
       data: sandboxref name creator createdDate.iso8601 storeNames" : [ ] isAuthorSandbox isStagingSandbox url 
      Returns STATUS_OK, 200.
      GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/sandbox.get
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandbox.get.desc.xml

      Create user sandbox

      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.
      POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/sandbox.post
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/sandbox.post.desc.xml

      Web Project Sandboxes

      Get a collection of a web project sandboxes.
      If userName is specified then returns the sandboxes for the specified user.

      GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes?userName={userName?}
      GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/sandboxes.get
      • Description: 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 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.

      DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
      DELETE /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: argument

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/Asset/asset.delete
      • Description: 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 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 .

      GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
      GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: argument

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/Asset/asset.get
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.get.desc.xml

      Create a new WCM asset.

      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</dt>
      mandatory name of this asset</dd>
      type</dt>
      mandatory "file" or "folder"</dd>
      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.</dd>
      JSON Return value:
       data:The newly created asset in JSON format. 
      .
      POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
      POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: argument

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/Asset/asset.post
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.post.desc.xml

      Update a WCM asset.

      Update a WCM Asset, you can rename or move an asset.
      JSON Input properties

      name</dt>
      optional rename this file or folder to this new name</dd>
      path</dt>
      optional move this file or folder to this path. The destination folder must already exist.</dd>

      JSON Return data:.

      PUT /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}
      PUT /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/assets/{path}?webApp={webApp?}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: argument

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/Asset/asset.put
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/asset.put.desc.xml

      Get modified assets within the specified sandbox.

      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.

      GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/modified
      GET /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/modified?webApp={webApp?}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/Asset/modified.get
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/modified.get.desc.xml

      Revert modified assets within the specified author sandbox.

      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</dt>
      boolean is this submit all? (optional)</dd>
      assets
      array, of JSON objects containing a path property (optional). If the "all" option is true then this parameter is ignored</dd>
      paths
      array, of String paths. If the "all" option is true then this parameter is ignored</dd>
      .

      POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/reverter
      POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/reverter?webApp={webApp?}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/Asset/revert.post
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/revert.post.desc.xml

      Submit modified assets from within the specified author sandbox.

      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 fields:

      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

      POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/submitter
      POST /alfresco/service/api/wcm/webprojects/{webprojectref}/sandboxes/{sandboxref}/submitter?webApp={webApp?}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/wcm/sandbox/Asset/submit.post
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/wcm/sandbox/Asset/submit.post.desc.xml

      Package: /org/alfresco/repository/workflow

      End Workflow Task

      Ends a task for an in-flight workflow with the passed-in transition or the default.

      POST /alfresco/service/api/workflow/task/end/{taskId}/{transitionId}
      POST /alfresco/service/api/workflow/task/end/{taskId}
      

      Requirements:

      • Default Format: json
      • Authentication: user
      • Transaction: required
      • Format Style: any

      Definition:

      • Id: org/alfresco/repository/workflow/end-task.post
      • Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/workflow/end-task.post.desc.xml
Personal tools
Download and go
© 2014 Alfresco Software, Inc. All Rights Reserved. Legal | Privacy | Accessibility