マーケットAPI
マーケットAPIを使用して、マーケットデータの作成、更新、照会を行います。 これには、作成・更新・削除などの操作を行うための専用エンドポイントや、マーケットに関連するイベントも含まれます。
APIにアクセスするためのURL: https://<instance>.cso.coupahost.com/api/markets
詳細については、統合のベストプラクティスを参照してください。
アクション
動詞 | パス | アクション | 説明 |
|---|---|---|---|
GET |
| インデックス | GETアクションを実行し、すべてのマーケットを取得 |
POST |
| 作成 | 1つまたは複数のマーケットオブジェクトを作成。 |
PUT |
| 更新 | 1つまたは複数のマーケットを更新。 一括更新も可能です。 |
DELETE |
| delete | 1つまたは複数のマーケットを削除。 一括削除も可能です。 |
GET |
| 表示 | 1つのマーケットデータを表示。 |
PUT |
| 更新 | IDを使用して1つずつマーケットを更新 |
DELETE |
| delete | マーケットを1つずつ削除。 |
Elements
マーケットAPIで使用できる要素は次のとおりです。
フィールド名 | フィールドの説明 | 必須 | 一意？ | 許容値 | 入力 | 出力 | Type |
|---|---|---|---|---|---|---|---|
ID | 一意の自動増分のシステム生成ID | yes | 整数 | ||||
名前 | マーケットの名前 | はい | yes | yes | 文字列 | ||
description | マーケットの簡単な説明 | yes | yes | 文字列 |
例
この例では、マーケットAPIに対してクエリを実行しました。 以下のURLに対してGETリクエストを実行しました。
https ://<instance>.cso.coupahost.com/api/markets
マーケットGETレスポンス
{" total ": 10 ," markets ":[{" id ":" 9219601763469521167 "," name ":"!モントリオール銀行貯蓄トラッカーのデモ"}、{" id ":" 9219595277140974408 "," name ":"! JIRA - Tickets "}, {" id ": "9219593060488131385 "," name ": "!市場1 "," description ":" Logistics and Transportation "},{" id ":" 9220538753220565326 "," name ":" Arj Market 1 "," description ":" XPO logistics "},{" id ":" 9220538753220565329 "," name ":" Arj Market 2 "," description ":" XPO Transportation "},{" id ":" 9219592846040196615 "," name ":" Common Information "},{" id ":" 9219593864376360801 "," name ":" Consulting "},{" id ":" 9219601774059719348 "," name ":" D - Nikisha's Demo Market "},{" id ":" 9219601938334799391 "," name ":" E - Integrations "},{" id ":" 9219601936493380282 "," name ":" E - Top Tips to Audit Events "}}]作成/更新/削除
以下はCoupa APIを使ってマーケット対してアクションを実行する方法の説明です。
Create
/api/markets
以下のペイロードは、2つのマーケットを作成します。
ペイロード：{" markets ":[{" name ":" Arjun Market 1 "," description ":" XPO logistics "},{" name ":" Arjun Market 2 "," description ":" XPO Transportation "}]}応答： 201 {" result ":[{" type ":" api.post.added "," description ":" 2個のオブジェクトが作成されました。" }]," ADDED ": 2 ," MARKETS ":[{" id ":" 9220538753220565326 "},{" id ":" 9220538753220565329 "}]}Update
/api/markets
以下のペイロードは、マーケットを更新します。
一度に1つ以上の市場を更新するには：ペイロード：{" markets ":[{" name ":" Arj Market 1 "," description ":" XPO logistics updated "},{" name ":" Arj Market 2 "," description ":" XPO Transportation updated "}]}応答： 200 OK {" result ":[{" type ":" api.put.updated "," description ":" 2 objects updated ." }], "updated": 2}削除
/api/markets
以下のペイロードは複数のマーケットを一度に削除するためのものです。 マーケットを個別または一括で削除すると、関連するイベントも削除されることにご注意ください。
ペイロード：{" markets ":[{" id ":" 9220538753220565326 "},{" name ":" Arjun Market 2 "}]}応答： 200 OK {" result ":[{" type ":" market.deleted.logMsg "," description ":" The market Arjun Market 1 was deleted ." }]," deleted ": 1}更新は寛容に処理されます。つまり、1つのリソースの更新に失敗しても、他のリソースは成功する場合があります。 削除のペイロード例は上記をご参照ください。 このペイロードでは、1つのマーケットのみを削除します。 削除や更新を行うには、ペイロードにIDが必要です。
成功した要求は HTTP 200応答を返します。 レスポンスの本文には作成された申請書が含まれます。 リクエストが失敗すると、次が返されます:
HTTP 400不正な要求. レスポンスの本文にはXML形式の検証エラーが含まれます。