Die REST-API kann verwendet werden, um Benutzeranfragen auf die übliche Weise zu behandeln(/c/company/user-query
). Zusätzlich kann auch die Benutzerabfrage aufgerufen werden.
Die einfachste Abfrage, d. h. eine, die keine Parameter hat (oder alle Parameter haben ausreichende Standardwerte), kann wie folgt aufgerufen werden: /c/company/user-query/
/call.xml (.json
ist auch möglich).
Die üblichen Detailstufen- oder Paging-Parameter funktionieren.
Wenn eine Abfrage Parameter hat, müssen Sie für jeden Abfrageparameter einen Parameter in der URL angeben. D.h. wenn eine Abfrage einen Datumsparameter
hat, sieht der Aufruf wie folgt aus: /c/company/user-query/
/call.xml?Datum=2012-01-01
.
Wenn der Abfrageparameter eine Kardinalität von N hat, d. h. mehrere Werte angegeben werden können, wiederholen Sie den Parameter einfach in der URL. Zum Beispiel, um mehrere Firmen auszuwählen: /c/company/user-query/
/call.xml?company=code:FIRMA1&company=code:FIRMA2
. Verwenden Sie dann in der gespeicherten Abfrage den IN-Operator (<<Firm>>).
Parameterwerte werden in der üblichen Weise geschrieben, nicht in Anführungszeichen eingeschlossen. Vergessen Sie nicht die richtige Kodierung in der URL.
Neben der GET-Methode kann auch die POST-Methode für den Aufruf der Abfrage verwendet werden, die es erlaubt, eine große Anzahl von Parametern im Body der Anfrage zu übergeben.
Gespeicherte Abfragen können auch gedruckt werden. Es ist notwendig, für jede gespeicherte Abfrage einen benutzerdefinierten Druck zu erstellen und diesen für die gespeicherte Abfrage auszuwählen. Der Druck kann dann über die REST-API aufgerufen werden.