dms.GetObjectDetails

This job can be used to determine the index data of a single DMS object. The location is irrelevant. Data of inactive variants can also be determined this way. The result is returned in the DMSContent HOL Format. All input parameters that can be specified for the job dms.GetResultList to influence the output information can also be used analogously for GetObjectDetails.

For this job, the request property [FollowDocLink] is set to '1' by default, if it is not explicitly disabled by the job parameter. This means that in the default case, the document properties of the linked DMS object are returned when [FileInfo] is requested, if it is a document link object (see File Information).

When variants are requested (Variants=1), the desired fields can be specified via internal names (VariantFields) and the base parameters (VariantSystemFields) can also be requested.

Base parameters: OBJECT_CRDATE; OBJECT_CRID; OBJECT_MODIFYUSER; OBJECT_MODIFYTIME; OBJECT_RETENTION_PLANNED; OBJECT_RETENTION; OBJECT_AVDATE; OBJECT_AVID; OBJECT_TIME; OBJECT_DOCPAGECOUNT

The system fields SDSTA_ID, SDREG_ID, and SDREG_TYPE are not supported by this job and will cause errors if used. If these fields are required, the job dms.GetResultList must be used instead.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`ObjectID`	INT	Yes	The ID of the object instance
`[ObjectType]`	INT	No	Type of the object. If this parameter is not specified or specified with the value -1, the job itself determines the object type.
`[SystemFields]`	String	No	Semi-colon separated list of additionally requested system fields. Internal names of system fields are expected (see System Fields). If base parameters are requested, these have preference, i.e. the information requested with SystemFields appears in the respective result block in the return result (e.g. within <baseparams>) and is not returned redundantly. Not all system fields are supported by this job — whether a system field is supported is documented in the System Field Reference.

ObjectID

INT

Yes

The ID of the object instance

[ObjectType]

INT

Type of the object. If this parameter is not specified or specified with the value -1, the job itself determines the object type.

[SystemFields]

String

Semi-colon separated list of additionally requested system fields. Internal names of system fields are expected (see System Fields). If base parameters are requested, these have preference, i.e. the information requested with SystemFields appears in the respective result block in the return result (e.g. within <baseparams>) and is not returned redundantly. Not all system fields are supported by this job — whether a system field is supported is documented in the System Field Reference.

2. Output Parameters

Name Type Dependency Description

Name	Type	Dependency	Description
`XML`	BASE64	—	Index data in DMSContent XML format

XML

BASE64

—

Index data in DMSContent XML format

3. Return Value

(INT): 0 = Job successful, otherwise error code
Complete error list

Additional possible parameters: See job dms.GetResultList.

Example for SystemFields request:

SystemFields=OBJECT_MEDDOCID;OBJECT_MEDDOCNA

4. Related Jobs

dms.GetResultList — Search for multiple objects; returns the same DMSContent HOL format and shares all output parameters