> 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/models.md).

# Models

## The ErrorResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"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"}}}}
```

## The BasicErrorResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"BasicErrorResponse":{"description":"Reduced error body, returned by the few endpoints that build the response themselves instead of letting the REST exception subscriber format it — the token endpoint notably, since that subscriber only runs on the API host.","properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}
```

## The TokenResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"TokenResponse":{"properties":{"access_token":{"description":"Token to send in the `Authorization` header.","type":"string"},"refresh_token":{"description":"Token to keep in order to refresh the access token.","type":"string"},"expires_in":{"description":"Lifetime of the access token, in seconds.","type":"integer"},"token_type":{"description":"Always \"bearer\". Unused.","type":"string"},"scope":{"description":"Unused.","type":"string"}},"type":"object"}}}}
```

## The PasswordGrantRequest object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"PasswordGrantRequest":{"required":["client_id","client_secret","grant_type","username","password"],"properties":{"client_id":{"description":"OAuth2 application id.","type":"string"},"client_secret":{"description":"OAuth2 secret key.","type":"string"},"grant_type":{"type":"string","enum":["password"]},"username":{"description":"Email address of the user.","type":"string"},"password":{"type":"string"}},"type":"object"}}}}
```

## The RefreshTokenGrantRequest object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"RefreshTokenGrantRequest":{"required":["client_id","client_secret","grant_type","refresh_token"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"grant_type":{"type":"string","enum":["refresh_token"]},"refresh_token":{"type":"string"}},"type":"object"}}}}
```

## The User object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"User":{"properties":{"id":{"type":"integer"},"email":{"description":"Email address, which is also the login.","type":"string"},"email_canonical":{"description":"Normalized form of the email, used for lookups.","type":"string"},"active":{"description":"Whether the account is active and holds a valid licence.","type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"},"last_login_at":{"type":"string","format":"date-time"},"last_login_mobile_at":{"description":"Last login from a mobile application.","type":"string","format":"date-time"},"settings":{"description":"Additional per-user settings, such as the locale.","properties":{"locale":{"type":"string"}},"type":"object"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"}},"type":"object"}}}}
```

## The WorkspaceUser object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"WorkspaceUser":{"properties":{"id":{"type":"integer"},"email":{"description":"Email address, which is also the login.","type":"string"},"active":{"description":"Whether the account is active and holds a valid licence.","type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"},"subscription_id":{"description":"Identifier of the subscription attached to the user. Empty string when none is attached.","type":"string"},"system_groups":{"description":"Identifiers of the system groups the user belongs to (1 = admin, 2 = mobile, 3 = web).","type":"array","items":{"type":"integer"}},"groups":{"description":"Identifiers of the groups the user belongs to.","type":"array","items":{"type":"integer"}},"settings":{"description":"Additional per-user settings, such as the locale.","properties":{"locale":{"type":"string"}},"type":"object"}},"type":"object"}}}}
```

## The Company object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Company":{"properties":{"id":{"type":"integer"},"title":{"type":"string"},"sync_settings":{"type":"object"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"}},"type":"object"}}}}
```

## The Submission object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"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"}}}}
```

## The Comment object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Comment":{"description":"A comment posted on a submission, or a reply to another comment.","properties":{"id":{"type":"string","format":"uuid"},"message":{"type":"string"},"submission_id":{"type":"string","format":"uuid"},"parent_id":{"description":"Identifier of the comment being replied to. Absent on a top-level comment.","type":"string","format":"uuid"},"user":{"properties":{"id":{"type":"integer"},"full_name":{"type":"string"}},"type":"object"},"client_created_at":{"description":"Creation timestamp, as sent by the client.","type":"integer"},"client_updated_at":{"description":"Last update timestamp, as sent by the client.","type":"integer"},"replies_count":{"description":"Number of replies to this comment. Only present when listing the comments of a submission, not on other operations returning a comment.","type":"integer"}},"type":"object"}}}}
```

## The CommentInput object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"CommentInput":{"required":["message"],"properties":{"message":{"type":"string"},"parent_id":{"description":"Set it to reply to an existing comment.","type":"string","format":"uuid"}},"type":"object"}}}}
```

## The App object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"App":{"properties":{"android_map":{"type":"boolean"},"description":{"type":"string"},"is_model":{"type":"boolean"},"main_color_theme":{"description":"Primary brand color configured for the workspace theme, when one is set.","type":"string"},"name":{"type":"string"},"settings":{"type":"object","additionalProperties":true},"short":{"description":"Use this as the `{app_short}` prefix in subsequent API calls","type":"string"}},"type":"object"}}}}
```

## The CallbackUrlResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"CallbackUrlResponse":{"properties":{"callbackUrl":{"description":"URL to poll for async job status","type":"string"}},"type":"object"}}}}
```

## The Condition object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Condition":{"properties":{"cdt":{"description":"JavaScript condition expression","type":"string"},"fields":{"type":"array","items":{"type":"string"}},"json_format":{"type":"array","items":{"properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}},"type":"object"}},"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"}},"type":"object"}}}}
```

