Common Service Elements



Download 1.14 Mb.
Page2/4
Date26.04.2018
Size1.14 Mb.
#46906
1   2   3   4

Services

1.3.1 Service URL


The document returned by the Service URL provides the repository information for all available repositories. How the client will get the Service URL is repository specific.

In this document the abbreviation used for the Service URL is .

In addition to the repository information described by the CMIS 1.0 specification, the document answered by the Service URL MUST contain two additional properties:


  • The Repository URL (repository info property: repositoryUrl)

  • The Root URL (repository info property: rootUrl)
      1. Repository URL


The Repository URL provides access to data that is independent of the folder hierarchy such as type definitions, query and content changes. It can be obtained using the getRepositories or getRepository services.

In this document the abbreviation used for the Repository URL is .


      1. Root URL


The Root URL is used to build Object URL’s.

In this document the abbreviation used for the Root URL is <root>.


      1. Object URL’s


An object is either identified by a parameter “objectId” added to the Root URL or by a path that is appended to the Root URL. If the parameter “objectId” is set, it takes precedence over the path.

The two forms of an Object URL are:



  • ?objectId=
    where is a CMIS object id.

  • /

    where
    is an absolute CMIS path to an object.



In this document the abbreviation used for the Root URL is .

Examples:



  • If the Root URL is “http://myrepository/cmis/repository/123” and the object id is “1a2b-3c4d-5e6f” the Object URL is:
    http://myrepository/cmis/repository/123?objectId=1a2b-3c4d-5e6f

  • If the Root URL is “http://myrepository/cmis/repository/123” and the object path is “/myFolder/myDocument” the Object URL is: http://myrepository/cmis/repository/123/myFolder/myDocument
    1. CMIS Operations



      1. Read Operations


Read operations use HTTP GET. The particular data that is returned by a read operation is determined by the query parameter “cmisselector”.

If the "cmisselector" parameter is absent, the following default values are used:



  • For document objects: content

  • For folder objects: children

  • For relationship objects: object

  • For policies objects: object

The value of the "cmisselector" parameter is case insensitive.
        1. Read Operations Summary Table


The following table defines the GET request responses.

The arguments supplied to the GET service requests SHALL be encoded as URL parameters. The name of each such parameter SHALL be the name of the argument as defined in the schema element enumArguments in the CMIS REST Atom schema (e.g. skipCount, includeRelationships, etc).



In all cases, the HTTP status code of 200 indicates a successful operation.

Service

CMIS Operation

Response Body Description

Response Schema Element

Repository Services

getRepositories

JSON representation of the list of repositories

http://docs.oasis-open.org/ns/cmis/browser/201103/repositories




getRepository

JSON representation of the specified repository

http://docs.oasis-open.org/ns/cmis/browser/201103/repositoryInfo




getTypeChildren

JSON representation of the types that are immediate children of the specified typeId, or the base types if no typeId is provided

http://docs.oasis-open.org/ns/cmis/browser/201103/typeList




getTypeDescendants

JSON representation of all types descended from the specified typeId, or all the types in the repository if no typeId is provided

http://docs.oasis-open.org/ns/cmis/browser/201103/typeContainer




getTypeDefinition

JSON representation of the specified type

http://docs.oasis-open.org/ns/cmis/browser/201103/typeDefinitionType













Navigation Services

getChildren

JSON representation of the children of the specified folder

http://docs.oasis-open.org/ns/cmis/browser/201103/objectInFolderList




getDescendants

JSON representation of the descendants of the specified folder

http://docs.oasis-open.org/ns/cmis/browser/201103/objectContainer




getFolderTree

JSON representation of the folders descended from the specified folder

http://docs.oasis-open.org/ns/cmis/browser/201103/objectContainer




getFolderParent

JSON representation of the parent folder of the specified folder

http://docs.oasis-open.org/ns/cmis/browser/201103/object




getObjectParents

JSON representation of the folders that are the parents of the specified object

http://docs.oasis-open.org/ns/cmis/browser/201103/objectParentList




getCheckedOutDocs

JSON representation of the documents that have been checked out in the repository or in the specified folder

http://docs.oasis-open.org/ns/cmis/browser/201103/objectInFolderList













Object Services

getAllowableActions

JSON representation of the actions allowed on the specified object

http://docs.oasis-open.org/ns/cmis/browser/201103/allowableActions




getObject

JSON representation of the specified object

http://docs.oasis-open.org/ns/cmis/browser/201103/object




getProperties

JSON representation of the properties of the specified object

http://docs.oasis-open.org/ns/cmis/browser/201103/properties




getObjectByPath

JSON representation of the specified object

http://docs.oasis-open.org/ns/cmis/browser/201103/object




getContentStream

Stream of the document

N/A




getRenditions

JSON representation of the renditions for the specified object

http://docs.oasis-open.org/ns/cmis/browser/201103/object













Discovery Services

query


A JSON representation of the results of the query

http://docs.oasis-open.org/ns/cmis/browser/201103/objectInFolderList




getContentChanges

A JSON representation of the changed objects

http://docs.oasis-open.org/ns/cmis/browser/201103/objectInFolderList













Versioning Services

getObjectOfLatestVersion

JSON representation of the latest version of the document in the Version Series

http://docs.oasis-open.org/ns/cmis/browser/201103/object




getPropertiesOfLatestVersion

JSON representation of the properties of the latest version of the document in the Version Series

http://docs.oasis-open.org/ns/cmis/browser/201103/properties




getAllVersions

JSON representation of all the versions in the Version Series

http://docs.oasis-open.org/ns/cmis/browser/201103/objectInFolderList













Relationship Services

getObjectRelationships

JSON representation of the relationships of the specified object

http://docs.oasis-open.org/ns/cmis/browser/201103/objectInFolderList













Policy Services

getAppliedPolicies

A JSON object representing the policies applied to the specified object

http://docs.oasis-open.org/ns/cmis/browser/201103/objectInFolderList













ACL Service

getACL

JSON representation of the Access Control Entries for the specified object

http://docs.oasis-open.org/ns/cmis/browser/201103/acl



Directory: committees -> download.php
download.php -> Emergency Interoperability Consortium Membership Meeting
download.php -> Technical Communicators, Get ready: Here comes Augmented Reality! Rhonda Truitt
download.php -> Oasis set tc
download.php -> Iepd analyze Requirements Use Cases for edxl situation reporting messages Draft Version 4
download.php -> Technical Committee: oasis transformational Government Framework tc chair
download.php -> Ibops protocol Version 0 Working Draft 2 9 March 2015 Technical Committee
download.php -> Reliability of Messages Sent as Responses over an Underlying Request-response Protocol
download.php -> Service Component Architecture sca-j common Annotations and apis Specification Version 1 Committee Draft 03 – Rev1 + Issue 127
download.php -> Scenario Two – Hurricane Warning
download.php -> Technical Committee: oasis augmented Reality in Information Products (arip) tc chairs

Download 1.14 Mb.

Share with your friends:
1   2   3   4




The database is protected by copyright ©ininet.org 2024
send message

    Main page