CMIS Web Scripts Reference

Document created by resplin Employee on Jun 6, 2015
Version 1Show Document
  • View in full screen mode

Obsolete Pages{{Obsolete}}

The official documentation is at: http://docs.alfresco.com



CMIS
3.3

Back to CMIS.



Note: This document was generated on Apr 1, 2010 12:59:43 PM from Alfresco Community v3.3.0 (dev @build-number@).




Table of Contents


Alfresco CMIS AtomPub Binding


The Content Management Interoperability Services (CMIS) standard defines a domain model and set of bindings that include Web Services and ReSTful AtomPub that
can be used by applications to work with one or more Content Management repositories/systems. The CMIS interface is designed to be layered on top of existing
Content Management systems and their existing programmatic interfaces. It is not intended to prescribe how specific features should be implemented within those
CM systems, nor to exhaustively expose all of the CM system’s capabilities through the CMIS interfaces. Rather, it is intended to define a generic/universal set
of capabilities provided by a CM system and a set of services for working with those capabilities.



For a full description of the domain model and binding see the CMIS specification.



This Web Scripts package provides the Alfresco implementation of the CMIS AtomPub binding. This binding is based upon the Atom (RFC4287) and Atom Publishing Protocol (RFC5023).
In this binding, the client interacts with the repository by acquiring the service document, which Alfresco provides with each repository installation at:



http://[host]:[port]/alfresco/service/cmis



Note : This article was written for Alfresco 3.x for Alfresco 4.x and above http://[host]:[port]/alfresco/service/cmisws should be used instead.



The client will then choose a CMIS collection, and then start accessing the repository by following the references in the returned documents. This binding consists of a service
document specifying at least CMIS service collections, atom collections, feeds and entry documents. CMIS extends the Atom and AtomPub documents utilizing the Atom and AtomPub
extension mechanism. CMIS also leverages link tags to specify additional resources related to the requested resource.


Paging


All of the methods that allow for the retrieval of a collection of CMIS objects support paging of their result sets except where explicitly stated otherwise. The following
parameters control paging:




  • Integer maxItems : This is the maximum number of items to return in a response. Defaults to -1, which means unlimited.

  • Integer skipCount : This is the number of potential results that the repository skip over before returning any results. Defaults to 0.

Properties Filter


All of the methods that allow for the retrieval of properties for CMIS Objects have a “Property Filter” as an optional parameter, which allows the caller to specify a subset of
properties that must be returned by the repository in the output of the method. The filter is specified as follows:




  • Not set : All properties of the CMIS Object are returned (default)

  • A comma-delimited list of property query names : The properties listed are returned

  • * : All properties are returned

Include Allowable Actions


Many methods provide support for including allowable actions for the each CMIS Object returned in the response. Allowable actions are specified by the
includeAllowableActions parameter:




  • true : include allowable actions

  • false : exlude allowable actions (default)

Include Relationships


Many methods provide support for including relationships for each CMIS Object returned in the response. Relationships are specified by the includeRelationships parameter:




  • none : Relationships are not returned (default)

  • source : Only relationships in which the objects are the source are returned

  • target : Only relationships in which the objects are the target are returned

  • both : Relationships in which the objects are source of target are returned


Rendition Filter


Many methods provide support for including renditions of each CMIS Object returned in the response. The renditions to return are specified by the renditionFilter parameter:




  • cmis:none : exclude all associated renditions (default)

  • * : include all associated renditions

  • comma-separated list of kinds or mimetypes : include only those renditions that match one of the specified kinds or mimetypes

