クエリのオプション

クエリを使用して必要なデータをすばやく特定・取得する方法をご覧ください。

Coupa APIを使用すると、高度なクエリを実行して必要なデータをすばやく特定・取得できます。 Coupaでは、こうしたクエリを構築するための「構文」が確立されています。 この機能を使用すると、参照/子オブジェクトの属性を検索することもできます。 たとえば申請明細に関連する属性を検索することで、申請書を見つけることができます。

一般的な構文

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

次のように表示される場合:

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

order-lines[account][code]を介してアカウントを照会します。 この場合の発注明細などの要素のコレクションについては複数形を使用し、ネストされた単数形は無視されることにご注意ください。

サポートされている演算子

演算子

注記

<none/no operator>

完全一致/等価、以前の動作と同じ

contains

日付フィールドでは不使用

starts_with

日付フィールドでは不使用

ends_with

日付フィールドでは不使用

blank

trueまたはfalseを受付

gt

より大きい

lt

未満

gt_or_eq

以上

lt_or_eq

以下

not_eq

等しくない

in

値のリスト内

not_in値のリスト外

例

演算子を使用したクエリ

<instancename>.coupahost.com/api/purchase_orders?exported=false&created_at [gt ]= 2010 -01 -15

関連付けを通じた等価性のテスト

<instancename>.coupahost.com/api/purchase_orders?exported=false&created_at [gt ]= 2010 -01 -15 & supplier [name ]= Fishy

関連付けを通じた演算子の使用

<instancename>.coupahost.com/api/purchase_orders?exported=false&created_at [gt] = 2010 -01 -15 &サプライヤー[name] [gt] = Fish

1対多を含む2つのレベルの関連付けを介したクエリ

<instancename>.coupahost.com/api/purchase_orders?exported=false&created_at [gt] = 2010 -01 -15 & supplier [name] [gt] = Fish&order_lines [account] [code] = a - c

値のリスト内

<instancename>.coupahost.com/api/invoices?status [in] =承認済み、無効

検索でレコードが提供されない場合は、APIレスポンスにそのメッセージが表示されます。 検索クエリが無効な場合は、APIレスポンスで問題を特定できるようお手伝いします。

日付と時間に関する注意事項

日付は、ISO 8601形式の厳密なサブセットで指定されることを期待しています（例： 2010 -03 -25 T 18:38:00 - 07:00 3/25/10 PDTの6:38 pm ）。 受信したものはすべて解析が試みられますが、異なる形式での日付の場合、タイムゾーンの影響により予期しない結果が発生する可能性があります。ご注意ください。 現時点では、時刻とタイムゾーンなしで指定された日付はその日の始まりの午前0時(UTC)と解釈されます。

日付は常に、特定の時点を示す暗黙的または明示的な時間情報とともに保存されます。 Coupa UIを通じて入力された日付には、会社の既定のタイムゾーンにおける午前0時の時刻が割り当てられます。 created_atやupdated_at属性などによって自動生成される日付はより正確となります。 クエリを実行する特定の時間がわからない場合や、特定の日に作成された文書を確認したい場合は、特定の時間ではなく、適切な時間範囲を問い合わせるようにしてください。

URLを介したクエリで日付と時刻を使用する場合は、コロン( :)を %3A に置き換え、プラス記号( +)を %2Bに置き換える必要があることに注意してください。 結果を返すには、指定したすべての条件が true である必要があるため、比較演算子を使うと日付の範囲を効果的に指定できます。 たとえば太平洋標準時の特定の日付に絞ってクエリを制限するには、次の条件を使用できます。

created_at [gt_or_eq] = 2010 -03 -25 T 00:00:00 - 07:00 & created_at [lt] = 2010 -03 -26 T 00:00:00 - 07:00

各クエリ呼び出しごとのレコードの制限

APIのGETごとにレコード数を最大50に制限することで、処理速度を効率的に維持し、お客様とCoupaの双方で大量のデータパケットが意図せずに返されるのを防ぐことができます。

50を超えるレコードを取得する必要がある場合は、オフセットを使用してAPI GETを再実行できます。 例:以下のAPI URLは、最初の50がプルされた後の次の50のレコードを提供します(51～100)。 そのため、オフセットを50刻みで調整し続けることが可能となります。

https://instance.coupahost.com/api/invoices?offset=50&exported=false

APIコールで'exported=false'クエリをプルし、以前にエクスポートされていないレコードのみをプルするようにしてください。 これにより、連携を実行する際に取得するレコードの量が制限されます。