引数

概要

引数は、属性、演算子、値で構成されます。結果を制限するためにリクエストに追加できます。利用可能な属性は各ビジネスオブジェクトの詳細ドキュメントにリストされています。Coupaは、デフォルトの等値/完全一致に加えて、いくつかの演算子をサポートしています。

一般的な申請フォーマット

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

最初の例は、id = 1で始まる最初の50のアクティブなサプライヤーを返します。2番目の例は、指定された日付以降の更新日を含む最初の50の発注書を返します。

例：

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の発注書を取得するには：

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