クエリオプション
このページは機械翻訳を使用して翻訳されています。
概要
Coupa APIを使用すると、高度なクエリを実行して、必要なデータをすばやく特定して取得できます。これらのクエリを作成するための「構文」を確立しました。この機能を使用すると、参照/子オブジェクトの属性を検索することもできます。たとえば、請求品目に関連する属性を検索して、申請を見つけることができます。
一般的な構文
<url>?<attribute><[operator]>=<value>&...
だから、あなたが見る場合：
<order-header>
<order-lines>
<order-line>
<account>
<code>a-c</code>
</account>
</order-line>
</order-lines>
</order-header>
あなたは注文明細[アカウント] [コード]を介してアカウントを照会します。この場合の注文品目などの要素のコレクションでは、複数形を使用し、ネストされた単数形は無視してください。
サポートされている演算子
| 演算子 | メモ |
|---|---|
<none/no operator> |
完全一致/同等、以前の動作と同じ |
contains |
日付フィールドでは使用されません |
starts_with |
日付フィールドでは使用されません |
ends_with |
日付フィールドでは使用されません |
blank |
真または偽を受け入れる |
gt |
より大きい |
lt |
未満 |
gt_or_eq |
以上 |
lt_or_eq |
以下 |
not_eq |
と等しくありません |
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&supplier[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]=approved,voided
検索でレコードが提供されない場合、API応答にそのメッセージが表示されます。検索クエリが無効な場合、APIレスポンスで問題を特定できるようお手伝いします。
日付と時間に関するメモ
日付はISO 8601形式の厳密なサブセットで指定する必要があります（例：3/25/10 PDTの午後6時38分には2010-03-25T18:38:00-07:00）。受け取ったものは何でも解析しようとしますが、日付の形式が異なる場合、タイムゾーンの影響によって予期しない結果が生じる可能性があることに注意してください。現在、時刻とタイムゾーンなしで指定された日付は、その日の初めの真夜中のUTCとして解釈されます。
日付は常に、特定の時点を表す暗黙的または明示的な時間コンポーネントとともに保存されます。Coupa UIを使用して入力した日付の時刻は、会社の既定のタイムゾーンの午前0時です。created_atやupdated_at属性などの自動生成された日付はより正確です。クエリを実行している特定の時間がわからず、特定の日の経過中に作成されたドキュメントに関心がある場合は、特定の時間ではなく、適切な時間範囲をクエリしてください。
URL経由のクエリで日付と時刻を使用する場合は、コロン（ <b id="i2"><a id="x2" xid="i42.1.1">[]</a></b> ）を<b id="i3"><a id="x3" xid="i42.1.2">[]</a></b>に、プラス記号（ <b id="i4"><a id="x4" xid="i42.1.3">[]</a></b> <b id="i5"><a id="x5" xid="i42.1.4">）を[]に</a></b>置き換える必要があります。:%3A+%2B 結果が返されるには、渡すすべての条件が真でなければならないので、比較演算子を使用して日付範囲を効率的に指定できます。たとえば、太平洋標準時の特定の日にクエリを制限するには、次の条件を使用できます。
created_at[gt_or_eq]=2010-03-25T00:00:00-07:00&created_at[lt]=2010-03-26T00: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'クエリを確実にプルして、以前にエクスポートされていないレコードのみをプルする必要があります。これにより、統合を実行するときにプルするレコードの量が制限されます。