Description | To retrieve the metadata of the active variant of the specified DMS object, send a request with the objectId of the DMS object.
This endpoint returns only minimal meta data for the active variant of the object. To get query directly field and/or systemfield information the query parameters fields and systemFields as described below can be used. If this is not sufficient more data can be loaded within the endpoint for single objects. |
|---|
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 the active variant. The fields are separated by semicolon.
systemFields (String): System fields to query for the active 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 | 6.8.0 |
|---|
Request
Example | /api/dms/objects/2563/native/variants/active
/api/dms/objects/2563/native/variants/active?objectTypeId=262433
/api/dms/objects/2563/native/variants/active?objectTypeId=262433&fields=<internalName01>;<internalName02>&systemFields=system:creationDate;system:createdBy
|
|---|
Result
Example | {
"objects": [{
"properties": {
"system:objectId": {
"value": 75138
},
"system:objectTypeId": {
"value": 262236
},
"system:variantVersion": {
"value": "1.0.0"
},
"system:variantActive": {
"value": true
},
"system:variantOriginId": {
"value": 58652
}
}
}]
} |
|---|