イベントAPI
イベントAPIを使用して、イベントと関連データを作成、更新、またはクエリします。
イベントAPIを使用して、イベントデータを作成、更新、またはクエリします。これには、アクション(作成/更新/削除)を実行する特定のエンドポイントや、ファクトシート、行、フィールド、ラベルに関連するイベントが含まれます。
APIにアクセスするためのURLは次のとおりです。 https://<instance>.cso.coupahost.com/api/events
詳細については、 「インテグレーションのベストプラクティス 」を参照してください。
アクション
動詞 | パス | アクション | 説明 |
---|---|---|---|
取得 | /api/events |
インデックス | すべてのイベントを取得するGetアクションを実行 |
投稿 | /api/events |
作成 | 1つまたは複数のイベントオブジェクトを作成します。 |
プット | /api/events |
更新 | 1つ以上のイベントを更新します。一括更新を実行できます。 |
削除 | /api/events |
削除 | もう1つのイベントを削除します。一括削除を実行できます。 |
取得 | /api/events/:id |
表示 | 1つのイベントデータを表示します。 |
プット | /api/events/:id |
更新 | IDを使用して一度に1つのイベントを更新 |
削除 | /api/events/:id |
削除 | 一度に1つのイベントを削除します。 |
要素
これらはイベントAPIで使用できる要素です
フィールド名 | フィールドの説明 | 必須 | 一意ですか? | 許容値 | で | アウト* | タイプ |
---|---|---|---|---|---|---|---|
ID |
イベントのID |
はい | はい | 整数 | |||
マーケットID | イベントが属する市場のID。一度設定すると、変更できません。 | はい | はい | はい | string型 | ||
state | イベントのステータス/現在のフェーズ |
Setup、Active、Terminated(大文字/小文字の区別あり) |
はい | はい | string型 | ||
名前 | イベントの名前 | はい | はい | 文字列 | |||
説明 | イベントの簡単な説明 | はい | はい | 文字列 | |||
参照番号 | イベントを識別するための参照番号のためのフィールド | はい | はい | 文字列 | |||
イベント番号 | イベントの一意のID。この値は増分値です | はい | はい | 整数 | |||
時間帯 | イベントのタイムゾーン | はい | はい | 文字列 | |||
settings | イベントの設定 | はい | はい | 文字列 |
応答ペイロードにnull値が表示されません。
例
この例では、イベントAPIについてクエリしました。URLにGETしました:
https://<instance>.cso.coupahost.com/api/events
イベントの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"
}
}
]
}
作成/更新/削除
以下は、Coupa APIを使用してイベントに対するアクションを実行する方法について説明します。
作成
/api/events
以下のペイロードは2つのイベントを作成します。
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"
}
]
}
更新
/api/events
以下のペイロードはイベントを更新します。
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.
削除
/api/events
上記のAPIを使用して、一度に複数のイベントを削除できます。
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
}
更新は寛大な方法で行われます。たとえば、1つのリソースの更新に失敗した場合、他のリソースは正常に更新される可能性があります。 ペイロードで1つのイベントが削除されました。削除または更新には、イベントIDが必要です。
成功したリクエストは返り HTTP 200 Response
ます。回答の本文には、作成された申請書が含まれます。失敗したリクエストは返 HTTP 400 Bad Request
される。応答の本文には、XMLとしてフォーマットされた検証エラーが含まれます。
このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。