dms.GetPDFAnnotations

This job returns the PDF annotations stored for a DMS object as a JSON document.

This job is not listed in the official enaio® DMS engine overview. This description was reconstructed from the call code of the enaio-jobs-custom template. On the server, the job prefix is uppercase (DMS.GetPDFAnnotations); enaio® servers accept both spellings.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`Flags`	INT	Yes	Reserved; always pass `0`.
`ObjectId`	INT	Yes	Numeric ID of the DMS object.

Flags

INT

Yes

Reserved; always pass 0.

ObjectId

INT

Yes

Numeric ID of the DMS object.

2. Output Parameters

Name Type Dependency Description

Name	Type	Dependency	Description
`JSON`	BASE64	—	List of annotations in JSON format. Encoding is chosen by the caller (typically `UTF-8` or system default).

JSON

BASE64

—

List of annotations in JSON format. Encoding is chosen by the caller (typically UTF-8 or system default).

3. Return Value

(INT): 0 = job successful, otherwise error code.

For further return values see Error Codes.

4. Required Roles

The caller needs the following system role:

81 — Client: View preview annotations

5. See Also

dms.CreatePDFAnnotations — adds new annotations
dms.UpdatePDFAnnotations — modifies existing annotations
dms.DeletePDFAnnotations — deletes annotations