/
[GET] /locations

[GET] /locations

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

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

Description

To retrieve all locations where the requested object is present. The first level of the result is everytime
the folder. His child hierarchy goes then down until the requested object. If the object has multiple locations
in the same folder the child hierarchy has at a certain point multiple children. If the object is located in
multiple folders then there are multiple results on the first level.

The endpoint return only minimal data and no index data mask field data. Only the system:objectId, system:objectTypeId
and the system:baseTypeId. If you need further data to one of the objects you can query it within the normal search.

Request
Method

GET

Request optional
Query Parameter

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

Response
Format

JSON

Minimum Version

4.0.1

Request
Example

/api/dms/objects/11882/native/locations
/api/dms/objects/11882/native/locations?objectTypeId=262208

Result
Example

{ "objects": [{ "properties": { "system:objectId": { "value": "11816" }, "system:baseTypeId": { "value": "folder" }, "system:objectTypeId": { "value": "26" } }, "children": [{ "properties": { "system:objectId": { "value": "57557" }, "system:baseTypeId": { "value": "register" }, "system:objectTypeId": { "value": "6488100" } }, "children": [{ "properties": { "system:objectId": { "value": "11882" }, "system:baseTypeId": { "value": "document" }, "system:objectTypeId": { "value": "262208" } } }] },{ "properties": { "system:objectId": { "value": "47869" }, "system:baseTypeId": { "value": "register" }, "system:objectTypeId": { "value": "6488100" } }, "children": [{ "properties": { "system:objectId": { "value": "11882" }, "system:baseTypeId": { "value": "document" }, "system:objectTypeId": { "value": "262208" } } }] }] } ], "numItems": 5, "hasMoreItems": false, "totalNumItems": 5 }

 

Related content