How to Backlink DMS Documents

Clients using an external DMS system may want to integrate with DealCloud. As part of their implementation, they may want to link their existing DMS documents into DealCloud's documents object. Below are the steps on how to backlink DMS documents using the API.

💡

Pre-Condition: Ensure the DMS integration (Box, Sharepoint, iManage, etc.) is enabled and you have the DMS documentIDs of the files you want to backlink.

Step 1

We will leverage the /cells POST endpoint to create a new entry in the Documents object.

Step 2

Use following payload schema where

entryId is -1 to create a new entry
storeRequests > fieldId is the title field of the documents object
binaryStoreRequests > fieldId is the document binary field of the documents object
formatType is the format of the file
documentStorageID is the ID of the file from the DMS system
- Sharepoint Format: SiteID | DriveID | ItemID
- Box/Dropbox Format: Document ID

POST {{host}}/api/rest/v4/data/entrydata/{{entryTypeId}} HTTP/1.
Content-Type: application/json
Authorization: {{auth}}
 
{
    "storeRequests": [
        {
            "entryId": -1,
            "fieldId": 374033,
            "value": "My Document"
        }
    ],
    "binaryStoreRequests": [
        {
            "entryId": -1,
            "fieldId": 374040,
            "formatType": "pdf",
            "documentStorageId": "dealcloud.sharepoint.com,d2fc299a-0xs1-29mp-aa31-a928df414kl1, 19hx6b49-894f-1534-ab0c-83c38ae3fde0 | b!jXn8xvMK7US6YdV4rxJM8HFqroBNiYRFqwyDw4rj_eA_0xVHLPz5QIxLz_5HPERF| 017JSD7BVIXRB52K7UNBEKCF3J3CZRWZTA"
        }
    ]
}

Step 3

Submit API request and observe document linked successfully

⚠️

Note: We recommend backlinking up to 500,000 or fewer total documents.

How to Upload Files SDKs