Ein Tag hinzufügen¶
Note
Wenn die optionalen Attribute nicht gesetzt sind, setzt das System einen Standardwert ein.
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 /tags.
Beschreibung¶
Mit der Add-Tag-Anfrage fügen Sie der Organisation ein oder mehrere Tags hinzu.
Voraussetzungen¶
Werte der Anfrage: keine
Objekte: TagVO, TagAssignmentVO
Anfrage¶
Um ein Tag hinzuzufügen, müssen dem Pfad der HTTP-Anfrage keine weiteren Informationen hinzugefügt werden.
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 |
|---|---|---|
name |
Der Name des Tags. | string |
type |
Der Typ des Tags. |
|
assignments |
Ein oder mehrere Objekte TagAssignmentVO. |
TagAssignmentVO¶
| Attribut | Beschreibung | Werte |
|---|---|---|
type |
Der Typ der Tag-Zuweisung. |
|
subDomainName |
Der Name der Subdomain, wenn der Wert des Attributs type gleich SUBDOMAIN ist. |
string |
title |
Der Titel der Tag-Zuweisung. | string |
Die folgenden Attribute sind optional:
TagVO¶
| Attribut | Beschreibung | Werte |
|---|---|---|
label |
Ein Schlagwort für das Tag. | string |
comment |
Ein individueller Kommentar für den Eintrag. | string |
TagAssignmentVO¶
| Attribut | Beschreibung | Werte |
|---|---|---|
comment |
Ein individueller Kommentar für den Eintrag. | string |
Das System gibt als Antwort die Objekte TagVO und TagAssignmentVO mit den Informationen zum neuen Eintrag 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 |
|---|---|
| 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. |