CMIS is a comprehensive interface with many different services. In edoc CMIS archivelink, only certain standard CMIS services are used.
For a complete overview of the CMIS 1.1 standard (data model and methods), see: Content Management Interoperability Services (CMIS) Version 1.1 Plus Errata 01. If needed, you can find details on the individual CMIS services for edoc CMIS archivelink in the CMIS documentation from OASIS.
This article provides an overview of the CMIS features in edoc CMIS archivelink and the supported CMIS services that are used in edoc CMIS archivelink in a manner that differs from the CMIS standard.
Overview of the features of edoc CMIS archivelink
In this section, you'll find details about the general range of features.
General information about API requests
-
You must run API requests to edoc CMIS archivelink using the Browser Binding format.
-
You can use standard authentication (Basic Auth) or authenticate using a bearer token.
-
The query parameter suppressResponseCodes is supported.
-
The query parameter token and its handling using the getLastResult service are not supported.
Overview of supported CMIS services
The overview lists the CMIS services supported in edoc CMIS archivelink. It also includes a description of the functionalities (e.g., inputs and outputs) for each service that have been implemented in edoc CMIS archivelink and differ from the CMIS standard.
Tip
The numbers in parentheses allow you to quickly locate the corresponding section in the OASIS documentation on the CMIS standard.
Repository Services (2.2.2)
Repository Services allow you to retrieve information about repositories and their object types and to manage object type definitions.
Supported CMIS service “getRepositories” (2.2.2.1)
Description: You can list all existing repositories.
Deviations: There are no deviations from the standard.
Supported CMIS service “getRepositoryInfo” (2.2.2.2)
Description: You can retrieve information about a single repository.
Deviations: There are no deviations from the standard.
Supported CMIS service “getTypeChildren” (2.2.2.3)
Description: You can list the direct subtypes of an object type.
Deviations: There are no deviations from the standard.
Supported CMIS service “getTypeDescendants” (2.2.2.4)
Description: You can retrieve the complete hierarchy of subtypes for an object type.
Deviations: There are no deviations from the standard.
Supported CMIS service “getTypeDefinition” (2.2.2.5)
Description: You can retrieve the definition of an object type.
Deviations: There are no deviations from the standard.
Supported CMIS service “createType” (2.2.2.6)
Description: You can create a new object type.
Exceptions: Object types created using the CMIS service createType are not synchronized with the ECM system.
Supported CMIS service “updateType” (2.2.2.7)
Description: You can modify an existing object type.
Deviations: There are no deviations from the standard.
Supported CMIS service “deleteType” (2.2.2.8)
Description: You can delete an object type.
Deviations: There are no deviations from the standard.
Navigation Services (2.2.3)
Navigation Services allow you to traverse the structure of a repository and identify relationships between folders and objects.
Supported CMIS service “getChildren” (2.2.3.1)
Description: You can retrieve the direct child objects of an object.
Exceptions: The includeRelationships and renditionFilter parameters are ignored because the repository does not support either of these elements.
Supported CMIS service “getFolderParent” (2.2.3.4)
Description: You can retrieve the parent folder of a folder.
Deviations: There are no deviations from the standard.
Supported CMIS service “getObjectParents” (2.2.3.5)
Description: You can retrieve an object's parent elements.
Exceptions: The includeRelationships and renditionFilter parameters are ignored because the repository does not support either of these elements.
Supported CMIS service “getCheckedOutDocs” (2.2.3.6)
Description: You can view all documents that are currently checked out.
Exceptions: The includeRelationships and renditionFilter parameters are ignored because the repository does not support either of these elements.
Object Services (2.2.4)
With Object Services, you can create, retrieve, modify, move, and delete CMIS objects, as well as manage their content.
Supported CMIS service “createDocument” (2.2.4.1)
Description: You can create a new document, including its content and metadata.
Exceptions: The policies, addACEs, and removeACEs parameters are ignored because the repository does not support these elements. The output does not include relationships, policies, renditions, or acl.
Supported CMIS Service “createFolder” (2.2.4.3)
Description: You can create a new folder.
Exceptions: The policies, addACEs, and removeACEs parameters are ignored because the repository does not support these elements. The output does not include relationships, policies, or acl.
Supported CMIS service “createItem” (2.2.4.6)
Description: You can create a generic CMIS object without document content.
Exceptions: The policies, addACEs, and removeACEs parameters are ignored because the repository does not support these elements. The output does not include relationships, policies, or acl.
Supported CMIS service “getAllowableActions” (2.2.4.7)
Description: You can retrieve the actions allowed for an object.
Deviations: There are no deviations from the standard.
Supported CMIS service “getObject” (2.2.4.8)
Description: You can retrieve an object, including its metadata.
Exceptions: The parameters includeRelationships, includePolicyIds, includeACL, and renditionFilter are ignored because the repository does not support these elements.
Supported CMIS service “getProperties” (2.2.4.9)
Description: You can retrieve the properties of an object.
Deviations: There are no deviations from the standard.
Supported CMIS service “getObjectByPath” (2.2.4.10)
Description: You can retrieve an object based on its repository path.
Exceptions: The parameters includeRelationships, includePolicyIds, includeACL, and renditionFilter are ignored because the repository does not support these elements.
Supported CMIS service “getContentStream” (2.2.4.11)
Description: You can retrieve the contents of a document.
Exceptions: Since renditions are not supported, you can only specify the main content stream ID for the streamId parameter, or you can omit the streamId parameter entirely. If you specify a different stream ID, an error will be returned.
Supported CMIS service “getRenditions” (2.2.4.12)
Description: You can view the available versions of a document.
Exceptions: Renditions are not supported. The system always returns a message stating that no renditions exist.
Supported CMIS service “updateProperties” (2.2.4.13)
Description: You can change the properties of an object.
Deviations: There are no deviations from the standard.
Supported CMIS service “moveObject” (2.2.4.15)
Description: You can move an item between two folders.
Deviations: There are no deviations from the standard.
Supported CMIS service “deleteObject” (2.2.4.16)
Description: You can delete a single object.
Deviations: There are no deviations from the standard.
Supported CMIS service “deleteTree” (2.2.4.17)
Description: You can delete a folder, including all the objects it contains.
Deviations: There are no deviations from the standard.
Supported CMIS service “setContentStream” (2.2.4.18)
Description: You can set or replace the content (content stream).
Deviations: There are no deviations from the standard.
Supported CMIS service “appendContentStream” (2.2.4.19)
Description: You can attach additional content to a document.
Deviations: There are no deviations from the standard.
Supported CMIS service “deleteContentStream” (2.2.4.20)
Description: You can remove the content of a document.
Deviations: There are no deviations from the standard.
Multi-filing Services (2.2.5)
With the Multi-filing Services, you can map objects to multiple folders or remove existing mappings.
Supported CMIS service “addObjectToFolder” (2.2.5.1)
Description: You can map an object to another folder.
Deviations: There are no deviations from the standard.
Supported CMIS service “removeObjectFromFolder” (2.2.5.2)
Description: You can remove an object's mapping with a folder.
Deviations: There are no deviations from the standard.
Discovery Services (2.2.6)
Discovery Services allow you to find objects based on metadata and search queries.
Supported CMIS service “query” (2.2.6.1)
Description: You can search for objects based on their properties and object types.
Inputs that deviate from the standard
-
statement: Only the following elements are supported in the SQL query:
-
SELECT: Supports individual attributes (using AS in combination with an alias, if necessary) and * (asterisk).
-
FROM: Supports all valid sources.
-
WHERE: Supports the following conditions and function calls:
-
AND and OR
-
ANY
-
IN
-
IS NULL
-
=,!=, <,>,<=, >=
-
TIMESTAMP
-
IN_FOLDER: A function call that checks whether the object is a direct child of a specified folder object.
-
IN_TREE: A function call used to check whether the object is a descendant of a specified folder object.
-
-
-
searchAllVersions: This field is not supported.
-
includeRelationships: This field is not supported.
-
renditionFilter: This field is not supported.
Outputs that deviate from the standard
-
queryResult:
-
relationships: The field value is always null.
-
returns: The field value is always null.
-
Versioning Services (2.2.7)
Versioning Services allow you to control the versioning and editing of documents.
Supported CMIS service “checkOut” (2.2.7.1)
Description: You can check out a document for editing.
Deviations: There are no deviations from the standard.
Supported CMIS service “cancelCheckOut” (2.2.7.2)
Description: You can cancel a checkout and stop the process.
Deviations: There are no deviations from the standard.
Supported CMIS Service “checkIn” (2.2.7.3)
Description: You can check in changes to a document and create a new version.
Exceptions: The policies, addACEs, and removeACEs parameters are ignored because the repository does not support these elements.
Supported CMIS service “getObjectOfLatestVersion” (2.2.7.4)
Description: You can retrieve the latest version of a document.
Exceptions: The parameters includeRelationships, includePolicyIds, includeACL, and renditionFilter are ignored because the repository does not support these elements.
Supported CMIS service “getPropertiesOfLatestVersion” (2.2.7.5)
Description: You can view the properties of the latest version of the document.
Deviations: There are no deviations from the standard.
Supported CMIS service “getAllVersions” (2.2.7.6)
Description: You can retrieve all versions of a document.
Deviations: There are no deviations from the standard.