Saved Search REST APIs

Oracle CPQ 24B provides the following endpoints to support Saved Searches on the new Quotes List page. Grouping and keyword searches are supported for applicable endpoints.

For Quotes List Saved Searches the {resourceName} variable uses the following syntax: /commerceDocuments{ProcessVarName}{MainDocVarName}.

Get Saved Searches

Use this endpoint to retrieve a list of saved searches for the specified resource.

• Endpoint: /rest/v16/searchResources/{resourceVarName}
• Method:  GET

Create a Saved Search

Use this endpoint to create a new saved search for the specified resource.

• Endpoint: /rest/v16/searchResources/{resourceVarName}
• Method:  POST

Get a Saved Search

Use this endpoint to retrieve the specified saved search.

• Endpoint: /rest/v16/searchResources/{resourceVarName}/{searchId}
• Method:  GET

Delete a Saved Search

Use this endpoint to delete the specified saved search.

• Endpoint: /rest/v16/searchResources/{resourceVarName}/{searchId}
• Method:  DELETE

Update a Saved Search

Use this endpoint to update the specified saved search.

• Endpoint: /rest/v16/searchResources/{resourceVarName}/{searchId}
• Method:  PATCH

Update Saved Search Access Permissions

Use this endpoint to update the hidden or shared status of a saved search.

• Endpoint: /rest/v16/searchResources/{resourceVarName}/accessSavedSearches
• Method:  POST

Update User Default Saved Search

Use this endpoint to update the default saved search for the user.

• Endpoint: /rest/v16/searchResources/{resourceVarName}/entityPreferenceForUser
• Method:  POST

Update Site Default Saved Search

Use this endpoint to update the default saved search for the site.

• Endpoint: /rest/v16/searchResources/{resourceVarName}/entityPreferenceForSite
• Method:  POST

Saved Search REST APIs allow customers to manage search resources using REST web services.

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.