Abfrageoptionen

Übersicht

Über die Coupa-API können Sie erweiterte Abfragen zusammen mit Ihnen ausführen, um die benötigten Daten schnell zu identifizieren und abzurufen.  Wir haben eine "Syntax" zum Erstellen dieser Abfragen eingerichtet. Mit dieser Funktion können Sie auch nach Attributen für referenzierte / untergeordnete Objekte suchen.  Beispielsweise können Sie Anforderungen finden, indem Sie nach Attributen suchen, die sich auf die Anforderungspositionen beziehen.

Allgemeine Syntax

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

Wenn Sie sehen:

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

Sie würden das Konto über Bestellzeilen[account][code] abfragen. Beachten Sie, dass Sie für Auflistungen von Elementen, wie in diesem Fall Bestellzeilen, das Pluralformular verwenden und das geschachtelte Singular ignorieren.

Unterstützte Operatoren

Beispiele

Abfrage mit Operatoren

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

Tests auf Gleichheit durch eine Verknüpfung

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

Verwenden von Operatoren über eine Verknüpfung

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

Befragung über 2 Ebenen der Verknüpfung, einschließlich 1:n

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

In Werteliste

<instancename>.coupahost.com/api/invoices?status[in]=approved,voided

Wenn Ihre Suche keine Datensätze bereitstellt, sollten Sie diese Meldung in der API-Antwort sehen. Wenn Ihre Suchanfrage ungültig ist, werden wir versuchen, Ihnen bei der Identifizierung des Problems in der API-Antwort zu helfen.

Hinweis zu Daten und Zeiten

Wir erwarten, dass die Daten in einer strikten Teilmenge des ISO 8601-Formats angegeben werden (z. B. 2010-03-25T18:38:00-07:00 für 18:38 Uhr am 25.03.10 PDT).  Wir werden versuchen, das zu analysieren, was wir erhalten, aber beachten Sie, dass Zeitzoneneffekte zu unerwarteten Ergebnissen führen können, wenn Daten in einem anderen Format vorliegen. Derzeit wird jedes Datum, das ohne Zeit und Zeitzone angegeben ist, als Mitternacht zu Beginn dieses Tages, UTC, interpretiert.

Daten werden immer mit einer impliziten oder expliziten Zeitkomponente gespeichert, die einen bestimmten Zeitpunkt darstellt. Über die Coupa-Benutzeroberfläche eingegebene Daten haben eine Zeit, die Mitternacht in der Standard-Zeitzone des Unternehmens entspricht. Automatisch generierte Daten, wie die Attribute created_at und updated_at, sind präziser. Wenn Sie die spezifische Zeit, nach der Sie fragen, nicht kennen und an Dokumenten interessiert sind, die im Laufe bestimmter Tage erstellt wurden, stellen Sie sicher, dass Sie nach den entsprechenden Zeiträumen und nicht nach einer bestimmten Zeit fragen.

Wenn Sie Daten und Uhrzeiten in Abfragen über die URL verwenden, beachten Sie, dass ein Doppelpunkt:(1) durch %3Aund ein Pluszeichen (+1) durch %2Bersetzt werden muss. Da alle Bedingungen, die Sie übergeben, wahr sein müssen, damit Ergebnisse zurückgegeben werden, können Sie Datumsbereiche effektiv mit den Vergleichsoperatoren angeben. Um beispielsweise Abfragen auf einen bestimmten Tag in Pacific Time zu beschränken, könnten Sie die folgenden Bedingungen verwenden:

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

Begrenzung der Datensätze pro Abfrageaufruf

Wir erlauben bis zu 50 Datensätzen pro API GET, um die Verarbeitungsgeschwindigkeiten effizienter zu halten und sowohl Sie als auch Coupa davor zu schützen, versehentlich große Datenpakete zurückzugeben. 

Wenn Sie mehr als 50 Datensätze benötigen, können Sie API get mit einem Offset erneut ausführen.  Beispiel: Unter der API-URL würden die nächsten 50 Datensätze bereitgestellt, nachdem die ersten 50 abgerufen wurden (51-100).  Sie können also den Offset anpassen, um 50-fache Schritte zu erhalten.

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

Sie möchten sicherstellen, dass Sie in Ihren API-Aufrufen "exported=false"-Abfragen abrufen, damit Sie nur Datensätze abrufen, die zuvor nicht exportiert wurden.  Dies sollte die Anzahl der Datensätze begrenzen, die Sie bei der Ausführung Ihrer Integrationen abrufen.