/
[POST] /links

[POST] /links

Owned by Team Dodo
Last updated: Apr 01, 2025 by Technische Redaktion
1 min read

/api/dms/objects/{objectId}/native/links

Description

Within this endpoint new links can be created or existing links can be updated within their link text. Please note that this operation is not possible if the object or the object which should be linked is in the recycle bin. These objects can't be modified any longer.

Text for Links

Text to links can only be added if the links are stored in the database. There is also the option to store them in the filesystem but then it is not possible to send the "text" Property to DMS Microservice and enaio server. It will result in an error.

Request Method

POST

Request Query Parameter

  • objectTypeId (Integer): For performance reasons, the objectTypeId of the object can be provided.

  • minimalResponse (Boolean):  The response is on success HTTP/204. This speeds up the endpoint by 30%.

Response Format

JSON

Minimum Version

6.4.0

Request
Example

/api/dms/objects/4528/native/links?objectTypeId=262168
/api/dms/objects/4528/native/links?objectTypeId=262168&minimalResponse=true

Request
Example

{ "objects": [{ "properties": { "system:objectId": { "value": "1234567" }, "system:objectTypeId": { "value": "262245" }, "text": { "value": "Link Text" } } },{ "properties": { "system:objectId": { "value": "5566444" }, "system:objectTypeId": { "value": "262248" }, "text": { "value": "Link Text second link" } } }] }

Result
Example

{ "objects": [{ "properties": { "system:objectId": { "value": "1234567" }, "system:objectTypeId": { "value": "262245" }, "text": { "value": "Link Text" } } },{ "properties": { "system:objectId": { "value": "5566444" }, "system:objectTypeId": { "value": "262248" }, "text": { "value": "Link Text second link" } } }] }

 

Related content