REST API Services for Oracle CPQ

Update Saved Search Access Permissions

post

/rest/v19/searchResources/{resourceVarName}/accessSavedSearches

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

Request

Path Parameters

resourceVarName(required): string

The unique variable name to identify the process.

Root Schema : UpdateSavedSearchPropertyModel

Type: object

Show Source

_entity: string

Example: Quote
accessSavedSearches: array accessSavedSearches
hideSavedSearches: array hideSavedSearches

{
    "type":"object",
    "properties":{
        "_entity":{
            "type":"string",
            "example":"Quote"
        },
        "accessSavedSearches":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SavedSearchPropertyModel"
            }
        },
        "hideSavedSearches":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SavedSearchPropertyModel"
            }
        }
    }
}

Nested Schema : accessSavedSearches

Type: array

Show Source

Array of: object SavedSearchPropertyModel

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SavedSearchPropertyModel"
    }
}

Nested Schema : hideSavedSearches

Type: array

Show Source

Array of: object SavedSearchPropertyModel

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SavedSearchPropertyModel"
    }
}

Nested Schema : SavedSearchPropertyModel

Type: object

Show Source

queryId: number

Example: 34456783
status: boolean

{
    "type":"object",
    "properties":{
        "queryId":{
            "type":"number",
            "example":34456783
        },
        "status":{
            "type":"boolean"
        }
    }
}

Response

201 Response

The status change is successful.

404 Response

Search or Resource not found

405 Response

User has no access to modify the shared property of saved searches

Examples

The following examples show how to update access for the specified saved search by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/searchResources/commerceDocumentsOraclecpqoTransaction/accessSavedSearches

Hide a Saved Search Request Body Sample

{
  "_entity": "Quote",
  "accessSavedSearches": [],
  "hideSavedSearches": [{
      "queryId": 3023270385,
      "status": true
    }
  ]
}

Unhide a Saved Search Request Body Sample

{
  "_entity": "Quote",
  "accessSavedSearches": [],
  "hideSavedSearches": [{
      "queryId": 3023270385,
      "status": false
    }
  ]
}

Share a Saved Search Request Body Sample

{
  "_entity": "Quote",
  "accessSavedSearches": [{
      "queryId": 3023270385,
      "status": true
    }
  ],
  "hideSavedSearches": []
}

Unshare a Saved Search Request Body Sample

{
  "_entity": "Quote",
  "accessSavedSearches": [{
      "queryId": 3023270385,
      "status": false
    }
  ],
  "hideSavedSearches": []
}