dms.GetPDFAnnotationInfo

This job returns an integer-encoded info value about the PDF annotations present on a DMS document. Which value is returned is controlled by the InfoType parameter — typically an indicator or counter (e.g. "number of annotations" or "persistent PDF annotation layer present").

The job is the lightweight counterpart to dms.GetPDFAnnotations, which returns the full annotation content. Typical use: check up front whether a document has annotations without having to fetch the full content (e.g. for tab icons or badges in the document view).

This job is not listed in the official enaio® DMS engine overview. On the server the job prefix is written in upper case (DMS.GetPDFAnnotationInfo); enaio® servers accept both spellings.

1. Input Parameters

Name Type Required Description

ObjectId

INT

Yes

Numeric ID of the DMS document.

InfoType

INT

Yes

Selector for the info value to return. Default: 1.

UserIdent

INT

Yes

Numeric user ID of the caller; used for the permission check.

Flags

INT

Yes

Reserved; always pass 0.

2. Output Parameters

Name Type Dependency Description

Value

INT

—

Requested info value. The meaning depends on the input InfoType. 0 typically means "no annotations present" or "indicator not set".

3. Return Value

(INT): 0 = job successful, otherwise error code (e.g. object does not exist, missing permission).

For further return values see Error Codes.

4. Required Roles

The caller needs the following system role:

  • 81 — Client: View preview annotations

5. Notes

  • Read-only — the job modifies neither annotations nor object data.

  • In contrast to dms.GetPDFAnnotations (which transfers the full JSON content), this job returns only a single integer and is intended for high-frequency indicator queries.

6. Related Jobs