GET api/tag/{name}

Get a tag by its name Processes this tag API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

The name of the tag to get. Pass null to be returned an empty data contract.

string

Required

Body Parameters

None.

Response Information

Resource Description

The tag or null if it does not exist

TagDataContract
NameDescriptionTypeAdditional information
Name

The name value.

string

None.

SystemStatusName

The system status name value.

string

None.

TagType

The tag type value.

EnumDataContract

None.

Id

The unique identifier of this resource.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "SystemStatusName": "sample string 2",
  "TagType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Id": 3
}