Purge Unused Benefit Specification

This synchronous operation enables the deletion of unused benefit specifications.

Purging of unused benefit specifications is initiated by an HTTP POST request to the following endpoint:

  • http://[hostName]:[portNumber]/[api-context-root]//benefitspecifications/purge

Purge Operation

Purge benefit specification deletes all unused benefit specifications i.e.

  • The benefit specifications for which no product benefit specification exists

  • This scenario happens when a Product Service Definition is updated, and the product is re-build. Refer Build Product for additional information on the build process and creation of benefit specifications

Response Messages

This operation will provide HTTP status codes based on the outcome of the operation.

  • Success
    HTTP Status 200 OK is returned on the successful completion of purge operation.

  • Failure
    If an error occurs, the operation returns an appropriate HTTP status code, and a notification with the error details. See Response Messages for more details on error codes.

Authorization

The above described operation is protected by access restriction 'benefitspecifications.purge IP`.