Submissions

Create, read, update, delete and search records

List submissions

get

Returns submissions for a form with pagination. Set reference=true to return reference data across all forms (omit structure_id in that case).

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Query parameters

structure_idintegerOptional

Form identifier (required unless reference=true)

per_pageintegerOptional

pageintegerOptional

updated_sinceinteger · int64Optional

items_expandedbooleanOptional

Return list labels instead of IDs only

referencebooleanOptional

Set to true to return all reference data across all forms (shared reference lists used to prefill fields). Omit structure_id in that case.

Responses

200

Paginated submissions

application/json

total_countintegerOptional

total_pagesintegerOptional

server_timeinteger · int64Optional

get/{app_short}/submissions

By form

curl -H "Authorization: Bearer $TOKEN" \
     -H "X-Accept-Version: v1.3" \
     "https://api.daxium-air.com/daxium-test/submissions?structure_id=1"

200

Paginated submissions

{
  "submissions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "structure_id": 1,
      "structure_version": 1,
      "created_at": 1,
      "updated_at": 1,
      "data_created_at": 1,
      "data_updated_at": 1,
      "user_id": 1,
      "channels": [
        "text"
      ],
      "items": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "submission_number": 1,
      "number_in_structure": 1,
      "latitude": 1,
      "longitude": 1,
      "last_updated_user_id": 1,
      "current_state": "123e4567-e89b-12d3-a456-426614174000",
      "assigned_user": {
        "id": 1,
        "email": "[e-mail]",
        "first_name": "text",
        "last_name": "text",
        "groups": [],
        "system_groups": []
      },
      "subscribers": [],
      "settings": []
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

Create a submission

post

Creates a new submission. For image, signature, or file fields, upload the file first and use the returned UUID here.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Query parameters

partialbooleanOptional

If true, ignores required/editable field permissions

Body

application/json

idstring · uuidOptional

Auto-generated if omitted

structure_idintegerRequired

structure_versionintegerRequired

created_atinteger · int64Optional

Defaults to now

updated_atinteger · int64Optional

Defaults to now

trigger_idstring · uuidOptional

Workflow transition to apply (PUT/PATCH only)

substitute_user_idintegerOptional

Sets a different user as creator/owner; authenticated user is always traced in history

Responses

200

Submission created

application/json

idstring · uuidOptional

structure_idintegerOptional

structure_versionintegerOptional

created_atinteger · int64Optional

updated_atinteger · int64Optional

data_created_atinteger · int64Optional

data_updated_atinteger · int64Optional

user_idintegerOptional

channelsstring[]Optional

submission_numberintegerOptional

number_in_structureintegerOptional

latitudenumber · doubleOptional

longitudenumber · doubleOptional

last_updated_user_idintegerOptional

current_statestring · uuid · nullableOptional

Current workflow state UUID

post/{app_short}/submissions

CLI

curl -X POST \
     -H "Authorization: Bearer $TOKEN" \
     -H "X-Accept-Version: v1.3" \
     -H "Content-Type: application/json" \
     -d '{"structure_id":1,"structure_version":3,"items":{"string4":"Hello"}}' \
     https://api.daxium-air.com/daxium-test/submissions

200

Submission created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "structure_id": 1,
  "structure_version": 1,
  "created_at": 1,
  "updated_at": 1,
  "data_created_at": 1,
  "data_updated_at": 1,
  "user_id": 1,
  "channels": [
    "text"
  ],
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "submission_number": 1,
  "number_in_structure": 1,
  "latitude": 1,
  "longitude": 1,
  "last_updated_user_id": 1,
  "current_state": "123e4567-e89b-12d3-a456-426614174000",
  "assigned_user": {
    "id": 1,
    "email": "[e-mail]",
    "first_name": "text",
    "last_name": "text",
    "groups": [],
    "system_groups": []
  },
  "subscribers": [],
  "settings": []
}

Get submissions by IDs (up to 500)

post

Returns submissions for up to 500 UUIDs. Each ID can optionally carry an updated_since filter.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Query parameters

items_expandedbooleanOptional

Body

application/json

Responses

200

Matching submissions

application/json

400

Too many IDs (max 500)

application/json

post/{app_short}/submissions/byids

