クエリオプション

概要

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

一般的な構文

<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]を使用して勘定科目を問い合わせます。この場合の注文品目などの要素のコレクションでは、複数形のフォームを使用し、ネストされた単数形のフォームは無視してください。

サポートされる演算子

例

演算子でクエリする

<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形式の厳密なサブセットで指定されるものとします(例： 2010-03-25T18:38:00-07:00 10日3月25日（午後6時38分）の場合。  受け取った内容を解析しようとしますが、日付の形式が異なる場合、タイムゾーンの影響が予期しない結果につながる可能性があることに注意してください。現在、時刻とタイムゾーンなしで指定された日付は、その日の午前0時(UTC)と解釈されます。

日付は常に、特定の時点を表す暗黙または明示的な時間要素とともに保存されます。Coupa UIを介して入力された日付には、会社の既定のタイムゾーンで午前0時に対応する時間があります。 created_at属性やupdated_at属性などの自動生成された日付はより正確です。クエリする特定の時間がわからない場合で、特定の日数にわたって作成されたドキュメントに関心がある場合は、特定の時間ではなく適切な時間範囲でクエリを実行するようにしてください。

:URLを介してクエリで日付と時刻を使用する場合は、コロン( )を置き換え、プラス記号( ) %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」クエリを確実に取得して、これまでにエクスポートされていないレコードのみを取得するようにする必要があります。 これにより、インテグレーションの実行時に取得するレコードの量が制限されます。