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

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

Paramètres de requête

per_pageintegerOptionnel

Nombre de formulaires par page (défaut 10)

Default: 10

pageintegerOptionnel

Numéro de page (base 0)

Default: 0

updated_sinceinteger · int64Optionnel

Ne retourner que les formulaires mis à jour depuis ce timestamp UNIX

Réponses

200

Liste paginée de formulaires

application/json

total_countintegerOptionnel

Nombre total de formulaires

total_pagesintegerOptionnel

Nombre total de pages

next_pageintegerOptionnel

Numéro de la page suivante

server_timeinteger · int64Optionnel

Date courante du serveur (timestamp UNIX)

get/{app_short}/structures

HTTPcURLJavaScriptPython

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

200

Liste paginée de formulaires

{
  "structures": [
    {
      "id": 1,
      "version": 1,
      "name": "text",
      "created_at": 1,
      "updated_at": 1,
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "conditions": [
        {
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "cdt": "text",
          "fields": [
            "text"
          ],
          "json_format": [
            {
              "field": "text",
              "value": "text",
              "operator": "text"
            }
          ]
        }
      ],
      "fields": [
        {
          "name": "text",
          "label": "text",
          "position": 1,
          "type": "text",
          "enable": true,
          "required": true,
          "prefill": true,
          "readonly": true,
          "searchable": true
        }
      ],
      "layout": {
        "pages": [],
        "fields": []
      },
      "workflows": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "created_at": 1,
          "updated_at": 1,
          "start_state": "123e4567-e89b-12d3-a456-426614174000",
          "states": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "color": "text",
              "end": true
            }
          ],
          "transitions": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "from": "123e4567-e89b-12d3-a456-426614174000",
              "to": "123e4567-e89b-12d3-a456-426614174000",
              "label": "text"
            }
          ]
        }
      ],
      "triggers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "transition_id": "123e4567-e89b-12d3-a456-426614174000",
          "color": "text",
          "label": "text"
        }
      ]
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "next_page": 1,
  "server_time": 1,
  "workflows": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "created_at": 1,
      "updated_at": 1,
      "start_state": "123e4567-e89b-12d3-a456-426614174000",
      "states": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "color": "text",
          "end": true
        }
      ],
      "transitions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "from": "123e4567-e89b-12d3-a456-426614174000",
          "to": "123e4567-e89b-12d3-a456-426614174000",
          "label": "text"
        }
      ]
    }
  ],
  "required": {
    "linked_list_ids": [
      1
    ],
    "structure_ids": [
      1
    ]
  }
}

Récupérer un formulaire

get

Retourne le formulaire à la version indiquée, ou la dernière version si omise.

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

idintegerRequis

Identifiant du formulaire

Paramètres de requête

versionintegerOptionnel

Numéro de version du formulaire

Réponses

200

Objet formulaire

application/json

server_timeinteger · int64Optionnel

get/{app_short}/structures/{id}

HTTPcURLJavaScriptPython

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

200

Objet formulaire

{
  "structure": {
    "id": 1,
    "version": 1,
    "name": "text",
    "created_at": 1,
    "updated_at": 1,
    "settings": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "conditions": [
      {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "cdt": "text",
        "fields": [
          "text"
        ],
        "json_format": [
          {
            "field": "text",
            "value": "text",
            "operator": "text"
          }
        ]
      }
    ],
    "fields": [
      {
        "name": "text",
        "label": "text",
        "position": 1,
        "type": "text",
        "enable": true,
        "required": true,
        "prefill": true,
        "readonly": true,
        "searchable": true
      }
    ],
    "layout": {
      "pages": [],
      "fields": []
    },
    "workflows": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "created_at": 1,
        "updated_at": 1,
        "start_state": "123e4567-e89b-12d3-a456-426614174000",
        "states": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "color": "text",
            "end": true
          }
        ],
        "transitions": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "from": "123e4567-e89b-12d3-a456-426614174000",
            "to": "123e4567-e89b-12d3-a456-426614174000",
            "label": "text"
          }
        ]
      }
    ],
    "triggers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "transition_id": "123e4567-e89b-12d3-a456-426614174000",
        "color": "text",
        "label": "text"
      }
    ]
  },
  "server_time": 1
}

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

get

Retourne le fichier lié au formulaire (actuellement uniquement les images des champs Logo).

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

idintegerRequis

Identifiant du formulaire

file_idstring · uuidRequis

Identifiant du fichier (UUID)

Réponses

200

Contenu de l'image

image/jpeg

string · binaryOptionnel

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

HTTPcURLJavaScriptPython

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

200

Contenu de l'image

binary