dms.GetObjectDetails

Mit diesem Job lassen sich die Indexdaten eines einzelnen DMS Objektes ermitteln. Dabei ist der Standort unerheblich. Auch die Daten inaktiver Varianten lassen sich damit ermitteln. Das Ergebnis wird im DMSContent HOL Format zurückgegeben. Alle Eingabeparameter die bei dem Job dms.GetResultList angegeben werden können, um die Ausgabeinformationen zu beeinflussen, sind auch bei GetObjectDetails analog verwendbar.

Bei diesem Job wird die Anfrageeigenschaft [FollowDocLink] im Default auf '1' gesetzt, wenn es nicht durch den Job-Parameter explizit ausgeschaltet wird. Das hat zur Folge, dass im Default-Fall die Dokumenteneigenschaften des verlinkten DMS Objektes zurückgegeben werden, wenn [FileInfo] mit angefragt wird, und es sich um ein Dokumentverweis-Objekt handelt (s. Dateiinformationen).

Wenn Varianten mit angefragt werden (Variants=1), dann können die gewünschten Felder über interne Namen angegeben werden (VariantFields) und ebenfalls die Basisparameter (VariantSystemFields).

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

Die Systemfelder SDSTA_ID, SDREG_ID und SDREG_TYPE werden von diesem Job nicht unterstützt und führen bei Verwendung zu Fehlern. Werden diese Felder benötigt, muss stattdessen der Job dms.GetResultList verwendet werden.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

ObjectID

INT

Ja

Die ID der Objektinstanz

[ObjectType]

INT

Nein

Typ des Objekts. Wird dieser Parameter nicht oder als Wert -1 angegeben, bestimmt der Job selbst den Objekttyp.

[SystemFields]

String

Nein

Mit Semikolon getrennte Liste von zusätzlich angefragten Systemfeldern. Erwartet werden die internen Namen von Systemfeldern (siehe Systemfelder). Wenn Basisparameter angefragt werden, so haben diese Präferenz, d.h. die mit SystemFields angefragten Informationen stehen im Rückgabeergebnis in dem jeweiligen Ergebnisblock (z. B. innerhalb von <baseparams>) und werden nicht redundant zurückgegeben. Nicht alle Systemfelder werden von diesem Job unterstützt — ob ein Systemfeld unterstützt wird, ist in der Systemfeldreferenz dokumentiert.

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

XML

BASE64

—

Indexdaten im DMSContent XML-Format

3. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode
Vollständige Fehlerliste

Weitere mögliche Parameter: Siehe Job dms.GetResultList.
Beispiel für SystemFields-Anfrage:
SystemFields=OBJECT_MEDDOCID;OBJECT_MEDDOCNA

4. Verwandte Jobs