Document toolboxDocument toolbox

Anfragebeispiele

Tools

CURL-Aufrufe

Aufruf

Kommentar

Aufruf

Kommentar

curl --location --request GET 'https://localhost:8087/api/v1.0/infrastructure/locations'
--header 'Authorization: Basic YWRtaW46YWRtaW4='

Bei jedem API-Aufruf mit Basic-Authentifizierung müssen Benutzername und Passwort im Header übergeben werden.

In den Anfrageheadern sehen Sie, dass der Autorisierungsheader der API einen Base64-kodierten String übergibt, der Ihre Benutzerdaten repräsentiert, angehängt an “Basic ”.

curl --location --request POST 'https://localhost:8087/api/v1.0/auth/login'
--header 'Content-Type: application/json'
--data-raw '{
"username": "MyUser",
"password": "MyPassword",
"forceIntegratedAuthentication": false
}'

POST Macht einen Login-Aufruf, es wird ein Schlüssel für die JWT-Authentifizierung zurückgegeben.

curl --location --request GET 'https://localhost:8087/api/v1.0/tags/tags'
--header 'Authorization: Bearer {token}'

GET Gibt alle Tags zurück unter Verwendung eines JWT- oder API-Schlüssels. Ersetzen Sie {token} durch einen zuvor generierten Schlüssel.

curl --location --request GET 'https://localhost:8087/api/v1.0/tags/tags?Page=1&PageSize=10'
--header 'Authorization: Bearer {token}'

GET Gibt alle Tags auf Seiten der Größe 10 zurück unter Verwendung eines JWT- oder API-Schlüssels. Ersetzen Sie {token} durch einen zuvor generierten Schlüssel.

curl --location --request GET 'https://localhost:8087/api/v1.0/tags/tags?Page=1&PageSize=10&Filter=Name@=Uni'
--header 'Authorization: Bearer {token}'

GET Gibt alle Tags gefiltert nach Namen auf Seiten der Größe 10 zurück unter Verwendung eines JWT- oder API-Schlüssels. Ersetzen Sie {token} durch einen zuvor generierten Schlüssel.

curl --location --request GET 'https://localhost:8087/api/v1.0/tags/tags?Page=1&PageSize=10&Filter=Name@=Uni&Sort=Id'
--header 'Authorization: Bearer {token}'

GET Gibt alle Tags gefiltert nach Namen und sortiert nach Id auf Seiten der Größe 10 zurück unter Verwendung eines JWT- oder API-Schlüssels. Ersetzen Sie {token} durch einen zuvor generierten Schlüssel.

curl --location --request GET 'https://localhost:8087/api/v1.0/tags/tags?Page=1&PageSize=10&Filter=Name@=Uni&Sort=Id&Fields=Id,Name'
--header 'Authorization: Bearer {token}'

GET Gibt die Felder Id und Name aller Tags gefiltert nach Namen und sortiert nach Id auf Seiten der Größe 10 zurück unter Verwendung eines JWT- oder API-Schlüssels. Ersetzen Sie {token} durch einen zuvor generierten Schlüssel.

curl --location --request POST 'https://localhost:8087/api/v1.0/infrastructure/locations/' --header 'Authorization: Bearer {token}'
--header 'Content-Type: application/json'
--data-raw ' {
"Name":"New Created Location",
"Street":"New Street",
"PostalCode":"NewZipCode",
"City":"New City",
"Country":"New Country",
"Description":"My Description",
"Url":"location.com",
"ExternalRef":"New External Ref"
}'

POST Erstellt einen neuen Standort unter Verwendung eines JWT- oder API-Schlüssels. Ersetzen Sie {token} durch einen zuvor generierten Schlüssel.

curl --location --request PATCH 'https://localhost:8087/api/v1.0/infrastructure/locations/6' --header 'Authorization: Bearer {token}'
--header 'Content-Type: application/json'
--data-raw '[
{
"op": "replace",
"path": "/Street",
"value": "Ritterstr. 12-14 Patched"
},
{
"op": "replace",
"path": "/Name",
"value": "Universität Patched"
}
]'

PATCH Aktualisiert den Namen und die Straße eines Standorts mittels JSON Patch unter Verwendung eines JWT- oder API-Schlüssels. Ersetzen Sie {token} durch einen zuvor generierten Schlüssel.

curl --location --request PUT 'https://localhost:8087/api/v1.0/infrastructure/locations/6' --header 'Authorization: Bearer {token}'
--header 'Content-Type: application/json'
--data-raw ' {
"Id":6,
"Name":"New Name",
"Street":"New Street",
"PostalCode":"NewZipCode",
"City":"New City",
"Country":"New Country",
"Description":"My Description",
"Url":"location.com",
"ExternalRef":"New External Ref"
}'

PUT Aktualisiert einen Standort durch Änderung des ganzen Objekts unter Verwendung eines JWT- oder API-Schlüssels. Ersetzen Sie {token} durch einen zuvor generierten Schlüssel.

curl --location --request DELETE 'https://localhost:8087/api/v1.0/infrastructure/rooms/269'
--header 'Authorization: Bearer {token}'

DEL Löscht einen Raum unter Verwendung eines JWT- oder API-Schlüssels. Ersetzen Sie {token} durch einen zuvor generierten Schlüssel.