Arguments

Aperçu

Les arguments sont constitués d'attributs, d'opérateurs et de valeurs. Ils peuvent être annexés à toute demande de limitation des résultats, les attributs disponibles sont listés dans la documentation détaillée de chaque objet métier. Coupa prend en charge un certain nombre d'opérateurs en plus de la correspondance par défaut égalité/exacte.

Format général de la demande

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

Le premier exemple renvoie les 50 premiers fournisseurs actifs commençant par id=1.  Le deuxième exemple renvoie les 50 premiers bons de commande avec une date de mise à jour supérieure ou égale à la date spécifiée.

Exemple :

https://example.coupahost.com/api/suppliers?status=active

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

-->

Limite et décalage

Vous pouvez utiliser des paramètres de limite et de décalage pour paginer les résultats.  N'oubliez pas que le nombre maximum de résultats retournés est de 50 à la fois.

Exemple : Pour obtenir les 150 premiers bons de commande :

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

Recherche sur une collection

Pour les collections d'éléments, telles que les lignes de commande dans ce cas, utilisez la forme plurielle et ignorez la forme singulière imbriquée.

Exemple :

<order-header>

   <order-lines>

      <order-line>

         <account>

            <code>a-c</code>

         </account>

      </order-line>

   </order-lines>

</order-header>

Devient :

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

Soulignement

Lorsque vous utilisez des éléments de ressources dans vos arguments, les tirets doivent être convertis en traits de soulignement.

Exemple :

<exchange-rate>

   <from-currency>

      <code>USD</code>

      <id type="integer">1</id>

   </from-currency>

</exchange-rate>

Devient :

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