Faktblätter-API

Datenblätter werden verwendet, um Daten aus verschiedenen Quellen vor, während und nach einem Sourcing-Event in CSO zu speichern, anzupassen, zu ordnen und zu verarbeiten.

Faktenfelder definieren die zu haltenden Daten, genau wie Artikelfelder 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. Faktblätter werden verwendet, um Daten in das Event einzugeben, z. B. historische Volumen oder andere Artikelspezifikationen, Lieferantenleistungsbewertungen, Listen von Adressen und Codes für Pflanzen, Artikel oder Dienstleistungen, Postleitzahlen, Breiten usw. 

Verwenden Sie die Faktenblatt-APIs, um die Faktenblattdaten zu erstellen, zu aktualisieren oder abzufragen. Dazu gehören bestimmte zu ergreifende Endpunkte (Erstellen/Aktualisieren/Löschen) sowie Daten, die mit Zeilen, 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 Best Practices für die Integration.

Aktionen

Elemente

Dies sind die für die Faktenblatt-API verfügbaren Elemente

Beispiele

In diesem Beispiel haben wir nach einer Faktblätter-API gefragt.

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

Wir haben eine GET-to-URL unten für ein Beispiel einer Event-ID =9219593444837772101: 

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

Datenblätter GET-Antwort

{
		"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"
				} 
	 ]
}

Erstellen/Aktualisieren/Löschen

Im Folgenden wird beschrieben, wie Sie die Coupa-API verwenden können, um Aktionen für Faktblätter durchzuführen.

Erstellen

/api/events/:id/fact-sheets

Die folgende Payload erstellt ein neues Faktenblatt für ein Event(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"
				}
		]
}		

update

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

Die folgende Payload aktualisiert ein Faktenblatt.  

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.

Löschen

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

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

Payload:
{
		"fact-sheets": [
				{
						"id": "9220538753461853110"
				}
		]
}

Response: 200 OK
{
		"result": [
				{
						"type": "removedFactSheets",
						"description": "Removed the following fact sheets: demo-factsheet-newest"
				}
		],
		"deleted": 1
}

Erfolgreiche Anfragen werden zurückgegeben HTTP 200 Response. Der Text der Antwort enthält die erstellte Anforderung. Fehlgeschlagene Anfragen werden zurückgegeben HTTP 400 Bad Request. Der Text der Antwort enthält Validierungsfehler, die als XML formatiert sind.