GET api/Tickets/GetTags/{id}?pageIndex={pageIndex}&pageSize={pageSize}

Gets a list of all Ticket's Tags. Pagination is supported.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Ticket id

integer

Required

pageIndex

Optional page index (default is 0).

integer

None.

pageSize

Optional page size (default is 200).

integer

None.

Body Parameters

None.

Response Information

Resource Description

GetTagsResult
NameDescriptionTypeAdditional information
PagedTags

A page with tags.

TagData

None.

Response Formats

application/json, text/json

Sample:
{
  "PagedTags": {
    "PageIndex": 0,
    "PageSize": 200,
    "TotalItems": 2,
    "TotalPages": 1,
    "Items": [
      {
        "Id": 1,
        "Name": "Sample tag",
        "Static": true,
        "Color": "#ffffff",
        "Type": 1
      },
      {
        "Id": 2,
        "Name": "Sample 2",
        "Static": true,
        "Color": "#fafafa",
        "Type": 2
      }
    ]
  }
}

application/xml, text/xml

Sample:
<GetTagsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedTags>
    <Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
      <d3p1:TagData>
        <d3p1:Color>#ffffff</d3p1:Color>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Name>Sample tag</d3p1:Name>
        <d3p1:Static>true</d3p1:Static>
        <d3p1:Type>Ticket</d3p1:Type>
      </d3p1:TagData>
      <d3p1:TagData>
        <d3p1:Color>#fafafa</d3p1:Color>
        <d3p1:Id>2</d3p1:Id>
        <d3p1:Name>Sample 2</d3p1:Name>
        <d3p1:Static>true</d3p1:Static>
        <d3p1:Type>UserAndCompany</d3p1:Type>
      </d3p1:TagData>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>200</PageSize>
    <TotalItems>2</TotalItems>
    <TotalPages>1</TotalPages>
  </PagedTags>
</GetTagsResult>