Jump to

• Request
• Response
• Examples

Get List of the Selected Options from a Favorite

get

/rest/v19/favorites/{rootId}/subItems

This endpoint returns the list of selected options of an individual favorite.

Request

Supported Media Types

• application/json

Path Parameters

• rootId(required): integer
  The identifier for the parent favorite.

Query Parameters

• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  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: integer
  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.
• orderby: string
  Specifies a comma-separated list of fields to order the response by.
• q: string
  Declares a query specification expression.
• totalResults: boolean
  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

• application/json

Default Response

Body ()

Root Schema : favoriteItems-collection

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  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.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  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.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"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."
        },
        "totalResults":{
            "type":"integer",
            "description":"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."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/favoriteItems"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Favorite Items
  Title: Favorite Items

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

Nested Schema : Favorite Items

Type: object

Title: Favorite Items

Show Source

• configAttributes: object Configuration Attributes
  Title: Configuration Attributes

  Configuration Attributes holder
• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• id: integer
  Title: Id

  Primary Key of the resource
• isMandatory: boolean
  Title: Is Mandatory

  Mandatory item
• itemId: string
  Title: Item Id

  Id of the item
• itemName: string
  Title: Item Name

  Item Name
• label: string
  Title: Favorite Name

  Name of the favorite
• lineBomDisplayName: string
  Title: Bom Display Name

  Bom Display Name
• modelName: string
  Title: Model Name

  Model Name
• ownerUserEmail: string
  Title: Owner User Email

  Email of the Owner
• ownerUserFirstName: string
  Title: Owner User First Name

  First Name of the Owner
• ownerUserLastName: string
  Title: Owner User Last Name

  Last Name of the Owner
• parentId: integer
  Title: Parent Id

  Id of immediate parrent
• partProps: object Part Properties
  Title: Part Properties

  Part Properties JSON
• prefCurrencyName: string
  Title: Prefered Currency Name

  Name of prefered currency
• prefLanguageName: string
  Title: Prefered Language Name

  Name of prefered language
• price: object Price
  Title: Price

  total price
• priceBook: object Price Book
  Title: Price Book

  Associated Price Book
• productLineName: string
  Title: Product Line Name

  Product Line Name
• productType: string
  Title: Product Type

  Part or model name
• quantity: integer
  Title: Quantity

  Quantity
• refName: string
  Title: Ref Name

  Ref Name
• rootId: integer
  Title: Root Id

  Id of root favorite
• segmentName: string
  Title: Segment Name

  Product Family Name
• serialNumber: object Serial Number
  Title: Serial Number

  Serial Number
• serialNumberDescription: object Serial Number Description
  Title: Serial Number Description

  Serial Number Description
• status: integer
  Title: Status

  Status of captured favorite - is it needs any update action
• subType: integer
  Title: Sub Type

  Sub Type
• supplierCompanyId: integer
  Title: Supplier Company Id

  Supplier Company information
• supplierCompanyName: string
  Title: Supplier Company Name

  Name of the Supplier Company
• sysConfigPath: string
  Title: System Configuration Path

  System Configuration Path
• type: integer
  Title: Type

  Type
• typeSpecificAttrs: object Type Specific Attributes
  Title: Type Specific Attributes

  JSON of Type Specific Attributes
• userAddedFirstName: string
  Title: User Added First Name

  First Name of the user who created the record
• userAddedLastName: string
  Title: User Added Last Name

  Last Name of the user who created the record
• userModifiedFirstName: string
  Title: User Modified First Name

  First Name of the user who last modified the record
• userModifiedLastName: string
  Title: User Modified Last Name

  Last Name of the user who last modified the record

{
    "type":"object",
    "properties":{
        "configAttributes":{
            "type":"object",
            "description":"Configuration Attributes holder",
            "title":"Configuration Attributes"
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the resource",
            "title":"Id"
        },
        "isMandatory":{
            "type":"boolean",
            "description":"Mandatory item",
            "title":"Is Mandatory"
        },
        "itemId":{
            "type":"string",
            "description":"Id of the item",
            "title":"Item Id"
        },
        "itemName":{
            "type":"string",
            "description":"Item Name",
            "title":"Item Name"
        },
        "label":{
            "type":"string",
            "description":"Name of the favorite",
            "title":"Favorite Name"
        },
        "lineBomDisplayName":{
            "type":"string",
            "description":"Bom Display Name",
            "title":"Bom Display Name"
        },
        "modelName":{
            "type":"string",
            "description":"Model Name",
            "title":"Model Name"
        },
        "ownerUserEmail":{
            "type":"string",
            "description":"Email of the Owner",
            "title":"Owner User Email"
        },
        "ownerUserFirstName":{
            "type":"string",
            "description":"First Name of the Owner",
            "title":"Owner User First Name"
        },
        "ownerUserLastName":{
            "type":"string",
            "description":"Last Name of the Owner",
            "title":"Owner User Last Name"
        },
        "parentId":{
            "type":"integer",
            "description":"Id of immediate parrent",
            "title":"Parent Id"
        },
        "partProps":{
            "type":"object",
            "description":"Part Properties JSON",
            "title":"Part Properties"
        },
        "prefCurrencyName":{
            "type":"string",
            "description":"Name of prefered currency",
            "title":"Prefered Currency Name"
        },
        "prefLanguageName":{
            "type":"string",
            "description":"Name of prefered language",
            "title":"Prefered Language Name"
        },
        "price":{
            "type":"object",
            "description":"total price",
            "title":"Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        },
        "priceBook":{
            "type":"object",
            "description":"Associated Price Book",
            "title":"Price Book",
            "properties":{
                "variableName":{
                    "type":"string",
                    "description":"Unique name for price book",
                    "title":"Variable Name"
                },
                "name":{
                    "type":"string",
                    "description":"Price book name",
                    "title":"Name"
                }
            }
        },
        "productLineName":{
            "type":"string",
            "description":"Product Line Name",
            "title":"Product Line Name"
        },
        "productType":{
            "type":"string",
            "description":"Part or model name",
            "title":"Product Type"
        },
        "quantity":{
            "type":"integer",
            "description":"Quantity",
            "title":"Quantity"
        },
        "refName":{
            "type":"string",
            "description":"Ref Name",
            "title":"Ref Name"
        },
        "rootId":{
            "type":"integer",
            "description":"Id of root favorite",
            "title":"Root Id"
        },
        "segmentName":{
            "type":"string",
            "description":"Product Family Name",
            "title":"Segment Name"
        },
        "serialNumber":{
            "type":"object",
            "description":"Serial Number",
            "title":"Serial Number"
        },
        "serialNumberDescription":{
            "type":"object",
            "description":"Serial Number Description",
            "title":"Serial Number Description"
        },
        "status":{
            "type":"integer",
            "description":"Status of captured favorite - is it needs any update action",
            "title":"Status"
        },
        "subType":{
            "type":"integer",
            "description":"Sub Type",
            "title":"Sub Type"
        },
        "supplierCompanyId":{
            "type":"integer",
            "description":"Supplier Company information",
            "title":"Supplier Company Id"
        },
        "supplierCompanyName":{
            "type":"string",
            "description":"Name of the Supplier Company",
            "title":"Supplier Company Name"
        },
        "sysConfigPath":{
            "type":"string",
            "description":"System Configuration Path",
            "title":"System Configuration Path"
        },
        "type":{
            "type":"integer",
            "description":"Type",
            "title":"Type"
        },
        "typeSpecificAttrs":{
            "type":"object",
            "description":"JSON of Type Specific Attributes",
            "title":"Type Specific Attributes"
        },
        "userAddedFirstName":{
            "type":"string",
            "description":"First Name of the user who created the record",
            "title":"User Added  First Name"
        },
        "userAddedLastName":{
            "type":"string",
            "description":"Last Name of the user who created the record",
            "title":"User Added  Last Name"
        },
        "userModifiedFirstName":{
            "type":"string",
            "description":"First Name of the user who last modified the record",
            "title":"User Modified  First Name"
        },
        "userModifiedLastName":{
            "type":"string",
            "description":"Last Name of the user who last modified the record",
            "title":"User Modified  Last Name"
        }
    },
    "title":"Favorite Items"
}

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

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"total price",
    "title":"Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Nested Schema : Price Book

Type: object

Title: Price Book

Associated Price Book

Show Source

• name: string
  Title: Name

  Price book name
• variableName: string
  Title: Variable Name

  Unique name for price book

{
    "type":"object",
    "description":"Associated Price Book",
    "title":"Price Book",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"Unique name for price book",
            "title":"Variable Name"
        },
        "name":{
            "type":"string",
            "description":"Price book name",
            "title":"Name"
        }
    }
}