HTTPcURLJavaScriptPython

POST /{app_short}/submissions/byids HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "submission_ids": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "updated_since": 1
    }
  ]
}

{
  "submissions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "structure_id": 1,
      "structure_version": 1,
      "created_at": 1,
      "updated_at": 1,
      "data_created_at": 1,
      "data_updated_at": 1,
      "user_id": 1,
      "channels": [
        "text"
      ],
      "items": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "submission_number": 1,
      "number_in_structure": 1,
      "latitude": 1,
      "longitude": 1,
      "last_updated_user_id": 1,
      "current_state": "123e4567-e89b-12d3-a456-426614174000",
      "assigned_user": {
        "id": 1,
        "email": "[e-mail]",
        "first_name": "text",
        "last_name": "text",
        "groups": [],
        "system_groups": []
      },
      "subscribers": [],
      "settings": []
    }
  ]
}

Search submissions

post

Returns submissions matching field-level criteria. Each field can appear only once. Operator case 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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Query parameters

structure_idintegerRequired

per_pageintegerOptional

pageintegerOptional

last_updated_user_idintegerOptional

Filters submissions whose last update was performed by the user with this ID. Optional criterion passed directly in the URL.

Body

application/json

Object where each key is a valid system field name

Responses

200

Matching submissions

application/json

total_countintegerOptional

total_pagesintegerOptional

server_timeinteger · int64Optional

post/{app_short}/submissions/search

HTTPcURLJavaScriptPython

POST /{app_short}/submissions/search?structure_id=1 HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "ANY_ADDITIONAL_PROPERTY": {
    "value": null,
    "operator": "equal"
  }
}

200

Matching submissions

