• Zuletzt bearbeitet am: 25 March 2021

Ausschreibungs-API

Verwenden Sie die Ereignis-API, um die Ereignisse und verbundenen Daten zu erstellen, zu aktualisieren oder abzufragen.

Verwenden Sie die Ereignis-APIs, um die Ereignisdaten zu erstellen, zu aktualisieren oder abzufragen. Dazu gehören spezifische Endpunkte zum Ausführen von Maßnahmen (Erstellen/Aktualisieren/Löschen) sowie Ereignisse im Zusammenhang mit Factsheets, Zeilen, Feldern und Beschriftungen.

Die URL für den Zugriff auf die APIs lautet : https://<instance>.cso.coupahost.com/api/events

Weitere Informationen finden Sie unter Integrations-Best Practices.

Aktionen

Verb Pfad Aktion Beschreibung
ABFRAGEN /api/events index Führt Get-Aktion aus, um alle Ereignisse abzurufen
BEITRAG /api/events erstellen Erstellt ein oder mehrere Ereignisobjekte.
PUT /api/events aktualisieren Aktualisiert ein oder mehrere Ereignisse . Kann Massenaktualisierungen durchführen.
LÖSCHEN /api/events löschen Löscht noch ein weiteres Ereignis. Kann Massenlöschungen durchführen.
ABFRAGEN /api/events/:id anzeigen Zeigen Sie eine Ereignisdaten an. 
PUT /api/events/:id update Aktualisieren Sie ein Ereignis nach dem anderen mit der ID
LÖSCHEN /api/events/:id löschen Löschen Sie jeweils ein Ereignis.

Elemente

Dies sind die Elemente, die für die Ereignis-API verfügbar sind

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

ID der Veranstaltung

  Ja     ja ganze Zahl
market-id Die ID des Markts, zu dem die Veranstaltung gehört. Nach der Einstellung kann sie nicht mehr geändert werden.   Ja   ja ja zeichenfolge
status Status / Aktuelle Phase des Events    

Setup,Aktiv,Beendet     (Groß-/Kleinschreibung beachten)

ja ja zeichenfolge
name Name der Veranstaltung       ja ja zeichenfolge
beschreibung Kurzbeschreibung der Veranstaltung       ja ja zeichenfolge
referenznummer Ein Feld für eine Referenznummer zur Identifizierung des Ereignisses       ja ja zeichenfolge
ereignis-Nummer Eine eindeutige ID des Ereignisses. Dieser Wert ist ein inkrementeller Wert   ja     ja ganze Zahl
zeitzone Zeitzone für das Event       ja ja zeichenfolge
einstellungen Einstellungen für das Event       ja ja zeichenfolge
Hinweis

 Antwortnutzlast zeigt keine NULL-Werte an.

Beispiele

In diesem Beispiel haben wir nach einer Ereignis-API gefragt. Wir sind auf die URL GEKOMMEN: 

https://<instance>.cso.coupahost.com/api/events 

Ausschreibungen ERHALTEN ANTWORT

{

		"total": 5,

		"events": [

				{

						"id": "9219595375673293031",

						"market-id": "9219595214580536433",

						"state": "Einrichtung",

						"Name": "APC-Schulungsprojekt",

						"Beschreibung": "Für Angebote",

						"event-number": 10,

						"settings": {

								"Währung": "USD"

						}

				},

				{

						"id": "9219601944812992706",

						"market-id": "9219596879086622384",

						"state": "Einrichtung",

						"name": "API - Datenspeicherung",

						"Beschreibung": "Hamno Testen",

						"event-number": 11.

						"time-zone": "Europa/Stockholm",

						"settings": {

								"Währung": "EUR"

						}

				},

				{

						"id": "9219592828238410706",

						"market-id": "9219592396342653837",

						"state": "Aktiv",

						"name": "**IT-Hardware und Services 2014",

						"Beschreibung": "Indirekte Dienstleistungen",

						"Referenznummer": "MC-IN-15/02",

						"event-number": 613,

						"settings": {

								"Währung": "GBP"

						}

				},			 

				{

						"id": "9219593444808990596",

						"market-id": "9219593040793966498",

						"state": "Abgebrochen",

						"name": "!** * Testverfahren ***! (nur für Sicherungszwecke)",

						"Beschreibung": "Aufgaben, die ausgeführt werden müssen, wenn eine neue Version veröffentlicht wird",

						"event-number": 1602,

						"settings": {

								"Währung": "USD"

						}

				},

				{

						"id": "9219594228963465852",

						"market-id": "9219592396342653837",

						"state": "Einrichtung",

						"name": "** Beispiel für eine Luftfrachtausschreibung - desinfiziert am 12.09.15",

						"Beschreibung": "Beispiel Luftfrachtangebot",

						"Referenznummer": "MC-A15-01",

						"event-number": 13,

						"settings": {

								"Währung": "SEK"

						}

				}				

	 ]

}

Erstellen/Aktualisieren/Löschen

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

Erstellen

/api/events

Die unten stehende Nutzlast erstellt zwei Ereignisse.

Nutzdaten: 

{

		"events": [

				{

						"market-id": "9220538753220565329",

						"name": "IT-Hardware und -Services 2021",

						"description": "direkte Dienstleistungen",

						"Referenznummer": "DEMO-ref1",

						"settings": {

								"currency": "USD"

						}

				},

				{

						"market-id": "9220538753220565329",

						"state": "Einrichtung",

						"name": "NUR Dienstleistungen",

						"description": "gleicher Markt mit Bundesland, Zeitzone und ohne Referenznummer ",

						"time-zone": "Europa/Stockholm",

						"settings": {

								"Währung": "EUR"

						}

				}

		]

}



Antwort: 201

{

		"result": [

				{

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

						"Beschreibung": "2 Objekte erstellt."

				}

		],

		"hinzugefügt": 2.

		"events": [

				{

						"id": "9220538753252871154"

				},

				{

						"id": "9220538753252871160"

				}

		]

}		

Aktualisieren

/api/events

Die folgende Nutzlast aktualisiert ein Ereignis. 

So aktualisieren Sie ein oder mehrere Ereignisse gleichzeitig: 

Nutzdaten:

{

		"events": [

				{

						"id": "9220538753252871154",

						"state": "Aktiv",

						"name": "IT-Hardware und -Services 2021-ABC",

						"description": "direkte Dienstleistungen - ABC",

						"Referenznummer": "DEMO-Referenz"

				},

				{

						"id": "9220538753252871160",

						"Name": "NUR DIENSTLEISTUNGSKANÄLE"

				}

		]

}



Antwort: 200 OK

{

		"result": [

				{

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

						"Beschreibung": "2 Objekte aktualisiert."

				}

		],

		"aktualisiert": 2

}



Sie können alle Felder mit Ausnahme von Ereignisnummer und Markt-ID aktualisieren.

Löschen

/api/events

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

Nutzdaten:

{

		"events": [

				{

						"id": "9220538753252871154"

				}

		]

}



Antwort: 200 OK

{

		"result": [

				{

						"type": "event.deleted.logMsg",

						"Beschreibung": "Das Event IT Hardware and Services 2021-ABC wurde gelöscht."

				}

		],

		"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


Fakten-Blätter-API

25 March 2021

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

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.

Hinweis: Einige Inhalte wurden maschinell übersetzt.