引数
Coupaがオペレーターと組み合わせてサポートする引数の種類について説明します。
引数は、属性、演算子、値で構成されます。 結果を制限するために任意のリクエストに追加できます。使用可能な属性は、各ビジネスオブジェクトの詳細な文書に記載されています。 Coupaは、デフォルトの等しい/完全一致に加えて、多くの演算子をサポートしています。
一般的なリクエスト形式
<url>?<attribute><[ operator ]> =<value>&...最初の例では、id=1で始まる最初の50のアクティブなサプライヤーが返されます。 2つ目の例では、updated-at dategreaterが指定された日付以上の最初の50件の発注書を返します。
例:
https://example.coupahost.com/api/suppliers?status=active https://example.coupahost.com/api/purchase_orders?updated_at [gt_or_eq] = 2010 -12 -31 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>米ドル</code> <id type="integer">1</id> </from-currency> </exchange-rate>
結果:
https://example.coupahost.com/api/exchange_rates?from_currency_id=1