{
  "submissions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "structure_id": 1,
      "structure_version": 1,
      "created_at": 1,
      "updated_at": 1,
      "data_created_at": 1,
      "data_updated_at": 1,
      "user_id": 1,
      "channels": [
        "text"
      ],
      "items": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "submission_number": 1,
      "number_in_structure": 1,
      "latitude": 1,
      "longitude": 1,
      "last_updated_user_id": 1,
      "current_state": "123e4567-e89b-12d3-a456-426614174000",
      "assigned_user": {
        "id": 1,
        "email": "[e-mail]",
        "first_name": "text",
        "last_name": "text",
        "groups": [],
        "system_groups": []
      },
      "subscribers": [],
      "settings": []
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

Create multiple submissions (async)

post

Creates up to 100 submissions asynchronously. Poll callbackUrl for status.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Bodyobject · SubmissionInput[]

application/json

idstring · uuidOptional

Auto-generated if omitted

structure_idintegerRequired

structure_versionintegerRequired

created_atinteger · int64Optional

Defaults to now

updated_atinteger · int64Optional

Defaults to now

trigger_idstring · uuidOptional

Workflow transition to apply (PUT/PATCH only)

substitute_user_idintegerOptional

Sets a different user as creator/owner; authenticated user is always traced in history

Responses

200

Async job accepted

application/json

callbackUrlstringOptional

URL to poll for async job status

400

Empty payload or more than 100 submissions

application/json

post/{app_short}/submissions/multiple

HTTPcURLJavaScriptPython

POST /{app_short}/submissions/multiple HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "structure_id": 1,
    "structure_version": 1,
    "created_at": 1,
    "updated_at": 1,
    "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
    "substitute_user_id": 1,
    "items": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

{
  "callbackUrl": "text"
}

Update multiple submissions (async)

put

Updates up to 100 submissions asynchronously. Poll callbackUrl for status.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Bodyobject · SubmissionInput[]

application/json

idstring · uuidOptional

Auto-generated if omitted

structure_idintegerRequired

structure_versionintegerRequired

created_atinteger · int64Optional

Defaults to now

updated_atinteger · int64Optional

Defaults to now

trigger_idstring · uuidOptional

Workflow transition to apply (PUT/PATCH only)

substitute_user_idintegerOptional

Sets a different user as creator/owner; authenticated user is always traced in history

Responses

200

Async job accepted

application/json

callbackUrlstringOptional

URL to poll for async job status

400

Empty payload or more than 100 submissions

application/json

put/{app_short}/submissions/multiple

HTTPcURLJavaScriptPython

PUT /{app_short}/submissions/multiple HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "structure_id": 1,
    "structure_version": 1,
    "created_at": 1,
    "updated_at": 1,
    "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
    "substitute_user_id": 1,
    "items": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

{
  "callbackUrl": "text"
}

Poll async submission job status

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

callback_idstring · uuidRequired

Responses

200

Job status and per-submission results

application/json

get/{app_short}/submissions/multiple/callback/{callback_id}

HTTPcURLJavaScriptPython

GET /{app_short}/submissions/multiple/callback/{callback_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Job status and per-submission results

{
  "callbackDetails": {
    "status": "Planned",
    "nbRecordsTodo": 1,
    "nbRecordsDone": 1,
    "nbSuccess": 1,
    "nbErrors": 1,
    "success": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "errors": [
      {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      }
    ]
  }
}

Upload a file for a submission

post

Uploads a file to attach to a submission field (image, signature, file type).

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Body

application/octet-stream

string · binaryOptional

Responses

200

File uploaded — use the returned uuid in the submission field

application/json

uuidstring · uuidOptional

Reference this UUID in submission fields of type image/signature/file

mime-typestringOptional

sizeintegerOptional

File size in bytes

post/{app_short}/submissions/upload

HTTPcURLJavaScriptPython

POST /{app_short}/submissions/upload HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/octet-stream
Accept: */*
Content-Length: 8

"binary"

200

File uploaded — use the returned uuid in the submission field

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "mime-type": "text",
  "size": 1
}

Upload a file with explicit submission and file IDs

post

Alternative upload that pre-assigns both the submission UUID and file UUID.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

submissionIdstring · uuidRequired

fileIdstring · uuidRequired

Body

application/octet-stream

string · binaryOptional

Responses

200

File uploaded

application/json

uuidstring · uuidOptional

Reference this UUID in submission fields of type image/signature/file

mime-typestringOptional

sizeintegerOptional

File size in bytes

post/{app_short}/submissions/upload/{submissionId}/{fileId}

HTTPcURLJavaScriptPython

POST /{app_short}/submissions/upload/{submissionId}/{fileId} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/octet-stream
Accept: */*
Content-Length: 8

"binary"

200

File uploaded

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "mime-type": "text",
  "size": 1
}

Get a submission

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

Responses

200

Submission object

application/json

idstring · uuidOptional

structure_idintegerOptional

structure_versionintegerOptional

created_atinteger · int64Optional

updated_atinteger · int64Optional

data_created_atinteger · int64Optional

data_updated_atinteger · int64Optional

user_idintegerOptional

channelsstring[]Optional

submission_numberintegerOptional

number_in_structureintegerOptional

latitudenumber · doubleOptional

longitudenumber · doubleOptional

last_updated_user_idintegerOptional

current_statestring · uuid · nullableOptional

Current workflow state UUID

get/{app_short}/submissions/{id}

HTTPcURLJavaScriptPython

GET /{app_short}/submissions/{id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Submission object

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "structure_id": 1,
  "structure_version": 1,
  "created_at": 1,
  "updated_at": 1,
  "data_created_at": 1,
  "data_updated_at": 1,
  "user_id": 1,
  "channels": [
    "text"
  ],
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "submission_number": 1,
  "number_in_structure": 1,
  "latitude": 1,
  "longitude": 1,
  "last_updated_user_id": 1,
  "current_state": "123e4567-e89b-12d3-a456-426614174000",
  "assigned_user": {
    "id": 1,
    "email": "[e-mail]",
    "first_name": "text",
    "last_name": "text",
    "groups": [],
    "system_groups": []
  },
  "subscribers": [],
  "settings": []
}

Update a submission

put

Replaces submission data. For workflow-enabled forms, include trigger_id to advance the state. Submissions in an end-state cannot be modified.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

Query parameters

partialbooleanOptional

If true, ignores required/editable field permissions

Body

application/json

idstring · uuidOptional

Auto-generated if omitted

structure_idintegerRequired

structure_versionintegerRequired

created_atinteger · int64Optional

Defaults to now

updated_atinteger · int64Optional

Defaults to now

trigger_idstring · uuidOptional

Workflow transition to apply (PUT/PATCH only)

substitute_user_idintegerOptional

Sets a different user as creator/owner; authenticated user is always traced in history

Responses

200

Updated submission

application/json

idstring · uuidOptional

structure_idintegerOptional

structure_versionintegerOptional

created_atinteger · int64Optional

updated_atinteger · int64Optional

data_created_atinteger · int64Optional

data_updated_atinteger · int64Optional

user_idintegerOptional

channelsstring[]Optional

submission_numberintegerOptional

number_in_structureintegerOptional

latitudenumber · doubleOptional

longitudenumber · doubleOptional

last_updated_user_idintegerOptional

current_statestring · uuid · nullableOptional

Current workflow state UUID

put/{app_short}/submissions/{id}

HTTPcURLJavaScriptPython

PUT /{app_short}/submissions/{id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "structure_id": 1,
  "structure_version": 1,
  "created_at": 1,
  "updated_at": 1,
  "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "substitute_user_id": 1,
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

200

Updated submission

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "structure_id": 1,
  "structure_version": 1,
  "created_at": 1,
  "updated_at": 1,
  "data_created_at": 1,
  "data_updated_at": 1,
  "user_id": 1,
  "channels": [
    "text"
  ],
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "submission_number": 1,
  "number_in_structure": 1,
  "latitude": 1,
  "longitude": 1,
  "last_updated_user_id": 1,
  "current_state": "123e4567-e89b-12d3-a456-426614174000",
  "assigned_user": {
    "id": 1,
    "email": "[e-mail]",
    "first_name": "text",
    "last_name": "text",
    "groups": [],
    "system_groups": []
  },
  "subscribers": [],
  "settings": []
}

Delete a submission

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

Responses

204

Submission deleted

No content

delete/{app_short}/submissions/{id}

HTTPcURLJavaScriptPython

DELETE /{app_short}/submissions/{id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Submission deleted

No content

Partially update a submission

patch

Updates only the items supplied; all other fields remain unchanged.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

Body

application/json

idstring · uuidOptional

Auto-generated if omitted

structure_idintegerRequired

structure_versionintegerRequired

created_atinteger · int64Optional

Defaults to now

updated_atinteger · int64Optional

Defaults to now

trigger_idstring · uuidOptional

Workflow transition to apply (PUT/PATCH only)

substitute_user_idintegerOptional

Sets a different user as creator/owner; authenticated user is always traced in history

Responses

200

Full updated submission returned

application/json

idstring · uuidOptional

structure_idintegerOptional

structure_versionintegerOptional

created_atinteger · int64Optional

updated_atinteger · int64Optional

data_created_atinteger · int64Optional

data_updated_atinteger · int64Optional

user_idintegerOptional

channelsstring[]Optional

submission_numberintegerOptional

number_in_structureintegerOptional

latitudenumber · doubleOptional

longitudenumber · doubleOptional

last_updated_user_idintegerOptional

current_statestring · uuid · nullableOptional

Current workflow state UUID

patch/{app_short}/submissions/{id}

HTTPcURLJavaScriptPython

PATCH /{app_short}/submissions/{id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "structure_id": 1,
  "structure_version": 1,
  "created_at": 1,
  "updated_at": 1,
  "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "substitute_user_id": 1,
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

200

Full updated submission returned

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "structure_id": 1,
  "structure_version": 1,
  "created_at": 1,
  "updated_at": 1,
  "data_created_at": 1,
  "data_updated_at": 1,
  "user_id": 1,
  "channels": [
    "text"
  ],
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "submission_number": 1,
  "number_in_structure": 1,
  "latitude": 1,
  "longitude": 1,
  "last_updated_user_id": 1,
  "current_state": "123e4567-e89b-12d3-a456-426614174000",
  "assigned_user": {
    "id": 1,
    "email": "[e-mail]",
    "first_name": "text",
    "last_name": "text",
    "groups": [],
    "system_groups": []
  },
  "subscribers": [],
  "settings": []
}

Get a file attached to a submission

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

file_idstring · uuidRequired

Responses

200

Binary file content

application/octet-stream

string · binaryOptional

get/{app_short}/submissions/{id}/file/{file_id}

HTTPcURLJavaScriptPython

GET /{app_short}/submissions/{id}/file/{file_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Binary file content

binary