Parametres.General.Agenda
En bref
8 opérations sur 4 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).
Opérations
| Méthode | Chemin | Rôle |
|---|---|---|
GET |
/v2/agenda |
Lister les enregistrements |
POST |
/v2/agenda |
Créer l'enregistrement |
PUT |
/v2/agenda |
Mettre à jour l'enregistrement |
DELETE |
/v2/agenda |
Supprimer l'enregistrement |
GET |
/v2/agenda/count |
Compter les enregistrements |
POST |
/v2/agenda/count |
Compter les enregistrements |
POST |
/v2/agenda/recherche |
Rechercher des enregistrements |
POST |
/v2/agenda/save |
Créer ou mettre à jour l'enregistrement (upsert) |
Rôle déduit
La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.
Détail
GET /v2/agenda
Lister les enregistrements.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
sort |
query | string |
non | - |
where |
query | string |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/agenda?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/agenda
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma AgendaDto - 4 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/agenda" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "type": 0}'
PUT /v2/agenda
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma AgendaDto - 4 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X PUT "https://<votre-connecteur>/v2/agenda" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "type": 0}'
DELETE /v2/agenda
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma AgendaDto - 4 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X DELETE "https://<votre-connecteur>/v2/agenda" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "type": 0}'
GET /v2/agenda/count
Compter les enregistrements.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
where |
query | string |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/agenda/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/agenda/count
Compter les enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/agenda/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/agenda/recherche
Rechercher des enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/agenda/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/agenda/save
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma AgendaDto - 4 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/agenda/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "type": 0}'
Schémas
Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.
AgendaDto
AgendaDto - 4 propriétés
| Propriété | Type | Notes |
|---|---|---|
id |
integer (int32) |
Indice (clé, cbIndice). |
intitule |
string |
nullable, Intitulé de la rubrique (35 caractères max). |
type |
integer (int32) |
Fichier / type d'intéressé concerné (énuméré AgendaTypeInteresse). |
indisponible |
boolean |
Rendre la ressource indisponible. |