Get a specific plan by plan Id
get
/PASService/rest/services/v1/plans/{planId}
Gets a plan based on the specified plan Id.
Request
Path Parameters
-
planId(required): string(guid)
Plan Id
There's no request body for this operation.
Back to TopResponse
200 Response
This operation fetches details of a specific plan by plan Id successfully.
Examples
This example describes how to get a plan based on the specified plan 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/plans/17CFE15E-0CDC-4CBA-A8BE-25BC0A0647D5"
Example Response Body
The following shows an example of the response body in JSON format:
{ "plan": { "links": [ { "href": "http://server:port/PASService/rest/services/v1/plans/9F5507A5-B7EC-4637-BD86-5168A1864408", "rel": "self", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/v1/plans/9F5507A5-B7EC-4637-BD86-5168A1864408/planslices", "rel": "planslices", "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" }, { "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PlanBusinessStatus&codeValue=Approved", "rel": "codes/businessStatus", "mediaType": "application/json", "method": "GET" } ], "codes": [ { "codeName": "AsCodePlanAllocationMethod", "codeValue": "01", "longDescription": "Default", "shortDescription": "Default" }, { "codeName": "AsCodePlanBusinessStatus", "codeValue": "Approved", "longDescription": "Approved", "shortDescription": "Approved" } ], "effectiveFrom": "2020-06-15T00:00:00Z", "effectiveTo": null, "planName": "MainPlanWithSegment123", "systemCode": "01", "defaultCurrencyCode": "USD", "pointInTimeValuation": "Y", "mixedValuation": "N", "planAllocationMethodCode": "01", "updatedGmt": "2023-02-01T07:09:17Z", "activeGmt": "2023-02-01T07:09:07Z", "recordStatusCode": "ACTIVE", "updatedBy": "qatester3", "businessStatusCode": "Approved", "planSliceId": "75483CD4-743B-4588-A4F0-E6AA6F90AEA1", "planId": "9F5507A5-B7EC-4637-BD86-5168A1864408", "companyId": "80798FC2-FEB9-4998-A575-513FF89698B1", "marketMakerId": "22FBC7C1-D8E0-4741-9D22-DF929A2890B5", "productId": "0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1" } }