Nested Schema : Serial Number

Type: object

Title: Serial Number

Serial Number

Nested Schema : Serial Number Description

Type: object

Title: Serial Number Description

Serial Number Description

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 the list of selected options of an individual 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/9100006903/subItems

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/favorites/9100006903/subItems"
    }
  ],
  "items": [{
      "type": 3,
      "lineBomDisplayName": "part12",
      "ownerUserEmail": "[e-mail]",
      "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/v19/priceBooks"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v19/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/v19/favorites/9100006903/subItems/9100006907"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/favorites/9100006903"
        }
      ]
    }, {
      "type": 3,
      "lineBomDisplayName": "part14",
      "ownerUserEmail": "[e-mail]",
      "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/v19/priceBooks"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v19/priceBooks/_default_price_book"
          }
        ]
      },
      "itemName": "part14",
      "prefLanguageName": "English",
      "price": {
        "value": 14.0,
        "currency": "USD"
      },
      "id": 9100006908,
      "refName": "part14",
      "isMandatory": true,
      "serialNumber": null,
      "userModifiedLastName": null,
      "userModifiedFirstName": "John",
      "itemId": "8523099",
      "productLineName": null,
      "subType": 2,
      "status": 0,
      "supplierCompanyId": 4118171,
      "rootId": 9100006903,
      "typeSpecificAttrs": null,
      "configAttributes": null,
      "userAddedLastName": null,
      "sysConfigPath": "_root:::part12::0::0:::part14::0::0",
      "productType": "Part",
      "ownerUserLastName": null,
      "quantity": 1,
      "dateModified": "2022-03-01T02:48:15.000Z",
      "partProps": {
        "Part Number": "part14",
        "Part Lead Time": "N/A",
        "Part Description": "",
        "Line BOM Display Name": "part14",
        "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, part14",
        "Required SSM (Custom Field 11)": "Required value",
        "Custom Field 13": "Custom Field 13, part14",
        "Custom Field 14": "Custom Field 14, part14",
        "Custom Field 15": "Custom Field 15, part14",
        "Custom Field 18": "Custom Field 18, part14",
        "Custom Field 19": "Custom Field 19, part14",
        "Custom Field 20": "Custom Field 20, part14",
        "Custom Field 21": "Custom Field 21, part14",
        "Custom Field 22": "Custom Field 22, part14",
        "Custom Field 23": "Custom Field 23, part14",
        "Custom Field 24": "Custom Field 24, part14",
        "Custom Field 25": "Custom Field 25, part14",
        "Custom Field 26": "Custom Field 26, part14",
        "Custom Field 27": "Custom Field 27, part14",
        "Custom Field 30": "Custom Field 30, part14"
      },
      "label": "Part",
      "parentId": 9100006907,
      "segmentName": null,
      "modelName": null,
      "supplierCompanyName": "abcCompany",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/favorites/9100006903/subItems/9100006908"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/favorites/9100006903"
        }
      ]
    }
  ]
}

Back to Top