REST API - linkDocument - with a Request Body

The table summarizes the REST API - linkDocument - with a request body.

Request - with Request Body

Format PUT <baseurl>/document/link
Body The document reference is embedded in the request body.

Response - with Request Body

JSON Returns a JSON representation of the content of the LinkDocumentResponse element.
XML Returns the content of the LinkDocumentResponse element (from the DocumentService schema).

Example - with Request Body

Request 
PUT <baseurl>/document/link
Body 
{
  "LinkDocumentRequest": {
    "targetOwner": { "caseReference": "BDS-1-com.example.ordermodel.Order-3-0" },
    "documentReference": "DocumentID-66e338f9-b511-475f-8f1d-9c693f8e5189;1.0"
  }
Response 
{ "xml-fragment": null }