In der URL, die zum Abrufen von Daten aus ABRA Flexi verwendet wird, ist es möglich, viele Parameter zu verwenden, die die erhaltenen Ergebnisse beeinflussen.

Fast jeder ABRA Flexi API-Benutzer wird früher oder später die vom System zurückgegebenen Ergebnisse irgendwie paginieren müssen. Zum Beispiel nur aus dem Grund, dass ABRA Flexi ohne weitere Angaben nur die ersten 20 Ergebnisse zurückgibt. Standardmäßig ist die Seite 20 Datensätze groß. Wenn Sie also mehr Seiten aus dem System holen müssen oder eine längere Seite haben, müssen Sie anfangen, Parameter zu verwenden.

Wichtige Parameter sind:

Grenze

Dieser Parameter legt fest, wie viele Datensätze auf einer Seite erscheinen sollen.
Wenn Sie eine Seite mit allen Datensätzen auf einmal erhalten möchten, müssen Sie diesen Parameter auf 0 setzen.

Gibt die ersten zwanzig Datensätze aus dem Verzeichnisdatensatz zurück.

Gibt die ersten fünf Einträge aus dem Verzeichnisdatensatz zurück.

Gibt alle Datensätze aus der Verzeichnisregistrierung zurück.

Start

Wenn ein Paging der Ergebnisse erforderlich ist, reicht ein Limit allein nicht aus. Sie müssen auch den Startparameter verwenden, der angibt, bei wie vielen Datensätzen die Seite beginnt.
Der erste Datensatz und der Standardwert ist start=0.

Gibt eine Seite der Größe 5 Datensätze aus dem Verzeichnisdatensatz zurück und beginnt mit dem ersten Datensatz.

Gibt eine zweite Seite mit 5 Datensätzen aus dem Verzeichnisdatensatz zurück. Die zweite Seite wird durch den Startparameter mit einem Wert von 5 angegeben.

add-row-count

Wenn Sie Datensätze auslagern, ist es sinnvoll, festzulegen, wann das Auslagern beendet werden soll. So ist es auch möglich, der URL einen Parameter hinzuzufügen, der die Gesamtzahl der zu durchblätternden Datensätze zur Ausgabe hinzufügt. Dieser Parameter wird add-row-count genannt und nimmt die Werte true oder false an, je nachdem, ob die Gesamtzahl addiert werden soll oder nicht.

Gibt eine Seite mit 5 Datensätzen aus dem Verzeichnisdatensatz zurück. Das Attribut rowCount wird im winstrom-Element hinzugefügt, um die Gesamtzahl der Datensätze zu enthalten.

Das gleiche Verfahren kann auf die JSON-Ausgabe angewendet werden. Dann wird "@rowCount": "457″ zur Ausgabe hinzugefügt.

Für die schnellstmögliche Flexi-Antwort empfehlen wir die Verwendung der Paginierung!

Eine weitere Optimierung kann darin bestehen, den Parameter add-row-count beim Laden zusätzlicher Seiten zu entfernen. Dies liegt daran, dass es nicht notwendig ist, jede Seite abzufragen, um zu sehen, ob sich diese Anzahl geändert hat. Außerdem ist das Abrufen dieser Nummer eine zusätzliche Abfrage an die Datenbank in ABRA Flexi, und jede unnötige zusätzliche Abfrage bedeutet eine Verzögerung.

Ein weiterer sehr wichtiger Parameter ist das Detail. Mit diesem Parameter können Sie beeinflussen, welche Eigenschaften einzelner Datensätze eines bestimmten Datensatzes in der Ausgabe vorhanden sein werden. Dies ist jedoch ein sehr umfangreiches Thema, so dass wir es in einem separaten Artikel in der Zukunft behandeln werden.
Die Dokumentation für jedes Detail ist auf der ABRA-Flexi-Websiteverfügbar.

In den meisten Fällen müssen die Datensätze, die ABRA Flexi zurückgibt, auch nach einer Eigenschaft sortiert werden. Warum sollen wir die Datensätze in unserer Anwendung sortieren, wenn ABRA Flexi dies für Sie erledigen kann?
Die Datensätze werden nach dem Order-Parametersortiert. Der Wert dieses Parameters ist die Eigenschaft, nach der Sie sortieren möchten.

