API UDo
Récupérer un enregistrement
GET https://api.udo.tools/v2/data/{env}/{appid}/{table}/{id}
Paramètres
Path
| Nom | Type | Description |
|---|---|---|
| env | texte |
Environnement de BDD utilisé |
| appid | texte |
GUID de l’application |
| table | texte |
Nom de la table (en minuscule et sans espace) |
| id | entier |
Identifiant de l’enregistrement à récupérer |
Header
| Nom | Type | Description |
|---|---|---|
| Authorization | texte |
BearerToken |
Exemple
Récupère l’enregistrement de la table contacts sur la BDD de développement avec l’identifiant 856
GET https://api.udo.tools/v2/data/dev/dop9sd-d87df9.../contacts/856
Récupérer plusieurs enregistrements
POST https://api.udo.tools/v2/data/all/{env}/{appid}/{table}
Paramètres
Path
| Nom | Type | Description |
|---|---|---|
| env | texte |
Environnement de BDD utilisé |
| appid | texte |
GUID de l’application |
| table | texte |
Nom de la table (en minuscule et sans espace) |
Query params (optionnel)
| Nom | Type | Description |
|---|---|---|
| cursor | entier |
Position de l’enregistrement |
| limit | entier |
Limite le nombre d’enregistrement retourné (max. 200) |
Header
| Nom | Type | Description |
|---|---|---|
| Authorization | texte |
BearerToken |
Body
| Nom | Type | Description |
|---|---|---|
| Filtrer et trier | json |
Filtre et trie les enregistrements récupérés |
Exemple
Récupère les 5 premiers enregistrements (sur la BDD de développement) de la table contacts dont le champ ville est égal à Paris et le champ identifiant est supérieur à 0 Trie les enregistrements sur les champs ville (croissant) et id (décroissant)
GET https://api.udo.tools/v2/data/all/dev/dop9sd-d87df9.../contacts?limit=5
Body :
{
"filter": [
{"key" : "ville", "type" : "=", "value" : "Paris"},
{"op" : "AND", "key" : "id", "type" : ">", "value" : "0"}
],
"sort" : [
{"key" : "ville", "type" : "ASC"},
{"key" : "id", "type" : "DESC"}
]
}
Modifier des enregistrements
PUT https://api.udo.tools/v2/data/{env}/{appid}/{table}
Paramètres
Path
| Nom | Type | Description |
|---|---|---|
| env | texte |
Environnement de BDD utilisé |
| appid | texte |
GUID de l’application |
| table | texte |
Nom de la table (en minuscule et sans espace) |
Header
| Nom | Type | Description |
|---|---|---|
| Authorization | texte |
BearerToken |
Body
| Nom | Type | Description |
|---|---|---|
| Valeurs | json (array) |
Liste des enregistrements à modifier (avec leurs valeurs) |
Exemple
Modifie les champs name et lastname (sur la BDD de développement) de la table contacts pour les identifiants 101 et 102
PUT https://api.udo.tools/v2/data/dev/dop9sd-d87df9.../contacts
Body :
[
{"id" : "101", "name" : "Marc", "lastname" : "dupont"},
{"id" : "102", "name" : "Pierre", "lastname" : "marchal"}
]
Créer des enregistrements
POST https://api.udo.tools/v2/data/{env}/{appid}/{table}
Paramètres
Path
| Nom | Type | Description |
|---|---|---|
| env | texte |
Environnement de BDD utilisé |
| appid | texte |
GUID de l’application |
| table | texte |
Nom de la table (en minuscule et sans espace) |
Header
| Nom | Type | Description |
|---|---|---|
| Authorization | texte |
BearerToken |
Body
| Nom | Type | Description |
|---|---|---|
| Valeurs | json (array) |
Liste des enregistrements à créer (avec leurs valeurs) |
Exemple
Créé 2 nouveaux enregistrements (sur la BDD de développement) dans la table contacts
POST https://api.udo.tools/v2/data/dev/dop9sd-d87df9.../contacts
Body :
[
{"name" : "Marc", "lastname" : "dupont"},
{"name" : "Pierre", "lastname" : "marchal"}
]
Supprimer un enregistrement
DELETE https://api.udo.tools/v2/data/{env}/{appid}/{table}/{id}
Paramètres
Path
| Nom | Type | Description |
|---|---|---|
| env | texte |
Environnement de BDD utilisé |
| appid | texte |
GUID de l’application |
| table | texte |
Nom de la table (en minuscule et sans espace) |
| id | entier |
Identifiant de l’enregistrement à supprimer |
Header
| Nom | Type | Description |
|---|---|---|
| Authorization | texte |
BearerToken |
Exemple
Supprime l’enregistrement avec l’identifiant 1589 (sur la BDD de développement) dans la table contacts
DELETE https://api.udo.tools/v2/data/dev/dop9sd-d87df9.../contacts/1589
Executer une requête SQL
POST https://api.udo.tools/v2/query/{env}/{appid}/{queryname}
Paramètres
Path
| Nom | Type | Description |
|---|---|---|
| env | texte |
Environnement de BDD utilisé |
| appid | texte |
GUID de l’application |
| queryname | texte |
Nom de la requête (en minuscule et sans espace) |
Header
| Nom | Type | Description |
|---|---|---|
| Authorization | texte |
BearerToken |
Body
| Nom | Type | Description |
|---|---|---|
| Variables | json |
Mapping des variables d’entrées de la requête |
Exemple
Récupère le résultat de la requête REQ_CONTACTS en alimentant les variables d’entrées “ville” et “nom”
POST https://api.udo.tools/v2/query/dev/dop9sd-d87df9.../req_contacts
Body :
{
"entries" : {"ville" : "Paris", "nom" : "DUPONT"}
}
Télécharger un fichier
GET https://api.udo.tools/v2/file/{appid}/{fileguid}
Paramètres
Path
| Nom | Type | Description |
|---|---|---|
| appid | texte |
GUID de l’application |
| fileguid | texte |
GUID du fichier |
Header
| Nom | Type | Description |
|---|---|---|
| Authorization | texte |
BearerToken |
Exemple
Récupère le fichier avec le guid 958qs-p6rad…
GET https://api.udo.tools/v2/file/dop9sd-d87df9.../958qs-p6rad...
Executer un backend workflow
POST https://api.udo.tools/v2/workflow/{env}/{appid}/{endpoint}
Paramètres
Path
| Nom | Type | Description |
|---|---|---|
| env | texte |
Environnement de BDD utilisé |
| appid | texte |
GUID de l’application |
| endpoint | texte |
Nom du workflow (en minuscule et sans espace) |
Header (optionnel)
Si l’option Demander le token d’accès a été selectionné dans les propriétés du workflow
| Nom | Type | Description |
|---|---|---|
| Authorization | texte |
BearerToken |
Body (optionnel)
Si une variable d’entrée à été défini comme body pour le workflow
| Nom | Type | Description |
|---|---|---|
| Variable | json ou jsonarray |
Alimente la variable d’entrée du workflow défini comme body |
Form-data (optionnel)
Si une variable d’entrée à été défini comme form-data pour le workflow
| Nom | Type | Description |
|---|---|---|
| Variable | texte/fichier |
Alimente les variables d’entrées du workflow définis comme form-data |
Query param (optionnel)
Si une variable d’entrée à été défini comme query param pour le workflow
| Nom | Type | Description |
|---|---|---|
| Variable | texte |
Alimente les variables d’entrées du workflow définis comme query param |
