Partially update a specific requirement for a specific policy by policy Id and requirement Id
patch
/PASService/rest/services/v1/policies/{policyId}/requirements/{requirementId}
Partially update a requirement based on the specified policy Id and requirement Id
Request
Path Parameters
-
policyId(required): string(guid)
Policy Id
-
requirementId(required): string(guid)
Requirement Id
Supported Media Types
- application/json
Root Schema : schema
Type:
stringResponse
204 Response
successful operation
Examples
This example describes how to update a requirement partially for the fields given in request body for a specified policy by policy Id and requirement Id.
Note
Below is the list of Fields that are not allowed for update using PATCH.
- requirementId
- requirementDefinitionId
- lastModifiedGmt
- lastModifiedBy
- previousStatusCode
- createdBy
- overDueGmt
- nextProcessGmt
- lockedGmt
- createdGmt
- policyId
- clientId
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/policies/C9343F06-0EDE-432E-86A3-36FF14E65379/requirements" \
-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:
{
"requirement": {
"message": "Blood work",
"comments": "CBP",
"status": "01"
}
}