POST api/Tickets/GetTickets

Gets a list of Tickets visible to the user based on advanced filtering.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PageIndex	The requested page index	integer	None.
PageSize	The requested page size	integer	None.
Closed	Filter by final workflow state as follows: null = all; false = not closed only; true = closed only	boolean	None.
ViewId	Filter by View, if set	integer	None.
Archived	Filter by archive as follows: null = all; false = active only; true = archive only. If the ViewId is set, this will be ignored, because the View determines the archive.	boolean	None.
TicketType	Filter by the type of ticket, if set	TicketTypeEnum	None.
ServiceId	Filter by Service, if set	integer	None.
CustomerId	Filter by Customer, if set	integer	None.
CreatedFromUtc	Filter by date of the creation - from.	date	None.
CreatedUntilUtc	Filter by date of the creation - until.	date	None.
OnlyUnread	Filter by read ticket	boolean	None.
SubmitterProviderKey	Filter by submitter key	string	None.
SolverProviderKey	Filter by solver key	string	None.
LastActivityDateFromUtc	Filter by date of the last ticket update - from.	date	None.
LastActivityDateUntilUtc	Filter by date of the last ticket update - until.	date	None.
CategoryItemId	Filter by category item id	integer	None.
HasJiraTickets	Filter by having links to Jira's tickets as follows: null = all; false = without Jira's tickets; true = with Jira's tickets	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "PageIndex": 0,
  "PageSize": 200,
  "Closed": false,
  "ViewId": null,
  "Archived": null,
  "TicketType": null,
  "ServiceId": null,
  "CustomerId": null,
  "CreatedFromUtc": null,
  "CreatedUntilUtc": null,
  "OnlyUnread": null,
  "SubmitterProviderKey": null,
  "SolverProviderKey": null,
  "LastActivityDateFromUtc": null,
  "LastActivityDateUntilUtc": null,
  "CategoryItemId": null,
  "HasJiraTickets": null
}

application/xml, text/xml

Sample:

<TicketsFilterPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <Archived i:nil="true" />
  <CategoryItemId i:nil="true" />
  <Closed>false</Closed>
  <CreatedFromUtc i:nil="true" />
  <CreatedUntilUtc i:nil="true" />
  <CustomerId i:nil="true" />
  <HasJiraTickets i:nil="true" />
  <LastActivityDateFromUtc i:nil="true" />
  <LastActivityDateUntilUtc i:nil="true" />
  <OnlyUnread i:nil="true" />
  <PageIndex>0</PageIndex>
  <PageSize>200</PageSize>
  <ServiceId i:nil="true" />
  <SolverProviderKey i:nil="true" />
  <SubmitterProviderKey i:nil="true" />
  <TicketType i:nil="true" />
  <ViewId i:nil="true" />
</TicketsFilterPost>

Response Information

Resource Description

GetTicketsResult

Name	Description	Type	Additional information
PagedTickets	A page with Ticket rows.	TicketRow	None.

Response Formats

application/json, text/json

Sample:

