1. REST API Services for Oracle CPQ
  2. Tasks
  3. Favorites

Get User's List of Favorites

get

/rest/v16/favorites

This endpoint returns a list of all favorites available to the user.

Request

Supported Media Types
Query Parameters
  • Exclude links from the response.
  • A list of fields to be returned.
  • Specifies the category for the favorite; personal (myFavorites), company (companyFavorites), or shared by other users (sharedWithMeFavorites).
  • Specifies the pagination limit, up to 1000. If no limit is specified or if a limit greater than 1000 is specified, a pagination limit of 1000 will be used.
  • Specifies the offset in the record set to start the response from. Usually used in conjunction with limit parameter to obtain the next set of records.
  • Specifies a comma-separated list of fields to order the response by.
  • Declares a query specification expression.
  • Specifies that the total count of records should be included in the response when doing pagination. Only effective when limit or offset are specified.
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : favorites-collection
Type: object
Show Source
  • The number of resource instances returned in the current range.
  • Returns true if more resources are available on the server than the subset returned in current page.
  • items
  • The actual paging size used by the server. If no limit was specified or if a limit greater than 1000 is specified, a pagination limit of 1000 will be used.
  • The offset used in the current page.
  • Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : items
Type: array
Show Source
Nested Schema : Favorites
Type: object
Title: Favorites
Show Source
Nested Schema : Active Actions
Type: object
Title: Active Actions
List of active action variable names
Nested Schema : Configuration Attributes
Type: object
Title: Configuration Attributes
Configuration Attributes holder
Nested Schema : Part Properties
Type: object
Title: Part Properties
Part Properties JSON
Nested Schema : Price
Type: object
Title: Price
total price
Show Source
Nested Schema : Price Book
Type: object
Title: Price Book
Associated Price Book
Show Source
Nested Schema : System Navigation Info
Type: object
Title: System Navigation Info
System Navigation Info
Nested Schema : Type Specific Attributes
Type: object
Title: Type Specific Attributes
JSON of Type Specific Attributes
Back to Top

Examples

The following example shows how to retrieve a list of favorites by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL. 

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/favorites

Sample Endpoint with Decoded Query Parameters

https://sitename.oracle.com/rest/v16/favorites?limit=50&offset=0&totalResults=true&finder=myFavorites&q=folderId:{$ne:6992502},$or[{"label":$like:"%@%",$options:'I'}}]}

