Groupes

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

Lister les groupes d'un vertical métier

get

Retourne tous les groupes du vertical métier. Nécessite des droits administrateur.

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)

Réponses

200

Liste des groupes

application/json

total_countintegerOptionnel

total_pagesintegerOptionnel

server_timeinteger · int64Optionnel

get/{app_short}/groups

HTTPcURLJavaScriptPython

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

200

Liste des groupes

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

Créer un groupe

post

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)

Corps

application/json

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

namestringRequis

Nom du groupe

descriptionstringRequis

Description du groupe

user_idsinteger[]Optionnel

Identifiants des utilisateurs du groupe

structure_idsinteger[]Optionnel

Identifiants des formulaires du groupe

Réponses

200

Groupe créé

application/json

Groupe d'un vertical métier

is_systembooleanOptionnel

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

idintegerOptionnel

Identifiant du groupe

namestringOptionnel

Nom affiché

descriptionstringOptionnel

Description renseignée par l'administrateur

user_idsinteger[]Optionnel

Identifiants des utilisateurs du groupe

structure_idsinteger[]Optionnel

Identifiants des formulaires liés au groupe

post/{app_short}/group

HTTPcURLJavaScriptPython

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

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

200

Groupe créé

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

Mettre à jour un groupe

put

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)

group_idintegerRequis

Identifiant du groupe

Corps

application/json

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

namestringRequis

Nom du groupe

descriptionstringRequis

Description du groupe

user_idsinteger[]Optionnel

Identifiants des utilisateurs du groupe

structure_idsinteger[]Optionnel

Identifiants des formulaires du groupe

Réponses

200

Groupe mis à jour

application/json

Groupe d'un vertical métier

is_systembooleanOptionnel

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

idintegerOptionnel

Identifiant du groupe

namestringOptionnel

Nom affiché

descriptionstringOptionnel

Description renseignée par l'administrateur

user_idsinteger[]Optionnel

Identifiants des utilisateurs du groupe

structure_idsinteger[]Optionnel

Identifiants des formulaires liés au groupe

put/{app_short}/group/{group_id}

HTTPcURLJavaScriptPython

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

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

200

Groupe mis à jour

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