linkDocument

Links a document to a specified case.

  • The request identifies the case to which the specified document is to be linked.
  • The response returns either a document reference or an empty response:
    • If a document specifier is passed in the request (as opposed to a document reference), a document reference is returned.
    • If a document reference is passed in the request, an empty response is returned.
Note: The linkDocument operation cannot be used if you are using Microsoft Sharepoint 2013 as your content management system (CMS). This is because Sharepoint 2013 does not support multi-filing capability.
Note that there are two REST variants for linkDocument:
  • PUT with path parameters - In this request, the document reference and target case reference are included as path parameters. Note, however, some CMIS servers use characters in document and case references that need escaping when included in URLs. If this is an issue, you can URL-encode the document or case reference, or you can use the alternative PUT method with a request body. (Notice that the command for this variant is actually "linkcase" rather than "linkdocument".)
  • PUT with a request body - In this request, the document reference and target case reference are embedded in the request body.
Note: If a document is linked to multiple cases, and that document is deleted, it is deleted from all case folders. Note, however, not all repositories allow you to link documents to multiple cases.
Required System Action
cmisUser
API Descriptions