• Zuletzt bearbeitet am: 25 March 2021

Fakten-Blätter-API

Verwenden Sie die Fact Sheets-API, um die Fact Sheets und die zugehörigen (Zeilen / Felder) Daten zu erstellen, zu aktualisieren oder abzufragen.

Mit Faktblättern werden Daten verschiedener Quellen vor, während und nach einem Sourcing-Ereignis in CSO gespeichert, angepasst, angeordnet und verarbeitet.

Faktenfelder definieren die zu beinhaltenden Daten, genau wie Positionsfelder oder Spalten in einem Excel-Arbeitsblatt. Jede Faktenzeile sollte nur einen Wert für jedes Faktenfeld enthalten, um die Daten effizient nutzen zu können. Datenblätter werden verwendet, um Daten in die Veranstaltung einzugeben, z. B. historische Volumina oder andere Artikelspezifikationen, Lieferantenleistungsbewertungen, Adressen- und Codelisten für Werke, Artikel oder Dienstleistungen, Postleitzahlen, Breitengrade usw. 

Verwenden Sie die Fact Sheets-APIs, um die Fact Sheets-Daten zu erstellen, zu aktualisieren oder abzufragen. Dazu gehören bestimmte zu ergreifende Endpunkte (Erstellen/Aktualisieren/Löschen) sowie Daten, die mit Zeilen und Feldern verknüpft sind.

Die URL für den Zugriff auf die APIs lautet : https://<instance>.cso.coupahost.com/api/events/{event-id}/fact-sheets

Weitere Informationen finden Sie unter Integrations-Best Practices.

Aktionen

Verb Pfad Aktion Beschreibung
ABFRAGEN /api/events/{event-id}/fact-sheets index Führt Get-Aktion aus, um alle Datenblätter abzurufen
BEITRAG /api/events/{event-id}/fact-sheets erstellen Erstellt ein oder mehrere Fact Sheets-Objekte.
PUT /api/events/{event-id}/fact-sheets aktualisieren Aktualisiert ein oder mehrere Informationsblätter . Kann Massenaktualisierungen durchführen.
LÖSCHEN /api/events/{event-id}/fact-sheets löschen Löscht ein weiteres Fact Sheet. Kann Massenlöschungen durchführen.
ABFRAGEN /api/events/{event-id}/fact-sheets/{fact-sheet-id} anzeigen Faktenblattdaten für eine Faktenblatt-ID anzeigen. 
PUT /api/events/{event-id}/fact-sheets/{fact-sheet-id} aktualisierung Aktualisieren Sie jeweils ein Faktenblatt mit der Faktenblatt-ID
LÖSCHEN /api/events/{event-id}/fact-sheets/{fact-sheet-id} löschen Löschen Sie jeweils ein Datenblatt.

Elemente

Dies sind die Elemente, die für die Fact Sheets API verfügbar sind

Feldname Feldbeschreibung Anf. Eindeutig? Zulässige Werte In Out  * Typ
iD

ID des Faktenblatts

  Ja     ja ganze Zahl
ordnungszahl Der Ordnungswert für das Faktenblatt         ja ganze Zahl
typ Die Art des Faktenblattes. Nach der Einstellung kann sie nicht mehr geändert werden ja  

Normal, Berichtswesen

  ja zeichenfolge
name Name des Datenblatts ja     ja ja zeichenfolge
formula-name Der Formelname des Faktenblattes       ja ja zeichenfolge
event-id Die Ereignis-ID für das Faktenblatt. Nach der Einstellung kann es nicht mehr geändert werden       ja ja ganze Zahl
beschreibung Eine Kurzbeschreibung       ja ja zeichenfolge
erstellungszeit Der Zeitpunkt, zu dem das Faktenblatt erstellt wurde. ISO8601-Format         ja datum/Uhrzeit
Hinweis

 Die Antwortnutzlast zeigt keine Nullwerte an.

Beispiele

In diesem Beispiel haben wir nach einer Fact Sheets-API gefragt.

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

Wir haben die unten stehende URL für eine Beispiel-Ereignis-ID = 9219593444837772101 aufgerufen

htpss://<instance>.cso.coupacloud.com/api/events/9219593444837772101/fact-sheets

Faktenblätter ERHALTEN ANTWORT

