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.

Operation Name: Retrieve all IssueSubTypes3
Relative API Request Path: ~/api/v1/issuesubtypes3
HTTP Verb: GET
Description: Retrieve a collection of currently defined IssueSubTypes3.

Retrieve an IssueSubType3 by IssueSubType3 ID

Description: This API method retrieves an IssueSubType3 from the Issuetrak data store for a specified IssueSubType3 ID. The “issueSubType3ID” parameter must correspond to an existing IssueSubType3. If there is no such IssueSubType3 ID, an error message will be returned with an HTTP response status code of 404.

When retrieving an IssueSubType3 using the API, no special character decoding (e.g., HTML decoding &lt; as < or &gt; as >) is performed. Therefore, please note that the IssueSubType3Name returned via the API method represents the IssueSubType3Name as stored within the Issuetrak database. Thus, when retrieving an IssueSubType3 created through the Issuetrak web interface where HTML encoding of the IssueSubType3Name 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 ReadIssueSubType3DTO instance.

Response DTO Schema:

ReadIssueSubType3DTO
{
 ExtensionData (array[KeyValuePair[String,Object]]),
 Metadata (array[KeyValuePair[String,Object]]),
 IssueSubType3ID": 0,
 IssueSubType3Name“: ”",
 DisplayOrder": 0
}

Request HTTP Verb: GET

Response Status Codes:

  • Success: 200
  • Invalid IssueSubType3 ID: 400 (Bad Request, e.g., a negative integer is supplied)
  • Non-existent IssueSubType3: 404
  • Invalid IssueSubType3 ID: 422 (Unprocessable Entity, e.g., a non-numeric value is supplied)

Response DTO Property Notes:

  • The ExtensionData property is not used in version 1 of the API.
  • The Metadata property provides a key/value collection of additional data about the API operation and/or the response body.

Sample Request URL: ~/api/

Sample Request URL: ~/api/v1/issuesubtypes3/11

Sample Response:

{
 “ExtensionData”: [],
 “Metadata”: [
  {
   “Key”: “APIVersion”,
   “Value”: “v1”
  },
  {
   “Key”: “QueryDate”,
   “Value”: “2014-12-09T20:19:23.9695584Z”
  }
 ],
 “IssueSubType3ID”: 11,
 “IssueSubType3Name”: “Duplicate Ticket”,
 “DisplayOrder”: 0
}

Retrieve all IssueSubTypes3

Description: This API method retrieves a collection of all currently-defined IssueSubTypes3 from the Issuetrak data store.

When retrieving an IssueSubType3 using the API, no special character decoding (e.g., HTML decoding &lt; as < or &gt; as >) is performed. Therefore, please note that the IssueSubType3Name returned via the API method represents the IssueSubType3Name as stored within the Issuetrak database. Thus, when retrieving an IssueSubType3 created through the Issuetrak web interface where HTML encoding of the IssueSubType3Name 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 ReadIssueSubType3DTO instance.

Response DTO Schema:

{
 “IsPageIndexZeroBased”: false,
 “PageIndex”: 0,
 “CountForPage”: 0,
 “PageSize”: 0,
 “TotalCount”: 0,
 “Collection”: [
  {
   “ExtensionData”: [
    “KeyValuePair[String,Object]”
   ],
   “Metadata”: [
    “KeyValuePair[String,Object]”
   ],
   “IssueSubType3ID”: 0,
   “IssueSubType3Name”: "",
   “DisplayOrder”: 0
  }
 ]
}

Request HTTP Verb: GET

Response Status Codes:

  • Success: 200
  • Non-existent IssueSubType3: 404

Response DTO Property Notes:

  • 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 ReadIssueSubType3DTO objects returned.
  • The ExtensionData property is not implemented in v1 of the API.

Sample Request URL: ~/api/v1/issuesubtypes3/

Sample Response:

{
 “IsPageIndexZeroBased”: true,
 “PageIndex”: 0,
 “CountForPage”: 1,
 “PageSize”: 2147483647,
 “TotalCount”: 1,
 “Collection”: [
  {
   “ExtensionData”: [“KeyValuePair[String,Object]”],
   “Metadata”: [“KeyValuePair[String,Object]”],
   “IssueSubType3ID”: 0,
   “IssueSubType3Name”: "",
   “DisplayOrder”: 0
  }
 ]
}