Business App Technisches Handbuch

4.9.3.1.1. Methode: GET

Syntax: GET /rest/v1/enum

Diese Syntax liefert eine Liste aller Auswahllisten ohne deren Werte zurück.

Mögliche Rückgabestatus

Status Beschreibung
200 OK Das Ergebnis der Anfrage wird im Antwortinhalt zurückgegeben.
304 Not modified Die angegebene Anfragebedingung wird nicht erfüllt.
500 Internal server error Bei der Verarbeitung kam es zu einem unvorhergesehenen Fehler.

Rückgabe

Die verwendete Syntax liefert eine Liste aller Auswahllisten zurück. Jedes Objekt dieser Liste hat folgende Eigenschaften:

Eigenschaft Beschreibung
Oid Die Guid der Auswahlliste.
Description Name / Beschreibung der Auswahlliste.
SortByText Ist true, wenn die Werte dieser Auswahlliste nach dem übersetzten Text und nicht nach der Sortierreihenfolge sortiert werden sollen.
Type Technischer Name der Auswahlliste ohne Namespace (z. B. EnumCountries)

Beispiel

[
    {
        "Oid": "e8b23720-0922-4598-b699-2e4d17c075e9",
        "Type": "EnumAttachmentState",
        "Description": "HasAttachment",
        "SortByText": false
    },
    {
        "Oid": "70032e01-4e3c-46e3-8fd0-abe8f573e874",
        "Type": "EnumDataSource",
        "Description": "Data sources",
        "SortByText": true
    },
...
]

 

Syntax: GET /rest/v1/enum/<master>

Diese Syntax liefert Informationen über die angegebene Auswahlliste und alle in der Auswahlliste beinhalteten Werte zurück.

Parameter

Name Pflicht Beschreibung
master Ja Beschränkt die Antwort auf eine bestimmte Auswahlliste. Es werden auch die Auswahllistenwerte zurückgegeben. Der angegebene Wert kann die Guid einer Auswahlliste (empfohlen) oder der technische Name (z. B. EnumCountries) sein.

Mögliche Rückgabestatus

Status Beschreibung
200 OK Das Ergebnis der Anfrage wird im Antwortinhalt zurückgegeben.
304 Not modified Die angegebene Anfragebedingung wird nicht erfüllt.
400 Bad request Es wurde eine leere Guid als Parameter angegeben.
404 Not found Die gewünschte Auswahlliste konnte anhand der angegebenen Id oder anhand des angegebenen Namens nicht ermittelt werden.
500 Internal server error Bei der Verarbeitung kam es zu einem unvorhergesehenen Fehler.

Rückgabe

Die verwendete Syntax liefert sowohl die oben beschriebenen Informationen über die Auswahlliste selbst also auch alle Auswahllistenwerte zurück.
Die Auswahllistenwerte beinhalten folgende Eigenschaften:

Eigenschaft Beschreibung
Oid Die Guid des Auswahllistenwerts.
SortOrder Sortierreihenfolge innerhalb der Auswahlliste.
Language_* Eine Eigenschaft pro im System konfigurierter Sprache, Suffix ist das Sprachkürzel (z. B. Language_en). Beinhaltet den Namen dieses Auswahllistenwerts in der entsprechenden Sprache.
(zusätzliche Werte) Die zusätzlichen programmierten Werte von Auswahllistenwerten mit ihrem technischen Eigenschaftsnamen wie zum Beispiel die Adressformatierung bei Ländern in der Länderliste.

Beispiel (EnumCountries)

{
    "Oid": "622f43ae-c80f-49bc-aefa-553ec320dbd4",
    "Type": "EnumCountries",
    "Description": "Countries",
    "SortByText": true,
    "Values": [
        {
            "Oid": "cde1db15-e786-4272-8296-97f1b4b32d20",
            "Language_de": "Afghanistan",
            "Language_en": "Afghanistan",
            "ISOCode": "AF",
            "FormatAddress": "{ Address }\\n{ AdditionalAddress1 }\\n{ City }\\n{ PostalCode }\\n{ Country }",
            "SortOrder": 0
        },
        {
            "Oid": "421e418a-c01e-43b8-8dc4-d58f075417b3",
            "Language_de": "Ägypten",
            "Language_en": "Egypt",
            "ISOCode": "EG",
            "FormatAddress": "{ Address }\\n{ AdditionalAddress1 }\\n{ State }\\n{ City }\\n{ PostalCode }\\n{ Country }",
            "SortOrder": 58
        },
...
    ]
}

 

Syntax: GET /rest/v1/enum/<master>/<value>

Diese Syntax liefert ausschließlich den Inhalt des einzelnen gewünschten Auswahllistenwertes.

Parameter

Name Pflicht Beschreibung
master Ja Beschränkt die Antwort auf eine bestimmte Auswahlliste. Der angegebene Wert kann die Guid einer Auswahlliste (empfohlen) oder der technische Name (z. B. EnumCountries) sein.
value Ja Liefert Informationen über einen bestimmten Auswahllistenwert zurück. Der angegebene Wert kann die Guid eines Auswahllistenwerts sein (empfohlen) oder eine beliebige aber vollständige Übersetzung eines der in der Auswahlliste beinhalteten Auswahllistenwerte. Der Vergleich erfolgt unabhängig von Groß- und Kleinschreibung.

Mögliche Rückgabestatus

Status Beschreibung
200 OK Das Ergebnis der Anfrage wird im Antwortinhalt zurückgegeben.
304 Not modified Die angegebene Anfragebedingung wird nicht erfüllt.
400 Bad request
  • Es wurde eine leere Guid als einer der Parameter angegeben oder
  • die angegebene Übersetzung ist innerhalb der ermittelten Auswahlliste nicht eindeutig (führt beispielsweise unter unterschiedlichen Übersetzungen zu unterschiedlichen Auswahllistenwerten).
404 Not found
  • Die gewünschte Auswahlliste konnte anhand der angegebenen Id oder anhand des angegebenen Namens nicht ermittelt werden oder
  • der gewünschte Auswahllistenwert konnte anhand der angegebenen Id oder anhand der angegebenen Übersetzung nicht ermittelt werden.
500 Internal server error Bei der Verarbeitung kam es zu einem unvorhergesehenen Fehler.

Rückgabe

Die verwendete Syntax liefert keine informationen über die Auswahlliste sondern ausschließlich die Inhalte des gewünschten Auswahllistenwerts zurüc:

Eigenschaft Beschreibung
Oid Die Guid des Auswahllistenwerts.
MasterEnumGuid Id der übergeordneten Auswahlliste.
Language_* Eine Eigenschaft pro im System konfigurierter Sprache, Suffix ist das Sprachkürzel (z. B. Language_en). Beinhaltet den Namen dieses Auswahllistenwerts in der entsprechenden Sprache.
(zusätzliche Werte) Die zusätzlichen programmierten Werte von Auswahllistenwerten mit ihrem technischen Eigenschaftsnamen wie zum Beispiel die Adressformatierung bei Ländern in der Länderliste.

Beispiel (EnumCountries/Egypt)

{
    "Oid": "421e418a-c01e-43b8-8dc4-d58f075417b3",
    "Language_de": "Ägypten",
    "Language_en": "Egypt",
    "ISOCode": "EG",
    "FormatAddress": "{ Address }\\n{ AdditionalAddress1 }\\n{ State }\\n{ City }\\n{ PostalCode }\\n{ Country }",
    "MasterEnumGuid": "622f43ae-c80f-49bc-aefa-553ec320dbd4"
}