Changing tag information of a tag¶

Note

The body must include the attributes id and modified to identify the corresponding entry.

Note

The ID of the entry in the path of the request must match the value of the attribute id in the body.

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

Description¶

The Change-Tag-Information request allows the user to change the content of a tag information of the organisation.

Requirements¶

Values of the request: Tag-ID {id}, Information-Tag-ID {id}

Objects: TagInformationVO

Request¶

To change a tag information, the Tag-ID {id} and the Information-Tag-ID {id} need to be added to the path of the HTTP request.

For a detailed specification of which information is required to change a tag information, the object TagInformationVO with the following attributes needs 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`
`id`	The ID of the tag information.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`

The system returns the object TagInformationVO with the changed information.

Example¶

Example request body:

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

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
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.