• Zuletzt bearbeitet am: 25 March 2021

Felder-API

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

Faktenfeldersind die Spalten im Faktenblatt und wie jedes andere Feld in der Ausschreibung haben sie einen Namen, einen Formelnamen und einen Datentyp, um die zu haltenden Werte anzugeben.

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. 

Verwenden Sie die Felder-APIs, um die Felddaten zu erstellen, zu aktualisieren oder abzufragen. Dies umfasst bestimmte zu ergreifende Endpunkte (Erstellen/Aktualisieren/Löschen) sowie mit Zeilen verknüpfte Daten.

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

Weitere Informationen finden Sie unter Best Practices für die Integration.

Aktionen

Verb Pfad Aktion Beschreibung
GET /api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields Index Führt eine Aktion zum Abrufen aller Felder aus, die zu einem Faktenblatt gehören.
POST /api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields erstellen Erstellt ein oder mehrere Felder für ein Faktenblatt.
PUT /api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields aktualisieren Aktualisiert ein oder mehrere Felder in einem Faktenblatt. Kann Massenaktualisierungen durchführen.
LÖSCHEN /api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields löschen Löscht ein weiteres Feld in einem Faktenblatt. Kann Massenlöschungen durchführen.
GET /api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields/{field-id} zeigen Zeigen Sie individuelle Felddaten für die Faktenblatt-ID an. 
PUT /api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields/{field-id} aktualisieren Aktualisieren Sie ein einzelnes Feld für eine Faktenblatt-ID unter Verwendung der Feld-ID.
LÖSCHEN /api/events/{event-id}/fact-sheets/{fact-sheet-id}/fields/{field-id} löschen Löschen Sie einzelne Felder für eine Faktenblatt-ID unter Verwendung der Feld-ID.

Elemente

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

Feldname Feldbeschreibung Erford. Eindeutig? Zulässige Werte In Ausgang * Typ
ID

ID des Feldes

  Ja     Ja Ganzzahl
Ordnungszahl Ordnungszahl für das Feld.         Ja Ganzzahl
Typ Der Feldtyp. Ja       Ja Zeichenfolge
Name Name des Felds. Ja     Ja Ja Zeichenfolge
Formelname Der Formelname des Felds.       Ja Ja Zeichenfolge
Beschreibung Eine kurze Beschreibung des Felds.       Ja Ja Zeichenfolge
erforderlich Die erforderliche Markierung des Felds.       Ja Ja Zeichenfolge
Dezimalstellen Anzahl der Dezimalstellen für numerisches Feld       Ja Ja Zeichenfolge
Eingabe des Bieters Dies gibt an, ob dieses Feld von einem Bieter ausgefüllt werden soll.       Ja Ja Zeichenfolge
Optionen Die Optionen des Felds, wenn es sich um ein Multiple-Choice-Feld handelt.       Ja Ja Zeichenfolge
unterscheidend Wenn dieses Feld in die unterscheidende Zeile eingeschlossen werden soll.       Ja Ja Zeichenfolge
Formel Formel für das Formeltypfeld       Ja Ja Zeichenfolge
Minimalwert Der minimale Wert von numerischen Feldern       Ja Ja Nummer
Maximalwert Der Maximalwert von numerischen Feldern und die zulässige Länge von Textfeldern.       Ja Ja Nummer
Ausschlussgrenzen Gibt an, ob Höchst- und Mindestwerte einbezogen oder ausgeschlossen werden sollen.       Ja Ja Zeichenfolge
Hinweis

 Antwort-Payload zeigt keine Nullwerte an.

Beispiele

In diesem Beispiel haben wir eine Felder-API abgefragt.

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

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

Wir haben eine GET-to-URL unten für ein Beispiel von Event-ID =9219593444837772101und Faktblatt-ID = 9220538753431210838

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

Felder GET-Antwort

