API Fiches descriptives
Utilisez l'API Fact Sheets pour créer, mettre à jour ou interroger les Fact Sheets et les données (lignes / champs) associées.
Les fiches de renseignements sont utilisées pour stocker, adapter, organiser et traiter les données depuis diverses sources avant, pendant et après un événement de sourcing dans CSO.
Les champs de faits définissent les données à maintenir, tout comme les champs d'article ou les colonnes dans une feuille de travail Excel. Chaque ligne de faits ne doit contenir qu'une seule valeur pour chaque champ de faits afin de pouvoir utiliser les données efficacement. Les fiches d'information sont utilisées pour entrer des données dans l'événement, par exemple des volumes historiques ou d'autres spécifications d'articles, des scores de performance des fournisseurs, des listes d'adresses et des codes pour les usines, les articles ou les services, des codes postaux, des latitudes, etc.
Utilisez les API de feuilles de faits pour créer, mettre à jour ou interroger les données des feuilles de faits. Cela inclut des points de terminaison spécifiques pour prendre des mesures (créer/mettre à jour/supprimer) ainsi que les données associées aux lignes et aux champs.
L'URL pour accéder aux API est : https ://.cso.coupahost.com/api/events/<instance> {event-id}/fact-sheets
Voir les meilleures pratiques d'intégration pour plus d'informations.
Actions
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| OBTENIR | /api/events/{event-id}/fact-sheets |
index | Effectue une action Get pour récupérer toutes les fiches d'information |
| PUBLIER | /api/events/{event-id}/fact-sheets |
créer | Crée un ou plusieurs objets Fact Sheets. |
| METTRE | /api/events/{event-id}/fact-sheets |
mettre à jour | Met à jour une ou plusieurs fiches d'information. Peut effectuer des mises à jour de masse. |
| SUPPRIMER | /api/events/{event-id}/fact-sheets |
supprimer | Supprime une feuille de fait de plus. Peut effectuer des suppressions massives. |
| OBTENIR | /api/events/{event-id}/fact-sheets/{fact-sheet-id} |
afficher | Afficher les données de la feuille de fait pour un ID de feuille de fait. |
| METTRE | /api/events/{event-id}/fact-sheets/{fact-sheet-id} |
mettre à jour | Mettez à jour une feuille de faits à la fois à l'aide de l'ID de la feuille de faits |
| SUPPRIMER | /api/events/{event-id}/fact-sheets/{fact-sheet-id} |
supprimer | Supprimer une fiche d'information à la fois. |
Éléments
Ce sont les éléments disponibles pour l'API Fact Sheets
| Nom de champ | Description du champ | Dem. | Unique ? | Valeurs admissibles | Dans | Sortie * | Type |
|---|---|---|---|---|---|---|---|
| iD |
ID de la feuille de faits |
Oui | oui | nombre entier | |||
| ordinal | La valeur ordinale de la fiche d'informations | oui | nombre entier | ||||
| type | Le type de la feuille de faits. Une fois défini, il ne peut pas être modifié | oui |
Ordinaire, Reporting |
oui | chaîne | ||
| nom | Nom de la fiche d'information | oui | oui | oui | chaîne | ||
| formula-name | Le nom de la formule de la feuille de faits | oui | oui | chaîne | |||
| event-id | L'identifiant de l'événement pour la feuille de fait. Une fois défini, il ne peut pas être modifié | oui | oui | nombre entier | |||
| description | Une brève description | oui | oui | chaîne | |||
| created-time | L'heure à laquelle la fiche d'informations a été créée . Format ISO8601 | oui | datetime |
La charge utile de réponse n'affiche pas de valeurs NULL.
Exemples
Dans cet exemple, nous avons demandé une API Fact Sheets.
https ://<instance>.cso.coupahost.com/api/events/{event-id}/fact-sheets
Nous avons accédé à l'URL ci-dessous pour un exemple d'Event-id = 9219593444837772101 :
htpss ://<instance>.cso.coupacloud.com/api/events/9219593444837772101/fact-sheets
Fiches descriptives OBTENIR UNE RÉPONSE
{
"total" : 4,
"fiches techniques" : [
{
"id" : "9219593444824438589",
"ordinal" : 0,
"type" : "Ordinaire",
"nom" : "B_Supernova 2014 - Analyse Rd2",
"formula-name" : "b_supernova_2014_rd2_analysis",
"event-id" : "9219593444837772101",
"created-time" : "27/02/2015T16:56:09.875+0000"
},
{
"id" : "9219593444824438592",
"ordinal" : 1,
"type" : "Ordinaire",
"nom" : "PD_Détails du projet",
"formula-name" : "pd_project_details",
"event-id" : "9219593444837772101",
"created-time" : "27/02/2015T16:56:09.875+0000"
},
{
"id" : "9219601795978222763",
"ordinal" : 1,
"type" : "Rapports",
"nom" : "Rapports de gestion",
"formula-name" : "gestion_rapports",
"event-id" : "9219593444837772101",
"created-time" : « 2020-02-10T03:17:03.96+0000 »
},
{
"id" : "9219601942217814052",
"ordinal" : 1,
"type" : "Rapports",
"nom" : "Tester le statut de tous les événements",
"formula-name" : "test_all_event_status",
"event-id" : "9219593444837772101",
"description" : "Tester le statut de tous les événements",
"created-time" : « 2020-09-09T10:30:07.376+0000 »
}
]
}Créer/Mettre à jour/Supprimer
Ce qui suit décrit comment vous pouvez utiliser l'API Coupa pour effectuer des actions sur des fiches d'information.
Créer
/api/events/:id/fact-sheets
La charge utile ci-dessous crée une nouvelle fiche d'information sur un événement(9220538753252871154)
Charge utile :
{
"fiches techniques" : [
{
"id" : "9220538753431210838",
"nom" : "demo-factsheet-new",
"event-id" : "9220538753252871154",
"description" : "test de la fiche de démonstration à l'aide de l'API"
}
]
}
Réponse : 201
{
"result" : [
{
"type" : "api.post.added",
"description" : "1 objets créés."
}
],
"ajouté" : 1,
"fiches techniques" : [
{
"id" : "9220538753455571178"
}
]
} Mettre à jour
/api/events/{event-id}/fact-sheets
La charge utile ci-dessous met à jour une ou plusieurs fiches d'informations.
Pour mettre à jour un ou plusieurs événements à la fois :
Charge utile :
{
"fiches techniques" : [
{
"id" : "9220538753461853110",
"name" : "démo-factsheet-newest",
"formula-name" : "demo_factsheet_newest",
"description" : "test de la fiche de démonstration à l'aide de l'API avec ordinal"
}
]
}
Réponse : 200 OK
{
"result" : [
{
"type" : "api.put.updated",
"description" : "1 objets mis à jour."
}
],
"mis à jour" : 1
}
Vous ne pouvez mettre à jour que les champs name/formula-name/description d'une fiche de fait.Supprimer
/api/events/{event-id}/fact-sheets
L'API ci-dessus peut être utilisée pour supprimer plusieurs fiches d'information à la fois.
Charge utile :
{
"fiches techniques" : [
{
"id" : "9220538753461853110"
}
]
}
Réponse : 200 OK
{
"result" : [
{
"type" : "removedFactSheets",
"description" : "Les fiches d'informations suivantes ont été enlevées : demo-factsheet-newest"
}
],
"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.