API des événements
Utilisez l'API Événements pour créer, mettre à jour ou interroger les événements et les données associées.
Utilisez les API d'événements pour créer, mettre à jour ou interroger les données d'événement. Cela inclut des points de terminaison spécifiques pour prendre des mesures (créer/mettre à jour/supprimer) ainsi que des événements liés aux fiches d'information , aux lignes, aux champs et aux étiquettes.
L'URL pour accéder aux API est : https ://<instance>.cso.coupahost.com/api/events
Voir les meilleures pratiques d'intégration pour plus d'informations.
Actions
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| OBTENIR | /API/événements |
index | Effectue une action Get pour récupérer tous les événements |
| PUBLIER | /API/événements |
créer | Crée un ou plusieurs objets d'événements. |
| METTRE | /API/événements |
mettre à jour | Met à jour un ou plusieurs événements . Peut effectuer des mises à jour de masse. |
| SUPPRIMER | /API/événements |
supprimer | Supprime un événement de plus. Peut effectuer des suppressions massives. |
| OBTENIR | /api/events/:id |
afficher | Afficher les données d'un événement. |
| METTRE | /api/events/:id |
mettre à jour | Mettre à jour un événement à la fois à l'aide de l'ID |
| SUPPRIMER | /api/events/:id |
supprimer | Supprimer un événement à la fois. |
Éléments
Ce sont les éléments disponibles pour l'API Événements
| Nom de champ | Description du champ | Dem. | Unique ? | Valeurs admissibles | Dans | Sortie * | Type |
|---|---|---|---|---|---|---|---|
| iD |
ID de l'événement |
Oui | oui | nombre entier | |||
| market-id | L'ID du marché auquel l'événement appartient. Une fois défini, il ne peut pas être modifié. | Oui | oui | oui | chaîne | ||
| état | État /Phase actuelle de l'événement |
Configuration,actif,terminé (sensible à la casse) |
oui | oui | chaîne | ||
| nom | Nom de l'événement | oui | oui | chaîne | |||
| description | Description courte de l'événement | oui | oui | chaîne | |||
| référence-numéro | Un champ pour un numéro de référence pour identifier l'événement | oui | oui | chaîne | |||
| event-number | Un identifiant unique de l'événement. Cette valeur est une valeur incrémentielle | oui | oui | nombre entier | |||
| fuseau horaire | Fuseau horaire de l'événement | oui | oui | chaîne | |||
| paramètres | Paramètres de l'événement | oui | oui | chaîne |
La charge utile de réponse n'affiche pas de valeurs nulles.
Exemples
Dans cet exemple, nous avons demandé une API d'événements. Nous avons accédé À l'URL :
https ://<instance>.cso.coupahost.com/api/events
Les événements OBTIENNENT UNE RÉPONSE
{
"total" : 5,
"événements" : [
{
"id" : "9219595375673293031",
"market-id" : "9219595214580536433",
"state" : "Configuration",
"nom" : "Projet de formation APC",
"description" : "Pour les offres",
"event-number" : 10,
"settings" : {
"devise" : "USD"
}
},
{
"id" : "9219601944812992706",
"market-id" : "9219596879086622384",
"state" : "Configuration",
"nom" : "API - Stockage de données",
"description" : "Tester Hamno",
"event-number" : 11,
"fuseau horaire" : "Europe/Stockholm",
"settings" : {
"devise" : "EUR"
}
},
{
"id" : "9219592828238410706",
"market-id" : "9219592396342653837",
"state" : "Actif",
"nom" : "** Matériel et services informatiques 2014",
"description" : "Services indirects",
"numéro de référence" : "MC-IN-15/02",
"event-number" : 613,
"settings" : {
"devise" : "GBP"
}
},
{
"id" : "9219593444808990596",
"market-id" : "9219593040793966498",
"state" : "Résilié",
"name" : "!* ** Procédures de test * ** ! (à des fins de sauvegarde uniquement)",
"description" : "Tâches à effectuer lorsqu'une nouvelle version est sur le point d'être lancée",
"event-number" : 1602,
"settings" : {
"devise" : "USD"
}
},
{
"id" : "9219594228963465852",
"market-id" : "9219592396342653837",
"state" : "Configuration",
"name" : "** Exemple d'appel d'offres pour le fret aérien - aseptisé le 12/09/15",
"description" : "Exemple d'offre de fret aérien",
"numéro de référence" : "MC-A15-01",
"event-number" : 13,
"settings" : {
"devise" : "SEK"
}
}
]
}Créer/Mettre à jour/Supprimer
Ce qui suit décrit comment vous pouvez utiliser l'API Coupa pour effectuer des actions sur des événements.
Créer
/API/événements
La charge utile ci-dessous crée deux événements.
Charge utile :
{
"événements" : [
{
"market-id" : "9220538753220565329",
"nom" : "Matériel et services informatiques 2021",
"description" : "services directs",
"numéro de référence" : "DEMO-ref1",
"settings" : {
"devise" : "USD"
}
},
{
"market-id" : "9220538753220565329",
"state" : "Configuration",
"nom" : "Services UNIQUEMENT",
"description" : "même marché avec état, fuseau horaire et aucun numéro de référence",
"fuseau horaire" : "Europe/Stockholm",
"settings" : {
"devise" : "EUR"
}
}
]
}
Réponse : 201
{
"result" : [
{
"type" : "api.post.added",
"description" : "2 objets créés."
}
],
"ajouté" : 2,
"événements" : [
{
"id" : "9220538753252871154"
},
{
"id" : "9220538753252871160"
}
]
}
Mettre à jour
/API/événements
La charge utile ci-dessous met à jour un événement.
Pour mettre à jour un ou plusieurs événements à la fois :
Charge utile :
{
"événements" : [
{
"id" : "9220538753252871154",
"state" : "Actif",
"nom" : "Matériel et services informatiques 2021-ABC",
"description" : "services directs - ABC",
"numéro de référence" : « DEMO-référence »
},
{
"id" : "9220538753252871160",
"nom" : « Les services canalisent UNIQUEMENT »
}
]
}
Réponse : 200 OK
{
"result" : [
{
"type" : "api.put.updated",
"description" : "2 objets mis à jour."
}
],
"mis à jour" : 2
}
Vous pouvez mettre à jour tous les champs sauf event-number et market-id.Supprimer
/API/événements
L'API ci-dessus peut être utilisée pour supprimer plus d'un événement à la fois.
Charge utile :
{
"événements" : [
{
"id" : "9220538753252871154"
}
]
}
Réponse : 200 OK
{
"result" : [
{
"type" : "event.deleted.logMsg",
"description" : "L'événement Matériel et services informatiques 2021-ABC a été supprimé."
}
],
"supprimé" : 1
}Les mises à jour sont effectuées de manière indulgente, c'est-à-dire que si la mise à jour d'une ressource échoue, les autres pourraient réussir. La charge utile a supprimé un événement. Pour la suppression ou les mises à jour, l'ID d'événement est obligatoire.
Les demandes réussies renverront une réponse HTTP 200. Le corps de la réponse inclura la demande créée. Les demandes infructueuses renverront HTTP 400 Bad Request. Le corps de la réponse comprendra des erreurs de validation formatées en XML.