Playground

Playground

Attachment

/api/v1/common/attachments

A file uploaded against any EDM entity — ticket, deal, contract, policy, etc. Bytes live in MinIO; this record is the metadata pointer.

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidFK → UserUser id from the caller's JWT (sub).
updated_byuuidFK → UserUser id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidFK → UserUser id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
entity_type*stringEDM entity type this file is attached to (ticket, deal, contract, policy, etc.).
entity_id*stringID of the source entity this file belongs to.
file_key*stringMinIO object key returned by client.storage.files.put().
name*stringOriginal filename shown in the UI.
sizenumberFile size in bytes.
content_typestringMIME content type (e.g. image/png, application/pdf).
uploaded_by_idstringUser who uploaded the file.
notestringOptional caption or description for the file.

API

client.common.attachments.*
Loading manifest…