Global Dictionary REST API

Oracle CPQ 24B adds web services support for retrieving, updating, and deleting the values in the global dictionary defined for a site. Previously, this was only available via a BML function. Only a full access administrator can access this REST API.

The following new REST API endpoints are supported:

Get All Global Dictionary Key Values

Use this endpoint to retrieve all the global dictionary key values defined for the site.

• Endpoint:  /rest/v16/globalDict
• Method:  GET

Get Global Dictionary Key

Use this endpoint to retrieve a global dictionary key value defined for the site.

• Endpoint:  /rest/v16/globalDict/{key}
• Method:  GET

Add or Update Global Dictionary Key Values

Use this endpoint to add or update the global dictionary key values defined for the site. To update an existing global dictionary key value, the Upsert-Mode header parameter must be set to True. If set to False, only new global dictionary key values are added.

• Endpoint:  /rest/v16/globalDict
• Method:  POST

Delete a Global Dictionary Key Value

Use this endpoint to delete a global dictionary key value defined for the site.

• Endpoint:  /rest/v16/globalDict/{key}
• Method:  DELETE

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.