Get a Favorite
get
/rest/v19/favorites/{id}
This endpoint returns a list of all favorites available to the user.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
The identifier for the favorite.
Query Parameters
-
expand: string
Return child resource details.
-
finder: string
Specifies the category for the favorite; personal (myFavorites), company (companyFavorites), or shared by other users (sharedWithMeFavorites).
Response
Supported Media Types
- application/json
Default Response
Root Schema : Favorites
Type:
objectTitle:
Show Source
Favorites-
activeActions:
object Active Actions
Title:
Active ActionsList of active action variable names -
buyerCompanyId:
integer
Title:
Buyer Company IdId of the company owner user belongs to -
configAttributes:
object Configuration Attributes
Title:
Configuration AttributesConfiguration Attributes holder -
dateAdded:
string
Title:
Date AddedSystem field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date ModifiedSystem field indicating the date on which the Resource was last modified. -
description:
string
Title:
DescriptionDescription of the favorite -
folderId:
string
Title:
Folder IdId of the Associated Folder -
folderName:
string
Title:
Folder NameName of the folder -
id:
integer
Title:
IdPrimary Key of the resource - isFolderShared: boolean
-
isMandatory:
boolean
Title:
Is MandatoryMandatory item -
isReadOnly:
boolean
Title:
Is Read OnlyFavorite is not updatable -
itemId:
string
Title:
Item IdId of the item -
itemName:
string
Title:
Item NameItem Name -
label:
string
Title:
Favorite NameName of the favorite -
lineBomDisplayName:
string
Title:
Bom Display NameBom Display Name -
modelName:
string
Title:
Model NameModel Name -
ownerUserEmail:
string
Title:
Owner User EmailEmail of the Owner -
ownerUserFirstName:
string
Title:
Owner User First NameFirst Name of the Owner -
ownerUserKey:
string
Title:
Owner User KeyUnique string identifiyng the Owner -
ownerUserLastName:
string
Title:
Owner User Last NameLast Name of the Owner -
parentId:
integer
Title:
Parent IdId of immediate parrent -
partProps:
object Part Properties
Title:
Part PropertiesPart Properties JSON -
prefCurrencyName:
string
Title:
Prefered Currency NameName of prefered currency -
prefLanguageName:
string
Title:
Prefered Language NameName of prefered language -
price:
object Price
Title:
Pricetotal price -
priceBook:
object Price Book
Title:
Price BookAssociated Price Book -
productLineName:
string
Title:
Product Line NameProduct Line Name -
productType:
string
Title:
Product TypePart or model name -
quantity:
integer
Title:
QuantityQuantity -
refName:
string
Title:
Ref NameRef Name -
rootId:
integer
Title:
Root IdId of root favorite -
segmentName:
string
Title:
Segment NameProduct Family Name -
serialNumber:
string
Title:
Serial NumberSerial Number -
serialNumberDescription:
string
Title:
Serial Number DescriptionSerial Number Description -
status:
integer
Title:
StatusStatus of captured favorite - is it needs any update action -
subType:
integer
Title:
Sub TypeSub Type -
supplierCompanyId:
integer
Title:
Supplier Company IdSupplier Company information -
supplierCompanyName:
string
Title:
Supplier Company NameName of the Supplier Company -
sysConfigPath:
string
Title:
System Configuration PathSystem Configuration Path - sysNavError: string
- sysNavInfo: object System Navigation Info
-
type:
integer
Title:
TypeType -
typeSpecificAttrs:
object Type Specific Attributes
Title:
Type Specific AttributesJSON of Type Specific Attributes -
userAddedFirstName:
string
Title:
User Added First NameFirst Name of the user who created the record -
userAddedLastName:
string
Title:
User Added Last NameLast Name of the user who created the record -
userModifiedFirstName:
string
Title:
User Modified First NameFirst Name of the user who last modified the record -
userModifiedLastName:
string
Title:
User Modified Last NameLast Name of the user who last modified the record -
visibilityType:
integer
Title:
Visibility TypeIs it visibile to current user because it is owned by him, shared to him through folder or shared to him via permission
Nested Schema : Active Actions
Type:
objectTitle:
Active ActionsList of active action variable names
Nested Schema : Configuration Attributes
Type:
objectTitle:
Configuration AttributesConfiguration Attributes holder
Nested Schema : Part Properties
Type:
objectTitle:
Part PropertiesPart Properties JSON
Nested Schema : Price
Type:
objectTitle:
Pricetotal price
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Price Book
Type:
objectTitle:
Price BookAssociated Price Book
Show Source
-
name:
string
Title:
NamePrice book name -
variableName:
string
Title:
Variable NameUnique name for price book
Nested Schema : Type Specific Attributes
Type:
objectTitle:
Type Specific AttributesJSON of Type Specific Attributes
Examples
The following example shows how to retrieve the specified favorite by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/favorites/3022619257
Response Body 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/v19/priceBooks"
}, {
"rel": "canonical",
"href": "https://sitename.oracle.com/rest/v19/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/v19/favorites/3022619257"
}, {
"kind": "",
"rel": "child",
"name": "sharePermissions",
"href": "https://sitename.oracle.com/rest/v19/favorites/3022619257/sharePermissions"
}, {
"kind": "",
"rel": "child",
"name": "subItems",
"href": "https://sitename.oracle.com/rest/v19/favorites/3022619257/subItems"
}
]
}
]
}