Get a specific segment
get
/PASService/rest/services/segments/{id}
Gets a segment based on the specified segment Id
Request
Path Parameters
-
id: string
Segment Id
Response
Supported Media Types
- application/json
Default Response
successful operation
Examples
This example describes how to get a segment based on the specified segment 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/segments/A3046709-CF2E-4AFF-A4B9-D65C4769F838"
Example Response Body
The following shows an example of the response body in JSON format:
"{
"segment": {
"links": [
{
"href": "http://server:port/PASService/rest/services/segments/A3046709-CF2E-4AFF-A4B9-D65C4769F838",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Status&codeValue=24",
"rel": "codes/status",
"mediaType": "application/json",
"method": "GET"
}
],
"multiFields": {},
"codes": [],
"effectiveDate": "2015-08-04T00:00:00Z",
"roles": [],
"segmentId": "A3046709-CF2E-4AFF-A4B9-D65C4769F838",
"parentSegmentId": "A5EB3029-1171-4530-BE03-43032219C27A",
"policyId": "B6780DC5-D0DE-431B-B049-82DBEE3C7D80",
"segmentNameId": "8123E9B1-498C-4A06-A065-5A4D384C2167",
"status": "24",
"planSegmentNameId": "FA77428F-5094-48EE-B605-9D61A7C8D12F",
"segmentName": {
"multiFields": {},
"codes": [],
"segmentName": "Base Coverage",
"activeFromDate": "2020-01-06T00:00:00Z",
"activeToDate": "2030-01-06T00:00:00Z",
"planSegmentName": "Base Plan",
"segmentNameId": "8123E9B1-498C-4A06-A065-5A4D384C2167",
"planId": "C5EE0DA4-3003-42C1-9468-D91DA546B79F",
"productId": "4821E869-53F5-4CF9-A8BD-645249E8902A",
"type": "04",
"status": "01"
}
}
}
"