API Fiches de renseignements
Utilisez l'API Fiches de renseignements pour créer, mettre à jour ou interroger les feuilles de renseignements et les données associées (Lignes / Champs).
Les fiches de renseignements sont utilisées pour stocker, adapter, organiser et traiter des données provenant de diverses sources avant, pendant et après un appel d'offres dans CSO.
Les champs de fait définissent les données à conserver, tout comme les champs d'article ou les colonnes dans une feuille de travail Excel. Chaque ligne d'informations ne doit contenir qu'une seule valeur pour chaque champ d'informations afin de pouvoir utiliser les données efficacement. Les fiches de renseignements sont utilisées pour saisir 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 de codes pour les usines, les articles ou les services, les codes postaux, les latitudes, etc.
Utilisez les API de feuilles de fait pour créer, mettre à jour ou interroger les données des feuilles de fait. Cela inclut les points de terminaison spécifiques pour effectuer une action (créer/mettre à jour/supprimer) ainsi que les données associées aux lignes, aux champs.
L'URL pour accéder aux API est : https://<instance>.cso.coupahost.com/api/events/{event-id}/fact-sheets
Consultez la rubrique Bonnes 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 Obtenir pour récupérer toutes les feuilles de fait |
POSTE | /api/events/{event-id}/fact-sheets |
créer | Crée un ou plusieurs objets Fiches de renseignements. |
METTRE | /api/events/{event-id}/fact-sheets |
mettre à jour | Met à jour une ou plusieurs feuilles de fait . Peut effectuer des mises à jour en masse. |
EFFACER | /api/events/{event-id}/fact-sheets |
effacer | Supprime une ou plusieurs feuilles de fait. Peut effectuer des suppressions en masse. |
OBTENIR | /api/events/{event-id}/fact-sheets/{fact-sheet-id} |
montrer | Afficher les données de la fiche d'informations pour un ID de fiche d'informations. |
METTRE | /api/events/{event-id}/fact-sheets/{fact-sheet-id} |
mettre à jour | Mettre à jour une feuille de fait à la fois en utilisant l'ID de la feuille de fait |
EFFACER | /api/events/{event-id}/fact-sheets/{fact-sheet-id} |
effacer | Effacer une fiche d'informations à la fois. |
Éléments
Voici les éléments disponibles pour l'API Fiches de renseignements
Nom de champ | Description du champ | Demande d'achat | Unique ? | Valeurs autorisées | Dans | Sortie * | Type |
---|---|---|---|---|---|---|---|
id |
ID de la fiche d’informations |
Oui | oui | entier | |||
ordinal | La valeur ordinale de la feuille de fait | oui | entier | ||||
type | Type de la fiche d'informations. Une fois défini, il ne peut pas être modifié | oui |
Ordinaire, rapports |
oui | chaîne | ||
Nom | Nom de la feuille de fait | oui | oui | oui | chaîne | ||
nom_formule | Nom de formule de la feuille de fait | oui | oui | chaîne | |||
id_événement | ID de l'événement pour la fiche d'informations. Une fois défini, il ne peut pas être modifié | oui | oui | entier | |||
description | Une brève description | oui | oui | chaîne | |||
heure de création | Heure de création de la feuille de fait . Format ISO8601 | oui | datetime |
La charge utile de réponse n'affiche pas de valeurs NULL.
Exemples
Dans cet exemple, nous avons recherché une API de feuilles de fait.
https://<instance>.cso.coupahost.com/api/events/{event-id}/fact-sheets
Nous avons effectué un GET vers l'URL ci-dessous pour obtenir un exemple d'ID d'événement =9219593444837772101
:
htpss://<instance>.cso.coupacloud.com/api/events/9219593444837772101/fact-sheets
Fiches de renseignements GET Réponse
{
"total": 4,
"fact-sheets": [
{
"id": "9219593444824438589",
"ordinal": 0,
"type": "Ordinary",
"name": "B_Supernova 2014 - Rd2 Analysis",
"formula-name": "b_supernova_2014_rd2_analysis",
"event-id": "9219593444837772101",
"created-time": "2015-02-27T16:56:09.875+0000"
},
{
"id": "9219593444824438592",
"ordinal": 1,
"type": "Ordinary",
"name": "PD_Project details",
"formula-name": "pd_project_details",
"event-id": "9219593444837772101",
"created-time": "2015-02-27T16:56:09.875+0000"
},
{
"id": "9219601795978222763",
"ordinal": 1,
"type": "Reporting",
"name": "Management Reporting",
"formula-name": "management_reporting",
"event-id": "9219593444837772101",
"created-time": "2020-02-10T03:17:03.96+0000"
},
{
"id": "9219601942217814052",
"ordinal": 1,
"type": "Reporting",
"name": "Test All Event Status",
"formula-name": "test_all_event_status",
"event-id": "9219593444837772101",
"description": "Test All Event Status",
"created-time": "2020-09-09T10:30:07.376+0000"
}
]
}
Créer/Mettre à jour/Supprimer
La section suivante décrit comment utiliser l'API Coupa pour effectuer des actions sur les feuilles de fait.
Créer
/api/events/:id/fact-sheets
La charge utile ci-dessous crée une nouvelle feuille de fait sur un événement(
9220538753252871154)
Payload:
{
"fact-sheets": [
{
"id": "9220538753431210838",
"name": "demo-factsheet-new",
"event-id": "9220538753252871154",
"description": "testing demo fact sheet using API"
}
]
}
Response: 201
{
"result": [
{
"type": "api.post.added",
"description": "1 objects created."
}
],
"added": 1,
"fact-sheets": [
{
"id": "9220538753455571178"
}
]
}
Mettre à jour
/api/events/{event-id}/fact-sheets
La charge utile ci-dessous met à jour une ou plusieurs feuilles de fait.
To update one or more Event at a time:
Payload:
{
"fact-sheets": [
{
"id": "9220538753461853110",
"name": "demo-factsheet-newest",
"formula-name": "demo_factsheet_newest",
"description": "testing demo fact sheet using API with ordinal"
}
]
}
Response: 200 OK
{
"result": [
{
"type": "api.put.updated",
"description": "1 objects updated."
}
],
"updated": 1
}
You can update only name/formula-name/description fields on a fact sheet.
Effacer
/api/events/{event-id}/fact-sheets
L'API ci-dessus peut être utilisée pour supprimer plusieurs fiches d'informations à la fois.
Payload:
{
"fact-sheets": [
{
"id": "9220538753461853110"
}
]
}
Response: 200 OK
{
"result": [
{
"type": "removedFactSheets",
"description": "Removed the following fact sheets: demo-factsheet-newest"
}
],
"deleted": 1
}
Les mises à jour sont effectuées de manière souple, c'est-à-dire que si la mise à jour d'une ressource échoue, les autres peuvent 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 seront renvoyées HTTP 200 Response
. Le corps de la réponse inclura la demande créée. Les demandes infructueuses seront renvoyées HTTP 400 Bad Request
. Le corps de la réponse inclut les erreurs de validation au format XML.
Veuillez noter que certaines parties de ce contenu peuvent avoir été générées par traduction automatique.