From AlfrescoWiki

Back to CMIS.

Contents 1 Introduction 2 Web Script Reference 2.1 Package: /org/alfresco/cmis 2.1.1 Retrieve Allowable Actions 2.1.2 Checked-out Documents (getCheckedoutDocuments) 2.1.3 Checkout a document (checkOut) 2.1.4 Retrieve list of children (getChildren) 2.1.5 Create folder or document (createDocument, createFolder) 2.1.6 CMIS AtomPub Service Document 2.1.7 Content Delete (deleteContent) 2.1.8 Content Retrieval (getContent) 2.1.9 Content Write (setContent) 2.1.10 Delete tree (deleteTree) 2.1.11 Retrieve tree of descendants (getDescendants) 2.1.12 CMIS Index Page 2.1.13 Delete item (deleteObject) 2.1.14 Retrieve properties (getProperties) 2.1.15 Update properties (updateProperties) 2.1.16 Update properties (updateProperties) 2.1.17 Retrieve Parent Folder (getFolderParent) 2.1.18 Retrieve Parent Folders (getObjectParents) 2.1.19 Cancel Checkout (cancelCheckout) 2.1.20 Retrieve properties of PWC 2.1.21 Checkin Private Working Copy (checkin) 2.1.22 Checkin Private Working Copy (checkin) 2.1.23 Issue ad-hoc query (query) 2.1.24 Issue ad-hoc query (query) 2.1.25 Delete relationship (deleteRelationship) 2.1.26 Retrieve relationship (getProperties) 2.1.27 Retrieve list of relationships (getRelationships) 2.1.28 Create relationship (createRelationship) 2.1.29 CMIS Test Harness 2.1.30 Delete tree (deleteTree) 2.1.31 Retrieve folder tree (getFolderTree) 2.1.32 Retrieve a Type (getTypeDefinition) 2.1.33 Retrieve list of child Types 2.1.34 Retrieve list of descendant Types 2.1.35 Unfiled Documents 2.1.36 Retrieve all versions (getAllVersions)

[edit] Introduction

Welcome to the reference documentation for the Alfresco Repository CMIS 1.0 CD04 RESTful API - Community v3.2.0 (r2 @build-number@).

This document was generated on Nov 20, 2009 5:27:31 PM via the Alfresco Repository URI...

http://<host>:<port>/alfresco/service/index/all.mediawiki?package=/org/alfresco/cmis&desc=CMIS 1.0 CD04

NOTE: This document is under construction and the APIs are subject to change while CMIS is still under development.

[edit] 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

[edit] Package: /org/alfresco/cmis

[edit] Retrieve Allowable Actions

Retrieve Allowable Actions.

GET /alfresco/service/cmis/i/{id}/allowableactions
GET /alfresco/service/cmis/s/{store}/i/{id}/allowableactions
GET /alfresco/service/cmis/p{path}/allowableactions
GET /alfresco/service/cmis/s/{store}/p{path}/allowableactions
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/allowableactions
GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/allowableactions

Requirements:

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

Definition:

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

[edit] 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/cmis/checkedout?folderId={folderId?}&includeDescendants={includeDescendants?}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}

Requirements:

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

Definition:

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

[edit] 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/cmis/checkedout

Requirements:

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

Definition:

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

[edit] 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/cmis/i/{id}/children?types={types}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/i/{id}/children?types={types}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/p{path}/children?types={types}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/p{path}/children?types={types}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/children?types={types}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/children?types={types}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}

Requirements:

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

Definition:

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

[edit] 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/cmis/i/{id}/children?sourceFolderId={sourceFolderId}
POST /alfresco/service/cmis/s/{store}/i/{id}/children?sourceFolderId={sourceFolderId}
POST /alfresco/service/cmis/p{path}/children?sourceFolderId={sourceFolderId}
POST /alfresco/service/cmis/s/{store}/p{path}/children?sourceFolderId={sourceFolderId}
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/children?sourceFolderId={sourceFolderId}
POST /alfresco/service/api/path/{store_type}/{store_id}/{path}/children?sourceFolderId={sourceFolderId}

Requirements:

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

Definition:

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

[edit] CMIS AtomPub Service Document

.

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

Requirements:

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

Definition:

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

[edit] Content Delete (deleteContent)

.

DELETE /alfresco/service/cmis/i/{id}/content{property}
DELETE /alfresco/service/cmis/s/{store}/i/{id}/content{property}
DELETE /alfresco/service/cmis/p{path}/content{property}
DELETE /alfresco/service/cmis/s/{store}/p{path}/content{property}
DELETE /alfresco/service/api/node/content{property}/{store_type}/{store_id}/{id}
DELETE /alfresco/service/api/path/content{property}/{store_type}/{store_id}/{id}
DELETE /alfresco/service/api/avmpath/content{property}/{store_id}/{id}
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}

Requirements:

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

Definition:

