1Browser Binding url patterns




Дата канвертавання27.04.2016
Памер100.31 Kb.

1Browser Binding URL Patterns


The URLs used by the Browser Binding are meant to be predictable in order to simplify client development. This section specifies the URL patterns.

1.1Browser Binding URLs

1.1.1Service URL


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

(Abbreviation in this document: .)

Each repository info MUST contain two additional URLs:


  • The Repository URL (repository info property: repositoryUrl)

  • The Root URL (repository info property: rootUrl)

1.1.2Repository URL


The Repository URL provides access to data that is independent of the folder hierarchy such as type definitions, query and content changes.

(Abbreviation in this document: .)


1.1.3Root URL


The Root URL is used to build Object URLs.

(Abbreviation in this document: .)


1.1.4Object URLs


(Abbreviation in this document: .)

1.1.4.1HTTP GET Object URLs


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 for HTTP GET are:



  • ?objectId=
    where is a CMIS object id.

  • /

    where
    is an absolute CMIS path to an object.



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.1.4.2HTTP POST Object URLs


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

The two forms of an Object URL for HTTP POST are:




  • where the CMIS object id transferred in the form data field “objectId”.

  • /

    where
    is an absolute CMIS path to an object.




1.2Operations


Almost all read operations (operations without side effects) use HTTP GET. The data returned by a read operation is determinate by the query parameter “selector”.

If the "selector" parameter is absent, the following values are assumed:



  • For document objects: content

  • For folder objects: children

  • For relationship objects: object

  • For policies objects: object

The value of the "selector" parameter is case insensitive.

All operations that create, modified or delete objects or change the state of the repository use HTTP POST. The action executed by such an operation is determinate by the form parameter “action”.

The “action” parameter MUST be set. The value of the "action" parameter is case insensitive.

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



Service

Operation

HTTP Method

URL

Selector

Action

Comment

Repository Service

getRepositories

GET









No selector




getRepositoryInfo

GET



repositoryInfo










getTypeChildren

GET



typeChildren










getTypeDescendants

GET



typeDescendants










getTypeDefinition

GET



typeDefintion







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





База данных защищена авторским правом ©shkola.of.by 2016
звярнуцца да адміністрацыі

    Галоўная старонка