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.
Operation Name: Retrieve all IssueSubTypes4
Relative API Request Path: ~/api /v1/issuesubtypes4
HTTP Verb: GET
Description: Retrieve a collection of currently defined IssueSubTypes4.
Retrieve an IssueSubType4 by IssueSubType4 ID
Description: This API method retrieves an IssueSubType4 from the Issuetrak data store for a specified IssueSubType4 ID. The “issueSubType4ID” parameter must correspond to an existing IssueSubType4. If there is no such IssueSubType4 ID, an error message will be returned with an HTTP response status code of 404.
When retrieving an IssueSubType4 using the API, no special character decoding (e.g., HTML decoding < as < or > as >) is performed. Therefore, please note that the IssueSubType4Name returned via the API method represents the IssueSubType4Name as stored within the Issuetrak database. Thus, when retrieving an IssueSubType4 created through the Issuetrak web interface where HTML encoding of the IssueSubType4Name 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 ReadIssueSubType4DTO instance.
Response DTO Schema:
ReadIssueSubType4DTO { IssueSubType4ID (integer), IssueSubType4Name (string), ExtensionData (Array[CustomKeyValuePairDataElement]), Metadata (Array[CustomKeyValuePairDataElement]), ParentID (integer), DisplayOrder (number), CreatedBy (string), CreatedDate(ISO 8601 string), ModifiedBy (string, optional), 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 IssueSubType4 ID: 400 (Bad Request, e.g., a negative integer is supplied)
- Non-existent IssueSubType4: 404
- Invalid IssueSubType4 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/issuesubtypes4/11
Sample Response:
{“IssueSubType4ID”: 11, “IssueSubType4Name”: “Other”,“ExtensionData”: [], “Metadata”: [ { “Key”: “APIVersion”, “Value”: “12.5” }, { “Key”: “QueryDate”, “Value”: “2018-12-09T20:19:23.9695584Z” } ], “ParentID”: 7, “DisplayOrder”: 0,“CreatedBy”: “admin” “CreatedDate”: “2017-11-16T08:26:46.44”, “ModifiedBy”: null, “ModifiedDate”: null, “TrakTip”: “”, “IsTrakTipAdvancedOnly”: false, “IsActive”: true}
Retrieve all IssueSubTypes4
Description: This API method retrieves a collection of all currently-defined IssueSubTypes4 from the Issuetrak data store.
When retrieving an IssueSubType4 using the API, no special character decoding (e.g., HTML decoding < as < or > as >) is performed. Therefore, please note that the IssueSubType4Name returned via the API method represents the IssueSubType4Name as stored within the Issuetrak database. Thus, when retrieving an IssueSubType4 created through the Issuetrak web interface where HTML encoding of the IssueSubType4Name 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 ReadIssueSubType4DTO instance.
Response DTO Schema:
QueryResultsContainer[ReadIssueSubType3DTO]{ IsPageIndexZeroBased (boolean), PageIndex (integer), CountForPage (integer), PageSize (integer), TotalCount (integer), Collection(array[ReadIssueSubType3DTO])}ReadIssueSubType4DTO{IssueSubType4ID (integer), IssueSubType4Name (string),ExtensionData(array[KeyValuePair[String,Object]]),Metadata(array[KeyValuePair[String,Object]]),ParentID (integer), DisplayOrder(integer),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 IssueSubType4: 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 ReadIssueSubType4DTO objects returned.
Sample Request URL: ~/api /v1/issuesubtypes4/
Sample Response:
{ “IsPageIndexZeroBased”: true, “PageIndex”: 0, “CountForPage”: 1, “PageSize”: 2147483647, “TotalCount”: 1, “Collection”: [ {“IssueSubType4ID”: 1, “IssueSubType4Name”: “Error”,“ExtensionData”: [], “Metadata”: [ { “Key”:“APIVersion”,“Value”: “12.5” } { “Key”: “QueryDate”, “Value”: “2020-12-10T18:34:37.8439079Z” } ],“ParentID”: 3,“DisplayOrder”: 1,“CreatedBy”: “admin”, “CreatedDate”: “2017-11-16T08:26:46.44”, “ModifiedBy”: null, “ModifiedDate”: null, “TrakTip”: “”, “IsTrakTipAdvancedOnly”: false, “IsActive”: true} ] }