{
		"total": 6,
		"fields": [
				{
						"id": "9220538753431213703",
						"ordinal": 1,
						"type": "Text",
						"name": "name-fld",
						"formula-name": "name_fld",
						"description": "name field for api",
						"distinguishing": true
				},
				{
						"id": "9220538753431215951",
						"ordinal": 2,
						"type": "Numeric",
						"name": "num-fld",
						"formula-name": "num_fld",
						"description": "number field",
						"decimals": 2,
						"distinguishing": false,
						"exclude-limits": false
				},
				{
						"id": "9220538753431226586",
						"ordinal": 3,
						"type": "Binary",
						"name": "checkbox-demo",
						"formula-name": "checkbox_demo",
						"description": "checkbox demo field",
						"distinguishing": true
				},
				{
						"id": "9220538753431234950",
						"ordinal": 4,
						"type": "Option",
						"name": "demo-multi-fld",
						"formula-name": "demo_multi_fld",
						"description": "demo multi fields",
						"options": {
								"default": 0,
								"values": [
										{
												"name": "first",
												"value": 1.0
										},
										{
												"name": "second",
												"value": 2.0
										},
										{
												"name": "other",
												"value": 0.0
										}
								]
						},
						"distinguishing": true
				},
				{
						"id": "9220538753431237952",
						"ordinal": 5,
						"type": "Formula",
						"name": "demo-formula",
						"formula-name": "demo_formula",
						"description": "demo formula",
						"required": false,
						"distinguishing": false,
						"formula": "demo_factsheet.num_fld"
				},
				{
						"id": "9220538753431240094",
						"ordinal": 6,
						"type": "StringFormula",
						"name": "demo-txt-formula",
						"formula-name": "demo_txt_formula",
						"description": "demo text formula field",
						"distinguishing": false,
						"formula": "demo_factsheet.name_fld"
				}
		]
}

Erstellen/Aktualisieren/Löschen

Im Folgenden wird beschrieben, wie Sie die Coupa-API verwenden können, um Aktionen für Felder auszuführen

Erstellen

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

Die folgende Payload erstellt neue Felder für ein Event(9219593444837772101und Faktblatt-ID = 9220538753431210838

Payload
{
		"fields": [
				{
						"type": "Text",
						"name": "name-fld-api",
						"formula-name": "name_fld-api",
						"description": "name field for api",
						"distinguishing": true
				}
				{
						"type": "StringFormula",
						"name": "demo-txt-formula-api",
						"formula-name": "demo_txt_formula_api",
						"description": "demo text formula field",
						"distinguishing": false,
						"formula": "demo_factsheet.name_fld_api"
				}
		]
}

Response: 201
{
		"result": [
				{
						"type": "api.post.added",
						"description": "2 objects created."
				}
		],
		"added": 2,
		"fields": [
				{
						"id": "9220538753532394472"
				}
				{
						"id": "9220538753530117686"
				}
		]
}	 

Note: Formula field only takes "_". 

update

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

Die folgende Payload aktualisiert ein Feld/Felder.  

To update one or more Fields at a time: 
Payload:
{
		"fields": [
				{
						"id": "9220538753530117686",
						"type": "Text",
						"name": "name-fld-api-upd",
						"formula-name": "name_fld_api-upd",
						"description": "name field for api",
						"distinguishing": false
				},
				{
						"id": "9220538753532394472",
						"type": "StringFormula",
						"name": "demo-txt-formula-api-upd",
						"formula-name": "demo_txt_formula_api_upd",
						"description": "demo text formula field update",
						"distinguishing": true,
						"formula": "demo_factsheet.name_fld_api_upd"
				}
		]
}

Response: 200 OK
{
		"result": [
				{
						"type": "api.put.updated",
						"description": "2 objects updated."
				}
		],
		"updated": 2
}

Löschen

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

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

Payload:
{
		"fields": [
				{
						"id": "9220538753530117686"
				},
				{
						"id": "9220538753532394472"
				}
		]
}
Response: 200 OK
{
		"result": [
				{
						"type": "fieldDeletionCompleted",
						"description": "The following fields were deleted: demo-txt-formula-api-upd, name-fld-api-upd. 
						In total, 0 values were removed for these fields."
				}
		],
		"deleted": 2
}
Hinweis

 Aktualisierungen erfolgen nachsichtig, d. h. wenn die Aktualisierung einer Ressource fehlschlägt, können die anderen erfolgreich sein. Die Payload hat zwei Felder gelöscht. Zum Löschen oder Aktualisieren ist die Ereignis-ID erforderlich.

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.

Parts or all of this page might have been machine-translated. We apologize for any inaccuracies.

Vergleichbare Artikel


Coupa Core API

Unsere RESTful-API bietet robusten Zugriff auf das Lesen, Bearbeiten oder Integrieren Ihrer Daten mit der Coupa-Plattform.

Ressourcen

Wir haben unsere API-Endpunkte nach Objekttyp geordnet: Referenzdaten, Transaktionsdaten und freigegebene Ressourcen.

Referenzdaten-Ressourcen

Referenzdaten werden verwendet, um die Kernkomponenten von Coupa wie Benutzer, Lieferanten, Konten usw. einzurichten.

Transaktionsressourcen

Wenn Benutzer Coupa verwenden, werden Transaktionsdaten wie Anforderungen, Bestellungen und Rechnungen erstellt.