{

		"total": 4.

		"fact-sheets": [

				{

						"id": "9219593444824438589",

						"Ordnungszahl": 0,

						"type": "Gewöhnlich",

						"Name": "B_Supernova 2014 - Rd2-Analyse",

						"formula-name": "b_supernova_2014_rd2_analyse",

						"event-id": "9219593444837772101",

						"created-time": "2015-02-27T16:56:09.875+0000"

				},

				{

						"id": "9219593444824438592",

						"Ordnungszahl": 1.

						"type": "Gewöhnlich",

						"name": "PD_Projektdetails",

						"formula-name": "pd_project_details",

						"event-id": "9219593444837772101",

						"created-time": "2015-02-27T16:56:09.875+0000"

				},

				{

						"id": "9219601795978222763",

						"Ordnungszahl": 1.

						"type": "Reporting",

						"name": "Management-Berichterstattung",

						"formula-name": "management_reporting",

						"event-id": "9219593444837772101",

						"created-time": "2020-02-10T03:17:03.96+0000"

				},

				{

						"id": "9219601942217814052",

						"Ordnungszahl": 1.

						"type": "Reporting",

						"Name": "Alle Event-Status testen",

						"formula-name": "test_all_event_status",

						"event-id": "9219593444837772101",

						"Beschreibung": "Alle Event-Status testen",

						"created-time": "2020-09-09T10:30:07.376+0000"

				} 

	 ]

}

Erstellen/Aktualisieren/Löschen

Im Folgenden wird beschrieben, wie Sie die Coupa-API zum Ausführen von Aktionen für Informationsblätter verwenden können.

Erstellen

/api/events/:id/fact-sheets

Die folgende Nutzlast erstellt ein neues Faktenblatt zu einem Ereignis(9220538753252871154)

Nutzdaten: 

{

		"fact-sheets": [

				{

						"id": "9220538753431210838",

						"name": "demo-factsheet-neu",

						"event-id": "9220538753252871154",

						"description": "Demo-Faktenblatt mit API testen"

				}

		]

}



Antwort: 201

{

		"result": [

				{

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

						"Beschreibung": "1 Objekte erstellt."

				}

		],

		"hinzugefügt": 1.

		"fact-sheets": [

				{

						"id": "9220538753455571178"

				}

		]

}		

Aktualisieren

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

Die folgende Nutzlast aktualisiert ein oder mehrere Faktenblätter.  

So aktualisieren Sie jeweils ein oder mehrere Ereignisse: 

Nutzdaten:

{

		"fact-sheets": [

				{

						"id": "9220538753461853110",

						"name": "Demo-Factsheet-Newest",

						"formula-name": "demo_factsheet_newest",

						"description": "Demo-Faktenblatt mit API mit Ordinalwert testen"

				}

		]

}



Antwort: 200 OK

{

		"result": [

				{

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

						"Beschreibung": "1 Objekte aktualisiert."

				}

		],

		"aktualisiert": 1

}



Sie können nur Namens-/Formelnamen-/Beschreibungsfelder in einem Faktenblatt aktualisieren.

Löschen

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

Die obige API kann verwendet werden, um mehr als ein Fact Sheet gleichzeitig zu löschen. 

Nutzdaten:

{

		"fact-sheets": [

				{

						"id": "9220538753461853110"

				}

		]

}



Antwort: 200 OK

{

		"result": [

				{

						"type": "removedFactSheets",

						"Beschreibung": "Folgende Faktenblätter entfernt: demo-factsheet-newest"

				}

		],

		"gelöscht": 1

}
Hinweis

 Aktualisierungen werden auf nachsichtige Weise durchgeführt, d. h. wenn die Aktualisierung einer Ressource fehlschlägt, können die anderen erfolgreich sein. Die Nutzlast hat ein Event gelöscht. Zum Löschen oder Aktualisieren ist die Ereignis-ID erforderlich.

Erfolgreiche Anfragen geben die HTTP-200-Antwort zurück. Der Text der Antwort enthält die erstellte Anforderung. Bei nicht erfolgreichen Anfragen wird http 400 Bad Request zurückgegeben. Der Text der Antwort enthält Validierungsfehler, die als XML formatiert sind.

Vergleichbare Artikel


Felder-API

25 March 2021

Verwenden Sie die Feld-API, um die Felder und zugehörigen (Zeilen) Daten zu erstellen, zu aktualisieren oder abzufragen.

Markt API

25 March 2021

Verwenden Sie die Markt-API, um die Märkte zu erstellen, zu aktualisieren oder abzufragen.

Benutzer-API

25 March 2021

Verwenden Sie die Benutzer-API, um die Benutzerdaten zu erstellen, zu aktualisieren oder abzufragen.

Unternehmens-API

25 March 2021

Verwenden Sie die Unternehmens-API, um die Unternehmensdaten zu erstellen, zu aktualisieren oder abzufragen.

Hinweis: Einige Inhalte wurden maschinell übersetzt.