• Id: org/alfresco/cmis/content.delete
• Description: classpath:alfresco/templates/webscripts/org/alfresco/cmis/content.delete.desc.xml

[edit] 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/cmis/i/{id}/content{property}?a={attach?}
GET /alfresco/service/cmis/s/{store}/i/{id}/content{property}?a={attach?}
GET /alfresco/service/cmis/p{path}/content{property}?a={attach?}
GET /alfresco/service/cmis/s/{store}/p{path}/content{property}?a={attach?}
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}/{path}?a={attach?}
GET /alfresco/service/api/avmpath/content{property}/{store_id}/{avmpath}?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}/{path}/content{property}?a={attach?}

Requirements:

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

Definition:

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

[edit] Content Write (setContent)

TODO.

PUT /alfresco/service/cmis/i/{id}/content{property}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/cmis/s/{store}/i/{id}/content{property}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/cmis/p{path}/content{property}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/cmis/s/{store}/p{path}/content{property}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/node/content{property}/{store_type}/{store_id}/{id}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/path/content{property}/{store_type}/{store_id}/{id}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/avmpath/content{property}/{store_id}/{id}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/node/{store_type}/{store_id}/{id}/content{property}?overwriteFlag={overwriteFlag?}
PUT /alfresco/service/api/path/{store_type}/{store_id}/{id}/content{property}?overwriteFlag={overwriteFlag?}

Requirements:

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

Definition:

• Id: org/alfresco/cmis/content.put
• Description: classpath:alfresco/templates/webscripts/org/alfresco/cmis/content.put.desc.xml

[edit] 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/cmis/i/{id}/descendants?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/cmis/s/{store}/i/{id}/descendants?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/cmis/p{path}/descendants?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/cmis/s/{store}/p{path}/descendants?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{path}/descendants?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}

Requirements:

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

Definition:

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

[edit] 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/cmis/i/{id}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/i/{id}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/p{path}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/p{path}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}

Requirements:

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

Definition:

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

[edit] CMIS Index Page

.

GET /alfresco/service/cmis/index
GET /alfresco/service/cmis/index.html

Requirements:

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

Definition:

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

[edit] 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/cmis/i/{id}?includeChildren={includeChildren?}
DELETE /alfresco/service/cmis/s/{store}/i/{id}?includeChildren={includeChildren?}
DELETE /alfresco/service/cmis/p{path}?includeChildren={includeChildren?}
DELETE /alfresco/service/cmis/s/{store}/p{path}?includeChildren={includeChildren?}
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}?includeChildren={includeChildren?}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{path}?includeChildren={includeChildren?}

Requirements:

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

Definition:

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

[edit] 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/cmis/i/{id}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/i/{id}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/p{path}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/p{path}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/arg/i?id={id}&filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/arg/p?path={path}&filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/arg/n?noderef={noderef}&filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{path}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}

Requirements:

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

Definition:

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

[edit] 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.
.

PATCH /alfresco/service/cmis/i/{id}
PATCH /alfresco/service/cmis/s/{store}/i/{id}
PATCH /alfresco/service/cmis/p{path}
PATCH /alfresco/service/cmis/s/{store}/p{path}
PATCH /alfresco/service/api/node/{store_type}/{store_id}/{id}
PATCH /alfresco/service/api/path/{store_type}/{store_id}/{path}

Requirements:

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

Definition:

• Id: org/alfresco/cmis/item.patch
• Description: classpath:alfresco/templates/webscripts/org/alfresco/cmis/item.patch.desc.xml

[edit] 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/cmis/i/{id}
PUT /alfresco/service/cmis/s/{store}/i/{id}
PUT /alfresco/service/cmis/p{path}
PUT /alfresco/service/cmis/s/{store}/p{path}
PUT /alfresco/service/api/node/{store_type}/{store_id}/{id}
PUT /alfresco/service/api/path/{store_type}/{store_id}/{path}

Requirements:

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

Definition:

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

[edit] Retrieve Parent Folder (getFolderParent)

.

GET /alfresco/service/cmis/i/{id}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/i/{id}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/p{path}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/p{path}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}

Requirements:

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

Definition:

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

[edit] 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/cmis/i/{id}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/i/{id}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/p{path}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/p{path}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}

Requirements:

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

Definition:

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

[edit] 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/cmis/pwc/i/{id}
DELETE /alfresco/service/cmis/pwc/s/{store}/i/{id}

Requirements:

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

Definition:

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

[edit] Retrieve properties of PWC

Retrieves the properties of a private working copy.

GET /alfresco/service/cmis/pwc/i/{id}?filter={filter?}
GET /alfresco/service/cmis/pwc/s/{store}/i/{id}?filter={filter?}

Requirements:

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

Definition:

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

[edit] 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.
.

PATCH /alfresco/service/cmis/pwc/i/{id}?checkinComment={checkinComment?}&major={major?}&checkin={checkin?}
PATCH /alfresco/service/cmis/pwc/s/{store}/i/{id}?checkinComment={checkinComment?}&major={major?}&checkin={checkin?}

