Anforderungsparameter

Online bearbeiten

Das Dokument beschreibt die verschiedenen Anfrageparameter, die bei einem API-Aufruf für einen API-Endpunkt oder eine Zielressource definiert werden müssen.

Abhängig von dem API-Endpunkt oder der Zielressource müssen Sie gegebenenfalls die folgenden Parameter in Ihrem API-Anforderungsaufruf definieren:
Formulardaten
Verwenden Sie die folgenden Parameter, um ein Zugriffstoken anzufordern, das Ihr Client für nachfolgende API-Anforderungsaufrufe benötigt:
Tabelle 1. Formularparameter
Parameter Beschreibung
client_id Die Client-ID, die dem API-Client zugeordnet ist.
client_secret Der geheime Clientschlüssel, der dem API-Client zugeordnet ist.
grant_type Dieser Parameter ist auf client_credentials gesetzt.
scope Eine Liste mit durch Leerzeichen getrennten Bereichen, die diesem Token zugeordnet sind. Der gültige Bereich für API-Clients ist openid.
Header
Verify erfordert die folgenden Angaben im Header „ HTTP “:
Tabelle 2. Kopfzeilenparameter
Parameter Beschreibung
Content Type

In einem Anforderungsheader gibt dieser Parameter den Typ der Daten an, die der Client an den Server gesendet hat. In einem Antwortheader gibt er den Typ der Daten an, die an den Client zurückgegeben werden.

Beispiel:
-H "Content-type: application/json"
Accept

Dieser Parameter gibt den Typ des Inhalts an, den der Client in einer Antwort interpretieren und akzeptieren kann.

Beispiel:
-H "Accept: application/json"
-H "Accept: image/png"
Location Die URL des neu erstellten Objekts in der Kopfzeile der POST-HTTP-Methode. Beispiel: /<resource-noun>/<resource-id>.
Accept-Language Die Sprache, die der Client versteht oder bevorzugt.
Abfrageparameter
Die folgenden Parameter sind, abhängig davon, welche Ergebnisse Ihrer API-Anforderung zurückgegeben werden sollen, und abhängig davon, wie sie zurückgegeben werden sollen, optional.
Tabelle 3. Abfrageparameter
Parameter Beschreibung
pagination
Wenn keine Paginierungsparameter übergeben werden, werden alle Ergebnisse zurückgegeben. Der maximal zulässige Wert für "limit" oder "count" ist 1000.
  • count ist die Gesamtzahl Ergebnisse, die aus dem Datenspeicher zurückgegeben werden sollen.
  • page ist angeforderte Seite.
  • limit ist die Gesamtzahl Ergebnisse, die auf einer einzelnen Seite zurückgegeben werden sollen.
sort

Jedem Attribut muss entweder das Präfix + (aufsteigend) oder - (absteigend) hinzugefügt werden.

Mehrere Attribute müssen jeweils durch ein Komma (,) voneinander getrennt werden.
search
Gültige Operatoren sind:
  • Zeichenfolgen sind = , != und contains
  • Boolesche Werte sind = und !=
  • Die Zahlen sind >=, >, <=, <, =, und !=
filter Gültige Formate sind entweder ausschließlich inklusiv oder ausschließlich exklusiv. Mehrere Filterparameter müssen jeweils durch ein Komma (,) voneinander getrennt werden.
Body

Verwenden Sie diesen Parameter für Anforderungen POST, PUT und PATCH. Definieren Sie hier die Attribute und Werte, die erstellt oder aktualisiert werden sollen. Klicken Sie auf den Datentyp Modell oder Beispielwert, um die Attribute anzuzeigen, die im Hauptteil definiert werden müssen, einschließlich des Formats und des Beispielwerts.

Der Parameter content type ist application/json. Der Inhalt wird im JSON-Dateiformat gespeichert.