For example:




  • * : include all renditions

  • cmis:thumbnail : include only thumbnails

  • image/* : include all image renditions

  • application/pdf,application/x-shockwave-flash : include web ready renditions

ACLs


Some methods provide support for including ACLs for each CMIS Object returned in the response. ACLs are specified by the includeACL parameter:



  • true : include all ACLs for each CMIS Object

  • false : exclude ACLs (default)

Schemas


CMIS Atom Service Document



   
    The AtomPub Service Document (application/atomsvc+xml) contains the set of repositories that are available. Each repository is mapped to a workspace
    element in the AtomPub Service document.
   
   

format: atomsvc

http://docs.oasis-open.org/cmis/CMIS/v1.0/cd07/CMIS-RestAtom.xsd


CMIS Tree



   
    This document is an atom feed (application/atom+xml;type=feed) with CMIS markup to represent the nesting of a hierarchy.
   
   

format: atomfeed

http://docs.oasis-open.org/cmis/CMIS/v1.0/cd07/CMIS-RestAtom.xsd


CMIS Atom Entry



   
    An Atom entry (application/atom+xml;type=entry) containing extension CMIS markup.
   
   

format: atomentry

http://docs.oasis-open.org/cmis/CMIS/v1.0/cd07/CMIS-RestAtom.xsd


CMIS Atom Feed



   
    An Atom feed (application/atom+xml;type=feed) containing extension CMIS markup.
   
   

format: atomfeed

http://docs.oasis-open.org/cmis/CMIS/v1.0/cd07/CMIS-RestAtom.xsd


CMIS Query



   
    This document (application/cmisquery+xml) contains the representation of a query to be executed in a CMIS repository.
   
   

format: cmisquery

definition:

   <cmis:query xmlns:cmis='http://docs.oasis-open.org/ns/cmis/core/200908/'>
       <cmis:statement>SELECT * FROM cmis:document</cmis:statement>
       <cmis:searchAllVersions>true</cmis:searchAllVersions>
       <cmis:includeAllowableActions>false</cmis:includeAllowableActions>
       <cmis:includeRelationships>none</cmis:includeRelationships>
       <cmis:renditionFilter>*</cmis:renditionFilter>
       <cmis:maxItems>50</cmis:maxItems>
       <cmis:skipCount>0</cmis:skipCount>
   </cmis:query>
  
  

http://docs.oasis-open.org/cmis/CMIS/v1.0/cd07/CMIS-Core.xsd


CMIS Allowable Actions



   
    This document (application/cmisallowableactions+xml) contains the representation of the allowable actions the user may perform on the referenced object.
   
   

format: cmisallowableactions

definition:

   <cmis:allowableActions xmlns:cmis='http://docs.oasis-open.org/ns/cmis/core/200908/'>
       <cmis:canDeleteObject>true</cmis:canDeleteObject>
       <cmis:canUpdateProperties>true</cmis:canUpdateProperties>
       <cmis:canGetProperties>true</cmis:canGetProperties>
       <cmis:canGetObjectRelationships>true</cmis:canGetObjectRelationships>
       <cmis:canGetObjectParents>true</cmis:canGetObjectParents>
       <cmis:canMoveObject>true</cmis:canMoveObject>
       <cmis:canDeleteContentStream>true</cmis:canDeleteContentStream>
       <cmis:canCheckOut>true</cmis:canCheckOut>
       <cmis:canCancelCheckOut>true</cmis:canCancelCheckOut>
       <cmis:canCheckIn>true</cmis:canCheckIn>
       <cmis:canSetContentStream>true</cmis:canSetContentStream>
       <cmis:canGetAllVersions>true</cmis:canGetAllVersions>
       <cmis:canAddObjectToFolder>true</cmis:canAddObjectToFolder>
       <cmis:canRemoveObjectFromFolder>true</cmis:canRemoveObjectFromFolder>
       <cmis:canGetContentStream>true</cmis:canGetContentStream>
       <cmis:canApplyPolicy>true</cmis:canApplyPolicy>
       <cmis:canGetAppliedPolicies>true</cmis:canGetAppliedPolicies>
       <cmis:canRemovePolicy>true</cmis:canRemovePolicy>
       <cmis:canCreateDocument>true</cmis:canCreateDocument>
   </cmis:allowableActions>
  
  

http://docs.oasis-open.org/cmis/CMIS/v1.0/cd07/CMIS-Core.xsd


CMIS ACL



   
    This document (application/cmisacl+xml) specifies an Access Control List based on the schema in CMIS Domain Model.
   
   

format: cmisacl

definition:

   <cmis:acl xmlns:cmis='http://docs.oasis-open.org/ns/cmis/core/200908/'>
       <cmis:permission>
           <cmis:principal>
               <cmis:principalId>Al Brown</cmis:principalId>
           </cmis:principal>
           <cmis:permission>cmis:read</cmis:permission>
           <cmis:permission>cmis:write</cmis:permission>
           <cmis:permission>cmis:all</cmis:permission>
           <cmis:permission>publish</cmis:permission>
           <cmis:direct>true</cmis:direct>
       </cmis:permission>
   </cmis:acl>
  
  

http://docs.oasis-open.org/cmis/CMIS/v1.0/cd07/CMIS-Core.xsd


Resources


CMIS Documentation Index


Documentation for Alfresco Repository CMIS Implementation


CMIS Documentation Index


public_api


Documentation for Alfresco Repository CMIS Implementation

GET /alfresco/service/cmis/index

GET /alfresco/service/cmis/index.html



Options for selecting response format:


  • default: html
  • style: any

Advanced:


  • authentication: none
  • cache: neverCache mustRevalidate
  • transaction: required

Service Document


Entry point for accessing CMIS AtomPub binding.


Get Repositories (getRepositories, getRepositoryInfo)


public_api




  Returns a list of CMIS repositories available from this CMIS service endpoint.
 
 

GET /alfresco/service/cmis

GET /alfresco/service/api/cmis



Available response format: atomsvc


Options for selecting response format:


  • default: atomsvc
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Types Collection


Represents a collection of CMIS Type definitions.


Get Child Types (getTypeChildren)


public_api



 
  Returns the list of Type definitions that are children of the specified Type, or the list of base types, if no Type is specified.
  
 

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


  • typeId: (optional) if supplied, return the children of the specified type, otherwise return all base types
  • includePropertyDefinitions: (optional) (default: false) if true, include property definitions within each returned type definition
  • skipCount: (optional) see Paging
  • maxItems: (optional) see Paging



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Types Descendants


Represents a hierarchy of CMIS Type definitions.


Get Descendant Types (getTypeDescendants)


public_api



 
  Returns the set of descendant Type definitions under the specified Type, or all types if one is not specified.
 
 

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

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


  • typeId: (optional) if supplied, return the descendants of the specified type, otherwise return all types
  • includePropertyDefinitions: (optional) (default: false) if true, include property definitions within each returned type definition
  • depth: (optional) (default: -1) if 1, return only types that are children. if greater than 1, return types that are descendants up to depth levels deep, otherwise if -1, return all descendant types.



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Type Description


Represents a CMIS Type Definition


Get Type Definition (getTypeDefinition)


public_api



 
  Gets the definition of the specified type.
 
 

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


  • typeId: the type id of the type to describe
  • includePropertyDefinitions: (default: true) if true, include property definitions with the type definition



Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Queries


Represents a collection of Query Statements


Issue Query (query)


public_api



 
  Executes a CMIS query statement against the contents of the Repository.
 
 

POST /alfresco/service/cmis/queries



Accepted request format: cmisquery


  • schema: [[CMIS Web Scripts Reference#CMIS Query|CMIS Query]

Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Query


Represents a Query


Issue Query (query)


public_api



 
  Executes a CMIS query statement against the contents of the Repository.
 
 

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


  • q: query statement to execute
  • searchAllVersions: (optional) (default: false) note: Alfresco does not the optional capabilityAllVersionsSearchable
  • includeAllowableActions: (optional) see Allowable Actions
  • includeRelationships: (optional) see Relationships
  • renditionFilter: (optional) see Rendition Filter
  • skipCount: (optional) see Paging
  • maxItems: (optional) see Paging



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Checked Out Documents


Represents the collection of Checked Out Documents


Get Checked Out Documents (getCheckedOutDocs)


public_api



 
  Gets the list of documents that are checked out that the user has access to.
 
 

GET /alfresco/service/cmis/checkedout?folderId={folderId?}&includeDescendants={includeDescendants?}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}


  • folderId: (optional) if specified, only return checked out documents that are children of the specified folder, otherwise return all checked out documents
  • filter: (optional) see Properties Filter
  • includeAllowableActions: (optional) see Allowable Actions
  • includeRelationships: (optional) see Relationships
  • renditionFilter: (optional) see Rendition Filter
  • skipCount: (optional) see Paging
  • maxItems: (optional) see Paging



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Checkout Document (checkOut)


public_api



 
  Create a private working copy of the document.
 
 

POST /alfresco/service/cmis/checkedout



Accepted request format: atomentry


Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Change Log


Represents collection of Change Entries


Get Change Log Events (getContentChanges)


public_api



 
  Gets a list of content changes. This service is intended to be used by search crawlers or other applications that need to
  efficiently understand what has changed in the repository. 
 
 

GET /alfresco/service/cmis/changes?maxItems={maxItems?}&filter={filter?}&includeACL={includeACL?}&changeLogToken={changeLogToken?}


  • changeLogToken: (optional) if specified, return the change event corresponding to the value of the specified change log token as the first result in the output, otherwise, return the first change event recorded in the change log
  • filter: (optional) see Properties Filter
  • includeACL: (optional) see ACLs
  • maxItems: (optional) Paging



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: argument

Advanced:


  • authentication: admin
  • cache: neverCache mustRevalidate
  • transaction: required

Unfiled Documents


Represents all unfiled in the Repository


Unfiled Documents (getUnfiled)


public_api


Gets all unfiled documents in the Repository.

GET /alfresco/service/cmis/unfiled



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: any

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Folder Children


Represents the children of a Folder


Get Folder Children (getChildren)


public_api



 
  Gets the list of child objects contained in the specified folder.
 
 

GET /alfresco/service/cmis/i/{id}/children?types={types?}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&orderBy={orderBy?}

GET /alfresco/service/cmis/s/{store}/i/{id}/children?types={types?}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&orderBy={orderBy?}

GET /alfresco/service/cmis/p{path}/children?types={types?}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&orderBy={orderBy?}

GET /alfresco/service/cmis/s/{store}/p{path}/children?types={types?}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&orderBy={orderBy?}

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/children?types={types?}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&orderBy={orderBy?}

GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/children?types={types?}&filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&orderBy={orderBy?}


  • store: the store name
  • id: the node id of the folder
  • path: the path of the folder
  • types: (optional) restrict the type of children returned. one of documents, folders, policies, any
  • filter: (optional) see Properties Filter
  • includeAllowableActions: (optional) see Allowable Actions
  • includeRelationships: (optional) see Relationships
  • renditionFilter: (optional) see Rendition Filter
  • includePathSegment: (default: false) if true, returns a PathSegment element for each child for use in constructing that child's path
  • skipCount: (optional) see Paging
  • maxItems: (optional) see Paging



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Create / Move a Folder or Document (createDocument, createFolder, createPolicy, moveObject)


public_api



 
  Creates a folder, document or policy of the specified type (given by the cmis:objectTypeId property).
 
  If sourceFolderId is specified, a move operation is performed instead of create.
 
 

POST /alfresco/service/cmis/i/{id}/children?sourceFolderId={sourceFolderId}&versioningState={versioningState?}

POST /alfresco/service/cmis/s/{store}/i/{id}/children?sourceFolderId={sourceFolderId}&versioningState={versioningState?}

POST /alfresco/service/cmis/p{path}/children?sourceFolderId={sourceFolderId}&versioningState={versioningState?}

POST /alfresco/service/cmis/s/{store}/p/{path}/children?sourceFolderId={sourceFolderId}&versioningState={versioningState?}

POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/children?sourceFolderId={sourceFolderId}&versioningState={versioningState?}

POST /alfresco/service/api/path/{store_type}/{store_id}/{path}/children?sourceFolderId={sourceFolderId}&versioningState={versioningState?}


  • store: the store name
  • id: the node id of the folder
  • path: the path of the folder
  • sourceFolderId: if specified, indicates the folder from which the object shall be moved from
  • versioningState: (optional) specifies the initial versioning state of the created object. one of none, checkedout, major or minor.



Accepted request format: atomentry


Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Folder Descendants


Represents a Folder and Document hierarchy


Get Folder and Document Hierarchy (getDescendants)


public_api



 
  Gets the set of descendant objects contained in the specified folder or any of its child-folders.
 
 

GET /alfresco/service/cmis/i/{id}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/s/{store}/i/{id}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/p{path}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/s/{store}/p{path}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}

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

GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/descendants?types={types}&filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}


  • store: the store name
  • id: the node id of the folder
  • path: the path of the folder
  • types: restrict the type of descendants returned. one of documents, folders, policies, any
  • depth: (optional) (default: -1) if 1, return only children of the folder. if greater than 1, return children that are descendants up to depth levels deep, otherwise if -1, return all descendants.
  • filter: (optional) see Properties Filter
  • includeAllowableActions: (optional) see Allowable Actions
  • includeRelationships: (optional) see Relationships
  • renditionFilter: (optional) see Rendition Filter
  • includePathSegment: (default: false) if true, returns a PathSegment element for each child for use in constructing that child's path



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Delete Folder Tree (deleteTree)


public_api



 
  Deletes the specified folder and all of its child and descendant objects.
 
 

DELETE /alfresco/service/cmis/i/{id}/descendants?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}

DELETE /alfresco/service/cmis/s/{store}/i/{id}/descendants?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}

DELETE /alfresco/service/cmis/p{path}/descendants?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}

DELETE /alfresco/service/cmis/s/{store}/p{path}/descendants?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}

DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}

DELETE /alfresco/service/api/path/{store_type}/{store_id}/{path}/descendants?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}


  • store: the store name
  • id: the node id of the folder
  • path: the path of the folder
  • continueOnFailure: (optional) (default: false) if true, continue attempting to perform this operation, even if deletion of child or descendant fails
  • unfileObjects: (default: delete) one of unfile (unfile all fileable objects), deletesinglefiled, delete (delete all fileable objects)



Options for selecting response format:


  • default: atomfeed
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Folder Tree


Represents a Folder hierarchy


Get Folder Hierarchy (getFolderTree)


public_api



 
  Gets the set of descendant folder objects contained in the specified folder.
 
 

GET /alfresco/service/cmis/i/{id}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/s/{store}/i/{id}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/p{path}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/s/{store}/p{path}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}

GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/tree?filter={filter?}&depth={depth?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}


  • store: the store name
  • id: the node id of the folder
  • path: the path of the folder
  • depth: (optional) (default: -1) if 1, return only child folders of the folder. if greater than 1, return child folders that are descendants up to depth levels deep, otherwise if -1, return all descendant folders.
  • filter: (optional) see Properties Filter
  • includeAllowableActions: (optional) see Allowable Actions
  • includeRelationships: (optional) see Relationships
  • renditionFilter: (optional) see Rendition Filter
  • includePathSegment: (default: false) if true, returns a PathSegment element for each child for use in constructing that child's path



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Delete Folder Tree (deleteTree)


public_api



 
  Deletes the specified folder and all of its child and descendant objects.
 
 

DELETE /alfresco/service/cmis/i/{id}/tree?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}

DELETE /alfresco/service/cmis/s/{store}/i/{id}/tree?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}

DELETE /alfresco/service/cmis/p{path}/tree?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}

DELETE /alfresco/service/cmis/s/{store}/p{path}/tree?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}

DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}/tree?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}

DELETE /alfresco/service/api/path/{store_type}/{store_id}/{path}/tree?continueOnFailure={continueOnFailure?}&unfileObjects={unfileObjects}


  • store: the store name
  • id: the node id of the folder
  • path: the path of the folder
  • continueOnFailure: (optional) (default: false) if true, continue attempting to perform this operation, even if deletion of child or descendant fails
  • unfileObjects: (default: delete) one of unfile (unfile all fileable objects), deletesinglefiled, delete (delete all fileable objects)



Options for selecting response format:


  • default: atomfeed
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Folder Parent


Represents Parent Folder


Get Parent Folder (getFolderParent)


public_api



 
  Gets the parent folder for the specified folder.
 
 

GET /alfresco/service/cmis/i/{id}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}

GET /alfresco/service/cmis/s/{store}/i/{id}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}

GET /alfresco/service/cmis/p{path}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}

GET /alfresco/service/cmis/s/{store}/p{path}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}

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

GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/parent?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}




Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Object Parents


Represents Parents of a Document


Get Parent Folders (getObjectParents)


public_api



 
  Gets the parent folder(s) for the specified non-folder, fileable object.
   
 

GET /alfresco/service/cmis/i/{id}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&includeRelativePathSegment={includeRelativePathSegment?}

GET /alfresco/service/cmis/s/{store}/i/{id}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&includeRelativePathSegment={includeRelativePathSegment?}

GET /alfresco/service/cmis/p{path}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&includeRelativePathSegment={includeRelativePathSegment?}

GET /alfresco/service/cmis/s/{store}/p{path}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&includeRelativePathSegment={includeRelativePathSegment?}

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&includeRelativePathSegment={includeRelativePathSegment?}

GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/parents?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&renditionFilter={renditionFilter?}&includeRelativePathSegment={includeRelativePathSegment?}


  • store: the store name
  • id: the node id of the folder
  • path: the path of the folder
  • filter: (optional) see Properties Filter
  • includeAllowableActions: (optional) see Allowable Actions
  • includeRelationships: (optional) see Relationships
  • renditionFilter: (optional) see Rendition Filter
  • includeRelativePathSegment: (optional) (default: true) note: Alfresco ignores this argument and always returns a relative path segment



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Object


Represents an Object (Folder or Document)


Get Object (getObject, getObjectByPath, getObjectOfLatestVersion, getProperties)


public_api



 
  Gets the specified information for the object (Folder or Document).
 
 

GET /alfresco/service/cmis/i/{id}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/s/{store}/i/{id}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/p{path}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/s/{store}/p{path}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/s/{store}/arg/i?id={id}&filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/s/{store}/arg/p?path={path}&filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/arg/n?noderef={noderef}&filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}

GET /alfresco/service/api/path/{store_type}/{store_id}/{path}?filter={filter?}&returnVersion={returnVersion?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}


  • store: the store name
  • id: the node id of the object
  • path: the path of the object
  • noderef: the noderef of the object
  • returnVersion: (optional) one of this, latest or latestmajor
  • filter: (optional) see Properties Filter
  • includeAllowableActions: (optional) see Allowable Actions
  • includeRelationships: (optional) see Relationships
  • renditionFilter: (optional) see Rendition Filter
  • includeACL: (optional) see ACLs



Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Update Object (updateProperties)


public_api



 
  Update the properties of the specified Object.
 
 

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}


  • store: the store name
  • id: the node id of the object
  • path: the path of the object



Accepted request format: atomentry


Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: argument

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Update Object (updateProperties)


public_api



 
  Update the properties of the specified Object.
 
 

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}


  • store: the store name
  • id: the node id of the object
  • path: the path of the object



Accepted request format: atomentry


Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: argument

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Delete Object (deleteObject)


public_api



 
  Delete the specified object.
 
 

DELETE /alfresco/service/cmis/i/{id}

DELETE /alfresco/service/cmis/s/{store}/i/{id}

DELETE /alfresco/service/cmis/p{path}

DELETE /alfresco/service/cmis/s/{store}/p{path}

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

DELETE /alfresco/service/api/path/{store_type}/{store_id}/{path}



Options for selecting response format:


  • default: atomentry
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Content


Represents a Content Stream


Get Content (getContent)


public_api



 
  Gets the content stream for the specified document, or gets a rendition stream for a specified rendition of a document.
 
 

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


  • store: the store name
  • id: the node id of the object
  • path: the path of the object
  • property: (default: cm:content) the name of the content property to retrieve content from
  • attach: (default: false) if true, force download of content as attachment



Options for selecting response format:


  • default: Determined at run-time
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Write Content (setContent)


public_api



 
  Sets the content stream for the specified Document object.
 
 

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


  • store: the store name
  • id: the node id of the object
  • path: the path of the object
  • property: (default: cm:content) the name of the content property to retrieve content from
  • overwriteFlag: (optional) (default: true) if true, force download of content as attachment



Options for selecting response format:


  • default: text
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Delete Content (deleteContent)


public_api



 
  Deletes the content stream for the specified Document object.
 
 

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}


  • store: the store name
  • id: the node id of the object
  • path: the path of the object
  • property: (default: cm:content) the name of the content property to retrieve content from



Options for selecting response format:


  • default: atomentry
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Versions


Represents the versions of a Document.


Get Document Versions (getAllVersions)


public_api



 
  Returns the list of all Document Objects in the specified Version Series, sorted by cmis:creationDate descending.
 
 

GET /alfresco/service/cmis/i/{id}/versions?filter={filter?}&includeAllowableActions={includeAllowableActions?}

GET /alfresco/service/cmis/s/{store}/i/{id}/versions?filter={filter?}&includeAllowableActions={includeAllowableActions?}

GET /alfresco/service/cmis/p{path}/versions?filter={filter?}&includeAllowableActions={includeAllowableActions?}

GET /alfresco/service/cmis/s/{store}/p{path}/versions?filter={filter?}&includeAllowableActions={includeAllowableActions?}

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/versions?filter={filter?}&includeAllowableActions={includeAllowableActions?}

GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/versions?filter={filter?}&includeAllowableActions={includeAllowableActions?}


  • store: the store name
  • id: the node id of the folder
  • path: the path of the folder
  • filter: (optional) see Properties Filter
  • includeAllowableActions: (optional) see Allowable Actions



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: argument

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Private Working Copy


Represents a Checked Out Document


Get Private Working Copy (getObject)


public_api



 
  Gets the specified information for the private working copy.
 
 

GET /alfresco/service/cmis/pwc/i/{id}?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}

GET /alfresco/service/cmis/pwc/s/{store}/i/{id}?filter={filter?}&includeAllowableActions={includeAllowableActions?}&includeRelationships={includeRelationships?}&includeACL={includeACL?}&renditionFilter={renditionFilter?}




Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: argument

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Checkin Private Working Copy (checkin)


public_api



 
  Checks-in the Private Working Copy document.
 
 

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


  • store: the store name
  • id: the node id of the object
  • checkin: (optional) (default: false) if true, cause this update to checkin
  • checkinComment: (optional) comment to be recorded for this checkin
  • major: (optional) (default: true) if true, checkin as a major version, otherwise checkin as a minor version



Accepted request format: atomentry


Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Checkin Private Working Copy (checkin)


public_api



 
  Checks-in the Private Working Copy document.
 
 

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


  • store: the store name
  • id: the node id of the object
  • checkin: (optional) (default: false) if true, cause this update to checkin
  • checkinComment: (optional) comment to be recorded for this checkin
  • major: (optional) (default: true) if true, checkin as a major version, otherwise checkin as a minor version



Accepted request format: atomentry


Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Cancel Checkout (cancelCheckout)


public_api



 
  Reverses the effect of a check-out. Removes the private working copy of the checked-out document, allowing other documents in the version series
  to be checked out agai
 
 

DELETE /alfresco/service/cmis/pwc/i/{id}

DELETE /alfresco/service/cmis/pwc/s/{store}/i/{id}


  • store: the store name
  • id: the node id of the object



Options for selecting response format:


  • default: atomentry
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Relationships


Represents Relationships of an Object


Get Relationships Of Object (getObjectRelationships)


public_api



 
  Gets all or a subset of relationships associated with an independent object.
 
 

GET /alfresco/service/cmis/i/{id}/rels?filter={filter?}&typeId={typeId?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&relationshipDirection={relationshipDirection?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&filter={filter?}

GET /alfresco/service/cmis/s/{store}/i/{id}/rels?filter={filter?}&typeId={typeId?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&relationshipDirection={relationshipDirection?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&filter={filter?}

GET /alfresco/service/cmis/p{path}/rels?filter={filter?}&typeId={typeId?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&relationshipDirection={relationshipDirection?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&filter={filter?}

GET /alfresco/service/cmis/s/{store}/p{path}/rels?filter={filter?}&typeId={typeId?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&relationshipDirection={relationshipDirection?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&filter={filter?}

GET /alfresco/service/api/node/{store_type}/{store_id}/{id}/rels?filter={filter?}&typeId={typeId?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&relationshipDirection={relationshipDirection?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&filter={filter?}

GET /alfresco/service/api/path/{store_type}/{store_id}/{id}/rels?filter={filter?}&typeId={typeId?}&includeSubRelationshipTypes={includeSubRelationshipTypes?}&relationshipDirection={relationshipDirection?}&skipCount={skipCount?}&maxItems={maxItems?}&includeAllowableActions={includeAllowableActions?}&filter={filter?}


  • store: the store name
  • id: the node id of the folder
  • typeId: (optional) if specified, return only relationships whose type is of the type specified, otherwise return relationships of all types
  • includeSubRelationshipTypes: (optional) (default: false) if true, return relationships whose type is a sub-type of the specified typeId
  • relationshipDirection: (optional) (default: source) one of source, target, either
  • filter: (optional) see Properties Filter
  • includeAllowableActions: (optional) see Allowable Actions
  • skipCount: (optional) see Paging
  • maxItems: (optional) see Paging



Available response format: atomfeed


Options for selecting response format:


  • default: atomfeed
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Create Relationship (createRelationship)


public_api



 
  Creates a relationship object of the specified type
 
 

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


  • store: the store name
  • id: the node id of the object
  • path: the path of the object



Accepted request format: atomentry


Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Relationship


Represents a Relationship


Get a Relationship (getRelationship)


public_api



 
  Get a Relationship.
 
 

GET /alfresco/service/cmis/rel/{assoc_id}?filter={filter?}&includeAllowableActions={includeAllowableActions?}




Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Delete a Relationship (deleteRelationship)


public_api



 
  Deletes a Relationship.
 
 

DELETE /alfresco/service/cmis/rel/{assoc_id}


  • assoc_id: the id of the relationship



Options for selecting response format:


  • default: atomentry
  • style: any

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

Allowable Actions


Represents Actions Allowed on an Object


Get Allowable Actions (getAllowableActions)


public_api



 
  Gets the list of allowable actions for an Object.
 
 

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


  • store: the store name
  • id: the node id of the object
  • path: the path of the object



Available response format: cmisallowableactions


Options for selecting response format:


  • default: cmisallowableactions
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Get Relationship Allowable Actions (getAllowableActions)


public_api



 
  Gets the list of allowable actions for a Relationship.
 
 

GET /alfresco/service/cmis/rel/{assoc_id}/allowableactions


  • assoc_id: the relationship id to retrieve allowable actions for



Available response format: cmisallowableactions


Options for selecting response format:


  • default: cmisallowableactions
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

CMIS ACLs


Access Control List


Get ACL (getACL)


public_api



 
  Get the ACL currently applied to the specified document or folder object.
 
 

GET /alfresco/service/cmis/i/{id}/acl

GET /alfresco/service/cmis/s/{store}/i/{id}/acl

GET /alfresco/service/cmis/p{path}/acl

GET /alfresco/service/cmis/s/{store}/p{path}/acl

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

GET /alfresco/service/api/path/{store_type}/{store_id}/{path}/acl



Available response format: cmisacl


Options for selecting response format:


  • default: cmisacl
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Update ACL (applyACL)


public_api



 
  Adds or removes the given ACEs to or from the ACL of document or folder object.
 
 

PUT /alfresco/service/cmis/i/{id}/acl

PUT /alfresco/service/cmis/s/{store}/i/{id}/acl

PUT /alfresco/service/cmis/p{path}/acl

PUT /alfresco/service/cmis/s/{store}/p{path}/acl

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

PUT /alfresco/service/api/path/{store_type}/{store_id}/{path}/acl



Accepted request format: cmisacl


Available response format: cmisacl


Options for selecting response format:


  • default: cmisacl
  • style: argument

Advanced:


  • authentication: user
  • cache: neverCache mustRevalidate
  • transaction: required

AtomPub TCK


CMIS AtomPub Test Compatibility Kit


CMIS AtomPub TCK


public_api



 
  Execute TCK Tests
 
 

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


  • url: url of the AtomPub service document of the repository to test
  • user: (optional) username/password for authentication (HTTP BASIC Authentication)
  • validate: (optional) (default: false) if true, validate repository responses against CMIS XSDs
  • trace: (optional) (default: false) if true, trace request and response bodies
  • tests: (optional) (default: *) names of tests to excecute (use * in test name for wildcard)



Options for selecting response format:


  • default: text
  • style: any

Advanced:


  • authentication: none
  • cache: neverCache mustRevalidate
  • transaction: none

Policies


Represents Policies Applied to an Object


Get Applied Policies (getAppliedPolicies)


public_api



 
  Gets the list of policies currently applied to the specified object
 
 

GET /alfresco/service/cmis/i/{id}/pols?filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}

GET /alfresco/service/cmis/s/{store}/i/{id}/pols?filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}

GET /alfresco/service/cmis/p{path}/pols?filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}

GET /alfresco/service/cmis/s/{store}/p{path}/pols?filter={filter?}&skipCount={skipCount?}&maxItems={maxItems?}

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

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


  • store: the store name
  • id: the node id of the folder
  • path: the path of the folder
  • filter: (optional) see Properties Filter
  • skipCount: (optional) see Paging
  • maxItems: (optional) see Paging



Options for selecting response format:


  • default: atomfeed
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Apply Policy (applyPolicy)


public_api



 
  Applies a specified policy to an object.
 
 

POST /alfresco/service/cmis/i/{id}/pols

POST /alfresco/service/cmis/s/{store}/i/{id}/pols

POST /alfresco/service/cmis/p{path}/pols

POST /alfresco/service/cmis/s/{store}/p{path}/pols

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

POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/pols


  • store: the store name
  • id: the node id of the object
  • path: the path of the object



Accepted request format: atomentry


Available response format: atomentry


Options for selecting response format:


  • default: atomentry
  • style: argument

Advanced:


  • authentication: guest
  • cache: neverCache mustRevalidate
  • transaction: required

Attachments

    Outcomes