JQL Fundamentals
Files and uploads
Multipart JQL requests, file field mappings, upload controllers, and signed file access.
File uploads use PUT /jql with multipart form data. The JSON query is supplied as a query part or file, and uploaded files are referenced by part name through sideEffects.fileFieldMapping.
Multipart create
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "objects.Document",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "sideEffects": {
8 "multipartFormUpload": true,
9 "fileFieldMapping": {
10 "file": "upload"
11 }
12 },
13 "return": {
14 "id": null,
15 "name": null,
16 "file": null
17 }
18 },
19 "name": "Signed NDA"
20}Send that JSON as the multipart query part and the binary file as upload.
Multipart update
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "tickets.Document",
5 "intent": "update",
6 "authenticationClass": "jwt",
7 "uniqueObject": {
8 "id": 900
9 },
10 "sideEffects": {
11 "multipartFormUpload": true,
12 "fileFieldMapping": {
13 "file": "attachment"
14 }
15 },
16 "return": {
17 "id": null,
18 "file": null
19 }
20 },
21 "name": "diagnostic-log.txt"
22}Upload controllers
Some domains expose controller upload flows for richer behavior:
objects.Document.uploadfor object record documents.tickets.Document.uploadfor ticket documents.documents.Folder.addDocumentanddocuments.Folder.createFolderWithDocumentsfor document management.learning.LearningContentRegistration.uploadPackagefor SCORM/xAPI packages.filemanager.File.appendFilesfor generic file attachment flows.
json
1{
2 "__meta__": {
3 "schema": "controller",
4 "namespace": "documents.Folder",
5 "intent": "addDocument",
6 "authenticationClass": "jwt"
7 },
8 "folder": 12,
9 "name": "Policy update"
10}Download and signatures
Protected model files are served through private file routes and model file metadata. Some document surfaces generate share tokens or signed access through document controllers. Treat returned file URLs and signatures as tenant-scoped secrets.
See /developer/forms-uploads, /guides/records, and documents.