Jump to

• Request
• Response
• Examples

Get impairment for a policy

get

/PASService/rest/services/policies/{policyId}/impairments/{impairmentId}

Gets an impairment associated with a policy based on the specified policy Id and impairment Id

Request

Path Parameters

• impairmentId: string
  Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?

  Impairment Id
• policyId: string
  Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?

  Policy Id

Back to Top

Response

Supported Media Types

• application/json

Default Response

successful operation

Back to Top

Examples

This example describes how to get a impairment associated with a policy based on the specified policy Id and impairment Id.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -X GET -H "Accept: application/json" -u username:password "server:port/PASService/rest/services/policies/5F53C523-F201-4CEF-A376-DBA24BC7DC1A/impairments/94FC326F-3342-4C34-878E-B446E2950C3A"

Example Response Body

The following shows an example of the response body in JSON format:

"{
  "impairment": {
    "links": [
      {
        "href": "http://server:port/PASService/rest/services/policies/5F53C523-F201-4CEF-A376-DBA24BC7DC1A/impairments/94FC326F-3342-4C34-878E-B446E2950C3A",
        "rel": "self",
        "mediaType": "application/json",
        "method": "GET"
      },
      {
        "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentCategory&codeValue=04",
        "rel": "codes/category",
        "mediaType": "application/json",
        "method": "GET"
      },
      {
        "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentStatus&codeValue=01",
        "rel": "codes/status",
        "mediaType": "application/json",
        "method": "GET"
      }
    ],
    "multiFields": {},
    "codes": [
      {
        "codeName": "AsCodeImpairmentCategory",
        "codeValue": "04",
        "longDescription": "Financial",
        "shortDescription": "Financial"
      },
      {
        "codeName": "AsCodeImpairmentStatus",
        "codeValue": "01",
        "longDescription": "Active",
        "shortDescription": "Active"
      }
    ],
    "debit": 20,
    "flatExtra": 10,
    "duration": 10,
    "comments": "Test_bug_comments",
    "createdBy": "qatester3",
    "lastModifiedBy": "qatester3",
    "impairmentId": "94FC326F-3342-4C34-878E-B446E2950C3A",
    "category": "04",
    "priority": "01",
    "createdDate": "2018-12-21T00:00:00Z",
    "lastmodifiedDate": "2018-12-21T07:14:25Z",
    "status": "01",
    "policyId": "5F53C523-F201-4CEF-A376-DBA24BC7DC1A"
  }
}
"

Back to Top