Searching RT

  purl = FALSE,
  eval = FALSE

Searching through RT requires some knowledge of how RT does queries. This vignette provides a basic introduction to RT's query syntax and some examples of how to make queries with this package. Best Practical's Query Builder documentation and Ticket SQL wiki page highlight some of the key aspects of query-building and are useful to reference while learning.

Writing a query

The rt_ticket_search function makes it easy to search through your tickets. These are the fields that it will return by default, and that you can use to search with:

c("AdminCc", "Created", "Creator", "Due", "FinalPriority", "id", "InitialPriority", "LastUpdated", "Owner", "Priority", "Queue", "Requestors", "Resolved", "Started", "Starts", "Status", "Subject", "TimeEstimated", "TimeLeft", "TimeWorked", "Told", "CF.{NAME_OF_CUSTOM_FIELD}")

There are additional queryable fields such as FileName, ContentType, and Content, Requestor.Name that you can explore in the Query Builder (Search --> Tickets --> New Search).

These fields are some of the most commonly queried:

To build a query, you'll want to use the following vocabulary:

Example queries

To search for all tickets in the "General" queue, we'd run the following:

result <- rt_ticket_search("Queue = 'General'")

Note that, by default, rt_ticket_search returns a data.frame or tibble (if installed).

You can search against multiple fields using AND or OR to combine them.

rt_ticket_search("Queue = 'General' AND Subject LIKE 'test'")

Use parentheses to group query parameters together for more advanced logic.

rt_ticket_search("(Status = 'new' OR Status = 'open') AND Queue = 'General'")

For numeric and date/time fields, you can use >, >=, <, and <= in addition to =.

rt_ticket_search("Started > '2018-04-04'")

You can also use special date syntax for more options.

rt_ticket_search("Created >= '2 days ago'")

One of the most common use-cases is searching through RT ticket content. Note that this will only work if your RT installation has full text indexing turned on.

result <- rt_ticket_search("Content LIKE 'Can you please advise'")

Try the rt package in your browser

Any scripts or data that you put into this service are public.

rt documentation built on May 15, 2021, 9:06 a.m.