Argumente

Übersicht

Argumente bestehen ausAttributen,OperatorenundWerten. Sie können an jede Anforderung angehängt werden, um die Ergebnisse zu begrenzen. Die verfügbaren Attribute sind in der detaillierten Dokumentation jedes Geschäftsobjekts aufgelistet. Coupa unterstützt eine Reihe vonOperatorenzusätzlich zur Standardgleichheit/genauen Übereinstimmung.

Allgemeines Anforderungsformat

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

Das erste Beispiel gibt die ersten 50 aktiven Lieferanten zurück, die mit id=1 beginnen.  Im zweiten Beispiel werden die ersten 50 Bestellungen mit einem Aktualisierungsdatum zurückgegeben, das nach dem angegebenen Datum liegt oder diesem entspricht.

Beispiel:

https://example.coupahost.com/api/suppliers?status=active
https://example.coupahost.com/api/purchase_orders?updated_at[gt_or_eq]=2010-12-31

Limit und Offset

Sie können Grenzwert- und Offset-Parameter verwenden, um Ergebnisse zu paginieren.  Denken Sie daran, dass maximal 50 Ergebnisse gleichzeitig zurückgegeben werden.

Beispiel: So rufen Sie die ersten 150 Bestellungen ab:

https://example.coupahost.com/api/purchase_orders
https://example.coupahost.com/api/purchase_orders?offset=50
https://example.coupahost.com/api/purchase_orders?offset=100

Suche nach einer Sammlung

Verwenden Sie für Auflistungen von Elementen, wie in diesem Fall Bestellzeilen, das Pluralformular und ignorieren Sie das geschachtelte Singular.

Beispiel:

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

Wird zu:

https://example.coupahost.com/api/purchase_orders?order-lines[account][code]=a-c

Unterstriche

Wenn Sie Elemente aus Ressourcen in Ihren Argumenten verwenden, sollten alle Gedankenstriche in Unterstriche konvertiert werden.

Beispiel:

<exchange-rate>
   <from-currency>
      <code>USD</code>
      <id type="integer">1</id>
   </from-currency>
</exchange-rate>

Wird zu:

https://example.coupahost.com/api/exchange_rates?from_currency_id=1