• 最終編集日時: 25 March 2021

Events API

イベントAPIを使用して、イベントとその関連データの作成、更新、クエリを実行します。

イベントAPIを使用して、イベントデータの作成、更新、クエリを実行します。これには、アクションを実行する特定のエンドポイント(作成/更新/削除)、およびファクトシート、行、フィールド、ラベルに関連するイベントが含まれます。

APIにアクセスするためのURLは次のとおりです。https<instance> ://.cso.coupahost.com/api/events

詳細については、統合のベストプラクティスを参照してください。

アクション

動詞 パス アクション 説明
取得 /api/events index すべてのイベントを取得するための取得アクションを実行します
投稿 /api/events 作成 1つ以上のイベントオブジェクトを作成します。
プット /api/events 更新 1つ以上のイベントを更新します。大量のアップデートを実行できます。
削除 /api/events delete あと1つのイベントを削除します。一括削除が可能です。
取得 /api/events /: id 表示 1つのイベントデータを表示します。 
プット /api/events /: id update IDを使用して一度に1つのイベントを更新します
削除 /api/events /: id 削除 イベントを1つずつ削除します。

要素

これらは、イベントAPIで使用できる要素です。

フィールド名 フィールドの説明 申請済み 一意ですか? 使用可能な値 In アウト* タイプ
iD

イベントのID

  はい     はい 整数
market - id イベントが属する市場のID。いったん設定すると、変更できません。   はい   はい はい string
都道府県 イベントのステータス/現在のフェーズ    

セットアップ、アクティブ、終了(大文字と小文字を区別)

はい はい string
名前 イベントの名前       はい はい string
説明 イベントの簡単な説明       はい はい string
reference - number イベントを識別するための参照番号のフィールド       はい はい string
event - number イベントの一意のIDこの値はインクリメンタル値です   はい     はい 整数
time - zone イベントのタイムゾーン       はい はい string
settings イベントの設定       はい はい string
メモ

 応答ペイロードはNULL値を表示しません。

この例では、Events APIを照会しました。URLへのアクセスを行いました。 

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

Events GET Response

{

		"合計":5,

		"EVENTS ": [

				{

						"ID ":"9219595375673293031 ",

						"market - id ":"9219595214580536433 ",

						"state ":"設定",

						"name ":"APCトレーニングプロジェクト",

						"DESCRIPTION ":"入札の場合",

						"event - number ":10,

						"settings ": {

								"通貨":"USD"

						}

				},

				{

						"ID ":"9219601944812992706 ",

						"market - id ":"9219596879086622384 ",

						"state ":"設定",

						"NAME ":"API -データストレージ",

						"description ":"ハムノテスト",

						"event - number ":11,

						"time - zone ":"ヨーロッパ/ストックホルム",

						"settings ": {

								"currency ":"EUR"

						}

				},

				{

						"ID ":"9219592828238410706 ",

						"market - id ":"9219592396342653837 ",

						"state ":"有効",

						"name ": "** ITハードウェア&サービス2014 ",

						"description ":"間接サービス",

						"reference - number ":"MC - IN -15/02 ",

						"event - number ":613,

						"settings ": {

								"通貨":"GBP"

						}

				},			 

				{

						"ID ":"9219593444808990596 ",

						"market - id ":"9219593040793966498 ",

						"state ":"終了",

						"name ": "!***テスト手順***!(バックアップ目的のみ)",

						"description ":"新しいリリースが起動しようとしているときに実行するタスク",

						"event - number ":1602,

						"settings ": {

								"通貨":"USD"

						}

				},

				{

						"ID ":"9219594228963465852 ",

						"market - id ":"9219592396342653837 ",

						"state ":"設定",

						"name ": "**航空貨物入札の例- 2015年9月12日に消毒済み",

						"description ":"航空貨物入札の例",

						"reference - number ":"MC - A 15 -01 ",

						"event - number ":13,

						"settings ": {

								"currency ":"SEK"

						}

				}				

	 ]

}

作成/更新/削除

以下では、Coupa APIを使用してイベントにアクションを実行する方法について説明します。

作成

/api/events

以下のペイロードは2つのイベントを作成します。

ペイロード: 

{

		"EVENTS ": [

				{

						"market - id ":"9220538753220565329 ",

						"name ":"ITハードウェアとサービス2021 ",

						"description ":"直接サービス",

						"reference - number ":"DEMO - ref 1 ",

						"settings ": {

								"currency ":"USD"

						}

				},

				{

						"market - id ":"9220538753220565329 ",

						"state ":"設定",

						"name ":"サービスのみ",

						"description ":"州、タイムゾーン、参照番号のない同じ市場",

						"time - zone ":"ヨーロッパ/ストックホルム",

						"settings ": {

								"通貨":"EUR"

						}

				}

		]

}



回答:201

{

		"result ": [

				{

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

						"DESCRIPTION ":"2件のオブジェクトが作成されました。"

				}

		],

		"ADDED ":2,

		"EVENTS ": [

				{

						"ID ":"9220538753252871154"

				},

				{

						"ID ":"9220538753252871160"

				}

		]

}		

更新

/api/events

以下のペイロードはイベントを更新します。 

一度に1つまたは複数のイベントを更新するには: 

ペイロード:

{

		"EVENTS ": [

				{

						"ID ":"9220538753252871154 ",

						"state ":"アクティブ",

						"name ":"ITハードウェアとサービス2021 - ABC ",

						"description ":"直接サービス- ABC ",

						"reference - number ":"DEMO - reference"

				},

				{

						"ID ":"9220538753252871160 ",

						"name ":「サービスチャネリングのみ」

				}

		]

}



回答:200 OK

{

		"result ": [

				{

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

						"DESCRIPTION ":"2件のオブジェクトが更新されました。"

				}

		],

		"更新済み":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 Bad Requestが返されます。応答の本文には、XML形式の検証エラーが含まれます。

関連アイテム


ファクトシートAPI

25 March 2021

ファクトシートAPIを使用して、ファクトシートと関連する(行/フィールド)データを作成、更新、またはクエリします。

フィールドAPI

25 March 2021

フィールドAPIを使用して、フィールドと関連付けられた(行)データを作成、更新、またはクエリします。

マーケットAPI

25 March 2021

マーケットAPIを使用して、マーケットの作成、更新、クエリを実行します。

ユーザーAPI

25 March 2021

ユーザーAPIを使用して、ユーザーデータの作成、更新、クエリを実行します。