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.
Operation Name: Retrieve all IssueSubTypes
Relative API Request Path: ~/api/v1/issuesubtypes
HTTP Verb: GET
Description: Retrieve a collection of currently defined IssueSubTypes.
Retrieve an IssueSubType by IssueSubType ID
Description: This API method retrieves an IssueSubType from the Issuetrak data store for a specified IssueSubType ID. The “issueSubTypeID” parameter must correspond to an existing IssueSubType. If there is no such IssueSubType ID, an error message will be returned with an HTTP response status code of 404.
When retrieving an IssueSubType using the API, no special character decoding (e.g., HTML decoding < as < or > as >) is performed. Therefore, please note that the IssueSubTypeName returned via the API method represents the IssueSubTypeName as stored within the Issuetrak database. Thus, when retrieving an IssueSubType created through the Issuetrak web interface where HTML encoding of the IssueSubTypeName 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 ReadIssueSubTypeDTO instance.
Response DTO Schema:
ReadIssueSubTypeDTO {IssueSubTypeID: (integer), IssueSubTypeName: (string),ExtensionData (array[KeyValuePair[String,Object]]), Metadata (array[KeyValuePair[String,Object]]), ParentID:(integer),DisplayOrder: (number), CreatedBy: (string), CreatedDate: (ISO 8601 string), ModifiedBy: (string), ModifiedDate: (ISO 8601 string),TrakTip:(string), IsTrakTipAdvancedOnly:(boolean),IsActive: (boolean)}CustomKeyValuePairDataElement { Key (string), Value (object) }
Request HTTP Verb: GET
Response Status Codes:
- Success: 200
- Invalid IssueSubType ID: 400 (Bad Request, e.g., a negative integer is supplied)
- Non-existent IssueSubType: 404
- Invalid IssueSubType 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.
Sample Request URL: ~/api/v1/issuesubtypes/11
Sample Response:
{“IssueSubTypeID”: 11, “IssueSubTypeName”: “Duplicate Ticket”,“ExtensionData”: [], “Metadata”: [ { “Key”: “APIVersion”, “Value”: “12.5” }, { “Key”: “QueryDate”, “Value”: “2014-12-09T20:19:23.9695584Z” } ], “ParentID”: 5, “DisplayOrder”: 0,“CreatedBy”: “admin”, “CreatedDate”: “2013-08-15T09:18:07.673”, “ModifiedBy": “admin”, "ModifiedDate": “2013-10-12T08:58:47.837”, “TrakTip": “”, “IsTrakTipAdvancedOnly”: false, “IsActive”: true}
Retrieve all IssueSubTypes
Description: This API method retrieves a collection of all currently-defined IssueSubTypes from the Issuetrak data store.
When retrieving an IssueSubType using the API, no special character decoding (e.g., HTML decoding < as < or > as >) is performed. Therefore, please note that the IssueSubTypeName returned via the API method represents the IssueSubTypeName as stored within the Issuetrak database. Thus, when retrieving an IssueSubType created through the Issuetrak web interface where HTML encoding of the IssueSubTypeName 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 ReadIssueSubTypeDTO instance.
Response DTO Schema:
QueryResultsContainer[ReadIssueSubTypeDTO]{ IsPageIndexZeroBased:(boolean),PageIndex: (integer), CountForPage:(integer), PageSize:(integer), TotalCount:(integer), Collection:(Array[ReadIssueSubTypeDTO]) } ReadIssueSubtypeDTO{IssueSubTypeID: (integer), IssueSubTypeName: (string),ExtensionData: (Array[CustomKeyValuePairDataElement]), Metadata:(Array[CustomKeyValuePairDataElement]), ParentID:(integer),DisplayOrder:(number), Createdby: (string), CreatedDate: (ISO 8601 string), ModifiedBy: (string), ModifiedDate: (ISO 8601 string), TrakTip: (string), IsTrakTipAdvancedOnly: (boolean), IsActive: (boolean)}CustomKeyValuePairDataElement { Key (string), Value (object)}
Request HTTP Verb: GET
Response Status Codes:
- Success: 200
- Non-existent IssueSubType: 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 ReadIssueSubTypeDTO objects returned.
Sample Request URL: ~/api/v1/issuesubtypes/
Sample Response:
{ “IsPageIndexZeroBased”: true, “PageIndex”: 0, “CountForPage”: 1, “PageSize”: 2147483647, “TotalCount”: 1, “Collection”: [ {“IssueSubTypeID”: 1, “IssueSubTypeName”: “Hardware”,“ExtensionData”: [], “Metadata”: [{ “Key”: “APIVersion” “Value": “12.5” }, { “Key”: “QueryDate”, “Value": “2020-12-08T21:48:57.6823349Z” } ],“ParentID”: 10“DisplayOrder”: 0“CreatedBy”: “admin” “CreatedDate”: “2018-04-25T19:59:11.56” “ModifiedBy”: “admin” “ModifiedDate”: “2018-04-25T19:59:11.56” “TrakTip”: “” “IsTrakTipAdvancedOnly”: false, “IsActive”: true} ] }
