Business App Technisches Handbuch

4.9.5.1.1. Methode: POST

Syntax: POST /rest/v1/records/list/<ormType>

Dieser Aufruf dient dem Abruf einer Liste von Datensätzen des gegebenen Datentyps.

Parameter

Name Pflicht Beschreibung
ormType Ja Guid oder technischer Name einer Datentabelle (vgl. Benamung von CSV-Importdateien).
Beispiele für denselben Typen:
OrmUserProfile oder 4B00F31C-E05D-42EF-9172-64608316C4C3

Im Anfrageinhalt wird eine JSON-Struktur erwartet, welche die Erstellung der Liste steuern und parametrisieren kann.
Folgende Informationen sind Inhalt dieser Struktur:

Eigenschaft Beschreibung
Skip Diese Anzahl an Datensätzen ab dem Anfang der erstellten Liste überspringen (Paging-Unterstützung). Standardwert ist ‘0’, wenn nicht angegeben.
Take Diese Anzahl an Datensätzen ab dem Anfang (+ Skip) der erstellten Liste zurückliefern (Paging-Unterstützung). Standardwert ist ‘20’, wenn nicht angegeben. Maximalwert ist begrenzt auf 10000.
OrderBy Die Liste der Datensätze wird zunächst nach dieser Eigenschaft sortiert, bevor Skip und Take ausgewertet werden. Die zurückgegebene Liste ist daher nach dieser Eigenschaft sortiert. Wird dieser Parameter nicht angegeben, wird die Liste nach der Oid der Datensätze sortiert. Diese Sortierung wirkt dann zwar willkürlich, sie ist aber dennoch immer gleich, so lange keine neuen Datensätze hinzugefügt werden. Der Name der Eigenschaft orientiert sich an den von typeinfo gelieferten Informationen.
Include Liste von Feldnamen, die zurückgeliefert werden sollen (typeinfo). Ist dieser Parameter null werden die vollständigen Datensätze in der Liste zurückgegeben. Zusätzlich zu den beinhalteten Feldnamen werden immer die Felder ‘Oid’, ‘OrmType’ und ‘Common_EntityTitle’ als Minimalset zurückgeliefert. Sollte ein nicht existenter Feldname angegeben werden, so wird dieser ignoriert.
Filter Eine Formel, die geeignet ist, die Ergebnisliste einzugrenzen.

Beispiel (Abfrage auf Benutzerprofile):

{
    "Skip": 0,
    "Take": 20,
    "OrderBy": "LastName",
    "Include": [ "FirstName", "LastName" ],
    "Filter": "StartsWith([LastName], 'M')"
}

Mögliche Rückgabestatus

Status Beschreibung
200 OK Die gewünschten Daten wurden im Antwortinhalt übertragen.
304 Not modified Die angegebene Anfragebedingung wird nicht erfüllt.
400 Bad request
  • Der übergebene Wert für den Parameter ormType konnte nicht interpretiert werden oder identifiziert keinen gültigen Datentypen oder
  • die im Anfrageinhalt gesendete Parameterstruktur ist falsch und konnte nicht interpretiert werden.
403 Forbidden Der aktuelle Benutzer hat nicht die Berechtigung Datensätze des gegebenen Typs zu lesen.
500 Internal server error Bei der Verarbeitung kam es zu einem unvorhergesehenen Fehler.

Rückgabe

Der Antwortinhalt beinhaltet eine JSON-Struktur mit drei Eigenschaften: TotalCount, ReturnCount und Data.
TotalCount bezeichnet die Gesamtzahl der Datensätze, die für diese Anfrage gefunden wurden, ReturnCount ist dann die Anzahl, die tatsächlich zurückgeliefert wurde. Diese Zahlen können sich je nach Wahl des Parameters Take von einander unterscheiden.
Die Eigenschaft Data enthält eine Liste mit Objekten, die dem Ergebnis einer GET-Abfrage auf den record-Endpunkt ähneln, sie enthalten aber nur die im Parameter Include angegebenen und die Standardfelder.

Beispiel zu obiger Parametrisierung:

{
    "TotalCount": 2,
    "ReturnCount": 2,
    "Data": [
        {
            "Oid": "6a1ab622-2c16-4d80-a868-bfae0ccfaee7",
            "FirstName": "Max",
            "LastName": "Muster",
            "OrmType": {
                "Oid": "4b00f31c-e05d-42ef-9172-64608316c4c3",
                "Language_de": "Benutzerprofil",
                "Language_en": "User profile"
            },
            "Common_EntityTitle": "Max Muster"
        },
        {
            "Oid": "a8bffe71-52d4-4c92-b500-100dd326d377",
            "FirstName": "Sylvia",
            "LastName": "Muster",
            "OrmType": {
                "Oid": "4b00f31c-e05d-42ef-9172-64608316c4c3",
                "Language_de": "Benutzerprofil",
                "Language_en": "User profile"
            },
            "Common_EntityTitle": "Sylvia Muster"
        }
    ]
}