• Dernière modification le: 25 March 2021

API Champs

Utilisez l'API Champs pour créer, mettre à jour ou interroger les champs et les données (lignes) associées.

Les champs de faits sont les colonnes de la feuille de faits et, comme tout autre champ de l'événement, ils ont un nom, un nom de formule et un type de données pour spécifier les valeurs à conserver.

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. 

Utilisez les API Fields pour créer, mettre à jour ou interroger les données Fields. 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.

L'URL pour accéder aux API est : https ://.cso.coupahost.com/api/events/<instance> {event-id}/fact-sheets/{fact-sheet-id}/fields

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/{fact-sheet-id}/fields

index Effectue une action Get pour récupérer tous les champs qui appartiennent à une fiche de fait.
PUBLIER

/api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields

créer Crée un ou plusieurs champs pour une fiche de fait.
METTRE

/api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields

mettre à jour Met à jour un ou plusieurs champs d'une fiche de fait. Peut effectuer des mises à jour de masse.
SUPPRIMER

/api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields

supprimer Supprime un champ de plus sur une fiche de fait. Peut effectuer des suppressions massives.
OBTENIR

/api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields/{field-id}

afficher Affiche les données de champ individuelles pour l'ID de la fiche d'informations. 
METTRE

/api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields/{field-id}

mettre à jour Mettre à jour le champ individuel pour un ID de feuille de fait à l'aide de l'ID de champ.
SUPPRIMER

/api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields/{field-id}

supprimer Supprimer le champ individuel pour un ID de feuille de fait à l'aide de l'ID de champ.

Éléments

Ce sont les éléments disponibles pour l'API Fields

Nom de champ Description du champ Dem. Unique ? Valeurs admissibles Dans Sortie  * Type
iD

ID du champ

  Oui     oui nombre entier
ordinal La valeur ordinale du champ.         oui nombre entier
type Le type du champ. oui       oui chaîne
nom Nom du champ. oui     oui oui chaîne
formula-name Le nom de formule du champ.       oui oui chaîne
description Brève description du champ.       oui oui chaîne
obligatoire L'indicateur requis du champ.       oui oui chaîne
décimales Le nombre de décimales pour le champ numérique       oui oui chaîne
contribution du soumissionnaire Cela indique si ce champ doit ou non être rempli par un soumissionnaire.       oui oui chaîne
options Les options du champ si c'est un champ à choix multiple.       oui oui chaîne
distinguer Si ce champ doit être inclus dans la ligne de distinction.       oui oui chaîne
formule la formule du champ type de formule       oui oui chaîne
min-value La valeur minimale des champs numériques       oui oui nombre
valeur max La valeur maximale des champs numériques et la longueur autorisée des champs de texte.       oui oui nombre
exclure-limites Indique si les limites maximale et minimale doivent être incluses ou exclues.       oui oui chaîne
Remarque

 La charge utile de réponse n'affiche pas de valeurs NULL.

Exemples

Dans cet exemple, nous avons demandé une API Fields.

https ://<instance>.cso.coupacloud.com/api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields 

https ://.cso.coupacloud.com/api/events/<instance> {event-id}/fact-sheets ?name[contient]= nom_fiche

Nous avons OBTENU l'URL ci-dessous pour un exemple Event-id = 9219593444837772101 et Fact sheet id = 9220538753431210838

https ://<instance>.cso.coupacloud.com/api/events/9220538753252871154/fact-sheets/9220538753431210838/fields

Champs POUR OBTENIR UNE RÉPONSE

{

		"total" : 6,

		"fields" : [

				{

						"id" : "9220538753431213703",

						"ordinal" : 1,

						"type" : "Texte",

						"nom" : "nom-fld",

						"formula-name" : "nom_fld",

						"description" : "champ de nom pour l'API",

						« distinguer » : vrai

				},

				{

						"id" : "9220538753431215951",

						"ordinal" : 2,

						"type" : "Numérique",

						"nom" : "num-fld",

						"formula-name" : "num_fld",

						"description" : "champ de numéro",

						"décimales" : 2,

						"distinguer" : faux,

						"exclude-limits" : false

				},

				{

						"id" : "9220538753431226586",

						"ordinal" : 3,

						"type" : "Binaire",

						"name" : "checkbox-demo",

						"formula-name" : "checkbox_demo",

						"description" : "champ DE démonstration DE LA case À cocher",

						« distinguer » : vrai

				},

				{

						"id" : "9220538753431234950",

						"ordinal" : 4,

						"type" : "Option",

						"nom" : "demo-multi-fld",

						"formula-name" : "demo_multi_fld",

						"description" : "Multi-champs de démonstration",

						"options" : {

								"default" : 0,

								"values" : [

										{

												"name" : "premier",

												"value" : 1.0

										},

										{

												"name" : "deuxième",

												"value" : 2.0

										},

										{

												"name" : "autre",

												"value" : 0.0

										}

								]

						},

						« distinguer » : vrai

				},

				{

						"id" : "9220538753431237952",

						"ordinal" : 5,

						"type" : "Formule",

						"nom" : "demo-formula",

						"formula-name" : "formule_démo",

						"description" : "formule DE démonstration",

						"required" : false,

						"distinguer" : faux,

						"formula" : "demo_factsheet.num_fld"

				},

				{

						"id" : "9220538753431240094",

						"ordinal" : 6,

						"type" : "StringFormula",

						"nom" : "demo-txt-formula",

						"formula-name" : "demo_txt_formula",

						"description" : "champ de formule de texte de démonstration",

						"distinguer" : faux,

						"formula" : "demo_factsheet.name_fld"

				}

		]

}

