Namespace Reference — Modules
Documents
Curated JQL namespaces and examples for documents.
Documents namespaces cover registries, folders, cabinets, templates, documents, approvals, associations, versions, signature placeholders, signatures, annotations, history, permissions, shares, and settings.
Key namespaces and models
documents.DocumentTemplatedocuments.Documentdocuments.DocumentApprovalRequestdocuments.DocumentAssociationdocuments.DocumentVersiondocuments.DocumentVersionSignaturePlaceholderdocuments.DocumentVersionSignaturedocuments.DocumentVersionAnnotationdocuments.DocumentHistorydocuments.DocumentPermissiondocuments.DocumentSharedocuments.DocumentSettings
Common controller intents
documents.Folder.addDocumentdocuments.Folder.createFolderdocuments.Folder.createFolderWithDocumentsdocuments.Folder.getTenantDocumentStatisticsdocuments.Folder.accessFolderShareLinkdocuments.Document.irisChatWithDocumentdocuments.Document.awaitingApprovals
Common model intents
Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.
Retrieve example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "documents.Document",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "ordering": "-created",
8 "limit": 20
9 },
10 "id": null,
11 "created": null
12}Create example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "documents.DocumentTemplate",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "alias": null
11 }
12 },
13 "name": "NDA template",
14 "alias": "nda-template"
15}For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.