The REST API provides the following methods to manage product usage settings:

Product Usage data is not collected for engines running on AIX, HPUX and Solaris operating systems.

GET /api/productusage/settings

URI GET /api/productusage/settings
Description Retrieves product usage settings.
Request Header Accept: application/json

Accept: application/vnd.orchestral.rhapsody.6_5+json
Request Body Empty.
Response Status 200 OK - operation successful.
Response Body

The response body has the following data object structure:

  • productUsageEnabled - [boolean] true if product usage is enabled.
{
  "data":{
	"productUsageEnabled":false
  },
  "error":null
}
Access Rights 'Manage product usage REST API'.

PUT /api/productusage/settings

URI PUT /api/productusage/settings
Description Updates product usage settings.
Request Header

Content-Type: application/json
CSRF Protection Enabled

Content-Type: application/vnd.orchestral.rhapsody.6_5+json
CSRF Protection Enabled
Request Body

The request body has the following data object structure:

  • productUsageEnabled - [boolean] true if product usage is enabled.
{
  "productUsageEnabled":false
}
Response Status 204 No Content - operation successful.
Response Body Empty.
Access Rights 'Manage product usage REST API'.