API des événements

Utilisez les API d'événements pour créer, mettre à jour ou interroger les données d'événement. Cela inclut les points de terminaison spécifiques pour prendre des mesures (créer/mettre à jour/supprimer) ainsi que les événements liés aux fiches de renseignements , aux lignes, aux champs et aux étiquettes.

L'URL pour accéder aux API est : https://<instance>.cso.coupahost.com/api/events

Consultez la rubrique Bonnes pratiques d'intégration pour plus d'informations.

Actions

Éléments

Il s'agit des éléments disponibles pour l'API d'événements

Exemples

Dans cet exemple, nous avons recherché une API d'événements. Nous avons accédé à l'URL : 

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

Événements - Réponse GET

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

Créer/Mettre à jour/Supprimer

La section suivante décrit comment utiliser l'API Coupa pour effectuer des actions sur les événements.

Créer

/api/events

La charge utile ci-dessous crée deux événements.

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

Mettre à jour

/api/events

La charge utile ci-dessous met à jour un événement. 

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.

Effacer

/api/events

L'API ci-dessus peut être utilisée pour supprimer plusieurs événements à la fois. 

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
}

Les demandes réussies seront renvoyées HTTP 200 Response. Le corps de la réponse inclura la demande créée. Les demandes infructueuses seront renvoyées HTTP 400 Bad Request. Le corps de la réponse inclut les erreurs de validation au format XML.