引数

概要

引数は、属性、演算子、値で構成されます。結果を制限する要求に追加できます。使用可能な属性は、各ビジネスオブジェクトの詳細なドキュメントに一覧表示されます。 Coupaは、既定の等式/完全一致に加えて、いくつかの演算子をサポートしています。

一般的な申請形式

<url>?<attribute><[operator]>=<value>&...

最初の例では、id=1で始まる最初の50の有効なサプライヤーを返します。  2番目の例では、指定した日付以降のupdated-at日付を持つ最初の50のPOを返します。

例:

https://example.coupahost.com/api/suppliers?status=active
https://example.coupahost.com/api/purchase_orders?updated_at[gt_or_eq]=2010-12-31

リミットとオフセット

リミットパラメータとオフセットパラメータを使用して、結果にページを付けることができます。  返される結果の最大数は一度に50件です。

例：最新150件の発注書をfi得するには：

https://example.coupahost.com/api/purchase_orders
https://example.coupahost.com/api/purchase_orders?offset=50
https://example.coupahost.com/api/purchase_orders?offset=100

コレクションで検索する

この場合の注文品目などの要素のコレクションでは、複数形を使用し、ネストされた単数形を無視します。

例：

<order-header>
   <order-lines>
      <order-line>
         <account>
            <code>a-c</code>
         </account>
      </order-line>
   </order-lines>
</order-header>

～になる：

https://example.coupahost.com/api/purchase_orders?order-lines[account][code]=a-c

下線

引数にリソースの要素を使用する場合、ダッシュはアンダースコアに変換する必要があります。

例：

<exchange-rate>
   <from-currency>
      <code>USD</code>
      <id type="integer">1</id>
   </from-currency>
</exchange-rate>

～になる：

https://example.coupahost.com/api/exchange_rates?from_currency_id=1