Créer/Mettre à jour/Supprimer

Ce qui suit décrit comment vous pouvez utiliser l'API Coupa pour effectuer des actions sur les champs

Créer

/api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields

La charge utile ci-dessous crée un ou plusieurs nouveau (x) champ (s) sur un événement(9219593444837772101 et Fact sheet id = 9220538753431210838

Charge utile

{

		"fields" : [

				{

						"type" : "Texte",

						"nom" : "nom-fld-api",

						"formula-name" : "nom_fld-api",

						"description" : "champ de nom pour l'API",

						« distinguer » : vrai

				}

				{

						"type" : "StringFormula",

						"nom" : "demo-txt-formula-api",

						"formula-name" : "demo_txt_formula_api",

						"description" : "champ de formule de texte de démonstration",

						"distinguer" : faux,

						"formula" : "demo_factsheet.name_fld_api"

				}

		]

}



Réponse : 201

{

		"result" : [

				{

						"type" : "api.post.added",

						"description" : "2 objets créés."

				}

		],

		"ajouté" : 2,

		"fields" : [

				{

						"id" : "9220538753532394472"

				}

				{

						"id" : "9220538753530117686"

				}

		]

}	 



Remarque : Le champ de formule ne prend que "_". 

Mettre à jour

/api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields

La charge utile ci-dessous met à jour un ou plusieurs champs.  

Pour mettre à jour un ou plusieurs champs à la fois : 

Charge utile :

{

		"fields" : [

				{

						"id" : "9220538753530117686",

						"type" : "Texte",

						"nom" : "nom-fld-api-upd",

						"formula-name" : "nom_fld_api-upd",

						"description" : "champ de nom pour l'API",

						« distinguer » : faux

				},

				{

						"id" : "9220538753532394472",

						"type" : "StringFormula",

						"nom" : "demo-txt-formula-api-upd",

						"formula-name" : "demo_txt_formula_api_upd",

						"description" : "mise à jour du champ de formule de texte de démonstration",

						"distinction" : true,

						"formula" : "demo_factsheet.name_fld_api_upd"

				}

		]

}



Réponse : 200 OK

{

		"result" : [

				{

						"type" : "api.put.updated",

						"description" : "2 objets mis à jour."

				}

		],

		"mis à jour" : 2

}

Supprimer

/api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields

L'API ci-dessus peut être utilisée pour supprimer plus d'un champ à la fois. 

Charge utile :

{

		"fields" : [

				{

						"id" : "9220538753530117686"

				},

				{

						"id" : "9220538753532394472"

				}

		]

}

Réponse : 200 OK

{

		"result" : [

				{

						"type" : "fieldDeletionCompleted",

						"description" : "Les champs suivants ont été supprimés : demo-txt-formula-api-upd, name-fld-api-upd. 

						En tout, 0 valeur a été retirée pour ces champs."

				}

		],

		"supprimé" : 2

}
Remarque

 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é deux champs. 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.

Articles associés


API Fiches descriptives

25 March 2021

Utilisez l'API Fact Sheets pour créer, mettre à jour ou interroger les Fact Sheets et les données (lignes / champs) associées.

API de marché

25 March 2021

Utilisez l'API Marchés pour créer, mettre à jour ou interroger les marchés.

API utilisateur

25 March 2021

Utilisez l'API utilisateur pour créer, mettre à jour ou interroger les données utilisateur.

API de l'entreprise

25 March 2021

Utilisez l'API de l'entreprise pour créer, mettre à jour ou interroger les données de l'entreprise.

Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.