Favorite REST APIs

Get User's List of Favorites
Description	This endpoint returns a list of all favorites available to the user.
URI Endpoint	/rest/v17/favorites
Endpoint Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. expand - Return child resource details. limit - 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. offset - 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. totalResults - Specifies that the total count of records should be included in the response when doing pagination. Only effective when limit or offset are specified. orderby - Specifies a comma-separated list of fields to order the response by. excludeLinks - Exclude links from the response. fields - A list of fields to be returned. finder - Specifies the category for the favorite; personal (myFavorites), company (companyFavorites), or shared by other users (sharedWithMeFavorites).
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The JSON data for all favorites available to the user

URI Endpoint Sample

Response Sample

Get a Favorite
Description	This endpoint returns a list of all favorites available to the user.
URI Endpoint	/rest/v17/favorites/{id}
Endpoint Parameters	id	The identifier for the favorite
	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. expand - Return child resource details. limit - 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. offset - 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. totalResults - Specifies that the total count of records should be included in the response when doing pagination. Only effective when limit or offset are specified. excludeLinks - Exclude links from the response. fields - A list of fields to be returned. finder - Specifies the category for the favorite; personal (myFavorites), company (companyFavorites), or shared by other users (sharedWithMeFavorites).
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The JSON data for the specified favorite

URI Endpoint Sample

Response Sample

