引数
Coupaが演算子と連携してサポートする引数の種類について説明します。
概要
引数は属性、演算子、値で構成されています。これらは、結果を制限するために任意の要求に追加できます。利用可能な属性は、各ビジネスオブジェクトの詳細なドキュメントに記載されています。Coupaは、デフォルトの等しい/完全一致に加えて、多くの演算子をサポートしています。
一般的なリクエスト形式
<url>?<attribute><[operator]> =<value> &...
最初の例は、id = 1で始まる最初の50のアクティブなサプライヤーを返します。2つ目の例は、指定された日付以上の更新されたデータを持つ最初の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の発注書を取得するには：
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 [アカウント] [コード] = 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