Internal metadata keys
Documents in iBinder carry metadata. Each metadata entry has a metadataElementId (the key) and a value.
iBinder-defined system keys are prefixed with GLOBAL_. Customer-defined keys use the customer's own naming and can be discovered at runtime via GET /binders/{id}/metadataelements.
Reserved GLOBAL_* keys
| Metadata key | Description |
|---|---|
GLOBAL_TabId | Identifies the tab or folder a document belongs to. |
GLOBAL_BinderId | Unique identifier for a document binder, grouping related files. |
GLOBAL_TabType | Defines the type of tab, e.g. Drawings, Contracts. |
GLOBAL_Category | Categorization of the document, such as Legal, Finance. |
GLOBAL_CreatedBy | User or system that originally created the document. |
GLOBAL_Date | Date of the document's creation, selected by the user. |
GLOBAL_RevisionDate | Revision date for the document, selected by the user. |
GLOBAL_Status | Indicates the document's status, e.g. Active, Archived. |
GLOBAL_Version | The viewable version number of the file. |
TIP
The reserved GLOBAL_* set is stable. New GLOBAL_* keys may be added but existing ones will not be removed or repurposed.
Customer-defined keys
In addition to the reserved keys, each customer can configure their own metadata schema per binder. Use GET /binders/{id}/metadataelements to enumerate the keys and (for enumerated keys) their allowed values.