For the complete documentation index, see llms.txt. This page is also available as Markdown.

Groupes

Gérer les groupes d'un vertical métier

Lister les groupes d'un vertical métier

get
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+
include_systemstringOptionnel

Inclure les groupes système

Default: 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 des groupes

application/json
total_countintegerOptionnel
total_pagesintegerOptionnel
server_timeintegerOptionnel
get/{app_short}/groups
GET /{app_short}/groups HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "groups": [
    {
      "description": "text",
      "id": 1,
      "is_system": true,
      "name": "text",
      "structure_ids": [
        1
      ],
      "user_ids": [
        1
      ]
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

Créer un groupe

post
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 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:
Corps

Corps de création ou de mise à jour d'un groupe

descriptionstringRequis

Description du groupe

namestringRequis

Nom du groupe

structure_idsinteger[]Optionnel

Identifiants des formulaires du groupe

user_idsinteger[]Optionnel

Identifiants des utilisateurs du groupe

Réponses
200

Groupe créé

application/json

Groupe d'un vertical métier

descriptionstringOptionnel

Description renseignée par l'administrateur

idintegerOptionnel

Identifiant du groupe

is_systembooleanOptionnel

Indique s'il s'agit d'un groupe système

namestringOptionnel

Nom affiché

structure_idsinteger[]Optionnel

Identifiants des formulaires liés au groupe. Calculés uniquement lors de la création ou de la mise à jour d'un groupe ; toujours un tableau vide sur l'endpoint de liste (GET /groups ne les renseigne jamais).

user_idsinteger[]Optionnel

Identifiants des utilisateurs du groupe. Calculés uniquement lors de la création ou de la mise à jour d'un groupe ; toujours un tableau vide sur l'endpoint de liste (GET /groups ne les renseigne jamais).

post/{app_short}/group
POST /{app_short}/group HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "description": "text",
  "name": "text",
  "structure_ids": [
    1
  ],
  "user_ids": [
    1
  ]
}
{
  "description": "text",
  "id": 1,
  "is_system": true,
  "name": "text",
  "structure_ids": [
    1
  ],
  "user_ids": [
    1
  ]
}

Mettre à jour un groupe

put
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.

group_idstringRequisPattern: \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:
Corps

Corps de création ou de mise à jour d'un groupe

descriptionstringRequis

Description du groupe

namestringRequis

Nom du groupe

structure_idsinteger[]Optionnel

Identifiants des formulaires du groupe

user_idsinteger[]Optionnel

Identifiants des utilisateurs du groupe

Réponses
200

Groupe mis à jour

application/json

Groupe d'un vertical métier

descriptionstringOptionnel

Description renseignée par l'administrateur

idintegerOptionnel

Identifiant du groupe

is_systembooleanOptionnel

Indique s'il s'agit d'un groupe système

namestringOptionnel

Nom affiché

structure_idsinteger[]Optionnel

Identifiants des formulaires liés au groupe. Calculés uniquement lors de la création ou de la mise à jour d'un groupe ; toujours un tableau vide sur l'endpoint de liste (GET /groups ne les renseigne jamais).

user_idsinteger[]Optionnel

Identifiants des utilisateurs du groupe. Calculés uniquement lors de la création ou de la mise à jour d'un groupe ; toujours un tableau vide sur l'endpoint de liste (GET /groups ne les renseigne jamais).

put/{app_short}/group/{group_id}
PUT /{app_short}/group/{group_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "description": "text",
  "name": "text",
  "structure_ids": [
    1
  ],
  "user_ids": [
    1
  ]
}
{
  "description": "text",
  "id": 1,
  "is_system": true,
  "name": "text",
  "structure_ids": [
    1
  ],
  "user_ids": [
    1
  ]
}

Mis à jour

Ce contenu vous a-t-il été utile ?