Common Service Elements



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

Write Operations


All operations that create, modify or delete objects or change the state of the repository in any way use HTTP POST. Since this binding is optimized for use in browser applications, the format of the transferred data is aligned to the capabilities of HTML forms and described in this specification in HTML terms. See section 1.4.4 for a description of how HTML forms are used for CMIS operations
        1. Write Operations Summary Table


The following table defines the POST request responses:

Service

CMIS Operation

Success HTTP status code

Response body

HTTP Location Header

Last response available

(see section 1.4.4.4)

Comment

Object Service

createDocument

201

JSON representation of the newly created document

yes

yes







createDocumentFromSource

201

JSON representation of the newly created document

yes

yes







createFolder

201

JSON representation of the newly created folder

yes

yes







createRelationship

201

JSON representation of the newly created relationship

yes

yes







createPolicy

201

JSON representation of the newly created policy

yes

yes







updateProperties

200

JSON representation of the updated object

no

yes

If a ‘file’ control is included in the form, the content stream of the object MAY be updated with the content of the file in the same operation.




moveObject

201

JSON representation of the moved object

yes

yes







deleteObject

204

Empty

no

yes







deleteTree

204

Empty

no

yes

When the operation partially succeeds, meaning that a 204 is returned but some objects in the tree are not deleted, an instance of type http://docs.oasis-open.org/ns/cmis/browser/201103/ids containing a list of id’s of the objects not deleted SHALL be returned.




setContentStream

201

JSON representation of the object

yes

yes







deleteContentStream

204

Empty

no

yes

























Multi-filing Service

addObjectToFolder

201

JSON representation of the added object

yes

yes







removeObjectFromFolder

201

JSON representation of the removed object

yes

yes

























Discovery Service

query


200

Query results

no

no

























Versioning Service

checkOut

201

JSON representation of the PWC

yes

yes







cancelCheckOut

204

Empty

no

yes







checkIn

201

JSON representation of the checked-in object

yes

yes

























Policy Service

applyPolicy

200

JSON representation of the updated object

no

yes







removePolicy

200

JSON representation of the updated object

no

yes

























ACL Service

applyACL

200

JSON representation of the new ACL

no

yes





      1. Operations Summary Table


The following table assigns “selector” and “action” values to CMIS operations:

Service

CMIS Operation

HTTP Method

URL

Selector

Action

Comment

Repository Service

getRepositories

GET









No selector




getRepositoryInfo

GET



repositoryInfo










getTypeChildren

GET



typeChildren










getTypeDescendants

GET



typeDescendants










getTypeDefinition

GET



typeDefinition




























Navigation Service

getChildren

GET



children




The selector can be omitted since getChildren only works on folders




getDescendants

GET



descendants










getFolderTree

GET



folder










getFolderParent

GET



parent










getObjectParents

GET



parents










getCheckedOutDocs

GET



checkedout




Returns Checked out documents in this folder




getCheckedOutDocs

GET



checkedout




Returns Checked out documents in the repository

Object Service

createDocument

POST






createDocument

Creates a document in this folder




createDocument

POST






createDocument

Creates an unfiled document




createDocumentFromSource

POST






createDocumentFromSource

Creates a document in this folder




createDocumentFromSource

POST






createDocumentFromSource

Creates an unfiled document




createFolder

POST






createFolder







createRelationship

POST






createRelationship







createPolicy

POST






createPolicy

Creates a policy in this folder




createPolicy

POST






createPolicy

Creates an unfiled policy




getAllowableActions

GET



allowableActions










getObject

GET



object




If the object is a policy or a relationship, the selector can be omitted.




getProperties




getObjectByPath




getContentStream

GET



content




If the object is a document, the selector can also be omitted.




getRenditions

GET



renditions










updateProperties

POST







updateProperties







moveObject

POST






move







deleteObject

POST






delete







deleteTree

POST






deleteTree







setContentStream

POST






setContent







deleteContentStream

POST






deleteContent

























Multi-filing Service

addObjectToFolder

POST






addObjectToFolder







removeObjectFromFolder

POST






removeObjectFromFolder

























Discovery Service

query


POST






query







query


GET



query










getContentChanges


GET



contentChanges




























Versioning Service

checkOut

POST






checkOut







cancelCheckOut

POST






cancelCheckOut







checkIn

POST






checkIn







getObjectOfLatestVersion

GET



object




Parameter returnVersion must be set




getPropertiesOfLatestVersion




getAllVersions

GET



versions




























Relationship Service

getObjectRelationships

GET



relationships




























Policy Service

applyPolicy

POST






applyPolicy







removePolicy

POST






removePolicy

























ACL Service

getACL

GET



acl










applyACL

POST






applyACL




      1. 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