Introduction to RT

Bryce Mecum

2021-06-04

Setup

To start using the rt package, log in to your RT instance by setting the server URL in using Sys.setenv and use rt_login() to log in and store your session locally.

Below, we log into Best Practical’s demo installation of RT:

library(rt)

Sys.setenv("RT_BASE_URL" = "https://demo.bestpractical.com")
rt_login() # Enter demo/demo

Once you are successfully logged in, you’re all set to use the package. The rt package supports all of the RequestTracker REST API:

• General
  • Login: rt_login()
  • Logout: rt_logout()
• Tickets
  • Ticket Properties: rt_ticket_properties()
  • Ticket Links: rt_ticket_links()
  • Ticket Attachments: rt_ticket_attachments()
  • Ticket Attachment: rt_ticket_attachment()
  • Ticket Attachment Content: rt_ticket_attachment_content()
  • Ticket History: rt_ticket_history()
  • Ticket History Entry: rt_ticket_history_entry()
  • Ticket Search: rt_ticket_search()
  • Ticket Create: rt_ticket_create()
  • Ticket Edit: rt_ticket_edit()
  • Tickets History Reply: rt_ticket_history_reply()
  • Ticket History Comment: rt_ticket_history_comment()
  • Ticket Links Edit: rt_ticket_links_edit()
• Users
  • User Properties: rt_user_properties()
  • User Create: rt_user_create()
  • User Edit: rt_user_edit()
• Queues
  • Queue Properties: rt_queue_properties()

Note: Most of these functions support being chained together (for example, with the %>%).

See the included vignettes for more information about usage.

Logging out

To log out, use the rt_logout function (or restart your R session):

rt_logout()