Working with Tags

Tags is one string which contains all the Tags of the entity combined together (separated by comma).
TagObjects is an array which contains all the Tags of the entity separately.

Select Tags

/api/v2/bugs?select={id,name,tags}

{
  "items": [
    {
      "id": 6366,
      "name": "Cleanup Sample Data link",
      "tags": "po"
    },
        {
      "id": 4613,
      "name": "Critical issue",
      "tags": "Hotfix 4, 4.0.12"
    }
  ]
}

/api/v2/bugs?select={id,name,tagobjects}

{
  "items": [
    {
      "id": 6366,
      "name": "Cleanup Sample Data link",
      "tagObjects": {"items":[{"resourceType":"Tag","id":22,"name":"po"}]}
    },
        {
      "id": 4613,
      "name": "Critical issue",
      "tagObjects": {"items":[{"resourceType":"Tag","id":99,"name":"Hotfix 4"},{"resourceType":"Tag","id":101,"name":"4.0.12"}]}
    }
  ]
}

Filters by Tags

These filters are helpful when you set up a view with General entities (such as User Stories, Tasks, Bugs, Requests, Features, Epics, Releases, Sprints (Iterations), Projects etc.) and the assigned Tags they have.

Entity

Filter

Result

General

where=(TagObjects.Count==0)

Entities with no tags assigned

General

where=(TagObjects.Count>0)

Entities having at least one tag assigned

General

where=(TagObjects.Count(Name=='plugin')>0)

Entities with “plugin” tag. The tag should contain exactly this single word

General

where=(TagObjects.Count(Name=='plugin')==0)

Negative filter. Entities with no “plugin” tag.

It is also possible to filter parent entities by tags assigned to parent entities. Say you can show a feature if a parent epic of this feature has been tagged with a specific tag.

Entity

Filter

Result

Feature

where=(Epic.TagObjects.Count(Name=='plugin')>0)

Features that are parts of Epics with “plugin” tag