Skip to content

adm_my_document_annotations_v

One row per annotation on a document the ADM user established in the current session may see.

Group: Application integration

Category: Annotations - Document and folder key-value metadata

  • Reading the file metadata ADM extracted on upload
  • Reading key-value metadata your own application wrote
  • Filtering documents by an annotation value

The view contains 9 columns providing comprehensive information:

Column NameDescription
annotation_idPrimary key of the annotation.
document_idThe annotated document. Joins to adm_my_documents_v.document_id.
annotation_keyThe annotation key, always lowercase. Unique per document.
annotation_valueThe annotation value, free text up to 4000 characters. May be null.
key_namespaceFILE for a key in ADM”s reserved “file.” prefix (technical metadata extracted from the file itself, rewritten on every new version), CUSTOM for anything the host application wrote. Never write a “file.” key yourself.
created_dateTimestamp the annotation was created.
created_byUser who created the annotation.
updated_dateTimestamp the annotation was last changed.
updated_byUser who last changed the annotation.
  • Unique by annotation_id, and by (document_id, annotation_key)
  • key_namespace separates ADM’s reserved file.* keys from your own
  • A metadata bag, not referential integrity

Other views in the Annotations category: