Copying a tag¶

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 values of these attributes are set by the system after the tag is created.

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

Description¶

The Copy-Tag request allows the user to copy a tag of the organisation and assign it to one or more domains and subdomains.

Requirements¶

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

Objects: TagVO, TagAssignmentVOgAssignmentVO

Request¶

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

Optionally, the objects TagVO and TagAssignmentVO can be added to the body of the Copy-Tag request to change the name or adjust the assigned domains or subdomains.

If the objects TagVO and TagAssignmentVO are not sent with the request, the system only creates a copy of the tag and adds(Copy) to the name of the copied tag.

The following attributes for the objects TagVO and TagAssignmentVO are optional:

TagVO¶

Attributes	Description	Values
`name`	The name of the tag.	`string`
`assignments`	One or more objects `TagAssignmentVO`.
`label`	A keyword for the tag.	`string`
`comment`	An individual comment for the entry.	`string`

TagAssignmentVO¶

Attributes	Description	Values
`type`	The type of the tag assignment.	`DOMAIN` `SUBDOMAIN`
`subDomainName`	The name of the subdomain, if the value of the attribute `type` is `SUBDOMAIN`.	`string`
`title`	The title of the tag assignment.	`string`
`comment`	An individual comment for the entry.	`string`

The system responds by returning the objects TagVO and TagAssignmentVO with the information about the new entry.

Example¶

Example request body:

{
  "name": "string",
  "assignments": "string",
  "label": "string",
  "comment": "string",
  "type": "DOMAIN",
  "subDomainName": "string",
  "title": "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.