## The CurrentUserResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"CurrentUserResponse":{"properties":{"company":{"$ref":"#/components/schemas/Company"},"user":{"$ref":"#/components/schemas/User"}},"type":"object"},"Company":{"properties":{"id":{"type":"integer"},"title":{"type":"string"},"sync_settings":{"type":"object"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"}},"type":"object"},"User":{"properties":{"id":{"type":"integer"},"email":{"description":"Email address, which is also the login.","type":"string"},"email_canonical":{"description":"Normalized form of the email, used for lookups.","type":"string"},"active":{"description":"Whether the account is active and holds a valid licence.","type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"},"last_login_at":{"type":"string","format":"date-time"},"last_login_mobile_at":{"description":"Last login from a mobile application.","type":"string","format":"date-time"},"settings":{"description":"Additional per-user settings, such as the locale.","properties":{"locale":{"type":"string"}},"type":"object"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"}},"type":"object"}}}}
```

## The CustomApp object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"CustomApp":{"description":"Full detail of a custom app, returned when fetching a single app. Adds fields not present in the list view (`CustomAppSummary`).","allOf":[{"$ref":"#/components/schemas/CustomAppSummary"},{"properties":{"button_type":{"description":"`standard` = Font Awesome icon, `mix` = image icon, `full` = background image","type":"string","enum":["standard","mix","full"]},"grant_all":{"type":"boolean"},"label_overlay":{"type":"boolean"},"splash":{"properties":{"active":{"type":"boolean"},"aspect":{"type":"string","enum":["fit","fill"]},"color":{"type":"string"},"created_at":{"type":"integer","format":"int64"},"image":{"description":"Image file UUID","type":"string"},"updated_at":{"type":"integer","format":"int64"}},"type":"object"},"widget_spacing":{"description":"`0` = flat mode, `1` = standard","type":"integer","enum":[0,1]}},"type":"object"}]},"CustomAppSummary":{"description":"Custom app as returned in the list view, and the common base of the detailed `CustomApp` object.","properties":{"banner":{"type":"object","additionalProperties":true},"created_at":{"type":"integer","format":"int64"},"groups":{"type":"array","items":{}},"id":{"type":"integer"},"logo":{"description":"Logo file UUID","type":"string"},"menus":{"type":"array","items":{"properties":{"created_at":{"type":"integer","format":"int64"},"icon":{"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"index":{"type":"integer"},"label":{"description":"Localised labels keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"target":{"type":"string"},"updated_at":{"type":"integer","format":"int64"}},"type":"object"}},"name":{"type":"string"},"screens":{"type":"array","items":{"properties":{"created_at":{"type":"integer","format":"int64"},"name":{"type":"string"},"pages":{"type":"array","items":{"properties":{"layout":{"type":"array","items":{"properties":{"height":{"type":"integer"},"width":{"type":"integer"},"x":{"type":"integer"},"y":{"type":"integer"}},"type":"object"}},"side_menu":{"type":"boolean"},"system_name":{"type":"string"},"title":{"type":"object","additionalProperties":{"type":"string"}},"widgets":{"type":"array","items":{"properties":{"background":{"description":"Background image UUID (full button type)","type":"string"},"color":{"type":"string"},"icon":{"type":"object","additionalProperties":true},"index":{"type":"integer"},"label":{"type":"object","additionalProperties":{"type":"string"}},"target":{"type":"string"},"type":{"type":"string"}},"type":"object"}}},"type":"object"}},"updated_at":{"type":"integer","format":"int64"}},"type":"object"}},"settings":{"type":"array","items":{}},"updated_at":{"type":"integer","format":"int64"}},"type":"object"}}}}
```

## The CustomAppSummary object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"CustomAppSummary":{"description":"Custom app as returned in the list view, and the common base of the detailed `CustomApp` object.","properties":{"banner":{"type":"object","additionalProperties":true},"created_at":{"type":"integer","format":"int64"},"groups":{"type":"array","items":{}},"id":{"type":"integer"},"logo":{"description":"Logo file UUID","type":"string"},"menus":{"type":"array","items":{"properties":{"created_at":{"type":"integer","format":"int64"},"icon":{"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"index":{"type":"integer"},"label":{"description":"Localised labels keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"target":{"type":"string"},"updated_at":{"type":"integer","format":"int64"}},"type":"object"}},"name":{"type":"string"},"screens":{"type":"array","items":{"properties":{"created_at":{"type":"integer","format":"int64"},"name":{"type":"string"},"pages":{"type":"array","items":{"properties":{"layout":{"type":"array","items":{"properties":{"height":{"type":"integer"},"width":{"type":"integer"},"x":{"type":"integer"},"y":{"type":"integer"}},"type":"object"}},"side_menu":{"type":"boolean"},"system_name":{"type":"string"},"title":{"type":"object","additionalProperties":{"type":"string"}},"widgets":{"type":"array","items":{"properties":{"background":{"description":"Background image UUID (full button type)","type":"string"},"color":{"type":"string"},"icon":{"type":"object","additionalProperties":true},"index":{"type":"integer"},"label":{"type":"object","additionalProperties":{"type":"string"}},"target":{"type":"string"},"type":{"type":"string"}},"type":"object"}}},"type":"object"}},"updated_at":{"type":"integer","format":"int64"}},"type":"object"}},"settings":{"type":"array","items":{}},"updated_at":{"type":"integer","format":"int64"}},"type":"object"}}}}
```

## The Field object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Field":{"description":"A form field's configuration. Its shape depends on when the form was last edited: forms saved with the current builder describe access rules through `permissions`; forms not re-saved since an older version of the builder may still expose the same rules through the flat `enable` / `readonly` / `required` booleans. A given field has one or the other, not both.","properties":{"barcodescan":{"description":"Whether scanning a barcode can fill this field. Only present on fields that support it.","type":"boolean"},"enable":{"description":"Legacy format only, see the note above. Superseded by `permissions.visible`.","type":"boolean"},"externalscan":{"description":"Whether an external scanner can fill this field. Only present on fields that support it.","type":"boolean"},"label":{"type":"string"},"name":{"description":"System name — used as key in submission `items`","type":"string"},"permissions":{"description":"Current format only, see the note above. Each of the three rules is either a constant value or driven by a form condition.","properties":{"editable":{"$ref":"#/components/schemas/FieldPermissionRule"},"required":{"$ref":"#/components/schemas/FieldPermissionRule"},"visible":{"$ref":"#/components/schemas/FieldPermissionRule"}},"type":"object"},"position":{"type":"integer"},"prefill":{"type":"boolean"},"readonly":{"description":"Legacy format only, see the note above. Superseded by `permissions.editable`.","type":"boolean"},"required":{"description":"Legacy format only, see the note above. Superseded by `permissions.required`.","type":"boolean"},"richtext":{"description":"Whether the field accepts rich text formatting. Only present on text fields.","type":"boolean"},"searchable":{"type":"boolean"},"textRecognition":{"description":"Whether text recognition (OCR) can fill this field. Only present on fields that support it.","type":"boolean"},"type":{"description":"text, number, boolean, date, duration, phone, email, location, image, signature, file, list, relation, user, label…\n","type":"string"}},"type":"object"},"FieldPermissionRule":{"properties":{"type":{"description":"`constant`: the rule always evaluates to `value`. `condition`: the rule evaluates by checking the form conditions listed in `ids`.","type":"string","enum":["constant","condition"]},"value":{"description":"Present when `type` is `constant`.","type":"boolean"},"ids":{"description":"Present when `type` is `condition`. Identifiers of the form conditions driving this rule.","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}}
```

## The FieldPermissionRule object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"FieldPermissionRule":{"properties":{"type":{"description":"`constant`: the rule always evaluates to `value`. `condition`: the rule evaluates by checking the form conditions listed in `ids`.","type":"string","enum":["constant","condition"]},"value":{"description":"Present when `type` is `constant`.","type":"boolean"},"ids":{"description":"Present when `type` is `condition`. Identifiers of the form conditions driving this rule.","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}}
```

## The FileUploadResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"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"}}}}
```

