Eine benutzerdefinierte Konfiguration ändern¶

Note

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

Warning

Die optionalen Attribute werden zurückgesetzt, wenn sie nicht mitgesendet werden. Ein Eintrag behält seine Ticketnummer, seine Beschreibung, seinen Freigabestatus und seine Subdomain nur, wenn die Anfrage sie wiederholt.

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

Beschreibung¶

Mit der Change-Custom-Configuration-Anfrage ändert ein Myra-Agent eine dokumentierte, vom Standard abweichende Einstellung einer Domain einer Kundin oder eines Kunden.

Voraussetzungen¶

Werte der Anfrage: Domain-ID {domainId}, Custom-Configuration-ID {id}

Objekte: CustomConfigurationVO

Anfrage¶

Um eine benutzerdefinierte Konfiguration zu ändern, fügen Sie die Domain-ID {domainId} und die Custom-Configuration-ID {id} dem Pfad der Anfrage hinzu.

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

Attribut	Beschreibung	Werte
`id`	Die ID des Eintrags. Sie muss mit der Custom-Configuration-ID im Pfad übereinstimmen.	`integer`
`modified`	Das Datum der letzten Änderung im ISO-8601-Format, mit dem der Eintrag gelesen wurde. Die Anfrage wird abgewiesen, wenn der Eintrag zwischenzeitlich geändert wurde.	`string($date-time)`
`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. In der Myra App trägt das Attribut die Bezeichnung Freigegeben.	`true` `false`
`subDomainName`	Verschiebt den Eintrag auf die angegebene Subdomain. Ohne dieses Attribut wird der Eintrag auf die Domain-Ebene verschoben. In der Myra App trägt das Attribut die Bezeichnung Subdomain.	`string`

Das System antwortet mit dem Objekt CustomConfigurationVO mit den geänderten Informationen.

Beispiel¶

Beispiel-Request-Body:

{
  "id": 0,
  "modified": "string",
  "type": "string",
  "name": "string",
  "value": "string",
  "description": "string",
  "ticketNumber": "string",
  "read": true,
  "subDomainName": "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.