About the Issuetrak RESTful API

Information

This article provides information on the Issuetrak REST API, including important points to keep in mind and instructions on where to locate the documentation and installation files.


Before Getting Started

  • Programmers with RESTful API experience – The goal of any API is that you can utilize your own resources to create something unique that interacts with another product. Imagination and creativity is your only limit; therefore, you need to be sure you have the proper personnel to accomplish what you want to do with the API.
  • Latest and Greatest – In order to gain access to the latest API, On-Premises installations will need to be on the latest version of Issuetrak and Cloud installations will need to contact our Support Team. For On-Premises installations, the latest version of the API is included in the Issuetrak distribution attached to the following Issuetrak Support KB article.
  • System Requirements – The System Requirements for the API are located in the following Help Center article.

Functionality

The Issuetrak API gives your programmers access to the issue-related tables within your Issuetrak database through a .NET Web Service. Using the API, they''ll be able to insert, update, and retrieve issue data. There is a lot of flexibility to a RESTful API, which means you and your programmers may develop a number of uses for it.

Documentation

The following Help Center articles will provide you with everything you need to know to understand the ins and outs of the API:

API System Requirements
Installing the API
API Authorization Overview
API Operation Conventions
API Operations for APIMETADATA
API Operations for Attachments
API Operations for Causes
API Operations for Classes
API Operations for Departments
API Operations for Issues
API Operations for IssueSubTypes
API Operations for IssueSubTypes2
API Operations for IssueSubTypes3
API Operations for IssueSubTypes4
API Operations for IssueTypes
API Operations for Locations
API Operations for MenuItems
API Operations for Notes
API Operations for Organizations
API Operations for Priorities
API Operations for Projects
API Operations for ServiceLevelAgreements
API Operations for ServiceLevelSeverities
API Operations for ServiceLevels
API Operations for ServiceLevelTerms
API Operations for Substatuses
API Operations for TimeZones
API Operations for User-Defined Field Types
API Operations for Users
API Operations for User Types
API Samples Overview
API – Encrypting ConnectionStrings
API – Swagger Overview
API – Troubleshooting Swagger

Examples

Also included in the Distribution are some examples we've developed, which you can use for testing the API. For more information on the examples, including access for our Cloud customers, please visit the following article.