[GET] /{objectId}

[GET] /{objectId}

/api/dms/objects/{objectId}

Description

To retrieve the metadata of a DMS object, send the request with the objectId of the DMS object.
With the optional parameter includeAllowedChildObjectTypeIds the currently insertable child object types are returned. The parameter is only available for folder or register types.
For objects in the recycle bin the query parameter garbadeMode must be send with the value true. It is not possible to load typless objects from the recycle bin. Typless objects have no additional metadata and the available information from a search for recycle bin objects should give all information about them.

Please note that there are redundant system fields for the objectId. The system fields system:objectId, system:STAMM_ID and system:REG_ID all contain the objectid of the requested object and not the parent register (system:REG_ID) or the parent folder (system:STAMM_ID). These values can be fetched within a complete search request incl. the system fields system:SDSTA_ID and system:SDREG_ID.

Request
Method

GET

Request optional
Query Parameter

  • includePermissions (Boolean): The object rights are included in the response. Default: true

Non Core-API query parameters:

  • includeAllowedChildObjectTypeIds (Boolean): The insertable children objectTypeIds for folder and register types are returned. Default: false.

  • objectTypeId (String): The objectTypeId for the object to be queried. This speeds up the query.

  • includeContentStreams (Boolean): The content streams of the returned objects. Default: true

  • includeIcons (Boolean): The object type icon number is returned as a property. Default: false.

  • followDocLink (Boolean): The file information of the linked document content is returned. Only if includeContentStreams is requested. Default: false

  • outputCatalogueLocale (String): Beginning with enaio® 11.0, the locale in which multilingual catalog values are to be returned.

  • systemFields (String): A semicolon-seperated list of the system fields to be included in the response. Default: NULL (All system fields for the object). The system fields must be listed without the system: prefix.

  • garbageMode (Boolean): If the object is in the recycle bin, this parameter must be sent with the value true to receive the object. Otherwise, the endpoint returns that the object is not found.

Response
Format

JSON

Minimum Version

3.0.0

Changelog

  • 3.1.0: Query parameter includeallowedchildobjecttypeids introduced

  • 3.2.0: Query parameter includeallowedchildobjecttypeids renamed to includeAllowedChildObjectTypeIds

  • 5.0.0: Query parameter includeAllowedChildObjectTypeIds now returns a map of objects in the JSON, and no longer a plain list of objectTypeIds. maxCount is embedded.

  • 5.3.0: Query parameter garbageMode introduced.

  • 6.0.0: Query parameters includeRemarks and locale removed.

  • 6.0.0: Query parameter outputCatalogueLocale introduced.

Request
Example

/api/dms/objects/2563
/api/dms/objects/2563?includeAllowedChildObjectTypeIds=true

Result
Example

See 1.3 Result Format