Eine benutzerdefinierte Konfiguration hinzufügen¶

Note

Diese Anfrage steht ausschließlich Myra-Agents zur Verfügung.

Note

Eine Kombination aus Typ und Name ist je Bereich einmal möglich. Dieselbe Kombination kann auf der Domain und auf jeder ihrer Subdomains bestehen.

Note

Der Body enthält die Attribute id, created und modified nicht. Die Werte dieser Attribute werden vom System nach dem Erstellen des Eintrags gesetzt.

Senden einer POST-Anfrage an den Endpunkt /domain/{domainId}/custom-configurations.

Beschreibung¶

Mit der Add-Custom-Configuration-Anfrage dokumentiert ein Myra-Agent eine vom Standard abweichende Einstellung, die für eine Domain einer Kundin oder eines Kunden vorgenommen wurde.

Voraussetzungen¶

Werte der Anfrage: Domain-ID {domainId}

Objekte: CustomConfigurationVO

Anfrage¶

Um eine benutzerdefinierte Konfiguration hinzuzufügen, fügen Sie die Domain-ID {domainId} dem Pfad der Anfrage hinzu.

Für eine detaillierte Spezifikation, welche Informationen zum Hinzufügen einer benutzerdefinierten Konfiguration erforderlich sind, muss im Body das Objekt CustomConfigurationVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`type`	Die Art der Einstellung, die der Eintrag beschreibt. In der Myra App trägt das Attribut die Bezeichnung Typ.	`feature` `header` `ssl_cipher`
`name`	Der Name der Einstellung. In der Myra App trägt das Attribut die Bezeichnung Name.	`string`
`value`	Der Wert der Einstellung. Freier Text, es gilt keine Formatvorgabe. In der Myra App trägt das Attribut die Bezeichnung Wert.	`string`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`description`	Eine Erläuterung, warum die Einstellung vorgenommen wurde. In der Myra App trägt das Attribut die Bezeichnung Beschreibung.	`string`
`ticketNumber`	Das Ticket, in dem die Einstellung angefragt wurde. In der Myra App trägt das Attribut die Bezeichnung Ticket.	`string`
`read`	Gibt den Eintrag für die Kundin oder den Kunden frei. Bei `false` bleibt der Eintrag intern und die Kundin oder der Kunde sieht ihn weder in der Liste noch kann sie oder er ihn direkt abrufen. In der Myra App trägt das Attribut die Bezeichnung Freigegeben.	`true` `false`
`subDomainName`	Legt den Eintrag auf der angegebenen Subdomain statt auf der Domain an. Die Subdomain muss unter der Domain bestehen. In der Myra App trägt das Attribut die Bezeichnung Subdomain.	`string`

Das System antwortet mit dem Objekt CustomConfigurationVO mit den Informationen zum neuen Eintrag.

Beispiel¶

Beispiel-Request-Body:

{
  "type": "string",
  "name": "string",
  "value": "string",
  "description": "string",
  "ticketNumber": "string",
  "read": true,
  "subDomainName": "string"
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
201	Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt.
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.