Get Tag By Name

GET /rest/asset/v1/tagType/byName.json

Retrieves a tag by its name. This will also return the set of valid values for the tag.

Operation ID: getTagByNameUsingGET
Permissions: Read-Only Assets, Read-Write Assets
Request format: application/json
Returns: ResponseOfTagResponse

Parameters

Query 1

name string required

Name of the tag

Responses

200 OK ResponseOfTagResponse

errors array of Error

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

requestId string

result array of TagResponse

Model TagResponse

allowableValues string

The list of acceptable values for the tag type

applicableProgramTypes string required

Types of programs to which the tag can apply

required boolean required

Whether the tag is required for its applicable program types

tagType string required

Name of the tag

success boolean

warnings array of string

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "requestId": "123",
  "result": [
    {
      "allowableValues": "string",
      "applicableProgramTypes": "string",
      "required": true,
      "tagType": "string"
    }
  ],
  "success": true,
  "warnings": [
    "string"
  ]
}

Referenced models

Generated from swagger-asset.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.