Ausschreibungs-API
Verwenden Sie die Ereignis-API, um die Ereignisse und die zugehörigen Daten zu erstellen, zu aktualisieren oder abzufragen.
Verwenden Sie die Ereignis-APIs, um die Ereignisdaten zu erstellen, zu aktualisieren oder abzufragen. Dies umfasst bestimmte zu ergreifende Endpunkte (Erstellen/Aktualisieren/Löschen) sowie Ereignisse im Zusammenhang mit Faktenblättern, 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 Best Practices für die Integration.
Aktionen
Verb | Pfad | Aktion | Beschreibung |
---|---|---|---|
GET | /api/events |
Index | Führt eine Aktion zum Abrufen aller Ereignisse aus |
POST | /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 ein weiteres Ereignis. Kann Massenlöschungen durchführen. |
GET | /api/events/:id |
zeigen | Eine Ausschreibungsdaten anzeigen. |
PUT | /api/events/:id |
aktualisieren | Aktualisieren Sie ein Ereignis nach dem anderen unter Verwendung der ID |
LÖSCHEN | /api/events/:id |
löschen | Eine Ausschreibung nach der anderen löschen. |
Elemente
Dies sind die für die Ereignis-API verfügbaren Elemente
Feldname | Feldbeschreibung | Erford. | Eindeutig? | Zulässige Werte | In | Ausgang * | Typ |
---|---|---|---|---|---|---|---|
ID |
ID der Ausschreibung |
Ja | Ja | Ganzzahl | |||
Marktkennung | Die ID des Marktes, zu dem das Ereignis gehört. Einmal festgelegt, kann es nicht mehr geändert werden. | Ja | Ja | Ja | Zeichenfolge | ||
Staat | Status / Aktuelle Phase des Events |
Konfiguration, Aktiv, Beendet (Groß-/Kleinschreibung beachten) |
Ja | Ja | Zeichenfolge | ||
Name | Name der Ausschreibung | Ja | Ja | Zeichenfolge | |||
Beschreibung | Kurze Beschreibung der Ausschreibung | Ja | Ja | Zeichenfolge | |||
Referenznummer | Ein Feld für eine Referenznummer zur Identifizierung des Ereignisses | Ja | Ja | Zeichenfolge | |||
Ausschreibungsnummer | Eine eindeutige ID des Events. Dieser Wert ist ein inkrementeller Wert | Ja | Ja | Ganzzahl | |||
Zeitzone | Zeitzone für das Event | Ja | Ja | Zeichenfolge | |||
Einstellungen | Einstellungen für die Ausschreibung | Ja | Ja | Zeichenfolge |
Antwort-Payload zeigt keine Nullwerte an.
Beispiele
In diesem Beispiel haben wir eine Ereignis-API abgefragt. Wir haben eine GET-to-URL durchgeführt:
https://<instance>.cso.coupahost.com/api/events
Ereignisse GET-Antwort
{
"total": 5,
"events": [
{
"id": "9219595375673293031",
"market-id": "9219595214580536433",
"state": "Setup",
"name": "APC Training Project",
"description": "For Bids",
"event-number": 10,
"settings": {
"currency": "USD"
}
},
{
"id": "9219601944812992706",
"market-id": "9219596879086622384",
"state": "Setup",
"name": "API - Data storage",
"description": "Hamno Testing",
"event-number": 11,
"time-zone": "Europe/Stockholm",
"settings": {
"currency": "EUR"
}
},
{
"id": "9219592828238410706",
"market-id": "9219592396342653837",
"state": "Active",
"name": "**IT Hardware and Services 2014",
"description": "Indirect Services",
"reference-number": "MC-IN-15/02",
"event-number": 613,
"settings": {
"currency": "GBP"
}
},
{
"id": "9219593444808990596",
"market-id": "9219593040793966498",
"state": "Terminated",
"name": "!*** Test procedures ***! (for backup purposes only)",
"description": "Tasks to be performed when a new release is about to be launched",
"event-number": 1602,
"settings": {
"currency": "USD"
}
},
{
"id": "9219594228963465852",
"market-id": "9219592396342653837",
"state": "Setup",
"name": "**Air Freight Tender example - sanitised 9/12/15",
"description": "Example Air Freight tender",
"reference-number": "MC-A15-01",
"event-number": 13,
"settings": {
"currency": "SEK"
}
}
]
}
Erstellen/Aktualisieren/Löschen
Im Folgenden wird beschrieben, wie Sie die Coupa-API verwenden können, um Aktionen für Ereignisse durchzuführen.
Erstellen
/api/events
Die folgende Payload erstellt zwei Events.
Payload:
{
"events": [
{
"market-id": "9220538753220565329",
"name": "IT Hardware and Services 2021",
"description": "direct Services",
"reference-number": "DEMO-ref1",
"settings": {
"currency": "USD"
}
},
{
"market-id": "9220538753220565329",
"state": "Setup",
"name": "Services ONLY",
"description": "same market with state, timezone and no reference number ",
"time-zone": "Europe/Stockholm",
"settings": {
"currency": "EUR"
}
}
]
}
Response: 201
{
"result": [
{
"type": "api.post.added",
"description": "2 objects created."
}
],
"added": 2,
"events": [
{
"id": "9220538753252871154"
},
{
"id": "9220538753252871160"
}
]
}
update
/api/events
Die folgende Payload aktualisiert ein Ereignis.
To update one or more Event at a time:
Payload:
{
"events": [
{
"id": "9220538753252871154",
"state": "Active",
"name": "IT Hardware and Services 2021-ABC",
"description": "direct Services - ABC",
"reference-number": "DEMO-reference"
},
{
"id": "9220538753252871160",
"name": "Services channges ONLY"
}
]
}
Response: 200 OK
{
"result": [
{
"type": "api.put.updated",
"description": "2 objects updated."
}
],
"updated": 2
}
You can update all fields except event-number and market-id.
Löschen
/api/events
Die obige API kann verwendet werden, um mehr als ein Ereignis gleichzeitig zu löschen.
Payload:
{
"events": [
{
"id": "9220538753252871154"
}
]
}
Response: 200 OK
{
"result": [
{
"type": "event.deleted.logMsg",
"description": "The event IT Hardware and Services 2021-ABC was deleted."
}
],
"deleted": 1
}
Aktualisierungen erfolgen nachsichtig, d. h. wenn die Aktualisierung einer Ressource fehlschlägt, können die anderen erfolgreich sein. Die Payload hat ein Event 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.