Partially update a segment for a specific policy by policy Id and segment Id
patch
/PASService/rest/services/v1/policies/{policyId}/segments/{segmentId}
Partially updates a segment based on the specified policy Id and segment Id
Request
Path Parameters
-
policyId(required): string(guid)
Policy Id
-
segmentId(required): string(guid)
Segment Id
Supported Media Types
- application/json
Root Schema : schema
Type:
stringResponse
204 Response
successful operation
Examples
This example describes how to update a segment partially for the fields given in request body for a specified policy by policy Id and segment Id of the policy.
Note
Below is the list of Fields that are not allowed for update using PATCH.
- segmentId
- parentSegmentId
- policyId
- segmentNameId
- planSegmenNametId
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-L "http://server:port/PASService/rest/services/policies/B580F658-F2AC-4A73-8B0B-3BBF8BB2BC4C/segments" \
-d '{"Use this placeholder to plug-in the example request body given below"}'
Example Request Body
The following shows an example of the request body in JSON format:
{
"segment": {
"RebalanceFrequency": {
"textValue": "01",
"optionText": "Annual"
},
"SystematicWithdrawalProgram": {
"textValue": "00",
"optionText": "No"
},
"RebalanceProgram": {
"textValue": "00",
"optionText": "No"
}
}
}