Document Notes¶
Calling the getObject service on a document will return all associated notes as relationships. An actual note object can then be retrieved by calling the getObject service on a relationship’s targetId.
Create a document note¶
Sample request¶
POST https://test.com..net/Web.Start/testSQL/Api/CMIS/T1/children/?id=ROOTFOLDER HTTP/1.1
Host: test.com..net
Connection: keep-alive
Content-Length: 1029
Accept: application/xml, text/xml, */*; q=0.01
Origin: null
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36
Content-Type: application/xml
Referer: http://localhost:8080/
Accept-Encoding: gzip, deflate, br
Accept-Language: en-US,en;q=0.8
<?xml version="1.0" encoding="UTF-8"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:cmis="http://docs.oasis-open.org/ns/cmis/core/200908/" xmlns:cmisra="http://docs.oasis-open.org/ns/cmis/restatom/200908/">
<atom:id>urn:uuid:00000000-0000-0000-0000-00000000000</atom:id>
<atom:title>Test</atom:title>
<atom:updated>2014-11-26T03:54:24.435Z</atom:updated>
<cmisra:object>
<cmis:properties>
<cmis:propertyString localName="cmis:name" propertyDefinitionId="cmis:name">
<cmis:value>Test Note Name</cmis:value>
</cmis:propertyString>
<cmis:propertyString localName="cmis:description" propertyDefinitionId="cmis:description">
<cmis:value>Test Note Description</cmis:value>
</cmis:propertyString>
<cmis:propertyId localName="cmis:objectTypeId" propertyDefinitionId="cmis:objectTypeId">
<cmis:value>t1documentnotetype</cmis:value>
</cmis:propertyId>
<cmis:propertyId localName="cmis:documentId" propertyDefinitionId="cmis:documentId">
<cmis:value>document-601000</cmis:value>
</cmis:propertyId>
</cmis:properties>
</cmisra:object>
</atom:entry>
Sample response¶
HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/atom+xml;type=entry
Location: https://test.test.net/test.Web.Start/testSQL/Api/CMIS/T1/object/?id=documentnote-601027-601000
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-UA-Compatible: IE=edge
Date: Mon, 17 Oct 2016 06:41:59 GMT
Content-Length: 5772
<?xml version="1.0" encoding="utf-8"?>
<entry xml:base="https://test.test.net/test.Web.Start/testSQL/Api/CMIS/" xmlns="http://www.w3.org/2005/Atom" xmlns:cmis="http://docs.oasis-open.org/ns/cmis/core/200908/" xmlns:cmism="http://docs.oasis-open.org/ns/cmis/messaging/200908/" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:app="http://www.w3.org/2007/app" xmlns:cmisra="http://docs.oasis-open.org/ns/cmis/restatom/200908/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<atom:id>documentnote-601027-601000</atom:id>
<atom:title type="text">documentnote-601027-601000</atom:title>
<atom:published>2016-10-17T16:41:59+10:00</atom:published>
<atom:updated>2016-10-17T16:41:59+10:00</atom:updated>
<atom:link rel="self" type="application/atom+xml;type=entry" href="https://test.test.net/test.Web.Start/testSQL/Api/CMIS/T1/object/?id=documentnote-601027-601000"/>
<atom:link rel="service" type="application/atomsvc+xml" href="https://test.test.net/test.Web.Start/testSQL/Api/CMIS/T1/servicedoc"/>
<atom:link rel="describedby" type="application/atom+xml;type=entry" href="https://test.test.net/test.Web.Start/testSQL/Api/CMIS/T1/type/?id=cmis:item"/>
<atom:link rel="http://docs.oasis-open.org/ns/cmis/link/200908/allowableactions" type="application/cmisallowableactions+xml" href="https://test.test.net/test.Web.Start/testSQL/Api/CMIS/T1/allowableactions/?id=documentnote-601027-601000"/>
<atom:link rel="http://docs.oasis-open.org/ns/cmis/link/200908/policies" type="application/atom+xml;type=feed" href="https://test.test.net/test.Web.Start/testSQL/Api/CMIS/T1/policies/?id=documentnote-601027-601000"/>
<atom:link rel="down" type="application/atom+xml;type=feed" href="https://test.test.net/test.Web.Start/testSQL/Api/CMIS/T1/children/?id=documentnote-601027-601000"/>
<app:edited>2016-10-17T16:41:59.6071873+10:00</app:edited>
<cmisra:object>
<cmis:properties>
<cmis:propertyString propertyDefinitionId="cmis:name" localName="Name" displayName="Name" queryName="cmis:name">
<cmis:value>Test Note Name</cmis:value>
</cmis:propertyString>
<cmis:propertyString propertyDefinitionId="cmis:description" localName="Description" displayName="Description" queryName="cmis:description">
<cmis:value>Test Note Description</cmis:value>
</cmis:propertyString>
<cmis:propertyId propertyDefinitionId="cmis:objectId" localName="ObjectId" displayName="Object Id" queryName="cmis:objectId">
<cmis:value>documentnote-601027-601000</cmis:value>
</cmis:propertyId>
<cmis:propertyId propertyDefinitionId="cmis:baseTypeId" localName="BaseTypeId" displayName="Base Type Id" queryName="cmis:baseTypeId">
<cmis:value>cmis:item</cmis:value>
</cmis:propertyId>
<cmis:propertyId propertyDefinitionId="cmis:objectTypeId" localName="ObjectTypeId" displayName="Object Type Id" queryName="cmis:objectTypeId">
<cmis:value>t1documentnotetype</cmis:value>
</cmis:propertyId>
<cmis:propertyId propertyDefinitionId="cmis:secondaryObjectTypeIds" localName="secondaryObjectTypeIds" displayName="Ids of the objects secondary types." queryName="cmis:secondaryObjectTypeIds"/>
<cmis:propertyString propertyDefinitionId="cmis:createdBy" localName="CreatedBy" displayName="Created By" queryName="cmis:createdBy">
<cmis:value>N/A</cmis:value>
</cmis:propertyString>
<cmis:propertyDateTime propertyDefinitionId="cmis:creationDate" localName="CreationDate" displayName="Creation Date" queryName="cmis:creationDate">
<cmis:value>0001-01-01T00:00:00Z</cmis:value>
</cmis:propertyDateTime>
<cmis:propertyString propertyDefinitionId="cmis:lastModifiedBy" localName="LastModifiedBy" displayName="Last Modified By" queryName="cmis:lastModifiedBy">
<cmis:value>N/A</cmis:value>
</cmis:propertyString>
<cmis:propertyDateTime propertyDefinitionId="cmis:lastModificationDate" localName="LastModificationDate" displayName="Last Modification Date" queryName="cmis:lastModificationDate">
<cmis:value>0001-01-01T00:00:00Z</cmis:value>
</cmis:propertyDateTime>
<cmis:propertyString propertyDefinitionId="cmis:documentId" localName="DocId" displayName="cmis:documentId" queryName="cmis:documentId">
<cmis:value>document-601000</cmis:value>
</cmis:propertyString>
</cmis:properties>
<cmis:allowableActions>
<cmis:canDeleteObject>true</cmis:canDeleteObject>
<cmis:canUpdateProperties>true</cmis:canUpdateProperties>
<cmis:canGetFolderTree>false</cmis:canGetFolderTree>
<cmis:canGetProperties>true</cmis:canGetProperties>
<cmis:canGetObjectRelationships>false</cmis:canGetObjectRelationships>
<cmis:canGetObjectParents>false</cmis:canGetObjectParents>
<cmis:canGetFolderParent>false</cmis:canGetFolderParent>
<cmis:canGetDescendants>false</cmis:canGetDescendants>
<cmis:canMoveObject>false</cmis:canMoveObject>
<cmis:canDeleteContentStream>false</cmis:canDeleteContentStream>
<cmis:canCheckOut>false</cmis:canCheckOut>
<cmis:canCancelCheckOut>false</cmis:canCancelCheckOut>
<cmis:canCheckIn>false</cmis:canCheckIn>
<cmis:canSetContentStream>false</cmis:canSetContentStream>
<cmis:canGetAllVersions>false</cmis:canGetAllVersions>
<cmis:canAddObjectToFolder>false</cmis:canAddObjectToFolder>
<cmis:canRemoveObjectFromFolder>false</cmis:canRemoveObjectFromFolder>
<cmis:canGetContentStream>false</cmis:canGetContentStream>
<cmis:canApplyPolicy>false</cmis:canApplyPolicy>
<cmis:canGetAppliedPolicies>false</cmis:canGetAppliedPolicies>
<cmis:canRemovePolicy>false</cmis:canRemovePolicy>
<cmis:canGetChildren>false</cmis:canGetChildren>
<cmis:canCreateDocument>false</cmis:canCreateDocument>
<cmis:canCreateFolder>false</cmis:canCreateFolder>
<cmis:canCreateRelationship>false</cmis:canCreateRelationship>
<cmis:canDeleteTree>false</cmis:canDeleteTree>
<cmis:canGetRenditions>false</cmis:canGetRenditions>
<cmis:canGetACL>false</cmis:canGetACL>
<cmis:canApplyACL>false</cmis:canApplyACL>
</cmis:allowableActions>
</cmisra:object>
</entry>
Delete a document note¶
Sample request¶
DELETE https://test.test.net/Web.Start/testSQL/Api/CMIS/T1/object/?id=documentnote-601027-601000 HTTP/1.1
Host: test.test.net
Connection: keep-alive
Content-Length: 0
Accept: */*
Origin: null
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: http://localhost:8080/
Accept-Encoding: gzip, deflate, sdch, br
Accept-Language: en-US,en;q=0.8
Sample response¶
HTTP/1.1 204 No Content
Cache-Control: private
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-UA-Compatible: IE=edge
Date: Mon, 17 Oct 2016 06:51:53 GMT