Die Einstellungen eines Tags ändern¶
Note
Das Attribut type kann nicht geändert werden. Wenn Sie den Typ eines Tags ändern müssen, fügen Sie ein neues Tag hinzu.
Note
Der Body muss die Attribute id und modified enthalten, um den entsprechenden Eintrag zu identifizieren.
Note
Die ID des Eintrags im Pfad der Anfrage muss mit dem Wert des Attributs id im Body übereinstimmen.
Senden einer PUT-Anfrage an den Endpunkt /tags/{id}.
Beschreibung¶
Mit der Change-Tag-Settings-Anfrage ändern Sie die Einstellungen eines Tags der Organisation.
Voraussetzungen¶
Werte der Anfrage: Tag-ID {id}
Objekte: TagVO, TagAssignmentVO
Anfrage¶
Um die Einstellungen eines Tags zu ändern, fügen Sie die Tag-ID {id} dem Pfad der HTTP-Anfrage hinzu.
Für eine detaillierte Spezifikation, welche Informationen zum Ändern eines Tags erforderlich sind, müssen im Body die Objekte TagVO und TagAssignmentVO mit den folgenden Attributen definiert werden:
TagVO¶
| Attribut | Beschreibung | Werte |
|---|---|---|
assignments |
Ein Array von Tag-Zuweisungen. | TagAssignmentVO |
id |
Die ID des Tags. | integer |
modified |
Das Datum der letzten Änderung im ISO-8601-Format. | string($date-time) |
TagAssignmentVO¶
| Attribut | Beschreibung | Werte |
|---|---|---|
id |
Die ID der Tag-Zuweisung. | integer |
modified |
Das Datum der letzten Änderung im ISO-8601-Format. | string($date-time) |
Die folgenden Attribute sind optional:
TagVO¶
| Attribut | Beschreibung | Werte |
|---|---|---|
name |
Der Name des Tags. | string |
label |
Ein Schlagwort für das Tag. | string |
comment |
Ein individueller Kommentar für den Eintrag. | string |
TagAssignmentVO¶
| Attribut | Beschreibung | Werte |
|---|---|---|
type |
Der Typ der Tag-Zuweisung. |
|
subDomainName |
Der Name der Subdomain, wenn der Wert des Attributs type gleich SUBDOMAIN ist. |
|
title |
Der Titel der Tag-Zuweisung. | string |
comment |
Ein individueller Kommentar für den Eintrag. | string |
Das System gibt die Objekte TagVO und TagAssignmentVO mit den geänderten Informationen zurück.
Beispiel¶
Beispiel-Request-Body:
{
"objectType": "string",
"name": "string",
"type": "string",
"global": true,
"assignments": [
{
"objectType": "string",
"type": "string",
"subDomainName": "string",
"title": "string",
"comment": "string"
}
],
"organizationId": 0,
"sort": 0,
"comment": "string",
"label": "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. |