Response Body Sample 

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/favorites"
    }
  ],
  "items": [{
      "type": 2,
      "lineBomDisplayName": null,
      "ownerUserEmail": "john.jones@oracle.com",
      "dateAdded": "2022-02-16T21:46:23.000Z",
      "ownerUserFirstName": "John",
      "userAddedFirstName": "John",
      "prefCurrencyName": "US Dollar",
      "serialNumberDescription": null,
      "priceBook": {
        "variableName": "_default_price_book",
        "name": "Base Price",
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v16/priceBooks"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v16/priceBooks/_default_price_book"
          }
        ]
      },
      "itemName": "car1",
      "prefLanguageName": "English",
      "isFolderShared": false,
      "price": {
        "value": -1.0,
        "currency": "USD"
      },
      "id": 3022619257,
      "refName": "partpriority:car1",
      "isMandatory": false,
      "visibilityType": 3,
      "serialNumber": null,
      "userModifiedLastName": null,
      "folderId": "6992501",
      "sysNavInfo": {},
      "userModifiedFirstName": "John",
      "itemId": "12466079",
      "productLineName": "Car 1",
      "subType": 0,
      "folderName": "[Default]",
      "status": 1,
      "supplierCompanyId": 4118171,
      "rootId": 3022619257,
      "typeSpecificAttrs": null,
      "description": null,
      "isReadOnly": false,
      "configAttributes": {
        "_config_upgrade_name": {
          "name": "Config Upgrade Name",
          "value": ""
        },
        "_configuration_id": {
          "name": "Configuration Id",
          "value": ""
        },
        "systemConfigModelPath": {
          "name": "System Config Model Path",
          "value": ""
        },
        "_array_key_searchFlowArrayControl": {
          "name": "searchFlowArrayControl array key",
          "value": "[1] = 2fcab1c3-4563-4fca-8abf-54a2890f63af"
        },
        "_array_key_numberOfItems1": {
          "name": "numberOfItems1 array key",
          "value": "[1] = f62f4bc9-3ce4-4306-84ab-afd48cffcf58"
        },
        "ruleActionType": {
          "name": "Rule Action Type",
          "value": "Advanced action, hardcoded"
        },
        "numberOfLineItems": {
          "name": "Number of Line Items",
          "value": "3"
        }
      },
      "isShareable": true,
      "userAddedLastName": null,
      "sysConfigPath": null,
      "productType": "Economy SUV",
      "ownerUserLastName": null,
      "quantity": 1,
      "activeActions": ["copyTo", "reconfigure", "moveTo"],
      "dateModified": "2022-02-17T21:07:31.000Z",
      "partProps": null,
      "label": "Model",
      "buyerCompanyId": 4118171,
      "parentId": -1,
      "segmentName": "Economy SUV",
      "modelName": "ESUV100",
      "sysNavError": null,
      "supplierCompanyName": "ABC Company",
      "ownerUserKey": "bd6172e3-71b6-4b4d-a2c9-41c82e3e707c",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/favorites/3022619257"
        }, {
          "kind": "",
          "rel": "child",
          "name": "sharePermissions",
          "href": "https://sitename.oracle.com/rest/v16/favorites/3022619257/sharePermissions"
        }, {
          "kind": "",
          "rel": "child",
          "name": "subItems",
          "href": "https://sitename.oracle.com/rest/v16/favorites/3022619257/subItems"
        }
      ]
    }, {
      "type": 2,
      "lineBomDisplayName": null,
      "ownerUserEmail": "john.jones@oracle.com",
      "dateAdded": "2022-02-16T21:46:23.000Z",
      "ownerUserFirstName": "John",
      "userAddedFirstName": "John",
      "prefCurrencyName": "US Dollar",
      "serialNumberDescription": null,
      "priceBook": {
        "variableName": "_default_price_book",
        "name": "Base Price",
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com.com/rest/v16/priceBooks"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v16/priceBooks/_default_price_book"
          }
        ]
      },
      "itemName": " car2",
      "prefLanguageName": "English",
      "isFolderShared": false,
      "price": {
        "value": -1.0,
        "currency": "USD"
      },
      "id": 3022619257,
      "refName": "partpriority:car2",
      "isMandatory": false,
      "visibilityType": 3,
      "serialNumber": null,
      "userModifiedLastName": null,
      "folderId": "6992501",
      "sysNavInfo": {},
      "userModifiedFirstName": "John",
      "itemId": "12466079",
      "productLineName": "Car 2",
      "subType": 0,
      "folderName": "[Default]",
      "status": 1,
      "supplierCompanyId": 4118171,
      "rootId": 3022619257,
      "typeSpecificAttrs": null,
      "description": null,
      "isReadOnly": false,
      "configAttributes": {
        "_config_upgrade_name": {
          "name": "Config Upgrade Name",
          "value": ""
        },
        "_configuration_id": {
          "name": "Configuration Id",
          "value": ""
        },
        "systemConfigModelPath": {
          "name": "System Config Model Path",
          "value": ""
        },
        "_array_key_searchFlowArrayControl": {
          "name": "searchFlowArrayControl array key",
          "value": "[1] = 2fcab1c3-4563-4fca-8abf-54a2890f63af"
        },
        "_array_key_numberOfItems1": {
          "name": "numberOfItems1 array key",
          "value": "[1] = f62f4bc9-3ce4-4306-84ab-afd48cffcf58"
        },
        "ruleActionType": {
          "name": "Rule Action Type",
          "value": "Advanced action, hardcoded"
        },
        "numberOfLineItems": {
          "name": "Number of Line Items",
          "value": "3"
        }
      },
      "isShareable": true,
      "userAddedLastName": null,
      "sysConfigPath": null,
      "productType": "Testbed",
      "ownerUserLastName": null,
      "quantity": 1,
      "activeActions": ["copyTo", "reconfigure", "moveTo"],
      "dateModified": "2022-02-17T21:07:31.000Z",
      "partProps": null,
      "label": "Model",
      "buyerCompanyId": 4118171,
      "parentId": -1,
      "segmentName": "Economy SUV",
      "modelName": "ESUV200",
      "sysNavError": null,
      "supplierCompanyName": "ABC Company",
      "ownerUserKey": "bd6172e3-71b6-4b4d-a2c9-41c82e3e707c",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/favorites/3022619257"
        }, {
          "kind": "",
          "rel": "child",
          "name": "sharePermissions",
          "href": "https://sitename.oracle.com/rest/v16/favorites/3022619257/sharePermissions"
        }, {
          "kind": "",
          "rel": "child",
          "name": "subItems",
          "href": "https://sitename.oracle.com/rest/v16/favorites/3022619257/subItems"
        }
      ]
    }
  ]
}
Back to Top