API Operations for Substatuses

Summary

Operation Name: Retrieve a Substatus by Substatus ID
Relative API Request Path: ~/api/v1/substatuses/{substatusID}
HTTP Verb: GET
Description: Retrieve a single Substatus by Substatus ID.

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

Retrieve a Substatus by Substatus ID

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

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

Response DTO Schema:

ReadSubStatusDTO
{
 ExtensionData (array[KeyValuePair[String,Object]]),
 Metadata (array[KeyValuePair[String,Object]]),
 SubStatusID (integer),
 SubStatusName (string),
 DisplayOrder (number)
}

Request HTTP Verb: GET

Response Status Codes:

  • Success: 200
  • Invalid Substatus ID: 400 (Bad Request, e.g., a negative integer is supplied)
  • Non-existent Substatus: 404
  • Invalid Substatus 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/v1/substatuses/13

Sample Response:

{
 “ExtensionData”: [],
 “Metadata”: [
  {
   “Key”: “APIVersion”,
   “Value”: “v1”
  },
  {
   “Key”: “QueryDate”,
   “Value”: “2014-12-22T16:03:33.1153793Z”
  }
 ],
 “SubStatusID”: 13,
 “SubStatusName”: “Pending Assignment”,
 “DisplayOrder”: 1
}

Retrieve all Substatuses

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

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

Response DTO Schema:

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

Request HTTP Verb: GET

Response Status Codes:

  • Success: 200
  • Non-existent Substatus: 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 ReadSubstatusDTO objects returned.
  • The ExtensionData property is not implemented in v1 of the API.

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

Sample Response:

{
 “IsPageIndexZeroBased”: true,
 “PageIndex”: 0,
 “CountForPage”: 1,
 “PageSize”: 2147483647,
 “TotalCount”: 11,
 “Collection”: [
  {
   “ExtensionData”: [],
   “Metadata”: [
    {
     “Key”: “APIVersion”,
     “Value”: “v1”
    },
    {
     “Key”: “QueryDate”,
     “Value”: “2014-12-22T16:06:29.8010461Z”
    }
   ],
   “SubStatusID”: 8,
   “SubStatusName”: “Complete – Pending Second Review”,
   “DisplayOrder”: 9
  }
 ]
}