Get a specific product by product Id

get

/PASService/rest/services/v1/products/{productId}

Gets a product based on the specified product Id.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

200 Response

This operation fetches a specific prodcut by product Id successfully.
Back to Top

Examples

This example describes how to get a product based on the specified product 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/products/48C12B7F-BB92-47AE-8723-22085BF9FC91"

Example Response Body

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

{
    "product": {
        "links": [
            {
                "href": "http://server:port/PASService/rest/services/v1/products/06B2036D-6CBD-45C6-9997-58D6E17D395C",
                "rel": "self",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/v1/products/06B2036D-6CBD-45C6-9997-58D6E17D395C/plans",
                "rel": "plans",
                "mediaType": "application/json",
                "method": "GET"
            }
        ],
        "codes": null,
        "productName": "TestProduct_5",
        "productDescription": "",
        "effectiveFrom": "2014-12-23T00:00:00Z",
        "effectiveTo": "2015-12-23T00:00:00Z",
        "ancestorId": null,
        "plans": [
            {
                "links": [
                    {
                        "href": "http://server:port/PASService/rest/services/v1/products/06B2036D-6CBD-45C6-9997-58D6E17D395C/plans/78EB7DD1-329F-4143-9EFE-E42496103B0A",
                        "rel": "self",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PlanAllocationMethod&codeValue=01",
                        "rel": "codes/planAllocationMethodCode",
                        "mediaType": "application/json",
                        "method": "GET"
                    }
                ],
                "multiFields": null,
                "codes": [
                    {
                        "codeName": "AsCodePlanAllocationMethod",
                        "codeValue": "01",
                        "longDescription": "Default",
                        "shortDescription": "Default"
                    }
                ],
                "effectiveFrom": "2014-12-23T00:00:00Z",
                "effectiveTo": "2015-12-23T00:00:00Z",
                "planName": "RegPlan5",
                "systemCode": "00",
                "defaultCurrencyCode": "USD",
                "pointInTimeValuation": "Y",
                "mixedValuation": null,
                "planAllocationMethodCode": "01",
                "updatedGmt": "2014-12-24T04:38:32Z",
                "activeGmt": "2014-12-24T04:38:32Z",
                "recordStatusCode": "ACTIVE",
                "updatedBy": "install",
                "businessStatusCode": null,
                "planSliceId": "4281AE71-639B-4526-A488-2A814BE3DA33",
                "planId": "78EB7DD1-329F-4143-9EFE-E42496103B0A",
                "companyId": "80798FC2-FEB9-4998-A575-513FF89698B1",
                "marketMakerId": "22FBC7C1-D8E0-4741-9D22-DF929A2890B5",
                "productId": "06B2036D-6CBD-45C6-9997-58D6E17D395C"
            }
        ],
        "productId": "06B2036D-6CBD-45C6-9997-58D6E17D395C",
        "companyId": "80798FC2-FEB9-4998-A575-513FF89698B1"
    }
}
Back to Top