dms.CreatePDFAnnotations

This job creates one or more PDF annotations on a DMS object. The annotations are passed 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.CreatePDFAnnotations); enaio® servers accept both spellings.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Reserved; always pass 0.

JSON

BASE64

Yes

Annotations to create, in JSON format (including object reference).

OutputUnicode

INT

Yes

1 = response IDs as Unicode (sAnnotationIds); 0 = legacy AnnotationIds as bytearray in default encoding.

2. Output Parameters

Name Type Dependency Description

sAnnotationIds

STRING

if OutputUnicode=1

IDs of the created annotations as a string (e.g. comma-separated).

AnnotationIds

BASE64

if OutputUnicode=0

IDs of the created annotations as a bytearray (default encoding).

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 roles:

  • 81 — Client: View preview annotations

  • 82 — Client: Edit preview annotations

5. See Also