7.2.1.12. Issue Tags API

Endpoints

GET

/api/projects/{projectName}/issues/{issueIdentifier}/tags

Get Issue Tags

PUT

/api/projects/{projectName}/issues/{issueIdentifier}/tags/{tag}

Tag an Issue

DELETE

/api/projects/{projectName}/issues/{issueIdentifier}/tags/{tag}

Untag an Issue
GET /api/projects/{projectName}/issues/{issueIdentifier}/tags

Get Issue Tags.

Gets a list of tags for of a specific Issue The list contains the tags available for the issue with the ones that are actually set on the issue being marked using the selected field. In the Python API this functionality is provided by axivion.dashboard.Project.get_issue_tags().

Parameters:

  • projectName – path

    The project name

  • issueIdentifier – path

    The ID of the Issue, e.g. MV26 or SV2

Status Codes:
PUT /api/projects/{projectName}/issues/{issueIdentifier}/tags/{tag}

Tag an Issue.

Adds the Tag {tag} to the issue identified by {issueIdentifier}.

Tags are case-insensitive. Valid tag names may contain letters from the latin1 alphabet as well as the underscore and digits (except in the first position). Adding an already existing tag is a no-op.

In the Python API this functionality is provided by axivion.dashboard.Project.tag_issue().

Status Codes:
DELETE /api/projects/{projectName}/issues/{issueIdentifier}/tags/{tag}

Untag an Issue.

Removes the Tag {tag} from the issue identified by {issueIdentifier}.

Removing a non-existing tag is a no-op.

In the Python API this functionality is provided by axivion.dashboard.Project.untag_issue().

Status Codes:

Types

IssueTagTypeList

List of Issue Tag Types

IssueTagType

Describes an issue tag as returned by the Issue-Tags API
IssueTagTypeList

List of Issue Tag Types.

Properties:

  • tags (array) Element Type: IssueTagType. Result when querying tags of a given issue

IssueTagType

Describes an issue tag as returned by the Issue-Tags API.

Properties:

  • id (string) A canonicalized variant of the tag name that can be used for client-side equality checks and sorting.

  • text (string) DEPRECATED. Deprecated since 6.9.0, use tag instead.

  • tag (string) Since 6.9.0. Use this for displaying the tag

  • color (string) An RGB hex color in the form #RRGGBB directly usable by css.

    The colors are best suited to draw a label on bright background and to contain white letters for labeling.

  • description (string) The description of the tag. It can be assumed to be plain text with no need for further syntactic interpretation.

  • selected (boolean) Whether the tag is attached to the issue or only proposed.