- URL:
« /RestApi/Query?authToken=<authToken>&selectQuery=<selectQuery> »- Méthode: GET
- Paramètres URL:
- authToken [string] [Required]=l’authentication token
- selectQuery [string] [Required]=la requête sélectionnée. Exemple: “SELECT Name FROM Account WHERE Id=1329023730348722379”.
- useLocaleFormatting [bool] [Optionel]=permet de retourner les champs de type Date/DateTime/Number/Currency/Percent dans le format de la locale de l’utilisateur.
- Réponse de succès:
- Status Code=200 (OK)
- Returned Data [in XML or JSON]=une liste de tous les enregistrements sélectionnés
Exemple de données renvoyées (en format xml:
<Data>
<Account>
<Name>
Account Test 1
</Name>
<Address>
Address Test 1
</Address>
</Account>
<Account>
<Name>
Account Test 2
</Name>
<Address>
Address Test 2
</Address>
</Account>
</Data>
- Réponse d’erreur:
- Status Code=401 (Unauthorized) (en cas de fausse authentication token)
- Or
- Status Code=400 (BadRequest) (au cas où l’opération “querying data” a échoué)
- Mots clés:
| Mots clés pris en charge | Description | Exemple |
|---|---|---|
| LIMIT | Retour uniquement si la première ligne n (n < 2000), n étant la valeur spécifique après le mot clé « LIMIT » (Premières 10 lignes dans cet exemple). | “SELECT Id, Name FROM Lead LIMIT 10” |
| OFFSET | Retour d’un maximum de 2000 enregistrements à partir de la n-ième ligne (10ème ligne dans cet exemple) | « SELECT Id, Name From Contact WHERE OwnerId=UserId OFFSET 10 » |
