Get a specific requirement for a specific policy by policy Id and requirement Id

get

/PASService/rest/services/v1/policies/{policyId}/requirements/{requirementId}

Gets a requirement associated with a policy based on the specified policy Id and requirement Id.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

200 Response

This operation fetches a specific requirement for a specific policy by policy Id and requirement Id successfully.
Back to Top

Examples

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

Example cURL Command

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

curl \ 
    -X GET \ 
    -H "Content-Type: application/json" \
    -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
    -L "http://server:port/PASService/rest/services/v1/policies/22E39E64-7876-4A61-B5FE-9E45A291C54D/roles/0DE0006A-983F-4210-B3A5-54DD41955774"

Example Response Body

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

{
    "requirement": {
        "links": [
            {
                "href": "http://server:port/PASService/rest/services/v1/policies/F8CC7B38-95F9-4240-A528-B890AF87188C/requirements/A4B41B90-78FB-40A7-8754-33609294C4F6",
                "rel": "self",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/v1/codes?codeName=RequirementType&codeValue=Fu",
                "rel": "codes/requirementType",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/v1/codes?codeName=RequirementStatus&codeValue=00",
                "rel": "codes/status",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/v1/codes?codeName=RequirementStatus&codeValue=01",
                "rel": "codes/previousStatus",
                "mediaType": "application/json",
                "method": "GET"
            }
        ],
        "multiFields": null,
        "codes": [
            {
                "codeName": "AsCodeRequirementStatus",
                "codeValue": "00",
                "longDescription": "New",
                "shortDescription": "New"
            },
            {
                "codeName": "AsCodeRequirementStatus",
                "codeValue": "01",
                "longDescription": "Outstanding",
                "shortDescription": "Outstanding"
            }
        ],
        "message": "Reinsurance Transmittal Req",
        "comments": "Reinsurance Transmittal Req",
        "openDate": "2015-08-04T00:00:00Z",
        "closeDate": "2020-01-06T00:00:00Z",
        "dueDate": "2020-01-06T00:00:00Z",
        "expirationDate": "2050-01-06T00:00:00Z",
        "overdueGmt": "2040-01-06T00:00:00Z",
        "nextProcessGmt": "2019-03-09T13:49:02Z",
        "lockedGmt": "2030-01-06T00:00:00Z",
        "createdBy": "qatester3",
        "lastModifiedBy": "SYSTEM",
        "policyId": "F8CC7B38-95F9-4240-A528-B890AF87188C",
        "clientId": null,
        "fullName": null,
        "requirementId": "A4B41B90-78FB-40A7-8754-33609294C4F6",
        "requirementDefinitionId": "8E139408-0B64-477E-BE6B-FF9F880D1E26",
        "status": "00",
        "requirementType": "Fu",
        "previousStatus": "01",
        "createdDate": "2018-11-12T10:41:34Z",
        "lastmodifiedDate": "2019-03-09T13:44:02Z",
        "requirementDefinition": null
    }
}

Back to Top