Optionen für die Abfrage

Übersicht

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

Allgemeine Syntax

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

Also, 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 die Bestellzeilen[account][code] abfragen. Beachten Sie, dass Sie für Auflistungen von Elementen, wie z. B. Auftragszeilen in diesem Fall, die Pluralform verwenden und die verschachtelte Singularform ignorieren.

Unterstützte Operatoren

Beispiele

Abfrage mit Operatoren

<instancename>.coupahost.com/api/purchase_orders?exported=false&created_at[gt]=15.01.2010

Prüfung auf Gleichberechtigung durch einen Verband

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

Verwendung von Operatoren über eine Assoziation

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

Abfrage über 2 Assoziationsebenen, einschließlich einer Eins-zu-viele

<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]=genehmigt, für ungültig erklärt

Wenn Ihre Suche keine Datensätze liefert, sollten Sie diese Nachricht in der API-Antwort sehen. Wenn Ihre Suchanfrage ungültig ist, werden wir versuchen, Ihnen zu helfen, das Problem in der API-Antwort zu identifizieren.

Hinweis zu Terminen & Zeiten

Wir erwarten, dass die Daten in einer strengen Untermenge des ISO 8601-Formats angegeben  werden (z. B.2010-03-25T 18:38:00-07:00 für 18:38Uhr am 25.03.10  PDT).  Wir werden versuchen, alles, was wir erhalten, zu analysieren. Bitte beachte jedoch, dass Zeitzoneneffekte unerwartete Ergebnisse hervorrufen können, wenn Daten in einem  anderen Format vorliegen. Derzeit wird jedes Datum ohne Uhrzeit und  Zeitzone zu Beginn dieses Tages, UTC, als Mitternacht interpretiert.

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

Beachten Sie bei der Verwendung von Datums- und Uhrzeitangaben in Abfragen über URL, dass ein Doppelpunkt (:) durch %3A und ein Pluszeichen (+) durch %2B ersetzt werden muss. Da alle Bedingungen, die Sie eingeben, wahr sein müssen, damit die Ergebnisse zurückgegeben werden, können Sie mit den Vergleichsoperatoren effektiv Datumsbereiche angeben. Um Abfragen beispielsweise auf einen bestimmten Tag in Pacific Time zu beschränken, können 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ätze pro API, UM die Verarbeitungsgeschwindigkeiten effizienter zu halten und sowohl Sie als auch Coupa vor der unbeabsichtigten Rückgabe großer Datenpakete zu schützen. 

Wenn Sie mehr als 50 Datensätze benötigen, können Sie API get mit einem Offset erneut ausführen.  Beispiel: Die unten stehende API-URL würde die nächsten 50 Datensätze bereitstellen, nachdem die ersten 50 gezogen wurden (51-100).  So können Sie den Offset weiter anpassen, um Inkremente von 50 zu erhalten.

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

Sie möchten sicherstellen, dass in Ihren API-Aufrufen Abfragen "exportiert=falsch" abgerufen werden, sodass nur Datensätze abgerufen werden, die zuvor noch nicht exportiert wurden.  Dies sollte die Anzahl der Datensätze begrenzen, die Sie beim Ausführen Ihrer Integrationen abrufen.