## The Group object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Group":{"description":"Group within a workspace","properties":{"description":{"description":"Description set by the administrator","type":"string"},"id":{"description":"Group identifier","type":"integer"},"is_system":{"description":"Whether this is a system group","type":"boolean"},"name":{"description":"Displayed name","type":"string"},"structure_ids":{"description":"Identifiers of forms linked to the group. Only computed when creating or updating a group; always an empty array on the list endpoint (`GET /groups` never populates it).","type":"array","items":{"type":"integer"}},"user_ids":{"description":"Identifiers of users in the group. Only computed when creating or updating a group; always an empty array on the list endpoint (`GET /groups` never populates it).","type":"array","items":{"type":"integer"}}},"type":"object"}}}}
```

## The GroupInput object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"GroupInput":{"description":"Body for creating or updating a group","required":["name","description"],"properties":{"description":{"description":"Group description","type":"string"},"name":{"description":"Group name","type":"string"},"structure_ids":{"description":"Identifiers of forms in the group","type":"array","items":{"type":"integer"}},"user_ids":{"description":"Identifiers of users in the group","type":"array","items":{"type":"integer"}}},"type":"object"}}}}
```

## The ListAccessSetDetail object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ListAccessSetDetail":{"properties":{"groups":{"description":"Groups given access, serialized with their own fields (not just an identifier).","type":"array","items":{}},"id":{"type":"string","format":"uuid"},"lists":{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}},"name":{"type":"string"},"root_id":{"properties":{"has_image":{"type":"boolean"},"id":{"type":"integer"},"level":{"type":"integer"},"name":{"type":"string"},"position":{"type":"integer"}},"type":"object"},"users":{"description":"Users given access, serialized with the same fields as the `User` object (not a lightweight reference).","type":"array","items":{"$ref":"#/components/schemas/User"}}},"type":"object"},"ListItem":{"properties":{"all_items_readable":{"description":"Whether every descendant of this node is readable without an access set.","type":"boolean"},"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the item has been deleted.","type":"integer","format":"int64"},"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"has_image":{"type":"boolean"},"id":{"type":"integer"},"image_url":{"description":"URL of the item's image. Present only when `has_image` is true.","type":"string"},"latitude":{"type":"number"},"level":{"description":"Depth — 0 is the root node","type":"integer"},"longitude":{"type":"number"},"name":{"type":"string"},"parent_id":{"type":"integer"},"position":{"type":"integer"},"root_id":{"type":"integer"},"updated_at":{"type":"integer","format":"int64"},"url":{"type":"string"}},"type":"object"},"User":{"properties":{"id":{"type":"integer"},"email":{"description":"Email address, which is also the login.","type":"string"},"email_canonical":{"description":"Normalized form of the email, used for lookups.","type":"string"},"active":{"description":"Whether the account is active and holds a valid licence.","type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"},"last_login_at":{"type":"string","format":"date-time"},"last_login_mobile_at":{"description":"Last login from a mobile application.","type":"string","format":"date-time"},"settings":{"description":"Additional per-user settings, such as the locale.","properties":{"locale":{"type":"string"}},"type":"object"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"}},"type":"object"}}}}
```

## The ListAccessSetSummary object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ListAccessSetSummary":{"properties":{"groups":{"type":"array","items":{}},"id":{"type":"string","format":"uuid"},"lists":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"root_id":{"type":"integer"},"users":{"type":"array","items":{"type":"string"}}},"type":"object"}}}}
```

## The ListCallbackResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ListCallbackResponse":{"properties":{"callbackDetails":{"properties":{"errors":{"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"]},"success":{"type":"array","items":{}}},"type":"object"}},"type":"object"}}}}
```

## The ListCreateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ListCreateRequest":{"required":["name"],"properties":{"external_id":{"type":"string"},"items":{"description":"Nested child items (recursive)","type":"array","items":{"$ref":"#/components/schemas/ListCreateRequest"}},"name":{"type":"string"}},"type":"object"}}}}
```

## The ListItem object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ListItem":{"properties":{"all_items_readable":{"description":"Whether every descendant of this node is readable without an access set.","type":"boolean"},"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the item has been deleted.","type":"integer","format":"int64"},"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"has_image":{"type":"boolean"},"id":{"type":"integer"},"image_url":{"description":"URL of the item's image. Present only when `has_image` is true.","type":"string"},"latitude":{"type":"number"},"level":{"description":"Depth — 0 is the root node","type":"integer"},"longitude":{"type":"number"},"name":{"type":"string"},"parent_id":{"type":"integer"},"position":{"type":"integer"},"root_id":{"type":"integer"},"updated_at":{"type":"integer","format":"int64"},"url":{"type":"string"}},"type":"object"}}}}
```

## The ListItemPagedResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ListItemPagedResponse":{"properties":{"lists":{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}},"next_page":{"type":"integer"},"server_time":{"type":"integer","format":"int64"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"},"ListItem":{"properties":{"all_items_readable":{"description":"Whether every descendant of this node is readable without an access set.","type":"boolean"},"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the item has been deleted.","type":"integer","format":"int64"},"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"has_image":{"type":"boolean"},"id":{"type":"integer"},"image_url":{"description":"URL of the item's image. Present only when `has_image` is true.","type":"string"},"latitude":{"type":"number"},"level":{"description":"Depth — 0 is the root node","type":"integer"},"longitude":{"type":"number"},"name":{"type":"string"},"parent_id":{"type":"integer"},"position":{"type":"integer"},"root_id":{"type":"integer"},"updated_at":{"type":"integer","format":"int64"},"url":{"type":"string"}},"type":"object"}}}}
```

## The ListItemUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ListItemUpdateRequest":{"properties":{"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"name":{"type":"string"},"url":{"type":"string"}},"type":"object"}}}}
```

## The ListPagedResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ListPagedResponse":{"properties":{"lists":{"type":"array","items":{"properties":{"created_at":{"type":"integer","format":"int64"},"list_last_updated":{"type":"integer","format":"int64"},"name":{"type":"string"},"root_id":{"type":"integer"}},"type":"object"}},"next_page":{"type":"integer"},"server_time":{"type":"integer","format":"int64"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"}}}}
```

