API de marché
Utilisez l'API Marchés pour créer, mettre à jour ou interroger les marchés.
Utilisez les API de marché pour créer, mettre à jour ou interroger les données de marché. 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 marchés.
L'URL pour accéder aux API est : https ://<instance>.cso.coupahost.com/api/markets
Voir les meilleures pratiques d'intégration pour plus d'informations.
Actions
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| OBTENIR | /api/marchés |
index | Effectue une action Get pour récupérer tous les marchés |
| PUBLIER | /api/marchés |
créer | Crée un ou plusieurs objets de marché. |
| METTRE | /api/marchés |
mettre à jour | Met à jour un ou plusieurs marchés . Peut effectuer des mises à jour de masse. |
| SUPPRIMER | /api/marchés |
supprimer | Supprime un plus de marchés. Peut effectuer des suppressions massives. |
| OBTENIR | /api/markets/:id |
afficher | Afficher les données d'un marché. |
| METTRE | /api/markets/:id |
mettre à jour | Mettre à jour un marché à la fois à l'aide de l'identifiant |
| SUPPRIMER | /api/markets/:id |
supprimer | Supprimer un marché à la fois. |
Éléments
Ce sont les éléments disponibles pour l'API Marchés
| Nom de champ | Description du champ | Dem. | Unique ? | Valeurs admissibles | Dans | Sortie | Type |
|---|---|---|---|---|---|---|---|
| id |
Un ID unique généré par le système, incrémentiel automatique |
oui | nombre entier | ||||
| nom | Nom du marché | Oui | oui | oui | chaîne | ||
| description | Brève description du marché | oui | oui | chaîne |
Exemples
Dans cet exemple, nous avons demandé une API de marchés. Nous avons accédé À l'URL :
https ://<instance>.cso.coupahost.com/api/markets
Les marchés OBTIENNENT UNE RÉPONSE
{
"total" : 10,
"marchés" : [
{
"id" : "9219601763469521167",
"nom" : "! Démo du traqueur d'épargne de la Banque de Montréal"
},
{
"id" : "9219595277140974408",
"nom" : "! Billets JIRA"
},
{
"id" : "9219593060488131385",
"nom" : "!Marché 1",
"description" : « Logistique et transport »
},
{
"id" : "9220538753220565326",
"name" : "Marché Arj 1",
"description" : « XPO Logistics »
},
{
"id" : "9220538753220565329",
"nom" : "Marché Arj 2",
"description" : "XPO Transport"
},
{
"id" : "9219592846040196615",
"nom" : "Informations communes"
},
{
"id" : "9219593864376360801",
"nom" : « Consultation »
},
{
"id" : "9219601774059719348",
"nom" : « D - Nikisha' s Demo Market »
},
{
"id" : "9219601938334799391",
"nom" : « E-Intégrations »
},
{
"id" : "9219601936493380282",
"nom" : "Conseils E-Top pour auditer les événements"
}
]
}Créer/Mettre à jour/Supprimer
Ce qui suit décrit comment vous pouvez utiliser l'API Coupa pour effectuer des actions sur les marchés.
Créer
/api/marchés
La charge utile ci-dessous crée deux marchés.
Charge utile :
{
"marchés" : [
{
"nom" : "Marché Arjun 1",
"description" : « XPO Logistics »
},
{
"nom" : "Marché Arjun 2",
"description" : "XPO Transport"
}
]
}
Réponse : 201
{
"result" : [
{
"type" : "api.post.added",
"description" : "2 objets créés."
}
],
"ajouté" : 2,
"marchés" : [
{
"id" : "9220538753220565326"
},
{
"id" : "9220538753220565329"
}
]
}Mettre à jour
/api/marchés
La charge utile ci-dessous met à jour un marché.
Pour mettre à jour un ou plusieurs marchés à la fois :
Charge utile :
{
"marchés" : [
{
"nom" : "Marché Arj 1",
"description" : "XPO Logistics mis à jour"
},
{
"nom" : "Marché Arj 2",
"description" : "XPO Transport mis à jour"
}
]
}
Réponse : 200 OK
{
"result" : [
{
"type" : "api.put.updated",
"description" : "2 objets mis à jour."
}
],
"mis à jour" : 2
}
Supprimer
/api/marchés
La charge utile ci-dessous consiste à supprimer plus d'un marché à la fois. N'oubliez pas que la suppression de marchés individuellement ou en masse entraînera également la suppression d'événements associés.
Charge utile :
{
"marchés" : [
{
"id" : "9220538753220565326"
},
{
"nom" : "Marché Arjun 2"
}
]
}
Réponse : 200 OK
{
"result" : [
{
"type" : "market.deleted.logMsg",
"description" : "Le marché Arjun Market 1 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. Voir supprimer la charge utile ci-dessus, par exemple. La charge utile a supprimé un seul marché. Pour la suppression ou les mises à jour, un identifiant est requis dans la charge utile.
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.