マーケットAPI
マーケットAPIを使用して、マーケットの作成、更新、クエリを実行します。
マーケットAPIを使用して、マーケットデータを作成、更新、またはクエリします。これには、アクションを実行するための特定のエンドポイント（作成/更新/削除）や、市場に関連するイベントが含まれます。
APIにアクセスするためのURLは次のとおりです。https<instance> ://.cso.coupahost.com/api/markets
詳細については、統合のベストプラクティスを参照してください。
アクション
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| 取得 | /api/markets |
index | すべてのマーケットを取得するための取得アクションを実行 |
| 投稿 | /api/markets |
作成 | 1つ以上のマーケットオブジェクトを作成します。 |
| プット | /api/markets |
update | 1つまたは複数の市場を更新します。大量のアップデートを実行できます。 |
| 削除 | /api/markets |
削除 | あと1つのマーケットを削除します。一括削除が可能です。 |
| 取得 | /api/markets /: id |
表示 | 1つのマーケットデータを表示します。 |
| プット | /api/markets /: id |
update | IDを使用して一度に1つの市場を更新します |
| 削除 | /api/markets /: id |
削除 | 市場を1つずつ削除します。 |
要素
これらはMarkets APIで利用可能な要素です
| フィールド名 | フィールドの説明 | 申請書 | 一意ですか？ | 使用可能な値 | In | アウト | タイプ |
|---|---|---|---|---|---|---|---|
| iD |
一意の自動インクリメンタル、システム生成ID |
はい | 整数 | ||||
| 名前 | 市場の名前 | はい | はい | はい | string | ||
| 説明 | 市場の簡潔な説明 | はい | はい | string |
例
この例では、マーケットAPIを照会しました。URLへのアクセスを行いました。
https<instance> ://.cso.coupahost.com/api/markets
マーケットは回答を得ます
{
"TOTAL ":10,
"markets ": [
{
"ID ":"9219601763469521167 ",
"name ": "!モントリオール銀行貯蓄トラッカーのデモ"
},
{
"ID ":"9219595277140974408 ",
"NAME ": "! JIRA -チケット"
},
{
"ID ":"9219593060488131385 ",
"name ": "!マーケット1 ",
"description ":「物流・輸送」
},
{
"ID ":"9220538753220565326 ",
"name ":"Arjマーケット1 ",
"DESCRIPTION ":「XPO物流」
},
{
"ID ":"9220538753220565329 ",
"name ":"Arjマーケット2 ",
"description ":"XPO交通機関"
},
{
"ID ":"9219592846040196615 ",
"NAME ":「一般情報」
},
{
"ID ":"9219593864376360801 ",
"name ":CONSULTING
},
{
"ID ":"9219601774059719348 ",
"name ":「D - Nikishaのデモ市場」
},
{
"ID ":"9219601938334799391 ",
"NAME ":「E - Integrations」
},
{
"ID ":"9219601936493380282 ",
"name ":「イベントを監査するためのE - Topのヒント」
}
]
}作成/更新/削除
以下では、Coupa APIを使用してMarketsでアクションを実行する方法について説明します。
作成
/api/markets
以下のペイロードは、2つの市場を作成します。
ペイロード：
{
"markets ": [
{
"name ":"アルジュンマーケット1 ",
"DESCRIPTION ":「XPO物流」
},
{
"name ":"アルジュンマーケット2 ",
"description ":"XPO輸送"
}
]
}
回答:201
{
"result ": [
{
"type ":" api.post.added ",
"DESCRIPTION ":「2件のオブジェクトが作成されました。」
}
],
"ADDED ":2,
"markets ": [
{
"ID ":"9220538753220565326"
},
{
"ID ":"9220538753220565329"
}
]
}更新
/api/markets
以下のペイロードは市場を更新します。
一度に1つまたは複数の市場を更新するには：
ペイロード：
{
"markets ": [
{
"name ":"Arjマーケット1 ",
"description ":「XPOロジスティクスが更新されました」
},
{
"name ":"Arjマーケット2 ",
"description ":「XPO輸送が更新されました」
}
]
}
回答：200 OK
{
"result ": [
{
"type ":" api.put.updated ",
"description ":"2件のオブジェクトが更新されました。"
}
],
"updated ":2
}
削除
/api/markets
以下のペイロードは、一度に複数の市場を削除することです。マーケットを個別または一括で削除すると、関連するイベントも削除されることに注意してください。
ペイロード：
{
"markets ": [
{
"ID ":"9220538753220565326"
},
{
"name ":「アルジュンマーケット2」
}
]
}
回答:200 OK
{
"result ": [
{
"type ":" market.deleted.logMsg ",
"DESCRIPTION ":「市場アルジュン市場1が削除されました。
}
],
"DELETED ":1
}更新は寛大な方法で行われます。つまり、1つのリソースの更新に失敗した場合、他のリソースの更新は成功する可能性があります。たとえば、上記のペイロードの削除を参照してください。ペイロードは1つの市場のみを削除しました。削除または更新するには、ペイロードにIDが必要です。
要求が成功すると、HTTP 200応答が返されます。レスポンスの本文には、作成された申請書が含まれます。要求が失敗すると、HTTP 400 Bad Requestが返されます。応答の本文には、XML形式の検証エラーが含まれます。