{
  "PagedTickets": {
    "PageIndex": 0,
    "PageSize": 200,
    "TotalItems": 1028,
    "TotalPages": 6,
    "Items": [
      {
        "TicketId": 168,
        "TicketType": 1,
        "TicketREF": "TIC-000168",
        "Subject": "Toner for printer is needed",
        "CreatedUTC": "2024-04-28T01:03:39.4811403Z",
        "Unread": true,
        "Closed": false,
        "ClosedUTC": null,
        "SubmitterKey": "3a86d0fe-a68d-4e07-aa25-2b1bfa2994ce",
        "SubmitterFullName": "John Doe",
        "SubmitterCompany": null,
        "SolverKey": null,
        "SolverFullName": null,
        "TicketState": 101,
        "TicketSummaryState": 1,
        "Source": 1,
        "TicketUserSourceId": 0,
        "ServiceId": 2,
        "ServiceName": "Supply material",
        "MarkedAsSolvedUTC": null,
        "DeadlineUTC": null,
        "UserMessagesCount": 2,
        "AttachmentsCount": 0,
        "FirstMessage": null,
        "Priorities": null,
        "CustomForms": null,
        "Tags": [
          {
            "Id": 1,
            "Name": "Sample tag",
            "Static": true,
            "Color": "#ffffff",
            "Type": 1
          },
          {
            "Id": 2,
            "Name": "Sample 2",
            "Static": true,
            "Color": "#fafafa",
            "Type": 1
          }
        ],
        "VotesCount": 0,
        "StickyNotesCount": 0,
        "SelectedCategories": null,
        "LastActivityDateUTC": "2024-04-28T01:53:39.4811403Z",
        "CustomerId": null,
        "Invitations": null,
        "Satisfactions": null,
        "TicketRelations": null,
        "ProductItems": null,
        "ServiceMailboxId": null
      },
      {
        "TicketId": 143,
        "TicketType": 2,
        "TicketREF": "INC-000047",
        "Subject": "My Mac is very slow",
        "CreatedUTC": "2024-04-27T09:03:39.4811403Z",
        "Unread": false,
        "Closed": false,
        "ClosedUTC": null,
        "SubmitterKey": "e8fb6a2e-fe57-4ae7-96bc-b2203820a96a",
        "SubmitterFullName": "Jane Doe",
        "SubmitterCompany": null,
        "SolverKey": "05d1c3f2-1cea-4ecd-ad9c-8029ff19a78f",
        "SolverFullName": "Handyman",
        "TicketState": 205,
        "TicketSummaryState": 6,
        "Source": 2,
        "TicketUserSourceId": 0,
        "ServiceId": 1,
        "ServiceName": "IT support",
        "MarkedAsSolvedUTC": null,
        "DeadlineUTC": null,
        "UserMessagesCount": 2,
        "AttachmentsCount": 1,
        "FirstMessage": null,
        "Priorities": null,
        "CustomForms": null,
        "Tags": null,
        "VotesCount": 0,
        "StickyNotesCount": 0,
        "SelectedCategories": null,
        "LastActivityDateUTC": "2024-04-27T10:33:39.4811403Z",
        "CustomerId": null,
        "Invitations": null,
        "Satisfactions": [
          {
            "SatisfactionId": 1,
            "CompletedUtc": "2024-04-27T10:33:39.4811403Z",
            "EmailWasSent": true,
            "IsCompleted": false,
            "Text": null,
            "UserProviderKey": null,
            "Value": 1.0
          }
        ],
        "TicketRelations": null,
        "ProductItems": null,
        "ServiceMailboxId": null
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GetTicketsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedTickets>
    <Items>
      <GetTicketsResult.TicketRow>
        <AttachmentsCount>0</AttachmentsCount>
        <Closed>false</Closed>
        <ClosedUTC i:nil="true" />
        <CreatedUTC>2024-04-28T01:03:39.4811403Z</CreatedUTC>
        <CustomForms i:nil="true" />
        <CustomerId i:nil="true" />
        <DeadlineUTC i:nil="true" />
        <FirstMessage i:nil="true" />
        <Invitations xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <LastActivityDateUTC>2024-04-28T01:53:39.4811403Z</LastActivityDateUTC>
        <MarkedAsSolvedUTC i:nil="true" />
        <Priorities i:nil="true" />
        <ProductItems xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <Satisfactions xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <SelectedCategories xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <ServiceId>2</ServiceId>
        <ServiceMailboxId i:nil="true" />
        <ServiceName>Supply material</ServiceName>
        <SolverFullName i:nil="true" />
        <SolverKey i:nil="true" />
        <Source>Web</Source>
        <StickyNotesCount>0</StickyNotesCount>
        <Subject>Toner for printer is needed</Subject>
        <SubmitterCompany i:nil="true" />
        <SubmitterFullName>John Doe</SubmitterFullName>
        <SubmitterKey>3a86d0fe-a68d-4e07-aa25-2b1bfa2994ce</SubmitterKey>
        <Tags xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
          <d5p1:TagData>
            <d5p1:Color>#ffffff</d5p1:Color>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Name>Sample tag</d5p1:Name>
            <d5p1:Static>true</d5p1:Static>
            <d5p1:Type>Ticket</d5p1:Type>
          </d5p1:TagData>
          <d5p1:TagData>
            <d5p1:Color>#fafafa</d5p1:Color>
            <d5p1:Id>2</d5p1:Id>
            <d5p1:Name>Sample 2</d5p1:Name>
            <d5p1:Static>true</d5p1:Static>
            <d5p1:Type>Ticket</d5p1:Type>
          </d5p1:TagData>
        </Tags>
        <TicketId>168</TicketId>
        <TicketREF>TIC-000168</TicketREF>
        <TicketRelations xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <TicketState>TicketInQueue</TicketState>
        <TicketSummaryState>Registered</TicketSummaryState>
        <TicketType>EndUserTicket</TicketType>
        <TicketUserSourceId>0</TicketUserSourceId>
        <Unread>true</Unread>
        <UserMessagesCount>2</UserMessagesCount>
        <VotesCount>0</VotesCount>
      </GetTicketsResult.TicketRow>
      <GetTicketsResult.TicketRow>
        <AttachmentsCount>1</AttachmentsCount>
        <Closed>false</Closed>
        <ClosedUTC i:nil="true" />
        <CreatedUTC>2024-04-27T09:03:39.4811403Z</CreatedUTC>
        <CustomForms i:nil="true" />
        <CustomerId i:nil="true" />
        <DeadlineUTC i:nil="true" />
        <FirstMessage i:nil="true" />
        <Invitations xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <LastActivityDateUTC>2024-04-27T10:33:39.4811403Z</LastActivityDateUTC>
        <MarkedAsSolvedUTC i:nil="true" />
        <Priorities i:nil="true" />
        <ProductItems xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <Satisfactions xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
          <d5p1:SatisfactionData>
            <d5p1:CompletedUtc>2024-04-27T10:33:39.4811403Z</d5p1:CompletedUtc>
            <d5p1:EmailWasSent>true</d5p1:EmailWasSent>
            <d5p1:IsCompleted>false</d5p1:IsCompleted>
            <d5p1:SatisfactionId>1</d5p1:SatisfactionId>
            <d5p1:Text i:nil="true" />
            <d5p1:UserProviderKey i:nil="true" />
            <d5p1:Value>1</d5p1:Value>
          </d5p1:SatisfactionData>
        </Satisfactions>
        <SelectedCategories xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <ServiceId>1</ServiceId>
        <ServiceMailboxId i:nil="true" />
        <ServiceName>IT support</ServiceName>
        <SolverFullName>Handyman</SolverFullName>
        <SolverKey>05d1c3f2-1cea-4ecd-ad9c-8029ff19a78f</SolverKey>
        <Source>Email</Source>
        <StickyNotesCount>0</StickyNotesCount>
        <Subject>My Mac is very slow</Subject>
        <SubmitterCompany i:nil="true" />
        <SubmitterFullName>Jane Doe</SubmitterFullName>
        <SubmitterKey>e8fb6a2e-fe57-4ae7-96bc-b2203820a96a</SubmitterKey>
        <Tags xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <TicketId>143</TicketId>
        <TicketREF>INC-000047</TicketREF>
        <TicketRelations xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <TicketState>IncidentAnalyzed</TicketState>
        <TicketSummaryState>SolutionApproved</TicketSummaryState>
        <TicketType>Incident</TicketType>
        <TicketUserSourceId>0</TicketUserSourceId>
        <Unread>false</Unread>
        <UserMessagesCount>2</UserMessagesCount>
        <VotesCount>0</VotesCount>
      </GetTicketsResult.TicketRow>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>200</PageSize>
    <TotalItems>1028</TotalItems>
    <TotalPages>6</TotalPages>
  </PagedTickets>
</GetTicketsResult>