API

Articles

About the Issuetrak RESTful API
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.   Introduction Why might you want to use our API? ...
API System Requirements
The Issuetrak API requires the Issuetrak application to be installed as the base application platform. In addition, the Microsoft .NET Framework 4.6.2 update must be installed on the application server. The Issuetrak core product may be ins...
Installing the API
Issuetrak provides the means to deploy the API via either the Issuetrak Deployment Utility (IDU) or the Issuetrak Deployment Manager (IDM). If you wish to install the API while upgrading or installing a new instance of Issuetrak with th...
API Operation Conventions
DATA TRANSFER OBJECTS The Issuetrak API uses the concept of Data Transfer Objects (DTOs) to represent the serialized input to API operation endpoints for API methods that use the POST and PUT HTTP verbs and to represent the serialized output fr...
API Operations for APIMETADATA
Summary Operation Name: Retrieve API Metadata Relative API Request Path : ~/api/v1/metadata/current HTTP Verb: GET Description: Retrieves the current API metadata   Retrieve API Metadata Description: This...
API Operations for Attachments
Summary Operation Name: Retrieve an Attachment by Attachment ID Relative API Request Path: ~/api/v1/attachments/{attachmentID}/{includeAttachmentContent} HTTP Verb: GET Description: Retrieve a single Attachment from by its Attac...
API Operations for Causes
Summary Operation Name: Retrieve a Cause by Cause ID Relative API Request Path: ~/api/v1/causes/{causeID} HTTP Verb: GET Description: Retrieve a single Cause by Cause ID. Operation Name: Retrieve all Causes Relative ...
API - Encrypting ConnectionStrings
Overview For additional protection against breach of sensitive data, customers may wish to encrypt the database connection information contained within the Issuetrak API’s web.config file. For the encryption process, a tool provided by ...
API Operations for Classes
Summary Operation Name: Retrieve a Class by Class ID Relative API Request Path: ~/api/v1/classes/{classID} HTTP Verb: GET Description: Retrieve a single Class by Class ID. Operation Name: Retrieve all Classes Relativ...
API Authorization Overview
The Issuetrak API requires specific, custom authorization headers to be added to each HTTP request targeting an API operation endpoint. The following custom authorization headers must be defined. Issuetrak API Authorization...
API Operations for Departments
Summary Operation Name: Retrieve a Department by Department ID Relative API Request Path: ~/api/v1/departments/{departmentID} HTTP Verb: GET Description: Retrieve a single Department by Department ID. Operation Name: Ret...
API Operations for Issues
Summary Operation Name: Retrieve an Issue by Issue Number Relative API Request Path: ~/api/v1/issues/{includeNotes}/{issueNumber} HTTP Verb: GET Description: Retrieve a single Issue from by Issue Number. Operation Name: ...
API - Swagger Overview
Swagger is a RESTful API Documentation Specification that describes and documents Application Programming Interfaces (API). From the swagger.io site documentation: The Swagger specification defines a set of files required to describe such an...
API Operations for IssueTypes
Summary Operation Name: Retrieve an IssueType by IssueType ID Relative API Request Path: ~/api/v1/issuetypes/{issueTypeID} HTTP Verb: GET Description: Retrieve a single IssueType by IssueType ID. Operation Name: Retrieve...
API Operations for IssueSubTypes
Summary Operation Name: Retrieve an IssueSubType by IssueSubType ID Relative API Request Path: ~/api/v1/issuesubtypes/{issueSubTypeID} HTTP Verb: GET Description: Retrieve a single IssueSubType by IssueSubType ID. Operatio...
API Samples Overview
The Issuetrak API is a RESTful API that uses the HTTP protocol as the primary transport infrastructure both to invoke and API operation and to transmit the response from an API operation back to the API consumer. As such, the API is platform-agnosti...
API Operations for IssueSubTypes2
Summary Operation Name: Retrieve an IssueSubType2 by IssueSubType2 ID Relative API Request Path: ~/api/v1/issuesubtypes2/{issueSubType2ID} HTTP Verb: GET Description: Retrieve a single IssueSubType2 by IssueSubType2 ID. Op...
API Operations for IssueSubTypes3
Summary Operation Name: Retrieve an IssueSubType3 by IssueSubType3 ID Relative API Request Path: ~/api/v1/issuesubtypes3/{issueSubType3ID} HTTP Verb: GET Description: Retrieve a single IssueSubType3 by IssueSubType3 ID. Op...
API - Elevating NLog
The following steps can be used to help provide more feedback when encountering API problems such as "Authorization Failure" on API procedures or within the Swagger UI. Your site must be on a minimum version of Issuetrak 11.4.1 in order fo...
API Operations for IssueSubTypes4
Summary Operation Name: Retrieve an IssueSubType4 by IssueSubType4 ID Relative API Request Path: ~/api/v1/issuesubtypes4/{issueSubType4ID} HTTP Verb: GET Description: Retrieve a single IssueSubType4 by IssueSubType4 ID. Op...
API Operations for Locations
Summary Operation Name: Retrieve a Location by Location ID Relative API Request Path: ~/api/v1/locations/{locationID} HTTP Verb: GET Description: Retrieve a single Location by Location ID. Operation Name: Retrieve all Lo...
API Operations for MenuItems
Summary Operation Name: Retrieve a MenuItem by MenuItem ID Relative API Request Path: ~/api/v1/menuitems/{menuItemID} HTTP Verb: GET Description: Retrieve a single MenuItem by MenuItem ID. Operation Name: Retrieve all Me...
API Operations for Notes
Summary Operation Name: Retrieve a Note by Note ID Relative API Request Path: ~/api/v1/notes/{noteID} HTTP Verb: GET Description: Retrieve a single Note from the database by Note ID. Operation Name: Retrieve a Collection...
API Operations for Organizations
Summary Operation Name: Retrieve an Organization by Organization ID Relative API Request Path: ~/api/v1/organizations/{organizationID} HTTP Verb: GET Description: Retrieve a single Organization by Organization ID. Operatio...
API Operations for Priorities
Summary Operation Name: Retrieve a Priority by Priority ID Relative API Request Path: ~/api/v1/priorities/{priorityID} HTTP Verb: GET Description: Retrieve a single Priority by Priority ID. Operation Name: Retrieve all P...
API Operations for Projects
Summary Operation Name: Retrieve a Project by Project ID Relative API Request Path: ~/api/v1/projects/{projectID} HTTP Verb: GET Description: Retrieve a single Project by Project ID. Operation Name: Retrieve all Projects...
API Operations for ServiceLevels
Summary Operation Name: Retrieve a ServiceLevel by ServiceLevel ID Relative API Request Path: ~/api/v1/servicelevels/{serviceLevelID} HTTP Verb: GET Description: Retrieve a single ServiceLevel by ServiceLevel ID. Operation...
API Operations for ServiceLevelAgreements
Summary Operation Name: Retrieve a ServiceLevelAgreement by ServiceLevelAgreement ID Relative API Request Path: ~/api/v1/servicelevelagreements/{serviceLevelAgreementID} HTTP Verb: GET Description: Retrieve a single ServiceLevel...
API Operations for ServiceLevelSeverities
Summary Operation Name: Retrieve a ServiceLevelSeverity by ServiceLevelSeverity ID Relative API Request Path: ~/api/v1/servicelevelseverities/{severityID} HTTP Verb: GET Description: Retrieve a single ServiceLevelSeverity by Ser...
API Operations for ServiceLevelTerms
Summary Operation Name: Retrieve a ServiceLevelTerm by ServiceLevelTerm ID Relative API Request Path: ~/api/v1/servicelevelterms/{serviceLevelTermID} HTTP Verb: GET Description: Retrieve a single ServiceLevelTerm by ServiceLevel...
API Operations for Substatuses
Summary Operation Name: Retrieve a Substatus by Substatus ID Relative API Request Path: ~/api/v1/substatuses/{substatusID} HTTP Verb: GET Description: Retrieve a single Substatus by Substatus ID. Operation Name: Retrieve...
API Operations for TimeZones
Summary Operation Name: Retrieve a TimeZone by TimeZone ID Relative API Request Path: ~/api/v1/timezones/{timeZoneID} HTTP Verb: GET Description: Retrieve a single TimeZone by TimeZone ID. Operation Name: Retrieve all Ti...
API Operations for Users
Summary Operation Name: Retrieve a User by User ID Relative API Request Path: ~/api/v1/users/{userID}/{includeUserPhoto} HTTP Verb: GET Description: Retrieve a single User by User ID. Operation Name: Retrieve all Users ...
API Operations for User Types
Summary Operation Name: Retrieve a User Type by UserTypeID Relative API Request Path: ~/api/v1/usertypes/{usertypeID} HTTP Verb: GET Description: Retrieve a single User Type by User Type ID. Operation Name: Retrieve all ...
API Operations for User-Defined Field Types
Summary Operation Name: Retrieve a UserDefined FieldType by ID Relative API Request Path: ~/api/v1/userdefinedfieldtypes/{userDefinedFieldTypeID} HTTP Verb: GET Description: Retrieve a single UserDefinedFieldType by UserDefinedF...