## The PushKeyInput object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"PushKeyInput":{"description":"Push notification key for a device","properties":{"app_version":{"description":"Daxium-Air version","type":"string"},"id":{"description":"Unique device identifier","type":"string"},"key":{"description":"Push key","type":"string"},"name":{"description":"Device name","type":"string"},"os":{"description":"Device OS (Android or iOS)","type":"string"},"os_version":{"description":"OS version","type":"string"}},"type":"object"}}}}
```

## The Recurrency object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Recurrency":{"description":"Recurrence definition for a task. `min_by_week` / `max_by_week` are only present for a `weekly` recurrence, and `repeatEvery` / `ruleMonth` / `numofday` / `nth` / `dayOfWeek` / `taskTiming` are only present for a `monthly` one.","properties":{"days":{"description":"Days of the week (first 3 letters in English: mon, tue, wed, thu, fri, sat, sun).\nFor weekly recurrence, not all days are required.\n","type":"object","additionalProperties":{"properties":{"end":{"description":"Task duration in seconds","type":"integer"},"start":{"description":"Start time (HH:MM format)","type":"string"}},"type":"object"}},"dayOfWeek":{"description":"Monthly recurrence only.","type":"string"},"end":{"description":"Recurrence end condition","properties":{"type":{"description":"`occurrence` = number of occurrences, `date` = end date","type":"string","enum":["occurrence","date"]},"value":{"description":"Number of occurrences or end date (timestamp) depending on `type`","type":"integer"}},"type":"object"},"interval":{"description":"Interval between each occurrence (minimum 1)","type":"integer"},"max_by_week":{"description":"Weekly recurrence only. Maximum number of occurrences per week.","type":"integer"},"min_by_week":{"description":"Weekly recurrence only. Minimum number of occurrences per week.","type":"integer"},"notDaysoff":{"description":"Whether the recurrence ignores the users' days off.","type":"boolean"},"numofday":{"description":"Monthly recurrence only.","type":"integer"},"nth":{"description":"Monthly recurrence only.","type":"integer"},"repeatEvery":{"description":"Monthly recurrence only. Number of months between each occurrence.","type":"integer"},"ruleMonth":{"description":"Monthly recurrence only.","type":"string"},"taskTiming":{"description":"Monthly recurrence only.","type":"string"},"type":{"description":"Recurrence type","type":"string","enum":["daily","weekly","monthly"]}},"type":"object"}}}}
```

## The Report object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Report":{"description":"Generated mail merge","properties":{"errorMessage":{"description":"Error message, if any","type":"string"},"id":{"description":"Mail merge identifier","type":"integer"},"original_document":{"description":"File generated in the original format","properties":{"file_name":{"description":"Name of the generated file","type":"string"},"file_uuid":{"description":"UUID of the generated file","type":"string"}},"type":"object"},"pdf_document":{"description":"File generated in PDF format","properties":{"file_name":{"type":"string"},"file_uuid":{"type":"string"}},"type":"object"},"status":{"description":"Mail merge status (e.g. finished, error)","type":"string"}},"type":"object"}}}}
```

## The ReportInput object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ReportInput":{"description":"Body for starting a mail merge","required":["template_id","submission_id","api_callback"],"properties":{"api_callback":{"description":"URL called (PUT) when generation completes; `{publipostage_id}` is substituted (mandatory)","type":"string"},"header_name":{"description":"HTTP header name to send during the callback (optional)","type":"string"},"header_value":{"description":"HTTP header value to send during the callback (optional)","type":"string"},"join_format":{"description":"Output format: `original`, `pdf`, or `original,pdf` (two reports generated)","type":"string","enum":["original","pdf","original,pdf"]},"submission_id":{"description":"Submission identifier (mandatory)","type":"string","format":"uuid"},"template_id":{"description":"Template identifier (mandatory)","type":"integer"}},"type":"object"}}}}
```

## The ReportListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ReportListResponse":{"properties":{"next_page":{"type":"integer"},"reports":{"type":"array","items":{"$ref":"#/components/schemas/Report"}},"server_time":{"type":"integer","format":"int64"},"total_count":{"type":"integer"}},"type":"object"},"Report":{"description":"Generated mail merge","properties":{"errorMessage":{"description":"Error message, if any","type":"string"},"id":{"description":"Mail merge identifier","type":"integer"},"original_document":{"description":"File generated in the original format","properties":{"file_name":{"description":"Name of the generated file","type":"string"},"file_uuid":{"description":"UUID of the generated file","type":"string"}},"type":"object"},"pdf_document":{"description":"File generated in PDF format","properties":{"file_name":{"type":"string"},"file_uuid":{"type":"string"}},"type":"object"},"status":{"description":"Mail merge status (e.g. finished, error)","type":"string"}},"type":"object"}}}}
```

## The ReportTemplate object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ReportTemplate":{"description":"Mail-merge template","properties":{"id":{"description":"Template identifier","type":"integer"},"listingMode":{"description":"Whether the template is in listing mode","type":"boolean"},"mailBody":{"description":"Body of the email sent alongside the generated document, when sent by mail.","type":"string"},"mailSubject":{"description":"Subject of the email sent alongside the generated document, when sent by mail.","type":"string"},"name":{"description":"Template name","type":"string"},"reportName":{"description":"Name given to the generated document.","type":"string"},"sendAsHtml":{"description":"Whether the email body above is sent as HTML.","type":"boolean"},"templateEngine":{"description":"Template generation engine (e.g. docxopenxml, xlsxaspose)","type":"string"}},"type":"object"}}}}
```

## The ReportTemplateListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"ReportTemplateListResponse":{"properties":{"server_time":{"type":"integer","format":"int64"},"templates":{"type":"array","items":{"$ref":"#/components/schemas/ReportTemplate"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"},"ReportTemplate":{"description":"Mail-merge template","properties":{"id":{"description":"Template identifier","type":"integer"},"listingMode":{"description":"Whether the template is in listing mode","type":"boolean"},"mailBody":{"description":"Body of the email sent alongside the generated document, when sent by mail.","type":"string"},"mailSubject":{"description":"Subject of the email sent alongside the generated document, when sent by mail.","type":"string"},"name":{"description":"Template name","type":"string"},"reportName":{"description":"Name given to the generated document.","type":"string"},"sendAsHtml":{"description":"Whether the email body above is sent as HTML.","type":"boolean"},"templateEngine":{"description":"Template generation engine (e.g. docxopenxml, xlsxaspose)","type":"string"}},"type":"object"}}}}
```

## The SearchCriteria object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"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"}}}}}
```

