This function is available only for on-premises installations.

Released: JSON representation

This chapter explains how to remove the link between two DMS objects. You can only remove links of DMS objects individually.

To remove the link between two DMS objects, you must perform the following steps:

Determining the URL for a repository

In the chapter Determining a repository, you can learn how to determine the URL for a repository.

Determine and open the link relation for retrieving the details of a DMS object

In the chapter Retrieving and viewing the details of a DMS object, you can learn how to determine and open the URL for retrieving the details of a DMS object.

Determine the link relation for removing the link between two DMS objects

The JSON object for the details of a DMS object contains the link relation unlinkDmsObject with a placeholder for the ID of the parent DMS object for which you want to remove the link to the dossier.

Response

{ 
    "_links": {    
        "unlinkDmsObject": { 
            "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/{parentDmsObjectId}/children/D000004567" 
        } 
    }, 
    "id": "D000000123" 
}

Open the URL for removing the link between two DMS objects

Execute an HTTP DELETE request with the ID of the DMS object as a parameter in the URL determined above as follows to remove the link between the DMS object and the dossier:

Request

DELETE https://host/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/children/D000004567 HTTP/1.1 
Accept: application/hal+json

As the response, you receive the HTTP status code 200 (OK) if the removal of the link was successful. If the removal of the link was unsuccessful, you receive the HTTP status code 400 (bad request) and detailed information about the error.

Example for a response upon a failed request:

Response

HTTP/1.1 400 Bad Request 
Content-Type: application/hal+json 

{
  "reason": "These two documents are not linked with each other. [0000073] ",
  "severity": 1,
  "errorCode": 73,
  "requestId": "XyEWT4KPhyGaMg9dxcGNiAAAA@c"
}

If you want to remove multiple DMS objects, repeat this step.

Description of parameters for response upon a failed request:

Response format for errors

Success = 0,
Information = 1,
Warning = 2,
Error = 3