Adding tag information¶

Note

If the optional attributes are not set, the system adds a default value.

Note

The body does not contain the attributes id, created, and modified. The system sets the values of these attributes after the entry is created.

Sends a POST request to the endpoint /tags/{tagId}/information.

Description¶

The Add-Tag-Information request allows the user to add one or more tags for adding global comments to your domains or subdomains of the organisation.

Requirements¶

Values of the request: Tag-ID {id}d}

Objects: TagInformationVO

Request¶

To add a tag information to a tag, the Tag-ID {id} needs to be added to the path of the HTTP request.

For a detailed specification of which information is required to add tag information, one or more objects TagInformationVO with the following attributes need to be defined in the body:

Attributes	Description	Values
`key`	The name of the key.	`string`
`value`	The value of the key.	`string`
`comment`	An individual comment for the entry.	`string`

The system responds by returning the object TagInformationVO with the information about the new entry.

Example¶

Example request body:

{
  "objectType": "string",
  "key": "string",
  "value": "string",
  "comment": "string"
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
201	The request has succeeded and a new object has been created.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.