Overview of PATCHes
A PATCH is a system API operation that modifies an existing resource or a set of related resources in ClaimCenter.
A PATCH consists of the PATCH operation and the endpoint, such as PATCH
/activities/{activityId}
, and a request payload. The request payload
contains the data to modify in the specified resource.
The response to a PATCH includes an HTTP code indicating success or failure. It also includes a response payload. The default response for a PATCH consists of a predetermined set of fields and resources. This may or may not include the data that the PATCH modified.
When a developer is configuring a consumer application to PATCH information to a system API, they will need to determine the correct structure for the request payload. They may also need to parse information out of the response payload.