## The Structure object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Structure":{"properties":{"can_have_access_restrictions":{"description":"Whether the form supports restricting submissions by access set.","type":"boolean"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}},"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the form has been deleted.","type":"integer","format":"int64"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"id":{"type":"integer"},"is_current_user_allowed":{"description":"Whether the authenticated user is allowed to access this form.","type":"boolean"},"layout":{"properties":{"fields":{"type":"array","items":{}},"pages":{"type":"array","items":{}}},"type":"object"},"name":{"type":"string"},"nb_submissions":{"type":"integer"},"settings":{"type":"object","additionalProperties":true},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"}},"updated_at":{"type":"integer","format":"int64"},"version":{"type":"integer"},"workflow_id":{"description":"Identifier of the workflow driving this form, when the form has one.","type":"string","format":"uuid"}},"type":"object"},"Condition":{"properties":{"cdt":{"description":"JavaScript condition expression","type":"string"},"fields":{"type":"array","items":{"type":"string"}},"json_format":{"type":"array","items":{"properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}},"type":"object"}},"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"Field":{"description":"A form field's configuration. Its shape depends on when the form was last edited: forms saved with the current builder describe access rules through `permissions`; forms not re-saved since an older version of the builder may still expose the same rules through the flat `enable` / `readonly` / `required` booleans. A given field has one or the other, not both.","properties":{"barcodescan":{"description":"Whether scanning a barcode can fill this field. Only present on fields that support it.","type":"boolean"},"enable":{"description":"Legacy format only, see the note above. Superseded by `permissions.visible`.","type":"boolean"},"externalscan":{"description":"Whether an external scanner can fill this field. Only present on fields that support it.","type":"boolean"},"label":{"type":"string"},"name":{"description":"System name — used as key in submission `items`","type":"string"},"permissions":{"description":"Current format only, see the note above. Each of the three rules is either a constant value or driven by a form condition.","properties":{"editable":{"$ref":"#/components/schemas/FieldPermissionRule"},"required":{"$ref":"#/components/schemas/FieldPermissionRule"},"visible":{"$ref":"#/components/schemas/FieldPermissionRule"}},"type":"object"},"position":{"type":"integer"},"prefill":{"type":"boolean"},"readonly":{"description":"Legacy format only, see the note above. Superseded by `permissions.editable`.","type":"boolean"},"required":{"description":"Legacy format only, see the note above. Superseded by `permissions.required`.","type":"boolean"},"richtext":{"description":"Whether the field accepts rich text formatting. Only present on text fields.","type":"boolean"},"searchable":{"type":"boolean"},"textRecognition":{"description":"Whether text recognition (OCR) can fill this field. Only present on fields that support it.","type":"boolean"},"type":{"description":"text, number, boolean, date, duration, phone, email, location, image, signature, file, list, relation, user, label…\n","type":"string"}},"type":"object"},"FieldPermissionRule":{"properties":{"type":{"description":"`constant`: the rule always evaluates to `value`. `condition`: the rule evaluates by checking the form conditions listed in `ids`.","type":"string","enum":["constant","condition"]},"value":{"description":"Present when `type` is `constant`.","type":"boolean"},"ids":{"description":"Present when `type` is `condition`. Identifiers of the form conditions driving this rule.","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"},"Trigger":{"description":"Customises how a workflow transition appears as a save button","properties":{"color":{"type":"string"},"condition_id":{"description":"Identifier of the form condition that must be met for the button to show. Absent when the button always shows.","type":"string","format":"uuid"},"icon":{"type":"string"},"id":{"type":"string","format":"uuid"},"label":{"description":"Localised labels keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"transition_id":{"type":"string","format":"uuid"},"type":{"type":"string"}},"type":"object"}}}}
```

## The StructureListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"StructureListResponse":{"properties":{"next_page":{"type":"integer"},"required":{"properties":{"linked_list_ids":{"type":"array","items":{"type":"integer"}},"structure_ids":{"type":"array","items":{"type":"integer"}}},"type":"object"},"server_time":{"type":"integer","format":"int64"},"structures":{"type":"array","items":{"$ref":"#/components/schemas/Structure"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"workflows":{"type":"array","items":{"$ref":"#/components/schemas/Workflow"}}},"type":"object"},"Structure":{"properties":{"can_have_access_restrictions":{"description":"Whether the form supports restricting submissions by access set.","type":"boolean"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}},"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the form has been deleted.","type":"integer","format":"int64"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"id":{"type":"integer"},"is_current_user_allowed":{"description":"Whether the authenticated user is allowed to access this form.","type":"boolean"},"layout":{"properties":{"fields":{"type":"array","items":{}},"pages":{"type":"array","items":{}}},"type":"object"},"name":{"type":"string"},"nb_submissions":{"type":"integer"},"settings":{"type":"object","additionalProperties":true},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"}},"updated_at":{"type":"integer","format":"int64"},"version":{"type":"integer"},"workflow_id":{"description":"Identifier of the workflow driving this form, when the form has one.","type":"string","format":"uuid"}},"type":"object"},"Condition":{"properties":{"cdt":{"description":"JavaScript condition expression","type":"string"},"fields":{"type":"array","items":{"type":"string"}},"json_format":{"type":"array","items":{"properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}},"type":"object"}},"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"Field":{"description":"A form field's configuration. Its shape depends on when the form was last edited: forms saved with the current builder describe access rules through `permissions`; forms not re-saved since an older version of the builder may still expose the same rules through the flat `enable` / `readonly` / `required` booleans. A given field has one or the other, not both.","properties":{"barcodescan":{"description":"Whether scanning a barcode can fill this field. Only present on fields that support it.","type":"boolean"},"enable":{"description":"Legacy format only, see the note above. Superseded by `permissions.visible`.","type":"boolean"},"externalscan":{"description":"Whether an external scanner can fill this field. Only present on fields that support it.","type":"boolean"},"label":{"type":"string"},"name":{"description":"System name — used as key in submission `items`","type":"string"},"permissions":{"description":"Current format only, see the note above. Each of the three rules is either a constant value or driven by a form condition.","properties":{"editable":{"$ref":"#/components/schemas/FieldPermissionRule"},"required":{"$ref":"#/components/schemas/FieldPermissionRule"},"visible":{"$ref":"#/components/schemas/FieldPermissionRule"}},"type":"object"},"position":{"type":"integer"},"prefill":{"type":"boolean"},"readonly":{"description":"Legacy format only, see the note above. Superseded by `permissions.editable`.","type":"boolean"},"required":{"description":"Legacy format only, see the note above. Superseded by `permissions.required`.","type":"boolean"},"richtext":{"description":"Whether the field accepts rich text formatting. Only present on text fields.","type":"boolean"},"searchable":{"type":"boolean"},"textRecognition":{"description":"Whether text recognition (OCR) can fill this field. Only present on fields that support it.","type":"boolean"},"type":{"description":"text, number, boolean, date, duration, phone, email, location, image, signature, file, list, relation, user, label…\n","type":"string"}},"type":"object"},"FieldPermissionRule":{"properties":{"type":{"description":"`constant`: the rule always evaluates to `value`. `condition`: the rule evaluates by checking the form conditions listed in `ids`.","type":"string","enum":["constant","condition"]},"value":{"description":"Present when `type` is `constant`.","type":"boolean"},"ids":{"description":"Present when `type` is `condition`. Identifiers of the form conditions driving this rule.","type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"},"Trigger":{"description":"Customises how a workflow transition appears as a save button","properties":{"color":{"type":"string"},"condition_id":{"description":"Identifier of the form condition that must be met for the button to show. Absent when the button always shows.","type":"string","format":"uuid"},"icon":{"type":"string"},"id":{"type":"string","format":"uuid"},"label":{"description":"Localised labels keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"transition_id":{"type":"string","format":"uuid"},"type":{"type":"string"}},"type":"object"},"Workflow":{"properties":{"id":{"type":"string","format":"uuid"},"name":{"description":"Localised names keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"start_state":{"type":"string","format":"uuid"},"states":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowState"}},"transitions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowTransition"}}},"type":"object"},"WorkflowState":{"properties":{"color":{"type":"string"},"end":{"description":"Submissions in end states cannot be modified","type":"boolean"},"id":{"type":"string","format":"uuid"},"name":{"description":"Localised names keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}}},"type":"object"},"WorkflowTransition":{"properties":{"from":{"type":"string","format":"uuid"},"id":{"type":"string","format":"uuid"},"label":{"description":"Localised labels keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"to":{"type":"string","format":"uuid"}},"type":"object"}}}}
```