{ "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/v17/priceBooks" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/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/v17/favorites/3022619257" }, { "kind": "", "rel": "child", "name": "sharePermissions", "href": "https://sitename.oracle.com/rest/v17/favorites/3022619257/sharePermissions" }, { "kind": "", "rel": "child", "name": "subItems", "href": "https://sitename.oracle.com/rest/v17/favorites/3022619257/subItems" } ] } ] }

Get List of the Selected Options from a Favorite
Description	This endpoint returns the list of selected options of an individual favorite.
URI Endpoint	/rest/v17/favorites/{rootId}/subItems
Endpoint Parameters	rootId	The identifier for the parent favorite
	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. orderby - Specifies a comma-separated lit of fields to order the response by. fields - A list of fields to be returned.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The JSON data for the selected option of the specified favorite

URI Endpoint Sample

Response Sample

Get Details of a Favorite's Selected Option
Description	This endpoint returns the details of a favorite's selected option.
URI Endpoint	/rest/v17/favorites/{rootId}/subItems/{subitemId}
Endpoint Parameters	rootId	The identifier for the parent favorite
	subitemId	The identifier for the child of the parent favorite
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The JSON data for the selected option of the specified favorite

URI Endpoint Sample

Response Sample

{ "type": 3, "lineBomDisplayName": "part12", "ownerUserEmail": "john.jones@oracle.com", "dateAdded": "2022-03-01T02:45:00.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/v17/priceBooks" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/priceBooks/_default_price_book" } ] }, "itemName": "part12", "prefLanguageName": "English", "price": { "value": 12.0, "currency": "USD" }, "id": 9100006907, "refName": "part12", "isMandatory": true, "serialNumber": null, "userModifiedLastName": null, "userModifiedFirstName": "John", "itemId": "8523095", "productLineName": null, "subType": 2, "status": 0, "supplierCompanyId": 4118171, "rootId": 9100006903, "typeSpecificAttrs": null, "configAttributes": null, "userAddedLastName": null, "sysConfigPath": "_root:::part12::0::0", "productType": "Part", "ownerUserLastName": null, "quantity": 1, "dateModified": "2022-03-01T02:48:15.000Z", "partProps": { "Part Number": "part12", "Part Lead Time": "N/A", "Part Description": "", "Line BOM Display Name": "part12", "Part Type (Custom Field 9)": "100K Parts", "String (Custom Field 1)": "String", "String Filter (Custom Field 4)": "", "Float (Custom Field 5)": "0.0", "Float Filter (Custom Field 6)": "0.0", "Integer (Custom Field 7)": "0", "SSM (Custom Field 2)": "Value 1 Label", "SSM Filter (Custom Field 8)": "", "MSM (Custom Field 16)": "", "MSM Filter (Custom Field 17)": "", "Page Specific Label (Custom Field 3)": "", "Required String (Custom Field 10)": "Custom Field 10, part12", "Required SSM (Custom Field 11)": "Required value", "Custom Field 13": "Custom Field 13, part12", "Custom Field 14": "Custom Field 14, part12", "Custom Field 15": "Custom Field 15, part12", "Custom Field 18": "Custom Field 18, part12", "Custom Field 19": "Custom Field 19, part12", "Custom Field 20": "Custom Field 20, part12", "Custom Field 21": "Custom Field 21, part12", "Custom Field 22": "Custom Field 22, part12", "Custom Field 23": "Custom Field 23, part12", "Custom Field 24": "Custom Field 24, part12", "Custom Field 25": "Custom Field 25, part12", "Custom Field 26": "Custom Field 26, part12", "Custom Field 27": "Custom Field 27, part12", "Custom Field 30": "Custom Field 30, part12" }, "label": "Part", "parentId": 9100006903, "segmentName": null, "modelName": null, "supplierCompanyName": "abcCompany", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/favorites/9100006903/subItems/9100006907" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/favorites/9100006903" } ] }

Update the Favorite's Label or Description
Description	Use this endpoint to update the favorite's label.
URI Endpoint	/rest/v17/favorites/{rootId}
Endpoint Parameters	rootId	The identifier for the parent favorite
HTTP Method	POST
Request Body Parameters	None
Response Body Parameters	The JSON data for favorite with the label updated

URI Endpoint Sample

Request Sample

Response Sample

{ "rootId": 9100006903, "description": "Updated description", "userModifiedLastName": null, "dateModified": "2022-03-01T02:46:05.491Z", "label": "Updated value", "folderId": "6992501", "userModifiedFirstName": "Justin", "isFolderShared": false, "isReadOnly": false, "isShareable": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/favorites/9100006903" }, { "kind": "", "rel": "child", "name": "sharePermissions", "href": "https://sitename.oracle.com/rest/v17/favorites/9100006903/sharePermissions" }, { "kind": "", "rel": "child", "name": "subItems", "href": "https://sitename.oracle.com/rest/v17/favorites/9100006903/subItems" } ] }

Update the Label or Description of a Selected Option
Description	Use this endpoint to update the favorite's selected option label.
URI Endpoint	/rest/v17/favorites/{rootId}/subItems/{subitemId}
Endpoint Parameters	rootId	The identifier for the parent favorite
	subitemId	The identifier for the child of the parent favorite
HTTP Method	POST
Request Body Parameters	None
Response Body Parameters	The JSON data for the favorite with the selected option label updated

URI Endpoint Sample

Request Sample

Response Sample

{ "supplierCompanyId": 4118171, "rootId": 9100006903, "userModifiedLastName": null, "dateModified": "2022-03-01T18:13:51.217Z", "label": "Renamed Subitem", "userModifiedFirstName": "Joe", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/favorites/9100006903/subItems/9100006907" } ] }

Delete a List of Favorites
Description	This endpoint deletes a list of favorites.
URI Endpoint	/rest/v17/favorites/actions/delete
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	selections	The identifiers for the list of favorites to be deleted
Response Body Parameters	JSON data showing an empty items array

URI Endpoint Sample

Request Sample

Response Sample

{ "items": [] }

Delete a Favorite
Description	This endpoint deletes a favorite.
URI Endpoint	/rest/v17/favorites/{id}/actions/delete
Endpoint Parameters	id	The identifier for the favorite to delete
HTTP Method	POST
Request Body Parameters	None
Response Body Parameters	The JSON data showing an empty items array

URI Endpoint Sample

Response Sample

{ "items": [] }

Copy a List of Favorites to a Folder
Description	This endpoint copies a list of favorites to a folder.
URI Endpoint	/rest/v17/favorites/actions/copyTo
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	selections	The identifiers for the list of favorites to be copied
	targetFolderId	The folder identifier to put the copy of the favorite
	labels	The label for the copy of the favorite
Response Body Parameters	The identifiers for the new copy of the favorites

URI Endpoint Sample

Request Sample

Response Sample

{ "result": { "ids": [3023768871, 3023768873] } }

Copy a Favorite
Description	This endpoint copies a favorite.
URI Endpoint	/rest/v17/favorites/{id}/actions/copyTo
Endpoint Parameters	id	The identifier for the favorite to copy
HTTP Method	POST
Request Body Parameters	targetFolderId	The folder identifier to put the copy of the favorite
	label	The label for the copy of the favorite
Response Body Parameters	The identifier for the new copy of the favorite

URI Endpoint Sample

Request Sample

Response Sample

{ "result": { "ids": [3023768871] } }

Move a List of Favorites to a Folder
Description	This endpoint moves a list of favorites to a folder.
URI Endpoint	/rest/v17/favorites/actions/moveTo
Endpoint Parmeters	None
HTTP Method	POST
Request Body Parameters	selections	The identifiers for the favorites to be moved
	targetFolderId	The folder identifier to put the favorites
Response Body Parameters	JSON data showing an empty items array

URI Endpoint Sample

Request Sample

Response Sample

{ "items": [] }

Move a Favorite to a Folder
Description	This endpoint moves a favorite to a folder.
URI Endpoint	/rest/v17/favorites/{id}/actions/moveTo
Endpoint Parameters	id	The identifier for the favorite to move
HTTP Method	POST
Request Body Parameters	targetFolderId	The folder identifier to put the favorite
Response Body Parameters	JSON data showing an empty items array

URI Endpoint Sample

Request Sample

Response Sample

{ "items": [] }

Reconfigure a Favorite
Description	This endpoint reconfigures a favorite.
URI Endpoint	/rest/v17/favorites/{id}/actions/reconfigure
Endpoint Parameters	id	The identifier for the favorite
HTTP Method	POST
Request Body Parameters	None
Response Body Parameters	The response contains the destinationUrl to launch the Configuration page

URI Endpoint Sample

Response Sample

{ "destinationUrl": "https://localhost:8080//commerce/buyside/commerce_list_detail.jsp?id=<favoriteId>&contentType=7&autosubmit=true" }

Get Sharing Settings for a Favorite
Description	This endpoint returns the sharing settings for a favorite.
URI Endpoint	/rest/v17/favorites/{id}/sharePermissions
Endpoint Parameters	id	The identifier for the favorite
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The JSON data for the sharing permissions for the favorite

URI Endpoint Sample

Response Sample

{ "items": [{ "accessLevel": { "lookupCode": "1" }, "userId": { "key": "abcd-efgh" } }, { "accessLevel": { "lookupCode": "1" }, "groupId": { "id": 21081266 } } ] }

Update Sharing Settings for a Favorite
Description	This endpoint updates the sharing settings for a favorite. Only the owner of the favorite or FullAccess user can update a favorite.
URI Endpoint	/rest/v17/favorites/{id}/sharePermissions
Endpoint Parameters	id	The identifier for the favorite
HTTP Method	PUT
Request Body Parameters	items	The list of all permission settings for the favorite. All permissions must be included in the request regardless if being updated.
Successful Response	HTTP Code 204

URI Endpoint Sample

Request Sample

Remove Myself from a Shared Favorite
Description	This endpoint removes the current user from a shared favorite.
URI Endpoint	/rest/v17/favorites/{id}/actions/removeMe
Endpoint Parameters	id	The identifier for the shared favorite
HTTP Method	POST
Request Body Parameters	None
Successful Response	JSON data showing an empty items array

URI Endpoint Sample

Response Sample

{ "items": [] }

Get a List of Favorite Folders
Description	This endpoint returns a list of all favorite folders available to the user.
URI Endpoint	/rest/v17/favoriteFolders
Endpoint Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. expand - Return child resource details. limit - 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. offset - 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. totalResults - Specifies that the total count of records should be included in the response when doing pagination. Only effective when limit or offset are specified. orderby - Specifies a comma-separated list of fields to order the response by. excludeLinks - Exclude links from the response. fields - A list of fields to be returned.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The JSON data for all favorite folders available to the user

URI Endpoint Sample

Response Sample

Get a Favorite Folder
Description	This endpoint returns a favorite folder available to the user.
URI Endpoint	/rest/v17/favoriteFolders/{id}
Endpoint Parameters	id	The identifier for the favorite
	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. expand - Return child resource details. limit - 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. offset - 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. totalResults - Specifies that the total count of records should be included in the response when doing pagination. Only effective when limit or offset are specified. orderby - Specifies a comma-separated list of fields to order the response by. excludeLinks - Exclude links from the response. fields - A list of fields to be returned.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The JSON data for the specified favorite folder

URI Endpoint Sample

Response Sample

{ "id": 123, "name": "SUV List", "isShared": true, "canAdd": true, "dateAdded": "08/17/2021 2:00 AM", "dateModified": "08/17/2021 2:00 AM", "createdBy": "john.jones", "links": ... }

Create a Favorite Folder
Description	This endpoint creates a favorite folder.
URI Endpoint	/rest/v17/favoriteFolders
Endpoint Parmeters	None
HTTP Method	POST
Request Body Parameters	name	The name of the favorite folder
Response Body Parameters	The JSON data for the new favorite folder

URI Endpoint Sample

Request Sample

Response Sample

Update a Favorite Folder
Description	This endpoint updates a favorite folder.
URI Endpoint	/rest/v17/favoriteFolders/{id}
Endpoint Parameters	id	The identifier for the favorite folder to update
HTTP Method	POST
Request Body Parameters	name	The name for the favorite folder
Response Body Parameters	The JSON data for the updated favorite folder

URI Endpoint Sample

Request Sample

Response Sample

Delete a Favorite Folder
Description	This endpoint deletes a favorite folder. Favorites included in the folder are moved to the Trash folder.
URI Endpoint	/rest/v17/favoriteFolders/{id}
Endpoint Parameters	id	The identifier for the favorite folder to delete
HTTP Method	POST
Request Body Parameters	None
Successful Response	HTTP Code 204

URI Endpoint Sample

Get Permissions for a Favorite Folder
Description	This endpoint retrieves the favorite folder share permissions.
URI Endpoint	/rest/v17/favoriteFolders/{id}/sharePermissions
End Parameters	id	The identifier for the favorite folder to get permissions
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	hasMore	The boolean value indicates if there are more folder permissions available in the database
	items	The list of share permissions for the favorite folder

URI Endpoint Sample

Response Sample

{ "hasMore": false, "items": [{ "accessLevel": { "lookupCode": "1", "displayValue": "Edit", "id": 3022550530 }, "groupId": { "id": 21081269, "variableName": "salesAdministrator" }, "groupLabel": "Sales Administrator", "dateModified": "2021-10-29T04:36:24.000Z", "dateAdded": "2021-10-29T04:36:24.000Z", "favoriteFolderId": { "id": 3022551859, "name": "an" } } ] }

Update or Remove Permissions for a Favorite Folder
Description	This endpoint modifies the shared permissions for a favorite folder. Only groups can be granted folder permissions.
URI Endpoint	/rest/v17/favoriteFolders/{id}/sharePermissions
End Parameters	id	The identifier for the favorite folder to update
HTTP Method	PUT
Request Body Parameters	items	The list of specific permissions to update or [] to remove all permissions.
Successful Response	HTTP Code 204

URI Endpoint Sample

Request Sample

{ "items": [{ "accessLevel": { "displayValue": "Edit" }, "groupId": { "variableName": "salesAdministrator" } } ] }

Get Favorite Process Invocations
Description	This endpoint returns the process invocations for favorites.
URI Endpoint	/rest/v17/favorites/actions/getProcessInvocations
End Parameters	None
HTTP Method	POST
Request Body Parameters	None
Response Body Parameters	hasMore	The boolean value indicates if there are more process invocations available in the database
	items	The JSON data for process invocations for favorites

URI Endpoint Sample

Response Sample

{ "result": { "hasMore": false, "items": [{ "variableName": "CM_4174166", "name": "Create Quotes", "description": "Create Quote", "targetType": "start" }, { "variableName": "CM_7065206", "name": "Add to Cart (Quotes)", "description": "", "targetType": "shoppingCart" }, { "variableName": "CM_18321147", "name": "Add from Favorite", "description": "", "targetType": "start" } ] } }

Invoke Favorite
Description	This endpoint invokes a process actions upon user request.
URI Endpoint	/rest/v17/favorites/actions/start
End Parameters	None
HTTP Method	POST
Request Body Parameters	variableName	The variable name for the process invocation
	selections	The selected favorites for process invocation
	Note: For Add or Cancel actions, the transaction details are required. Therefore the Add from Favorite action must be performed before Add or Cancel actions.
Response Body Parameters	The response contains the destinationUrl to launch the process

URI Endpoint Sample

Request Sample

Response Sample

{ "destinationUrl": "" https: //sitename.oracle.com/commerce/buyside/commerce_list_detail.jsp?id=3022619257&contentType=7&autosubmit=true" }

Invoke Add to Cart from Favorites
Description	This endpoint invokes the Shopping Cart process action to add selected items to the specified process shopping cart.
URI Endpoint	/rest/v17/favorites/actions/shoppingCart
End Parameters	None
HTTP Method	POST
Request Body Parameters	variableName	The variable name for the process invocation
	selections	The selected favorites for process invocation
Response Body Parameters	The response contains the most recent updated shopping cart process

URI Endpoint Sample

Request Sample

Response Sample

{ “processVarName”: “oraclecpqo” }