Formulaires

Récupérer les définitions de formulaires et leurs versions

Lister tous les formulaires

get

Retourne tous les formulaires disponibles avec pagination.

Autorisations

OAuth2passwordRequis

Envoyez l'access token sous la forme Authorization: Bearer <token>.

Token URL: Refresh URL:

---

OAuth2authorizationCodeRequis

Envoyez l'access token sous la forme Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:

Paramètres de chemin

app_shortstringRequis

Nom court du vertical métier, tel qu'il apparaît dans l'URL du back-office.

Paramètres de requête

pagestringOptionnel

Page de la vue d'ensemble.

Default: 0Pattern: \d+

per_pagestringOptionnel

Nombre de résultats par page (max. 100)

Default: 10Pattern: -?\d+

updated_sincestringOptionnel

Récupérer uniquement les formulaires modifiés depuis cette date

Default: ""Pattern: \d+

include_exclusive_structuresstringOptionnel

Si vrai, les superadmins accèdent à tous les formulaires, y compris les formulaires exclusifs

Default: falsePattern: (true|false)

Paramètres d'en-tête

X-Accept-Versionstring · enumOptionnel

Version de l'API à appliquer. Vaut v1.0 si omise ; une valeur inconnue bascule sur la version la plus récente.

Default: v1.3Valeurs possibles:

Réponses

200

Liste paginée de formulaires

application/json

next_pageintegerOptionnel

server_timeinteger · int64Optionnel

total_countintegerOptionnel

total_pagesintegerOptionnel

401

Access token manquant ou invalide.

application/json

get/{app_short}/structures

GET /{app_short}/structures HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "next_page": 1,
  "required": {
    "linked_list_ids": [
      1
    ],
    "structure_ids": [
      1
    ]
  },
  "server_time": 1,
  "structures": [
    {
      "can_have_access_restrictions": true,
      "conditions": [
        {
          "cdt": "text",
          "fields": [
            "text"
          ],
          "json_format": [
            {
              "field": "text",
              "operator": "text",
              "value": "text"
            }
          ],
          "name": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "created_at": 1,
      "deleted_at": 1,
      "fields": [
        {
          "barcodescan": true,
          "enable": true,
          "externalscan": true,
          "label": "text",
          "name": "text",
          "permissions": {
            "editable": {
              "type": "constant",
              "value": true,
              "ids": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            },
            "required": {
              "type": "constant",
              "value": true,
              "ids": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            },
            "visible": {
              "type": "constant",
              "value": true,
              "ids": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            }
          },
          "position": 1,
          "prefill": true,
          "readonly": true,
          "required": true,
          "richtext": true,
          "searchable": true,
          "textRecognition": true,
          "type": "text"
        }
      ],
      "id": 1,
      "is_current_user_allowed": true,
      "layout": {
        "fields": [],
        "pages": []
      },
      "name": "text",
      "nb_submissions": 1,
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "triggers": [
        {
          "color": "text",
          "condition_id": "123e4567-e89b-12d3-a456-426614174000",
          "icon": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "label": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "transition_id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text"
        }
      ],
      "updated_at": 1,
      "version": 1,
      "workflow_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "workflows": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "start_state": "123e4567-e89b-12d3-a456-426614174000",
      "states": [
        {
          "color": "text",
          "end": true,
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ],
      "transitions": [
        {
          "from": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "label": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "to": "123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }
  ]
}

Récupérer un formulaire

get

Retourne le formulaire dans la version demandée, ou la plus récente si la version est omise.

Autorisations

OAuth2passwordRequis

Envoyez l'access token sous la forme Authorization: Bearer <token>.

Token URL: Refresh URL:

---

OAuth2authorizationCodeRequis

Envoyez l'access token sous la forme Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:

Paramètres de chemin

app_shortstringRequis

Nom court du vertical métier, tel qu'il apparaît dans l'URL du back-office.

structure_idstringRequisPattern: \d+

Paramètres de requête

versionstringOptionnel

Version du formulaire

Default: ""Pattern: \d+

Paramètres d'en-tête

X-Accept-Versionstring · enumOptionnel

Version de l'API à appliquer. Vaut v1.0 si omise ; une valeur inconnue bascule sur la version la plus récente.

Default: v1.3Valeurs possibles:

Réponses

200

Objet formulaire

application/json

server_timeintegerOptionnel

401

Access token manquant ou invalide.

application/json

404

Aucun formulaire avec cet identifiant dans le vertical métier.

application/json

get/{app_short}/structures/{structure_id}

GET /{app_short}/structures/{structure_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "structure": {
    "can_have_access_restrictions": true,
    "conditions": [
      {
        "cdt": "text",
        "fields": [
          "text"
        ],
        "json_format": [
          {
            "field": "text",
            "operator": "text",
            "value": "text"
          }
        ],
        "name": "text",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "created_at": 1,
    "deleted_at": 1,
    "fields": [
      {
        "barcodescan": true,
        "enable": true,
        "externalscan": true,
        "label": "text",
        "name": "text",
        "permissions": {
          "editable": {
            "type": "constant",
            "value": true,
            "ids": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "required": {
            "type": "constant",
            "value": true,
            "ids": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "visible": {
            "type": "constant",
            "value": true,
            "ids": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          }
        },
        "position": 1,
        "prefill": true,
        "readonly": true,
        "required": true,
        "richtext": true,
        "searchable": true,
        "textRecognition": true,
        "type": "text"
      }
    ],
    "id": 1,
    "is_current_user_allowed": true,
    "layout": {
      "fields": [],
      "pages": []
    },
    "name": "text",
    "nb_submissions": 1,
    "settings": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "triggers": [
      {
        "color": "text",
        "condition_id": "123e4567-e89b-12d3-a456-426614174000",
        "icon": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "transition_id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text"
      }
    ],
    "updated_at": 1,
    "version": 1,
    "workflow_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "server_time": 1
}

Récupérer un fichier lié à un formulaire

get

Limité pour l'instant aux images des champs Logo.

Autorisations

OAuth2passwordRequis

Envoyez l'access token sous la forme Authorization: Bearer <token>.

Token URL: Refresh URL:

---

OAuth2authorizationCodeRequis

Envoyez l'access token sous la forme Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:

Paramètres de chemin

app_shortstringRequis

Nom court du vertical métier, tel qu'il apparaît dans l'URL du back-office.

structure_idstringRequisPattern: \d+

file_idstringRequisPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}

Paramètres d'en-tête

X-Accept-Versionstring · enumOptionnel

Version de l'API à appliquer. Vaut v1.0 si omise ; une valeur inconnue bascule sur la version la plus récente.

Default: v1.3Valeurs possibles:

Réponses

200

Contenu de l'image

image/jpeg

string · binaryOptionnel

401

Access token manquant ou invalide.

application/json

404

Aucun fichier de ce nom sur ce formulaire.

application/json

get/{app_short}/structures/{structure_id}/file/{file_id}

GET /{app_short}/structures/{structure_id}/file/{file_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

binary