## The StructureRelationPagedResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"StructureRelationPagedResponse":{"properties":{"next_page":{"type":"integer"},"server_time":{"type":"integer","format":"int64"},"structure_relations":{"type":"array","items":{"properties":{"id":{"type":"string","format":"uuid"}},"type":"object"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"}}}}
```

## The SubmissionCallbackResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"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"}}}}
```

## The SubmissionInput object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"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"}}}}
```

## The SubmissionListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"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"}}}}
```

## The SubmissionRelationPagedResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"SubmissionRelationPagedResponse":{"properties":{"next_page":{"type":"integer"},"server_time":{"type":"integer","format":"int64"},"submission_relations":{"type":"array","items":{"properties":{"id":{"type":"string","format":"uuid"}},"type":"object"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"}}}}
```

## The Subscription object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Subscription":{"description":"Subscription attached to an account","properties":{"active":{"description":"Subscription status","type":"boolean"},"end":{"description":"End date (UNIX timestamp)","type":"integer","format":"int64"},"id":{"description":"Subscription identifier","type":"string","format":"uuid"},"name":{"description":"Displayed name","type":"string"},"sequence":{"description":"Sequential number","type":"integer"},"start":{"description":"Start date (UNIX timestamp)","type":"integer","format":"int64"},"used_licenses":{"description":"Number of licenses already in use","properties":{"mobile":{"type":"integer"},"web":{"type":"integer"}},"type":"object"},"users_max":{"description":"Maximum number of web and mobile users","properties":{"mobile":{"type":"integer"},"web":{"type":"integer"}},"type":"object"}},"type":"object"}}}}
```

## The SubscriptionListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"SubscriptionListResponse":{"properties":{"server_time":{"type":"integer","format":"int64"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"},"Subscription":{"description":"Subscription attached to an account","properties":{"active":{"description":"Subscription status","type":"boolean"},"end":{"description":"End date (UNIX timestamp)","type":"integer","format":"int64"},"id":{"description":"Subscription identifier","type":"string","format":"uuid"},"name":{"description":"Displayed name","type":"string"},"sequence":{"description":"Sequential number","type":"integer"},"start":{"description":"Start date (UNIX timestamp)","type":"integer","format":"int64"},"used_licenses":{"description":"Number of licenses already in use","properties":{"mobile":{"type":"integer"},"web":{"type":"integer"}},"type":"object"},"users_max":{"description":"Maximum number of web and mobile users","properties":{"mobile":{"type":"integer"},"web":{"type":"integer"}},"type":"object"}},"type":"object"}}}}
```

## The Task object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Task":{"properties":{"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the task has been deleted.","type":"integer","format":"int64"},"delay_after":{"description":"Indicative display delay in seconds after task completion time","type":"integer"},"delay_before":{"description":"Indicative display delay in seconds before the task begins","type":"integer"},"due_date":{"description":"Due date (Unix timestamp)","type":"integer","format":"int64"},"duration":{"description":"Expected duration in seconds","type":"integer"},"fill_status":{"description":"Whether the linked submission's end-date field has been filled in.","type":"string","enum":["filled","notfilled"]},"id":{"type":"string","format":"uuid"},"recurrency":{"description":"Present only on a recurring task.","allOf":[{"$ref":"#/components/schemas/Recurrency"}]},"start_date":{"description":"Planned start date (Unix timestamp)","type":"integer","format":"int64"},"submission":{"$ref":"#/components/schemas/Submission"},"submission_model":{"description":"Present only when the task has a submission model configured — the template the task's own submission was created from.","allOf":[{"$ref":"#/components/schemas/Submission"}]},"time_status":{"description":"Whether the task is on time relative to its due date.","type":"string","enum":["normal","late","advance","notplanned","error"]},"updated_at":{"type":"integer","format":"int64"},"user_id":{"type":"integer"}},"type":"object"},"Recurrency":{"description":"Recurrence definition for a task. `min_by_week` / `max_by_week` are only present for a `weekly` recurrence, and `repeatEvery` / `ruleMonth` / `numofday` / `nth` / `dayOfWeek` / `taskTiming` are only present for a `monthly` one.","properties":{"days":{"description":"Days of the week (first 3 letters in English: mon, tue, wed, thu, fri, sat, sun).\nFor weekly recurrence, not all days are required.\n","type":"object","additionalProperties":{"properties":{"end":{"description":"Task duration in seconds","type":"integer"},"start":{"description":"Start time (HH:MM format)","type":"string"}},"type":"object"}},"dayOfWeek":{"description":"Monthly recurrence only.","type":"string"},"end":{"description":"Recurrence end condition","properties":{"type":{"description":"`occurrence` = number of occurrences, `date` = end date","type":"string","enum":["occurrence","date"]},"value":{"description":"Number of occurrences or end date (timestamp) depending on `type`","type":"integer"}},"type":"object"},"interval":{"description":"Interval between each occurrence (minimum 1)","type":"integer"},"max_by_week":{"description":"Weekly recurrence only. Maximum number of occurrences per week.","type":"integer"},"min_by_week":{"description":"Weekly recurrence only. Minimum number of occurrences per week.","type":"integer"},"notDaysoff":{"description":"Whether the recurrence ignores the users' days off.","type":"boolean"},"numofday":{"description":"Monthly recurrence only.","type":"integer"},"nth":{"description":"Monthly recurrence only.","type":"integer"},"repeatEvery":{"description":"Monthly recurrence only. Number of months between each occurrence.","type":"integer"},"ruleMonth":{"description":"Monthly recurrence only.","type":"string"},"taskTiming":{"description":"Monthly recurrence only.","type":"string"},"type":{"description":"Recurrence type","type":"string","enum":["daily","weekly","monthly"]}},"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"}}}}
```

