イベントAPI
イベントAPIを使用して、イベントデータの作成、更新、照会を行います。 これには、作成・更新・削除などの操作を行うための専用エンドポイントや、ファクトシート、行、フィールド、ラベルに関連するイベントも含まれます。
APIにアクセスするためのURL: https://<instance>.cso.coupahost.com/api/events
詳細については、統合のベストプラクティスを参照してください。
アクション
動詞 | パス | アクション | 説明 |
|---|---|---|---|
GET |
| インデックス | GETアクションを実行し、すべてのイベントを取得 |
POST |
| 作成 | 1つまたは複数のイベントオブジェクトを作成。 |
PUT |
| 更新 | 1つまたは複数のイベントを更新。 一括更新も可能です。 |
DELETE |
| delete | 1つまたは複数のイベントを削除。 一括削除も可能です。 |
GET |
| 表示 | 1つのイベントデータを表示。 |
PUT |
| 更新 | IDを使用して1つずつイベントを更新 |
DELETE |
| delete | イベントを1つずつ削除。 |
Elements
イベントAPIで使用できる要素は次のとおりです。
フィールド名 | フィールドの説明 | 必須 | 一意？ | 許容値 | 入力 | アウト* | Type |
|---|---|---|---|---|---|---|---|
ID | イベントのID | はい | yes | 整数 | |||
market-id | イベントが属するマーケットのID。 一度設定すると、変更できません。 | はい | yes | yes | 文字列 | ||
state | イベントのステータス/現在のフェーズ | 設定、アクティブ、終了(大文字と小文字を区別) | yes | yes | 文字列 | ||
名前 | イベントの名前 | yes | yes | 文字列 | |||
説明 | イベントの簡潔な説明 | yes | yes | 文字列 | |||
reference-number | イベントを識別するための参照番号のフィールド | yes | yes | 文字列 | |||
event-number | イベントの一意のID。 この値は増分形式です | yes | yes | 整数 | |||
time-zone | イベントのタイムゾーン | yes | yes | 文字列 | |||
settings | イベントの設定 | yes | yes | 文字列 |
レスポンスのペイロードには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 -15/02 ","- number "," event ":" 613 ",":" currency ":" GB "}," id ":" 921949 ":" 92195928238410706 "," market - id ":":" 9219592396342653837 "," state ":":" Active "," name ":"* IT Hardware and Services 2014 ","" description ":" Indirect Services "," reference - number ":" MC -15/02 "," event ":" 613 ":" ***テスト手順***！ （バックアップ目的のみ）"," 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 - A 15 -01 "," event - number ": 13 ," settings ":{" currency ":" SEK "}}]}作成/更新/削除
以下はCoupa APIを使ってイベントに対してアクションを実行する方法の説明です。
Create
/api/events
以下のペイロードは、2つのイベントを作成します。
ペイロード：{ "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
以下のペイロードは、イベントを更新します。
一度に1つ以上のイベントを更新するには：ペイロード：{ "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" } ] } 応答： 200 OK { "result": [ { "type": "api.put.updated", "description": "2 objects updated." }], "updated": 2}イベント番号とマーケットID以外のすべてのフィールドを更新できます。削除
/api/events
上記のAPIを使用して、一度に複数のイベントを削除できます。
ペイロード：{" events ":[{" id ":" 9220538753252871154 "}]}応答： 200 OK {" result ":[{" type ":" event.deleted.logMsg "," description ":"イベントITハードウェアとサービス2021 - ABCが削除されました。" }]," deleted ": 1}更新は寛容に処理されます。つまり、1つのリソースの更新に失敗しても、他のリソースは成功する場合があります。 このペイロードでは、1つのイベントを削除します。 削除や更新を行うには、イベントIDが必須です。
成功した要求は HTTP 200応答を返します。 レスポンスの本文には作成された申請書が含まれます。 リクエストが失敗すると、次が返されます:
HTTP 400不正な要求. レスポンスの本文にはXML形式の検証エラーが含まれます。