dms.GetPDFAnnotationInfo

Dieser Job liefert für ein DMS-Dokument einen integer-codierten Informationswert über die vorhandenen PDF-Annotationen. Welche Information konkret zurückgegeben wird, steuert der Parameter InfoType — typischerweise ein Indikator- oder Zählwert (z. B. „Anzahl der Annotationen" oder „persistenter PDF-Annotations-Layer vorhanden").

Der Job ist das schlanke Pendant zu dms.GetPDFAnnotations, das den vollständigen Annotations-Inhalt liefert. Typischer Einsatz: vorab feststellen, ob ein Dokument Annotationen besitzt, ohne den vollen Inhalt laden zu müssen (z. B. für Tab-Icons oder Badges in der Dokumentenansicht).

Der Job ist in der offiziellen enaio®-DMS-Engine-Übersicht nicht gelistet. Im Server wird das Job-Präfix gross geschrieben (DMS.GetPDFAnnotationInfo); enaio®-Server akzeptieren beide Schreibweisen.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

ObjectId

INT

Ja

Numerische ID des DMS-Dokuments.

InfoType

INT

Ja

Selektor für die zurückzuliefernde Info-Art. Standardwert: 1.

UserIdent

INT

Ja

Numerische User-ID des Aufrufers; wird für die Berechtigungsprüfung verwendet.

Flags

INT

Ja

Reserviert; stets 0 übergeben.

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

Value

INT

—

Angefragter Informationswert. Die Bedeutung ergibt sich aus dem Input-InfoType. 0 bedeutet typischerweise „keine Annotationen vorhanden" bzw. „Indikator nicht gesetzt".

3. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode (z. B. Objekt existiert nicht, fehlende Berechtigung).

Weitere Rückgabewerte siehe Fehlercodes.

4. Erforderliche Rollen

Der Aufrufer benötigt folgende Systemrolle:

  • 81 — Client: Vorschauanmerkungen ansehen

5. Hinweise

  • Reiner Lesezugriff — der Job ändert weder Annotationen noch Objektdaten.

  • Im Gegensatz zu dms.GetPDFAnnotations (überträgt den vollständigen JSON-Inhalt) liefert dieser Job nur einen einzelnen Integer-Wert und ist für hochfrequente Indikator-Abfragen ausgelegt.

6. Verwandte Jobs