dms.GetForeignObjects

With this job, all objects that have a document reference to a given object can be determined (aka. green arrow reference). The result is returned in the DMS Content format. The same output format options apply as for the job dms.GetResultList.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Flags for controlling the output format
0x00000010 (16) = XML result is returned as a file, otherwise as a buffer

ObjectID

INT

Yes

ID of the target object whose document references should be displayed. The target object ID of the green arrow reference.

[ObjectTypes]

STRING

No

A semicolon-separated list of reference types. If this parameter is not set, search is performed in all types in all cabinets. The reference type can be passed as a type ID or as the internal name of the type. If an archive (cabinet) is passed as a type, all contained document types are used as source types.
Example: ObjectTypes=1;interne_email;262432

2. Output Parameters

Name Type Dependency Description

TotalHits

INT

—

Number of visible document reference objects to the target object.

TotalForeignObjects

INT

—

Complete number of document references to the target object. When determining the number, the security system is not taken into account. If the input parameter ObjectTypes was used, only the number of references found in the given types is returned.

[Result]

BASE64

Optional

Object list in DMSContent XML format (when Flags is not 0x00000010 (16))

3. Output Files

Name Description

[FileCount]

Only one file is always returned

[File List]

Name and path of the DMSContent XML file containing the hit list

4. Return Value

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

The job supports the same input parameters as dms.GetObjectDetails or dms.GetResultList.