## The TaskInput object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"TaskInput":{"description":"Body for creating a task. Provide either `submission_model_id` or `submissions`.\nAdd `recurrency` for a recurring task (in which case `due_date` is optional).\n","required":["start_date"],"properties":{"delay_after":{"description":"Indicative display delay in seconds after the task's due time","type":"integer"},"delay_before":{"description":"Indicative display delay in seconds before the task begins","type":"integer"},"due_date":{"description":"Due date (UNIX timestamp). Optional for a recurring task.","type":"integer","format":"int64"},"duration":{"description":"Task duration in seconds","type":"integer"},"recurrency":{"$ref":"#/components/schemas/Recurrency"},"start_date":{"description":"Task start date (UNIX timestamp)","type":"integer","format":"int64"},"submission_model_id":{"description":"Identifier of a submission model","type":"string","format":"uuid"},"submissions":{"description":"List of submission identifiers","type":"array","items":{"type":"string","format":"uuid"}},"user_id":{"description":"Identifier of the assigned user","type":"integer","nullable":true}},"type":"object"},"Recurrency":{"description":"Recurrence definition for a task. `min_by_week` / `max_by_week` are only present for a `weekly` recurrence, and `repeatEvery` / `ruleMonth` / `numofday` / `nth` / `dayOfWeek` / `taskTiming` are only present for a `monthly` one.","properties":{"days":{"description":"Days of the week (first 3 letters in English: mon, tue, wed, thu, fri, sat, sun).\nFor weekly recurrence, not all days are required.\n","type":"object","additionalProperties":{"properties":{"end":{"description":"Task duration in seconds","type":"integer"},"start":{"description":"Start time (HH:MM format)","type":"string"}},"type":"object"}},"dayOfWeek":{"description":"Monthly recurrence only.","type":"string"},"end":{"description":"Recurrence end condition","properties":{"type":{"description":"`occurrence` = number of occurrences, `date` = end date","type":"string","enum":["occurrence","date"]},"value":{"description":"Number of occurrences or end date (timestamp) depending on `type`","type":"integer"}},"type":"object"},"interval":{"description":"Interval between each occurrence (minimum 1)","type":"integer"},"max_by_week":{"description":"Weekly recurrence only. Maximum number of occurrences per week.","type":"integer"},"min_by_week":{"description":"Weekly recurrence only. Minimum number of occurrences per week.","type":"integer"},"notDaysoff":{"description":"Whether the recurrence ignores the users' days off.","type":"boolean"},"numofday":{"description":"Monthly recurrence only.","type":"integer"},"nth":{"description":"Monthly recurrence only.","type":"integer"},"repeatEvery":{"description":"Monthly recurrence only. Number of months between each occurrence.","type":"integer"},"ruleMonth":{"description":"Monthly recurrence only.","type":"string"},"taskTiming":{"description":"Monthly recurrence only.","type":"string"},"type":{"description":"Recurrence type","type":"string","enum":["daily","weekly","monthly"]}},"type":"object"}}}}
```

## The TaskListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"TaskListResponse":{"properties":{"server_time":{"type":"integer","format":"int64"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/Task"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"},"Task":{"properties":{"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the task has been deleted.","type":"integer","format":"int64"},"delay_after":{"description":"Indicative display delay in seconds after task completion time","type":"integer"},"delay_before":{"description":"Indicative display delay in seconds before the task begins","type":"integer"},"due_date":{"description":"Due date (Unix timestamp)","type":"integer","format":"int64"},"duration":{"description":"Expected duration in seconds","type":"integer"},"fill_status":{"description":"Whether the linked submission's end-date field has been filled in.","type":"string","enum":["filled","notfilled"]},"id":{"type":"string","format":"uuid"},"recurrency":{"description":"Present only on a recurring task.","allOf":[{"$ref":"#/components/schemas/Recurrency"}]},"start_date":{"description":"Planned start date (Unix timestamp)","type":"integer","format":"int64"},"submission":{"$ref":"#/components/schemas/Submission"},"submission_model":{"description":"Present only when the task has a submission model configured — the template the task's own submission was created from.","allOf":[{"$ref":"#/components/schemas/Submission"}]},"time_status":{"description":"Whether the task is on time relative to its due date.","type":"string","enum":["normal","late","advance","notplanned","error"]},"updated_at":{"type":"integer","format":"int64"},"user_id":{"type":"integer"}},"type":"object"},"Recurrency":{"description":"Recurrence definition for a task. `min_by_week` / `max_by_week` are only present for a `weekly` recurrence, and `repeatEvery` / `ruleMonth` / `numofday` / `nth` / `dayOfWeek` / `taskTiming` are only present for a `monthly` one.","properties":{"days":{"description":"Days of the week (first 3 letters in English: mon, tue, wed, thu, fri, sat, sun).\nFor weekly recurrence, not all days are required.\n","type":"object","additionalProperties":{"properties":{"end":{"description":"Task duration in seconds","type":"integer"},"start":{"description":"Start time (HH:MM format)","type":"string"}},"type":"object"}},"dayOfWeek":{"description":"Monthly recurrence only.","type":"string"},"end":{"description":"Recurrence end condition","properties":{"type":{"description":"`occurrence` = number of occurrences, `date` = end date","type":"string","enum":["occurrence","date"]},"value":{"description":"Number of occurrences or end date (timestamp) depending on `type`","type":"integer"}},"type":"object"},"interval":{"description":"Interval between each occurrence (minimum 1)","type":"integer"},"max_by_week":{"description":"Weekly recurrence only. Maximum number of occurrences per week.","type":"integer"},"min_by_week":{"description":"Weekly recurrence only. Minimum number of occurrences per week.","type":"integer"},"notDaysoff":{"description":"Whether the recurrence ignores the users' days off.","type":"boolean"},"numofday":{"description":"Monthly recurrence only.","type":"integer"},"nth":{"description":"Monthly recurrence only.","type":"integer"},"repeatEvery":{"description":"Monthly recurrence only. Number of months between each occurrence.","type":"integer"},"ruleMonth":{"description":"Monthly recurrence only.","type":"string"},"taskTiming":{"description":"Monthly recurrence only.","type":"string"},"type":{"description":"Recurrence type","type":"string","enum":["daily","weekly","monthly"]}},"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"}}}}
```

