• 最終編集日時: 21 October 2016

照会オプション

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

概要

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

一般構文

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

次のように表示されます。

<order-header>

   <order-lines>

      <order-line>

         <account>

            <code>a - c</code>

         </account>

      </order-line>

   </order-lines>

</order-header>

注文明細[account] [code]を介してアカウントに照会します。この場合の順序行などの要素の集合には、複数形を使用し、入れ子になった単数形を無視することに注意してください。

サポートされているオペレーター

演算子 メモ
<none/no operator> 以前の動作と同じように、完全に一致/等価
が右の値を含む 日付フィールドで使用されません
starts_with 日付フィールドで使用されません
ends_with 日付フィールドで使用されません
空欄 真または偽を受け入れる
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] =承認済み、無効

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

日付と時間に関する注意

日付は、ISO 8601形式の厳密なサブセットで指定されることを期待しています(例: 2010 -03 -25 T 18:38:00 - 07:00、3/25/10 PDTの午後6:38 )。受け取ったものは何でも解析しますが、日付が異なる場合、タイムゾーンの影響が予期しない結果になる可能性があることに注意してください。現在、時間とタイムゾーンなしで指定された日付は、その日の初めに午前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ごとに最大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」クエリを確実にプルして、以前にエクスポートされていないレコードのみをプルするようにする必要があります。これにより、連携を実行するときに取得するレコードの量が制限されます。

関連アイテム


特別措置とAPIメモ

21 October 2016

Coupa APIの使用方法に関する追加情報。

CoupaでのXMLとJSONの違い

16 December 2016

連携実行API

24 April 2017

このAPIを使用して、統合実行の作成、クエリ、更新、およびステータスの更新を行います。

タグ付けAPI

24 April 2017

タグ付けAPIを使用して、タグを取り込み、サードパーティシステムにエクスポートします。