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.
Operation Name: Retrieve all IssueSubTypes2
Relative API Request Path: ~/api/v1/issuesubtypes2
HTTP Verb: GET
Description: Retrieve a collection of currently defined IssueSubTypes2.
Retrieve an IssueSubType2 by IssueSubType2 ID
Description: This API method retrieves an IssueSubType2 from the Issuetrak data store for a specified IssueSubType2 ID. The “issueSubType2ID” parameter must correspond to an existing IssueSubType2. If there is no such IssueSubType2 ID, an error message will be returned with an HTTP response status code of 404.
When retrieving an IssueSubType2 using the API, no special character decoding (e.g., HTML decoding < as < or > as >) is performed. Therefore, please note that the IssueSubType2Name returned via the API method represents the IssueSubType2Name as stored within the Issuetrak database. Thus, when retrieving an IssueSubType2 created through the Issuetrak web interface where HTML encoding of the IssueSubType2Name 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 ReadIssueSubType2DTO instance.
Response DTO Schema:
ReadIssueSubType2DTO
{
IssueSubType2ID (integer),
IssueSubType2Name (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
- Invalid IssueSubType2 ID: 400 (Bad Request, e.g., a negative integer is supplied)
- Non-existent IssueSubType2: 404
- Invalid IssueSubType2 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/issuesubtypes2/11
Sample Response:
{“IssueSubType2ID”: 11, “IssueSubType2Name”: “Duplicate Ticket”,“ExtensionData”: [], “Metadata”: [ { “Key”: “APIVersion”, “Value”: “12.5” }, { “Key”: “QueryDate”, “Value”: “2020-12-16T19:20:17.4659304Z} ],“ParentID”: 42, “DisplayOrder”: 1, “CreatedBy”: “admin” “CreatedDate”: “2017-11-16T08:25:21.783” “ModifiedBy”: “admin” “ModifiedDate”: “2017-11-16T08:35:07.21” “TrakTip”: “” “IsTrakTipAdvancedOnly”: false, “IsActive”: true}
Retrieve all IssueSubTypes2
Description: This API method retrieves a collection of all currently-defined IssueSubTypes2 from the Issuetrak data store.
When retrieving an IssueSubType2 using the API, no special character decoding (e.g., HTML decoding < as < or > as >) is performed. Therefore, please note that the IssueSubType2Name returned via the API method represents the IssueSubType2Name as stored within the Issuetrak database. Thus, when retrieving an IssueSubType2 created through the Issuetrak web interface where HTML encoding of the IssueSubType2Name 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 ReadIssueSubType2DTO instance.
Response DTO Schema:
QueryResultsContainer[ReadIssueType2DTO]
{
IsPageIndexZeroBased (boolean),
PageIndex (integer),
CountForPage (integer),
PageSize (integer),
TotalCount (integer),
Collection (array[ReadIssueSubType2DTO])
}
ReadIssueSubType2DTO
{
IssueSubType2ID (integer),
IssueSubType2Name (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 IssueSubType2: 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 ReadIssueSubType2DTO objects returned.
Sample Request URL: ~/api/v1/issuesubtypes2/
Sample Response:
{ “IsPageIndexZeroBased”: true, “PageIndex”: 0, “CountForPage”: 1, “PageSize”: 2147483647, “TotalCount”: 1, “Collection”: [ {“IssueSubType2ID”: 5, “IssueSubType2Name”: "Usage",“ExtensionData”: [],“Metadata”: [ { “Key”: “APIVersion”, “Value”: “12.5” }, { “Key”: “QueryDate”, “Value”: “2020-12-16T19:19:58.2738929Z” } ],“ParentID”: 30, “DisplayOrder”: 1, “CreatedBy”:“admin”,“CreatedDate”: “2017-12-01T11:14:15.423”, “ModifiedBy”: null, “ModifiedDate”: null, “TrakTip”: “”,“IsTrakTipAdvancedOnly”: false, “IsActive”: true,}] }
