Alfresco public REST APIs

Document created by janv Employee on Dec 1, 2016Last modified by janv Employee on Aug 25, 2017
Version 37Show Document
  • View in full screen mode

As a follow-on to the original question Have you tried the new v1 REST APIs yet ? this document is intended to act as a quick start with links to useful resources. 


Have you had a chance to download the latest Alfresco Community Edition 201707 GA Release and try them out ?


Alfresco public APIs cover Content, Search, Governance & Process Services.


The incremental new public v1 REST APIs introduce features for managing nodes, people, groups, sites, shared-links (... and much more ...) as well built-in queries and new advanced search api for Solr. This is in addition to existing collaborative features, such as favourites, comments, ratings, tags & activities.


We would really appreciate your early feedback. Please comment here or in the forums. If you would like to suggest improvements or see any issues then please feel free to post a separate question or log an issue in JIRA (if repeatable).


Presentations (and slides)

Exciting new Alfresco APIs - YouTube (=> slides ) (BeeCon - Apr 2017)

Developing applications against Alfresco’s unified REST APIs - YouTube (=> slides) (BeeCon - Apr 2017)

Records Management: the API story - YouTube (=> slides) (BeeCon - Apr 2017)


Alfresco 5.2 REST API (London - Mar 2017)

Tech Talk Live #102: REST APIs v1.0 - YouTube (=> slides ) (Feb 2017)

Alfresco Day Vienna 2016: Alfrescos neue Rest API (Vienna - Dec 2016)

REST API Introduction - YouTube (Nov 2016)

REST API of the future - YouTube (=> slides ) (BeeCon - Apr 2016)

Tech Talk Live #93 - The Future of REST APIs - YouTube (=> slides ) (Jan 2016)




Introduction - REST API & CMIS


Live API Explorer (with "Try it now!" option)

  • alternatively, you can also deploy the appropriate version of the API Explorer (war) to your running Tomcat instance.


Blog Posts & Tutorials


Gavin Cornwell's excellent series for Alfresco v1 REST API - Content & Search Services

Part 1 - Introduction 

Part 2 - Navigation 

Part 3 - Creating Nodes 

Part 4 - Managing Nodes 

Part 5 - Versioning & Locking 

Part 6 - Associations 

Part 7 - Collaboration (Comments, Ratings, Tags, ...) 

Part 8 - Sites

Part 9 - Queries & Search 

Part 10 - People 

Part 11 - Trashcan 

Part 12 - Discovery 

Part 13 - 10 Things You Should Know 


More about the Search API

Structure, Tags, Categories and Query in the public API 

Query Templates in Share and the Public API 

Alfresco Search Services 1.1.0 


Governance Services - GS API Explorer & GS Core REST APIs

Records Management Community 2.6.a 


Client-side SDK & Libraries


JavaScript Client Library (used by ADF - see below)


Developing a simple JavaScript client using the Alfresco REST API (5 part tutorial)

1. Defining the development environment.

2. Authenticating over Alfresco using the Alfresco REST API.

3. Introducing the JavaScript client to list nodes.

4. How to upload new content.

5. How to preview the content.


Java Client Library (EA)


Alfresco Java Client SDK (6 part tutorial)

Part 1 Part 2 Part 3Part 4Part 5Part 6 


New experimental work:  (for bringing together Content, Process and Governance Services)


Example Clients & UI components


ADF 101 - Getting Started with Alfresco Application Development Framework 

Announcing Alfresco NG2 Components 

Demo: Alfresco "health-care-app" (dev branch) 


Testing APIs Using React Components 


Other related APIs


Basic example of developing a (custom) Rest API on the Alfresco Platform

6 people found this helpful