## The Trigger object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Trigger":{"description":"Customises how a workflow transition appears as a save button","properties":{"color":{"type":"string"},"condition_id":{"description":"Identifier of the form condition that must be met for the button to show. Absent when the button always shows.","type":"string","format":"uuid"},"icon":{"type":"string"},"id":{"type":"string","format":"uuid"},"label":{"description":"Localised labels keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"transition_id":{"type":"string","format":"uuid"},"type":{"type":"string"}},"type":"object"}}}}
```

## The UserInput object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"UserInput":{"description":"Body for creating or updating a user. Provide `plainPassword` for Daxium\nauthentication, or `ssoProvider` for SSO authentication.\n","required":["username","system_groups"],"properties":{"active":{"description":"Status (active / inactive)","type":"boolean"},"firstName":{"description":"First name","type":"string"},"force_login_password":{"description":"[SSO companies only] 0 to deactivate, 1 to force Daxium login/password authentication","type":"integer","enum":[0,1]},"groups":{"description":"Group identifiers (see the `/{app_short}/groups` API)","type":"array","items":{"type":"integer"}},"lastName":{"description":"Last name","type":"string"},"locale":{"description":"User language","type":"string","enum":["en","fr"]},"plainPassword":{"description":"Password. The `first` and `second` keys are mandatory and must be identical.\nRules: at least 1 uppercase, 1 lowercase, 1 digit, 8 characters total.\n","properties":{"first":{"type":"string","format":"password"},"second":{"type":"string","format":"password"}},"type":"object"},"ssoProvider":{"description":"[SSO companies only] Identifier of the SSO provider to use (provided by Daxium)","type":"integer","nullable":true},"subscription_id":{"description":"Subscription UUID (see the `/subscriptions` API)","type":"string"},"system_groups":{"description":"System groups: 1 = administrator, 2 = mobile access, 3 = web access","type":"array","items":{"type":"integer"}},"username":{"description":"Email address (login), must be unique","type":"string","format":"email"}},"type":"object"}}}}
```

## The UserListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"UserListResponse":{"properties":{"server_time":{"type":"integer","format":"int64"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"users":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceUser"}}},"type":"object"},"WorkspaceUser":{"properties":{"id":{"type":"integer"},"email":{"description":"Email address, which is also the login.","type":"string"},"active":{"description":"Whether the account is active and holds a valid licence.","type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"},"subscription_id":{"description":"Identifier of the subscription attached to the user. Empty string when none is attached.","type":"string"},"system_groups":{"description":"Identifiers of the system groups the user belongs to (1 = admin, 2 = mobile, 3 = web).","type":"array","items":{"type":"integer"}},"groups":{"description":"Identifiers of the groups the user belongs to.","type":"array","items":{"type":"integer"}},"settings":{"description":"Additional per-user settings, such as the locale.","properties":{"locale":{"type":"string"}},"type":"object"}},"type":"object"}}}}
```

## The UserRef object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"UserRef":{"properties":{"email":{"type":"string","format":"email"},"first_name":{"type":"string"},"groups":{"type":"array","items":{}},"id":{"type":"integer"},"last_name":{"type":"string"},"system_groups":{"type":"array","items":{}}},"type":"object"}}}}
```

## The UsersCallbackResponse object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"UsersCallbackResponse":{"properties":{"callbackDetails":{"properties":{"errors":{"description":"Errors per user. Format: {\"<username>\": {\"<field>\": [\"<error>\"]}}","type":"array","items":{"type":"object","additionalProperties":true}},"nbErrors":{"description":"Number of users that failed","type":"integer"},"nbRecordsDone":{"description":"Number of users already processed","type":"integer"},"nbRecordsTodo":{"description":"Number of users to process","type":"integer"},"nbSuccess":{"description":"Number of users processed successfully","type":"integer"},"status":{"description":"Current job status","type":"string","enum":["Planned","Running","Finished","Finished with errors","Failed","In timeout"]},"success":{"description":"Users created/updated successfully. Format: {\"<username>\": {\"id\": <user_id>}}","type":"array","items":{"type":"object","additionalProperties":true}}},"type":"object"}},"type":"object"}}}}
```

## The View object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"View":{"description":"Configured submission view","properties":{"assigned_to_user":{"description":"Whether the view restricts submissions to those assigned to the current user","type":"boolean"},"filters":{"description":"Filtering rules for the view","type":"array","items":{"properties":{"item_filters":{"description":"Filtering rules on fields","type":"array","items":{"properties":{"name":{"description":"System name of the field","type":"string"},"operator":{"description":"Operator to apply","type":"string"},"type":{"description":"Daxium-Air type of the field","type":"string"},"values":{"description":"Values to compare the field value against via the operator","type":"array","items":{}}},"type":"object"}},"metadata_filters":{"description":"Filtering rules on metadata","type":"array","items":{"properties":{"name":{"description":"System name of the metadata","type":"string"},"operator":{"description":"Operator to apply","type":"string"},"values":{"type":"array","items":{}}},"type":"object"}},"structure_id":{"description":"Form identifier of the submissions to display","type":"integer"}},"type":"object"}},"icon":{"description":"Icon type and value","properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"id":{"description":"Unique identifier","type":"string","format":"uuid"},"name":{"description":"Localised name of the view","type":"string"},"view_mode":{"description":"View display mode (e.g. table)","type":"string"},"view_options":{"description":"View options","properties":{"ordered_fields":{"description":"Ordered list of fields to display (applicable if view_mode = table)","type":"array","items":{"type":"string"}}},"type":"object"}},"type":"object"}}}}
```

## The Workflow object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"Workflow":{"properties":{"id":{"type":"string","format":"uuid"},"name":{"description":"Localised names keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"start_state":{"type":"string","format":"uuid"},"states":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowState"}},"transitions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowTransition"}}},"type":"object"},"WorkflowState":{"properties":{"color":{"type":"string"},"end":{"description":"Submissions in end states cannot be modified","type":"boolean"},"id":{"type":"string","format":"uuid"},"name":{"description":"Localised names keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}}},"type":"object"},"WorkflowTransition":{"properties":{"from":{"type":"string","format":"uuid"},"id":{"type":"string","format":"uuid"},"label":{"description":"Localised labels keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"to":{"type":"string","format":"uuid"}},"type":"object"}}}}
```

## The WorkflowState object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"WorkflowState":{"properties":{"color":{"type":"string"},"end":{"description":"Submissions in end states cannot be modified","type":"boolean"},"id":{"type":"string","format":"uuid"},"name":{"description":"Localised names keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}}},"type":"object"}}}}
```

## The WorkflowTransition object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"schemas":{"WorkflowTransition":{"properties":{"from":{"type":"string","format":"uuid"},"id":{"type":"string","format":"uuid"},"label":{"description":"Localised labels keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"to":{"type":"string","format":"uuid"}},"type":"object"}}}}
```

## The Pagination object

```json
{"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"components":{"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"}}}}
```


---

# 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/models.md?ask=<question>&goal=<user_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.