Wenn Sie also den Parameter order=code zur URL hinzufügen, gibt das System Datensätze sortiert nach der Eigenschaft "Abkürzung" zurück. Die Datensätze werden in aufsteigender Reihenfolge sortiert.

Wenn Sie die Datensätze in absteigender Reihenfolge sortieren müssen (nützlich z. B. für die Sortierung nach Beträgen, die Rechnungen mit dem höchsten Wert stehen dann ganz oben), fügen Sie @D hinter dem Eigenschaftsnamen ein

Die Sortierung nach mehreren Werten erfolgt durch wiederholte Verwendung des Parameters order. Dann kommt es auch auf die Reihenfolge an, in der die Auftragsparameter in die URL eingefügt werden.

In diesem Beispiel werden die Verzeichnisdatensätze zuerst nach Bundesland geordnet zurückgegeben, und wenn das Bundesland gleich ist, werden die Datensätze nach Abkürzung geordnet.

Eine Abfrage mit Sortierung zuerst nach Abkürzung und dann nach Bundesland liefert natürlich unterschiedliche Ergebnisse.

DerAuftragsparameter kann auch direkt in der ABRA Flexi-Web-Oberfläche verwendet werden.

ABRA Flexi erlaubt viele weitere Parameter in der URL. Ihre vollständige Liste finden Sie auf der Seite URL-Build, daher werden wir nur die wichtigsten und am häufigsten verwendeten erwähnen.

Logische Parameter mit den möglichen Werten true / false können durch einfache Angabe des Parameters (d. h. mit einem leeren Wert) aktiviert werden. Zum Beispiel kann ?no-ids=true als einfaches ?no-ids abgekürzt werden.

nur-ext-ids

Flexi gibt für jedes Objekt Bezeichner aus.
Wenn dieser Parameter verwendet wird, werden nur externe Objektbezeichner ausgegeben.

In diesem Fall sind also die internen Bezeichner von ABRA Flexi verschwunden und nur die externen Bezeichner für die Datensätze, die sie enthalten, sind in der Ausgabe enthalten.

no-ext-ids

Das Gegenteil des vorherigen Parameters ist der Parameter no-ext-ids. Wenn dieser Parameter verwendet wird, gibt es keine externen Bezeichner in der Ausgabe. Der Parameter no-ext-ids wird hauptsächlich verwendet, um den Datenabruf aus ABRA Flexi zu beschleunigen. Jeder Versuch, externe Bezeichner abzurufen, verlangsamt die Ausgabe.

no-ids

Ähnlich wie der vorherige Parameter, aber es werden keine internen ABRA-Flexi-Kennungen in der Ausgabe erscheinen. So können z. B. externe Bezeichner weiterhin angezeigt werden.

Der Parameter no-ids=true wirkt sich auf den Export auf allen Ebenen aus, also auch auf Dokumentelemente und eingebettete Links.

kommentarlos

Es wurde ein neuer logischer Parameter no-comments hinzugefügt, um Kommentare in der XML-Ausgabe zu unterdrücken.

mode=einfach

Neuer Exportmodus"simple"(?mode=simple), der eine minimalistische Ausgabe ohne ref- und showAs-Attribute und im Falle von XML ohne erklärende Kommentare erzeugt.

code-as-id

Mit diesem Parameter wird ein Kürzel als Bezeichner anstelle der internen ABRA-Flexi-Bezeichner für Datensätze ausgegeben, die es unterstützen.

Dieser Parameter kann in Kombination mit no-ids verwendet werden, um Datenübertragungen zwischen Unternehmen in Flexi zu sichern. Wenn Sie z. B. ein Verzeichnis von Firma A nach Firma B übertragen müssen, verwenden Sie am besten den Export über REST-API, von Firma A und den Import nach Firma B. Die URL zum Abrufen des Verzeichnisses würde z. B. wie folgt aussehen: