> For the complete documentation index, see [llms.txt](https://www.center.daxium-air.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.center.daxium-air.com/api-reference/submissions.md). # Submissions Create, read, update, delete and search records ## GET /{app\_short}/submissions/assigned/me > List the submissions assigned to the authenticated user ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"Pagination":{"description":"Envelope shared by every paginated collection, alongside the collection itself.","properties":{"server_time":{"description":"Server timestamp at the moment the response was built.","type":"integer"},"total_count":{"description":"Total number of items matching the request, across all pages.","type":"integer"},"total_pages":{"type":"integer"},"next_page":{"description":"Index of the next page. Absent on the last one.","type":"integer"}},"type":"object"},"Submission":{"properties":{"id":{"type":"string","format":"uuid"},"structure_id":{"description":"Identifier of the form.","type":"integer"},"structure_version":{"description":"Version of the form the submission was filled against.","type":"integer"},"items":{"description":"Values of the submission, keyed by the system name of the field. The shape of a value depends on the field type.","type":"object","additionalProperties":true},"channels":{"description":"Broadcasts matched by the submission.","type":"array","items":{"type":"string"}},"user_id":{"description":"Owner of the submission.","type":"integer"},"last_updated_user_id":{"description":"User who last modified the submission.","type":"integer"},"assigned_user":{"description":"User the submission is assigned to. Present only when it is assigned.","type":"object"},"user":{"description":"The owner of the submission — same object shape as `assigned_user`. Only present when the request carries `items_expanded=true`; absent on the list and search endpoints regardless of that parameter.","type":"object"},"subscribers":{"description":"Users subscribed to the submission.","type":"array","items":{"type":"string"}},"current_state":{"description":"Workflow state the submission currently sits in.","type":"string","format":"uuid"},"submission_number":{"description":"Sequential number across the workspace.","type":"integer"},"number_in_structure":{"description":"Sequential number within the form.","type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"},"settings":{"type":"object"},"task_id":{"description":"Task the submission belongs to, when there is one.","type":"string","format":"uuid"},"data_created_at":{"description":"Creation timestamp of the data on the server.","type":"integer"},"data_updated_at":{"description":"Last update timestamp of the data on the server.","type":"integer"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"deleted_at":{"description":"Deletion timestamp. Present only when the submission has been deleted.","type":"integer"},"read_at":{"description":"When the submission was marked as read. Present only once that has happened.","type":"string","format":"date-time"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/assigned/me":{"get":{"tags":["submissions"],"summary":"List the submissions assigned to the authenticated user","operationId":"listAssignedSubmissions","parameters":[{"name":"page","in":"query","description":"Page of the overview.","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"0","pattern":"\\d+"}},{"name":"per_page","in":"query","description":"Number of result by page (Max 100)","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"10","pattern":"-?\\d+"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Paginated list of the submissions assigned to the authenticated user.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"submissions":{"type":"array","items":{"$ref":"#/components/schemas/Submission"}}},"type":"object"}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The user has no access to this workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## List submissions > Results are restricted to the forms the authenticated user has access to in the workspace. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"Pagination":{"description":"Envelope shared by every paginated collection, alongside the collection itself.","properties":{"server_time":{"description":"Server timestamp at the moment the response was built.","type":"integer"},"total_count":{"description":"Total number of items matching the request, across all pages.","type":"integer"},"total_pages":{"type":"integer"},"next_page":{"description":"Index of the next page. Absent on the last one.","type":"integer"}},"type":"object"},"Submission":{"properties":{"id":{"type":"string","format":"uuid"},"structure_id":{"description":"Identifier of the form.","type":"integer"},"structure_version":{"description":"Version of the form the submission was filled against.","type":"integer"},"items":{"description":"Values of the submission, keyed by the system name of the field. The shape of a value depends on the field type.","type":"object","additionalProperties":true},"channels":{"description":"Broadcasts matched by the submission.","type":"array","items":{"type":"string"}},"user_id":{"description":"Owner of the submission.","type":"integer"},"last_updated_user_id":{"description":"User who last modified the submission.","type":"integer"},"assigned_user":{"description":"User the submission is assigned to. Present only when it is assigned.","type":"object"},"user":{"description":"The owner of the submission — same object shape as `assigned_user`. Only present when the request carries `items_expanded=true`; absent on the list and search endpoints regardless of that parameter.","type":"object"},"subscribers":{"description":"Users subscribed to the submission.","type":"array","items":{"type":"string"}},"current_state":{"description":"Workflow state the submission currently sits in.","type":"string","format":"uuid"},"submission_number":{"description":"Sequential number across the workspace.","type":"integer"},"number_in_structure":{"description":"Sequential number within the form.","type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"},"settings":{"type":"object"},"task_id":{"description":"Task the submission belongs to, when there is one.","type":"string","format":"uuid"},"data_created_at":{"description":"Creation timestamp of the data on the server.","type":"integer"},"data_updated_at":{"description":"Last update timestamp of the data on the server.","type":"integer"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"deleted_at":{"description":"Deletion timestamp. Present only when the submission has been deleted.","type":"integer"},"read_at":{"description":"When the submission was marked as read. Present only once that has happened.","type":"string","format":"date-time"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions":{"get":{"tags":["submissions"],"summary":"List submissions","description":"Results are restricted to the forms the authenticated user has access to in the workspace.","operationId":"listSubmissions","parameters":[{"name":"structure_id","in":"query","description":"Form identifier (required unless `reference=true`).","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":null,"pattern":"\\d+"}},{"name":"page","in":"query","description":"Page of the overview.","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"0","pattern":"\\d+"}},{"name":"per_page","in":"query","description":"Number of result by page (Max 100)","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"10","pattern":"-?\\d+"}},{"name":"reference","in":"query","description":"Fetch reference data","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":null,"pattern":"true|false"}},{"name":"updated_since","in":"query","description":"Results updated since this date","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"\\d+"}},{"name":"user_id","in":"query","description":"Filter by user ID","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null}},{"name":"last_updated_user_id","in":"query","description":"Filter by last updated user ID","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null}},{"name":"items_expanded","in":"query","description":"Get full items list or user","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"true|false"}},{"name":"expanded_types","in":"query","description":"set expanded items types","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"[a-z,]+"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Paginated list of submissions.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"submissions":{"type":"array","items":{"$ref":"#/components/schemas/Submission"}}},"type":"object"}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"The user has no access to this workspace or to this form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## Create a submission > For \`image\`, \`signature\` and \`file\` fields, upload the file first and use the returned UUID here. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"SubmissionInput":{"required":["structure_id","structure_version","items"],"properties":{"created_at":{"description":"Defaults to now","type":"integer","format":"int64"},"id":{"description":"Auto-generated if omitted","type":"string","format":"uuid"},"items":{"type":"object","additionalProperties":true},"structure_id":{"type":"integer"},"structure_version":{"type":"integer"},"substitute_user_id":{"description":"Sets a different user as creator/owner; authenticated user is always traced in history","type":"integer"},"trigger_id":{"description":"Workflow transition to apply (PUT/PATCH only)","type":"string","format":"uuid"},"updated_at":{"description":"Defaults to now","type":"integer","format":"int64"}},"type":"object"},"Submission":{"properties":{"id":{"type":"string","format":"uuid"},"structure_id":{"description":"Identifier of the form.","type":"integer"},"structure_version":{"description":"Version of the form the submission was filled against.","type":"integer"},"items":{"description":"Values of the submission, keyed by the system name of the field. The shape of a value depends on the field type.","type":"object","additionalProperties":true},"channels":{"description":"Broadcasts matched by the submission.","type":"array","items":{"type":"string"}},"user_id":{"description":"Owner of the submission.","type":"integer"},"last_updated_user_id":{"description":"User who last modified the submission.","type":"integer"},"assigned_user":{"description":"User the submission is assigned to. Present only when it is assigned.","type":"object"},"user":{"description":"The owner of the submission — same object shape as `assigned_user`. Only present when the request carries `items_expanded=true`; absent on the list and search endpoints regardless of that parameter.","type":"object"},"subscribers":{"description":"Users subscribed to the submission.","type":"array","items":{"type":"string"}},"current_state":{"description":"Workflow state the submission currently sits in.","type":"string","format":"uuid"},"submission_number":{"description":"Sequential number across the workspace.","type":"integer"},"number_in_structure":{"description":"Sequential number within the form.","type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"},"settings":{"type":"object"},"task_id":{"description":"Task the submission belongs to, when there is one.","type":"string","format":"uuid"},"data_created_at":{"description":"Creation timestamp of the data on the server.","type":"integer"},"data_updated_at":{"description":"Last update timestamp of the data on the server.","type":"integer"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"deleted_at":{"description":"Deletion timestamp. Present only when the submission has been deleted.","type":"integer"},"read_at":{"description":"When the submission was marked as read. Present only once that has happened.","type":"string","format":"date-time"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions":{"post":{"tags":["submissions"],"summary":"Create a submission","description":"For `image`, `signature` and `file` fields, upload the file first and use the returned UUID here.","operationId":"createSubmission","parameters":[{"name":"partial","in":"query","description":"Allow partial mode","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"false","pattern":"true|false"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionInput"}}}},"responses":{"200":{"description":"Submission created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Submission"}}}},"400":{"description":"The payload is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Search submissions > Returns the submissions matching field-level criteria. A field can appear only once, and the case\ > of the operators is significant.\ > \ > \| Operator | Compatible field types |\ > \|---|---|\ > \| \`equal\` / \`notequal\` | text, number, boolean, date, email, phone |\ > \| \`isNull\` / \`isNotNull\` | all |\ > \| \`less\` / \`greater\` / \`lesseq\` / \`greatereq\` | number |\ > \| \`contains\` / \`notContains\` / \`startWith\` / \`endWith\` | text, email, phone |\ > \| \`in\` | list, user, text |\ > \| \`range\` | number, date | ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"SearchCriteria":{"description":"Object where each key is a valid system field name","type":"object","additionalProperties":{"required":["operator"],"properties":{"operator":{"type":"string","enum":["equal","notequal","isNull","isNotNull","less","greater","lesseq","greatereq","contains","notContains","startWith","endWith","in","range"]},"value":{"description":"Search value (omit for isNull / isNotNull)"}},"type":"object"}},"SubmissionListResponse":{"properties":{"server_time":{"type":"integer","format":"int64"},"submissions":{"type":"array","items":{"$ref":"#/components/schemas/Submission"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"},"Submission":{"properties":{"id":{"type":"string","format":"uuid"},"structure_id":{"description":"Identifier of the form.","type":"integer"},"structure_version":{"description":"Version of the form the submission was filled against.","type":"integer"},"items":{"description":"Values of the submission, keyed by the system name of the field. The shape of a value depends on the field type.","type":"object","additionalProperties":true},"channels":{"description":"Broadcasts matched by the submission.","type":"array","items":{"type":"string"}},"user_id":{"description":"Owner of the submission.","type":"integer"},"last_updated_user_id":{"description":"User who last modified the submission.","type":"integer"},"assigned_user":{"description":"User the submission is assigned to. Present only when it is assigned.","type":"object"},"user":{"description":"The owner of the submission — same object shape as `assigned_user`. Only present when the request carries `items_expanded=true`; absent on the list and search endpoints regardless of that parameter.","type":"object"},"subscribers":{"description":"Users subscribed to the submission.","type":"array","items":{"type":"string"}},"current_state":{"description":"Workflow state the submission currently sits in.","type":"string","format":"uuid"},"submission_number":{"description":"Sequential number across the workspace.","type":"integer"},"number_in_structure":{"description":"Sequential number within the form.","type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"},"settings":{"type":"object"},"task_id":{"description":"Task the submission belongs to, when there is one.","type":"string","format":"uuid"},"data_created_at":{"description":"Creation timestamp of the data on the server.","type":"integer"},"data_updated_at":{"description":"Last update timestamp of the data on the server.","type":"integer"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"deleted_at":{"description":"Deletion timestamp. Present only when the submission has been deleted.","type":"integer"},"read_at":{"description":"When the submission was marked as read. Present only once that has happened.","type":"string","format":"date-time"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/search":{"post":{"tags":["submissions"],"summary":"Search submissions","description":"Returns the submissions matching field-level criteria. A field can appear only once, and the case\nof the operators is significant.\n\n| Operator | Compatible field types |\n|---|---|\n| `equal` / `notequal` | text, number, boolean, date, email, phone |\n| `isNull` / `isNotNull` | all |\n| `less` / `greater` / `lesseq` / `greatereq` | number |\n| `contains` / `notContains` / `startWith` / `endWith` | text, email, phone |\n| `in` | list, user, text |\n| `range` | number, date |","operationId":"searchSubmissions","parameters":[{"name":"structure_id","in":"query","description":"Form identifier (required unless `reference=true`).","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":null,"pattern":"\\d+"}},{"name":"page","in":"query","description":"Page of the overview.","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"0","pattern":"\\d+"}},{"name":"per_page","in":"query","description":"Number of result by page (Max 1000)","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"10","pattern":"-?\\d+"}},{"name":"reference","in":"query","description":"Fetch reference data","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":null,"pattern":"true|false"}},{"name":"updated_since","in":"query","description":"Results updated since this date","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"\\d+"}},{"name":"user_id","in":"query","description":"Filter by user ID","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null}},{"name":"last_updated_user_id","in":"query","description":"Filter by last updated user ID","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null}},{"name":"items_expanded","in":"query","description":"Get full items list or user","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"true|false"}},{"name":"expanded_types","in":"query","description":"set expanded items types","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"[a-z,]+"}},{"name":"show_deleted_lists","in":"query","description":"Get list item even deleted","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"true|false"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCriteria"}}}},"responses":{"200":{"description":"Matching submissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionListResponse"}}}},"400":{"description":"Unknown operator, or an operator incompatible with the field type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## GET /{app\_short}/submissions/{submission\_id} > Get a submission ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"Submission":{"properties":{"id":{"type":"string","format":"uuid"},"structure_id":{"description":"Identifier of the form.","type":"integer"},"structure_version":{"description":"Version of the form the submission was filled against.","type":"integer"},"items":{"description":"Values of the submission, keyed by the system name of the field. The shape of a value depends on the field type.","type":"object","additionalProperties":true},"channels":{"description":"Broadcasts matched by the submission.","type":"array","items":{"type":"string"}},"user_id":{"description":"Owner of the submission.","type":"integer"},"last_updated_user_id":{"description":"User who last modified the submission.","type":"integer"},"assigned_user":{"description":"User the submission is assigned to. Present only when it is assigned.","type":"object"},"user":{"description":"The owner of the submission — same object shape as `assigned_user`. Only present when the request carries `items_expanded=true`; absent on the list and search endpoints regardless of that parameter.","type":"object"},"subscribers":{"description":"Users subscribed to the submission.","type":"array","items":{"type":"string"}},"current_state":{"description":"Workflow state the submission currently sits in.","type":"string","format":"uuid"},"submission_number":{"description":"Sequential number across the workspace.","type":"integer"},"number_in_structure":{"description":"Sequential number within the form.","type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"},"settings":{"type":"object"},"task_id":{"description":"Task the submission belongs to, when there is one.","type":"string","format":"uuid"},"data_created_at":{"description":"Creation timestamp of the data on the server.","type":"integer"},"data_updated_at":{"description":"Last update timestamp of the data on the server.","type":"integer"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"deleted_at":{"description":"Deletion timestamp. Present only when the submission has been deleted.","type":"integer"},"read_at":{"description":"When the submission was marked as read. Present only once that has happened.","type":"string","format":"date-time"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/{submission_id}":{"get":{"tags":["submissions"],"summary":"Get a submission","operationId":"getSubmission","parameters":[{"name":"items_expanded","in":"query","description":"Get full items list or user","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"true|false"}},{"name":"expanded_types","in":"query","description":"set expanded items types","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"[a-z,]+"}},{"name":"fields","in":"query","description":"Get additionnal fields","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"\\w+"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"name":"submission_id","in":"path","required":true,"schema":{"type":"string","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"The requested submission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Submission"}}}},"400":{"description":"The identifier is not a valid UUID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No submission with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## Update a submission > Replaces the submission data. On a form with a workflow, include \`trigger\_id\` to advance the state. A submission sitting in an end state can no longer be modified. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"SubmissionInput":{"required":["structure_id","structure_version","items"],"properties":{"created_at":{"description":"Defaults to now","type":"integer","format":"int64"},"id":{"description":"Auto-generated if omitted","type":"string","format":"uuid"},"items":{"type":"object","additionalProperties":true},"structure_id":{"type":"integer"},"structure_version":{"type":"integer"},"substitute_user_id":{"description":"Sets a different user as creator/owner; authenticated user is always traced in history","type":"integer"},"trigger_id":{"description":"Workflow transition to apply (PUT/PATCH only)","type":"string","format":"uuid"},"updated_at":{"description":"Defaults to now","type":"integer","format":"int64"}},"type":"object"},"Submission":{"properties":{"id":{"type":"string","format":"uuid"},"structure_id":{"description":"Identifier of the form.","type":"integer"},"structure_version":{"description":"Version of the form the submission was filled against.","type":"integer"},"items":{"description":"Values of the submission, keyed by the system name of the field. The shape of a value depends on the field type.","type":"object","additionalProperties":true},"channels":{"description":"Broadcasts matched by the submission.","type":"array","items":{"type":"string"}},"user_id":{"description":"Owner of the submission.","type":"integer"},"last_updated_user_id":{"description":"User who last modified the submission.","type":"integer"},"assigned_user":{"description":"User the submission is assigned to. Present only when it is assigned.","type":"object"},"user":{"description":"The owner of the submission — same object shape as `assigned_user`. Only present when the request carries `items_expanded=true`; absent on the list and search endpoints regardless of that parameter.","type":"object"},"subscribers":{"description":"Users subscribed to the submission.","type":"array","items":{"type":"string"}},"current_state":{"description":"Workflow state the submission currently sits in.","type":"string","format":"uuid"},"submission_number":{"description":"Sequential number across the workspace.","type":"integer"},"number_in_structure":{"description":"Sequential number within the form.","type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"},"settings":{"type":"object"},"task_id":{"description":"Task the submission belongs to, when there is one.","type":"string","format":"uuid"},"data_created_at":{"description":"Creation timestamp of the data on the server.","type":"integer"},"data_updated_at":{"description":"Last update timestamp of the data on the server.","type":"integer"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"deleted_at":{"description":"Deletion timestamp. Present only when the submission has been deleted.","type":"integer"},"read_at":{"description":"When the submission was marked as read. Present only once that has happened.","type":"string","format":"date-time"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/{submission_id}":{"put":{"tags":["submissions"],"summary":"Update a submission","description":"Replaces the submission data. On a form with a workflow, include `trigger_id` to advance the state. A submission sitting in an end state can no longer be modified.","operationId":"updateSubmission","parameters":[{"name":"partial","in":"query","description":"Allow partial mode","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"false","pattern":"true|false"}},{"name":"force_restore","in":"query","description":"Allow mobile app to restore a deleted submission","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"false"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"name":"submission_id","in":"path","required":true,"schema":{"type":"string","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionInput"}}}},"responses":{"200":{"description":"Updated submission","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Submission"}}}},"400":{"description":"The payload is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No submission with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## DELETE /{app\_short}/submissions/{submission\_id} > Delete a submission ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}}},"paths":{"/{app_short}/submissions/{submission_id}":{"delete":{"tags":["submissions"],"summary":"Delete a submission","operationId":"deleteSubmission","parameters":[{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"name":"submission_id","in":"path","required":true,"schema":{"type":"string","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"204":{"description":"Submission deleted"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No submission with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## Partially update a submission > Only the \`items\` supplied are updated; every other field is left untouched. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"SubmissionInput":{"required":["structure_id","structure_version","items"],"properties":{"created_at":{"description":"Defaults to now","type":"integer","format":"int64"},"id":{"description":"Auto-generated if omitted","type":"string","format":"uuid"},"items":{"type":"object","additionalProperties":true},"structure_id":{"type":"integer"},"structure_version":{"type":"integer"},"substitute_user_id":{"description":"Sets a different user as creator/owner; authenticated user is always traced in history","type":"integer"},"trigger_id":{"description":"Workflow transition to apply (PUT/PATCH only)","type":"string","format":"uuid"},"updated_at":{"description":"Defaults to now","type":"integer","format":"int64"}},"type":"object"},"Submission":{"properties":{"id":{"type":"string","format":"uuid"},"structure_id":{"description":"Identifier of the form.","type":"integer"},"structure_version":{"description":"Version of the form the submission was filled against.","type":"integer"},"items":{"description":"Values of the submission, keyed by the system name of the field. The shape of a value depends on the field type.","type":"object","additionalProperties":true},"channels":{"description":"Broadcasts matched by the submission.","type":"array","items":{"type":"string"}},"user_id":{"description":"Owner of the submission.","type":"integer"},"last_updated_user_id":{"description":"User who last modified the submission.","type":"integer"},"assigned_user":{"description":"User the submission is assigned to. Present only when it is assigned.","type":"object"},"user":{"description":"The owner of the submission — same object shape as `assigned_user`. Only present when the request carries `items_expanded=true`; absent on the list and search endpoints regardless of that parameter.","type":"object"},"subscribers":{"description":"Users subscribed to the submission.","type":"array","items":{"type":"string"}},"current_state":{"description":"Workflow state the submission currently sits in.","type":"string","format":"uuid"},"submission_number":{"description":"Sequential number across the workspace.","type":"integer"},"number_in_structure":{"description":"Sequential number within the form.","type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"},"settings":{"type":"object"},"task_id":{"description":"Task the submission belongs to, when there is one.","type":"string","format":"uuid"},"data_created_at":{"description":"Creation timestamp of the data on the server.","type":"integer"},"data_updated_at":{"description":"Last update timestamp of the data on the server.","type":"integer"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"deleted_at":{"description":"Deletion timestamp. Present only when the submission has been deleted.","type":"integer"},"read_at":{"description":"When the submission was marked as read. Present only once that has happened.","type":"string","format":"date-time"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/{submission_id}":{"patch":{"tags":["submissions"],"summary":"Partially update a submission","description":"Only the `items` supplied are updated; every other field is left untouched.","operationId":"patchSubmission","parameters":[{"name":"partial","in":"query","description":"Allow partial mode","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"false","pattern":"true|false"}},{"name":"force_restore","in":"query","description":"Allow mobile app to restore a deleted submission","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"false"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"name":"submission_id","in":"path","required":true,"schema":{"type":"string","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionInput"}}}},"responses":{"200":{"description":"Full updated submission","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Submission"}}}},"400":{"description":"The payload is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No submission with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## Create multiple submissions (async) > Poll \`callbackUrl\` for the status of the job. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"SubmissionInput":{"required":["structure_id","structure_version","items"],"properties":{"created_at":{"description":"Defaults to now","type":"integer","format":"int64"},"id":{"description":"Auto-generated if omitted","type":"string","format":"uuid"},"items":{"type":"object","additionalProperties":true},"structure_id":{"type":"integer"},"structure_version":{"type":"integer"},"substitute_user_id":{"description":"Sets a different user as creator/owner; authenticated user is always traced in history","type":"integer"},"trigger_id":{"description":"Workflow transition to apply (PUT/PATCH only)","type":"string","format":"uuid"},"updated_at":{"description":"Defaults to now","type":"integer","format":"int64"}},"type":"object"},"CallbackUrlResponse":{"properties":{"callbackUrl":{"description":"URL to poll for async job status","type":"string"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/multiple":{"post":{"tags":["submissions"],"summary":"Create multiple submissions (async)","description":"Poll `callbackUrl` for the status of the job.","operationId":"createMultipleSubmissions","parameters":[{"name":"partial","in":"query","description":"Allow partial mode","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"false","pattern":"true|false"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubmissionInput"}}}}},"responses":{"200":{"description":"Async job accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallbackUrlResponse"}}}},"400":{"description":"Empty payload, or more submissions than the configured maximum.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Update multiple submissions (async) > Poll \`callbackUrl\` for the status of the job. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"SubmissionInput":{"required":["structure_id","structure_version","items"],"properties":{"created_at":{"description":"Defaults to now","type":"integer","format":"int64"},"id":{"description":"Auto-generated if omitted","type":"string","format":"uuid"},"items":{"type":"object","additionalProperties":true},"structure_id":{"type":"integer"},"structure_version":{"type":"integer"},"substitute_user_id":{"description":"Sets a different user as creator/owner; authenticated user is always traced in history","type":"integer"},"trigger_id":{"description":"Workflow transition to apply (PUT/PATCH only)","type":"string","format":"uuid"},"updated_at":{"description":"Defaults to now","type":"integer","format":"int64"}},"type":"object"},"CallbackUrlResponse":{"properties":{"callbackUrl":{"description":"URL to poll for async job status","type":"string"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/multiple":{"put":{"tags":["submissions"],"summary":"Update multiple submissions (async)","description":"Poll `callbackUrl` for the status of the job.","operationId":"updateMultipleSubmissions","parameters":[{"name":"partial","in":"query","description":"Allow partial mode","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"false","pattern":"true|false"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubmissionInput"}}}}},"responses":{"200":{"description":"Async job accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallbackUrlResponse"}}}},"400":{"description":"Empty payload, or more submissions than the configured maximum.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Get submissions by identifiers > Each identifier can optionally carry an \`updated\_since\` filter. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"Submission":{"properties":{"id":{"type":"string","format":"uuid"},"structure_id":{"description":"Identifier of the form.","type":"integer"},"structure_version":{"description":"Version of the form the submission was filled against.","type":"integer"},"items":{"description":"Values of the submission, keyed by the system name of the field. The shape of a value depends on the field type.","type":"object","additionalProperties":true},"channels":{"description":"Broadcasts matched by the submission.","type":"array","items":{"type":"string"}},"user_id":{"description":"Owner of the submission.","type":"integer"},"last_updated_user_id":{"description":"User who last modified the submission.","type":"integer"},"assigned_user":{"description":"User the submission is assigned to. Present only when it is assigned.","type":"object"},"user":{"description":"The owner of the submission — same object shape as `assigned_user`. Only present when the request carries `items_expanded=true`; absent on the list and search endpoints regardless of that parameter.","type":"object"},"subscribers":{"description":"Users subscribed to the submission.","type":"array","items":{"type":"string"}},"current_state":{"description":"Workflow state the submission currently sits in.","type":"string","format":"uuid"},"submission_number":{"description":"Sequential number across the workspace.","type":"integer"},"number_in_structure":{"description":"Sequential number within the form.","type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"},"settings":{"type":"object"},"task_id":{"description":"Task the submission belongs to, when there is one.","type":"string","format":"uuid"},"data_created_at":{"description":"Creation timestamp of the data on the server.","type":"integer"},"data_updated_at":{"description":"Last update timestamp of the data on the server.","type":"integer"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"deleted_at":{"description":"Deletion timestamp. Present only when the submission has been deleted.","type":"integer"},"read_at":{"description":"When the submission was marked as read. Present only once that has happened.","type":"string","format":"date-time"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/byids":{"post":{"tags":["submissions"],"summary":"Get submissions by identifiers","description":"Each identifier can optionally carry an `updated_since` filter.","operationId":"getSubmissionsByIds","parameters":[{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["submission_ids"],"properties":{"submission_ids":{"type":"array","items":{"required":["id"],"properties":{"id":{"type":"string","format":"uuid"},"updated_since":{"description":"Skip this submission when it has not changed since that timestamp.","type":"integer"}},"type":"object"}}},"type":"object"}}}},"responses":{"200":{"description":"Matching submissions","content":{"application/json":{"schema":{"properties":{"submissions":{"type":"array","items":{"$ref":"#/components/schemas/Submission"}}},"type":"object"}}}},"400":{"description":"Too many identifiers for a single request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Upload a file for a submission > Uploads a file to attach to an \`image\`, \`signature\` or \`file\` field. Use the returned \`uuid\` in that field. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"FileUploadResponse":{"properties":{"mime-type":{"type":"string"},"size":{"description":"File size in bytes","type":"integer"},"uuid":{"description":"Reference this UUID in submission fields of type image/signature/file","type":"string","format":"uuid"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/upload":{"post":{"tags":["submissions"],"summary":"Upload a file for a submission","description":"Uploads a file to attach to an `image`, `signature` or `file` field. Use the returned `uuid` in that field.","operationId":"uploadSubmissionFile","parameters":[{"name":"convertToPdf","in":"query","description":"Convert uploaded file to PDF","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"false","pattern":"true|false"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"File uploaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## POST /{app\_short}/submissions/upload/{submission\_id}/{file\_id} > Upload a file with explicit submission and file identifiers ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"FileUploadResponse":{"properties":{"mime-type":{"type":"string"},"size":{"description":"File size in bytes","type":"integer"},"uuid":{"description":"Reference this UUID in submission fields of type image/signature/file","type":"string","format":"uuid"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/upload/{submission_id}/{file_id}":{"post":{"tags":["submissions"],"summary":"Upload a file with explicit submission and file identifiers","operationId":"uploadSubmissionFileWithIds","parameters":[{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"name":"submission_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"file_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"File uploaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## GET /{app\_short}/submissions/{submission\_id}/file/{file\_id} > Get a file attached to a submission ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}}},"paths":{"/{app_short}/submissions/{submission_id}/file/{file_id}":{"get":{"tags":["submissions"],"summary":"Get a file attached to a submission","operationId":"getSubmissionFile","parameters":[{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"name":"submission_id","in":"path","required":true,"schema":{"type":"string","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}"}},{"name":"file_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Binary file content","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No submission with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## GET /{app\_short}/submissions/multiple/callback/{callback\_id} > Poll an async submission job ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"submissions"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"SubmissionCallbackResponse":{"properties":{"callbackDetails":{"properties":{"errors":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"nbErrors":{"type":"integer"},"nbRecordsDone":{"type":"integer"},"nbRecordsTodo":{"type":"integer"},"nbSuccess":{"type":"integer"},"status":{"type":"string","enum":["Planned","Running","Finished","Finished with errors","Failed","In timeout"]},"success":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/submissions/multiple/callback/{callback_id}":{"get":{"tags":["submissions"],"summary":"Poll an async submission job","operationId":"getMultipleSubmissionsCallback","parameters":[{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"name":"callback_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Job status and per-submission results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionCallbackResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://www.center.daxium-air.com/api-reference/submissions.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.