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 all IssueTypes
Relative API Request Path: ~/api/v1/issuetypes
HTTP Verb: GET
Description: Retrieve a collection of currently defined IssueTypes.
Retrieve an IssueType by IssueType ID
Description: This API method retrieves an IssueType from the Issuetrak data store for a specified IssueType ID. The “issueTypeID” parameter must correspond to an existing IssueType. If there is no such IssueType ID, an error message will be returned with an HTTP response status code of 404.
When retrieving an IssueType using the API, no special character decoding (e.g., HTML decoding < as < or > as >) is performed. Therefore, please note that the IssueTypeName returned via the API method represents the IssueTypeName as stored within the Issuetrak database. Thus, when retrieving an IssueType created through the Issuetrak web interface where HTML encoding of the IssueTypeName is performed, the API consumer may desire to perform additional client-side decoding.
A successful response will include an HTTP status code of 200 (OK) and a response body containing a serialized ReadIssueTypeDTO instance.
Response DTO Schema:
ReadIssueTypeDTO {ExtensionData (Array[CustomKeyValuePairDataElement]), Metadata (Array[CustomKeyValuePairDataElement]),IssueTypeID (integer), IssueTypeName (string), DisplayOrder (number), CreatedBy (string), CreatedDate(ISO 8601 string), ModifiedBy (string), ModifiedDate(ISO 8601 string),IsActive (boolean),TrakTip (string), IsTrakTipAdvancedOnly (boolean), CustomScreenID (integer) } CustomKeyValuePairDataElement { Key (string), Value (object) }
Request HTTP Verb: GET
Response Status Codes:
- Success: 200
- Invalid IssueType ID: 400 (Bad Request, e.g., a negative integer is supplied)
- Non-existent IssueType: 404
- Invalid IssueType ID: 422 (Unprocessable Entity, e.g., a non-numeric value is supplied)
Response Properties:
- The Metadata property provides a key/value collection of additional data about the API operation and/or the response body.
- BREAKING CHANGES from Previous API Versions:
- The “AutoAssignTo” (string) property has been removed as of Issuetrak API 10.0.
Sample Request URL: ~/api/v1/issuetypes/11
Sample Response:
{ “ExtensionData”: [], “Metadata”: [ { “Key”: “APIVersion”, “Value”: “12.5” }, { “Key”: “QueryDate”, “Value”: “2020-12-09T20:19:23.9695584Z” } ],“IssueTypeID”: 11, “IssueTypeName”: “Duplicate Ticket”, “DisplayOrder”: 3, “CreatedBy”: “admin”, “CreatedDate”: “2017-11-16T08:26:46.44”, “ModifiedBy”: null, “ModifiedDate”: null, “IsActive”: true “TrakTip”: “”, “IsTrakTipAdvancedOnly”: false, “CustomScreenID”: 7}
Retrieve all IssueTypes
Description: This API method retrieves a collection of all currently-defined IssueTypes from the Issuetrak data store.
When retrieving an IssueType using the API, no special character decoding (e.g., HTML decoding < as < or > as >) is performed. Therefore, please note that the IssueTypeName returned via the API method represents the IssueTypeName as stored within the Issuetrak database. Thus, when retrieving an IssueType created through the Issuetrak web interface where HTML encoding of the IssueTypeName is performed, the API consumer may desire to perform additional client-side decoding.
A successful response will include an HTTP status code of 200 (OK) and a response body containing a serialized collection of ReadIssueTypeDTO instance.
Response DTO Schema:
QueryResultsContainer[ReadIssueTypeDTO]{ IsPageIndexZeroBased (boolean), PageIndex (integer), CountForPage (integer), PageSize (integer), TotalCount (integer), Collection(array[ReadIssueSubType3DTO])}ReadIssueTypeDTO{ExtensionData(array[KeyValuePair[String,Object]]), Metadata (array[KeyValuePair[String,Object]]), IssueTypeID (integer), IssueTypeName (string),DisplayOrder(number),CreatedBy (string), CreatedDate(ISO 8601 string),ModifiedBy (string), ModifiedDate(ISO 8601 string), IsActive (boolean),TrakTip (string), IsTrakTipAdvancedOnly (boolean), CustomScreenID (integer) } CustomKeyValuePairDataElement {Key (string), Value (object) }
Request HTTP Verb: GET
Response Status Codes:
- Success: 200
- Non-existent IssueType: 404
Response Properties:
- The IsPageIndexZeroBased property value is always true. This property is included for use in future API versions.
- The PageIndex property value is always 0. This property is included for use in future API versions.
- The CountForPage property value is always the same as TotalCount. This property is included for use in future API versions.
- The PageSize property value is always the maximum value for a signed, 32-bit integer. This property is included for use in future API versions.
- The TotalCount property value is the number of records returned in the collection.
- The Collection property is an array containing the ReadIssueTypeDTO objects returned.
- BREAKING CHANGES from Previous API Versions:
- The “AutoAssignTo” (string) property has been removed as of Issuetrak API 10.0.
Sample Request URL: ~/api/v1/issuetypes
Sample Response:
{ “IsPageIndexZeroBased”: true, “PageIndex”: 0, “CountForPage”: 1, “PageSize”: 2147483647, “TotalCount”: 1, “Collection”: [{ “ExtensionData”: [], “Metadata”: [ { “Key”: “APIVersion”, “Value”: “12.5” } { “Key”: “QueryDate”, “Value”: “2020-12-10T18:34:37.8439079Z” }“IssueTypeID”: 5, “IssueTypeName”: "Facilities",“DisplayOrder”: 1,“CreatedBy”: “admin”, “CreatedDate”: “2017-11-16T08:26:46.44”, “ModifiedBy”: null, “ModifiedDate”: null, “IsActive”: true “TrakTip”: “”, “IsTrakTipAdvancedOnly”: false, “CustomScreenID”: 2} ] }
