/
[GET] /variants

[GET] /variants

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

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

Description

To retrieve the metadata of all variants of the specified DMS object, send a request with the objectId of the DMS object.
This endpoint returns only minimal meta data for all variants of the object. To get more information such as the values of their index data fields, you can use the endpoint for single objects.
A search for all returned objectIds is not possible, because only active variants can be searched. Therefore, currently the endpoint for single objects must be used for each objectId.

Request
Method

GET

Request Optional
Query Parameters

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

  • fields (String): Index data fields to query for each variant. The fields are separated by semicolon.

  • systemFields (String): System fields to query for each variant. The system fields are separated by semicolon. Supported system fields are: system:creationDate, system:createdBy, system:lastModifiedBy, system:lastModificationDate, system:OBJECT_RETENTION_PLANNED, system:OBJECT_RETENTION, system:OBJECT_AVDATE, system:OBJECT_AVID, system:OBJECT_DOCPAGECOUNT

Response
Format

JSON

Minimum Version

3.1.0

Changelog

  • 5.4.0: Query parameters fields and systemFields were added for enaio® 10.10+.

Request
Example

/api/dms/objects/2563/native/variants
/api/dms/objects/2563/native/variants?objectTypeId=262433
/api/dms/objects/2563/native/variants?objectTypeId=262433&fields=<internalName01>;<internalName02>&systemFields=system:creationDate;system:createdBy

Result
Example

{ "objects": [{ "properties": { "system:objectId": { "value": 58652 }, "system:objectTypeId": { "value": 262236 }, "system:variantVersion": { "value": "Original" }, "system:variantActive": { "value": false }, "system:variantOriginId": { "value": 0 }, "field1": { "value": "value of the field" }, "field2": { "value": "value of the field" }, "system:creationDate": { "value": "2022-01-17T12:25:07Z" }, "system:createdBy": { "value": "ROOT" } } },{ "properties": { "system:objectId": { "value": 75138 }, "system:objectTypeId": { "value": 262236 }, "system:variantVersion": { "value": "1.0.0" }, "system:variantActive": { "value": true }, "system:variantOriginId": { "value": 58652 }, "field1": { "value": "value of the field" }, "field2": { "value": "value of the field" }, "system:creationDate": { "value": "2022-01-25T08:13:38Z" }, "system:createdBy": { "value": "ROOT" }         } }] }

 

Related content