Partially update a specific role for a specific segment by segment Id and role Id

patch

/PASService/rest/services/v1/segments/{segmentId}/roles/{roleId}

Partially updates a segment role based on the specified segment Id and role Id

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: string
Back to Top

Response

204 Response

successful operation
Back to Top

Examples

This example describes how to update a role partially for the fields given in request body for a specified segment by segment Id and role Id.

Note

Below is the list of Fields that are not allowed for update using PATCH.

  • RoleId
  • companyId
  • policyId
  • segmentId
  • role

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/v1/segments/5C8FA666-56A1-434E-8E81-A29A599E3E96/roles" \
     -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:

{
  "role": {
    "roleAmount": 12,
    "rolePercent": 100
  }
}
Back to Top