Requirements:

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

Definition:

• Id: org/alfresco/cmis/pwc.patch
• Description: classpath:alfresco/templates/webscripts/org/alfresco/cmis/pwc.patch.desc.xml

[edit] 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/cmis/pwc/i/{id}?checkinComment={checkinComment?}&major={major?}&checkin={checkin?}
PUT /alfresco/service/cmis/pwc/s/{store}/i/{id}?checkinComment={checkinComment?}&major={major?}&checkin={checkin?}

Requirements:

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

Definition:

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

[edit] 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/cmis/queries

Requirements:

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

Definition:

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

[edit] 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.
.

GET /alfresco/service/cmis/query?q={q}&includeAllowableActions={includeAllowableActions?}&searchAllVersions={searchAllVersions?}&skipCount={skipCount?}&maxItems={maxItems?}

Requirements:

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

Definition:

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

[edit] Delete relationship (deleteRelationship)

.

DELETE /alfresco/service/cmis/rel/s/{store}/i/{id}/type/{rel_type}/target/s/{target_store}/i/{target_id}

Requirements:

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

Definition:

• Id: org/alfresco/cmis/relationship.delete
• Description: classpath:alfresco/templates/webscripts/org/alfresco/cmis/relationship.delete.desc.xml

[edit] Retrieve relationship (getProperties)

.

GET /alfresco/service/cmis/rel/s/{store}/i/{id}/type/{rel_type}/target/s/{target_store}/i/{target_id}?filter={filter?}&includeAllowableActions={includeAllowableActions?}

Requirements:

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

Definition:

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

[edit] Retrieve list of relationships (getRelationships)

.

GET /alfresco/service/cmis/i/{id}/rels?filter={filter?}&relationshipType={relationshipType?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&direction={direction?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/i/{id}/rels?filter={filter?}&relationshipType={relationshipType?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&direction={direction?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/p{path}/rels?filter={filter?}&relationshipType={relationshipType?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&direction={direction?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/p{path}/rels?filter={filter?}&relationshipType={relationshipType?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&direction={direction?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/rels?filter={filter?}&relationshipType={relationshipType?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&direction={direction?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/rels?filter={filter?}&relationshipType={relationshipType?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&direction={direction?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}

Requirements:

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

Definition:

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

[edit] Create relationship (createRelationship)

.

POST /alfresco/service/cmis/i/{id}/rels
POST /alfresco/service/cmis/s/{store}/i/{id}/rels
POST /alfresco/service/cmis/p{path}/rels
POST /alfresco/service/cmis/s/{store}/p{path}/rels
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/rels
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/rels

Requirements:

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

Definition:

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

[edit] 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)
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/cmis/test?url={serviceUrl}&user={user?}&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

[edit] Delete tree (deleteTree)

.

DELETE /alfresco/service/cmis/i/{id}/tree?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/cmis/s/{store}/i/{id}/tree?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/cmis/p{path}/tree?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/cmis/s/{store}/p{path}/tree?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}/tree?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{path}/tree?continueOnFailure={continueOnFailure?}&unfileMultiFiledDocuments={unfileMultiFiledDocuments}

Requirements:

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

Definition:

• Id: org/alfresco/cmis/tree.delete
• Description: classpath:alfresco/templates/webscripts/org/alfresco/cmis/tree.delete.desc.xml

[edit] Retrieve folder tree (getFolderTree)

.

GET /alfresco/service/cmis/i/{id}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/i/{id}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/p{path}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/cmis/s/{store}/p{path}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}

Requirements:

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

Definition:

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

[edit] 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/cmis/type/{typeId}?includeInheritedProperties={includeInheritedProperties?}

Requirements:

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

Definition:

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

[edit] Retrieve list of child Types

Retrieve list of all child Types.

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

Requirements:

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

Definition:

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

[edit] Retrieve list of descendant Types

Retrieve list of all descendant Types.

GET /alfresco/service/cmis/type/{typeId}/descendants?includePropertyDefinitions={includePropertyDefinitions?}&depth={depth?}
GET /alfresco/service/cmis/types/descendants?typeId={typeId?}&includePropertyDefinitions={includePropertyDefinitions?}&depth={depth?}

Requirements:

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

Definition:

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

[edit] Unfiled Documents

Retrieve list of documents that are not in any folder.

GET /alfresco/service/cmis/unfiled

Requirements:

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

Definition:

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

[edit] 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/cmis/i/{id}/versions?filter={filter?}
GET /alfresco/service/cmis/s/{store}/i/{id}/versions?filter={filter?}
GET /alfresco/service/cmis/p{path}/versions?filter={filter?}
GET /alfresco/service/cmis/s/{store}/p{path}/versions?filter={filter?}
GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/versions?filter={filter?}
GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/versions?filter={filter?}

Requirements:

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

Definition:

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