General.Entites¶
En bref
3 opérations sur 3 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).
Opérations¶
| Méthode | Chemin | Rôle |
|---|---|---|
GET |
/v2/entites |
Lister les enregistrements |
POST |
/v2/entites/{entite} |
Créer l'enregistrement |
GET |
/v2/entites/{entite}/{cle} |
Lire l'enregistrement désigné |
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/entites¶
Lister les enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | tableau |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/entites?targets=DEMO&limit=50" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/entites/{entite}¶
Créer l'enregistrement.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
entite |
path | string |
oui | — |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/entites/<entite>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
GET /v2/entites/{entite}/{cle}¶
Lire l'enregistrement désigné.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
entite |
path | string |
oui | — |
cle |
path | string |
oui | — |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/entites/<entite>/<cle>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"