Eine benutzerdefinierte Konfiguration abrufen¶
Note
Ein Eintrag, den Myra nicht für die Kundin oder den Kunden freigegeben hat, und ein Eintrag, der zu einer anderen Domain gehört, werden beide mit dem HTTP-Code 403 beantwortet.
Senden einer GET-Anfrage an den Endpunkt /domain/{domainId}/custom-configurations/{id}.
Beschreibung¶
Mit der Get-Custom-Configuration-Anfrage rufen Sie eine einzelne benutzerdefinierte Konfiguration ab, die Myra für eine Domain der Organisation eingerichtet hat.
Voraussetzungen¶
Werte der Anfrage: Domain-ID {domainId}, Custom-Configuration-ID {id}
Objekte: keine
Anfrage¶
Um eine benutzerdefinierte Konfiguration abzurufen, fügen Sie die Domain-ID {domainId} und die Custom-Configuration-ID {id} dem Pfad der Anfrage hinzu.
Als Ergebnis erhalten Sie ein Objekt CustomConfigurationVO mit den angefragten Informationen.
Das Objekt liefert die folgenden Informationen:
| Attribut | Beschreibung | Werte |
|---|---|---|
type |
Die Art der Einstellung, die der Eintrag beschreibt. In der Myra App trägt das Attribut die Bezeichnung Typ. |
|
name |
Der Name der Einstellung. In der Myra App trägt das Attribut die Bezeichnung Name. | string |
value |
Der Wert der Einstellung. Welcher Inhalt zulässig ist, hängt vom Typ ab. In der Myra App trägt das Attribut die Bezeichnung Wert. | string |
description |
Eine Erläuterung, warum die Einstellung vorgenommen wurde. In der Myra App trägt das Attribut die Bezeichnung Beschreibung. | string |
id |
Die ID des Eintrags. | integer |
modified |
Das Datum der letzten Änderung im ISO-8601-Format. | string($date-time) |
created |
Das Erstellungsdatum im ISO-8601-Format. | string($date-time) |
Beispiel¶
Beispiel-Antwort:
{
"objectType": "string",
"type": "string",
"name": "string",
"value": "string",
"description": "string",
"id": 0,
"modified": "string",
"created": "string"
}
Antworten¶
Die folgenden Antworten sind möglich:
| STATUSCODE | BESCHREIBUNG |
|---|---|
| 200 | Die Anfrage war erfolgreich. |
| 400 | Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen. |
| 401 | Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war. |
| 403 | Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen. |