1. REST API Services for Oracle CPQ
  2. Tasks
  3. Product Setups
  4. Attributes
  5. Product Family

Get a Product Family Attribute

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}

Use this endpoint to retrieve the specified Product Family attribute.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : Attributes
Type: object
Title: Attributes
Show Source
Nested Schema : Attribute Array Type
Type: object
Title: Attribute Array Type
Indicates if Attribute is Array Type
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Attribute Category
Type: object
Title: Attribute Category
Category Attribute Belongs To
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Data Type
Type: object
Title: Data Type
Data Type of the Attribute
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Display Type
Type: object
Title: Display Type
Display Type of the Attribute
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Attribute Menu Type
Type: object
Title: Attribute Menu Type
Indicates if Attribute is Menu Type
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Reference Type
Type: object
Title: Reference Type
Type of the Reference
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Back to Top

Examples

The following example shows how to retrieve a catalog definition for the specified Product Family attribute 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 "Accept: application/json"
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/attributes/_transaction_id

Response Body Sample

{
  "orderNumber": 2,
  "endDate": null,
  "defaultValue": "0",
  "inputTypeCode": "TextField",
  "pricingDisplayType": {
    "lookupCode": "1",
    "displayValue": "None",
    "id": 3023488696,
    "links": [{
        "rel": "domain",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_PRICING_DISPLAY%22%7D%7D"
      }, {
        "rel": "canonical",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues/3023488696"
      }
    ]
  },
  "dateAdded": "2011-07-06T20:04:27.000Z",
  "required": false,
  "id": 12059268,
  "displayPriceAtBottom": true,
  "jetDisplayTypeLookupValue": "Text",
  "dataType": {
    "lookupCode": "1",
    "displayValue": "Text",
    "id": 3022799195,
    "links": [{
        "rel": "domain",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_DATA_TYPE%22%7D%7D"
      }, {
        "rel": "canonical",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues/3022799195"
      }
    ]
  },
  "arrayControlAttr": false,
  "hideInTrans": false,
  "isAvp": false,
  "displayType": {
    "lookupCode": "1",
    "displayValue": "Text",
    "id": 3022799217,
    "links": [{
        "rel": "domain",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_DISPLAY_TYPE%22%7D%7D"
      }, {
        "rel": "canonical",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues/3022799217"
      }
    ]
  },
  "isImageMenu": false,
  "menuType": {
    "lookupCode": "0",
    "displayValue": "Standard",
    "id": 3022799206,
    "links": [{
        "rel": "domain",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_MENU_TYPE%22%7D%7D"
      }, {
        "rel": "canonical",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues/3022799206"
      }
    ]
  },
  "startDate": null,
  "hidden": false,
  "additional": "{text_area_cols:20,text_area_rows:5}",
  "autoLock": false,
  "refType": {
    "lookupCode": "1",
    "displayValue": "All Product Families",
    "id": 3022799210,
    "links": [{
        "rel": "domain",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_REF_TYPE%22%7D%7D"
      }, {
        "rel": "canonical",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues/3022799210"
      }
    ]
  },
  "description": "Unique ID of the current transaction",
  "displayTypeLookupValue": "Text",
  "array": false,
  "attributeType": {
    "lookupCode": "0",
    "displayValue": "Non Array Type",
    "id": 3022799231,
    "links": [{
        "rel": "domain",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_ARRAY_TYPE%22%7D%7D"
      }, {
        "rel": "canonical",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues/3022799231"
      }
    ]
  },
  "jetDisplayType": {
    "lookupCode": "1",
    "displayValue": "Text",
    "id": 3023488700,
    "links": [{
        "rel": "domain",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_JETDISPLAY_TYPE%22%7D%7D"
      }, {
        "rel": "canonical",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues/3023488700"
      }
    ]
  },
  "itemLevelProcess": false,
  "variableName": "_transaction_id",
  "dateModified": "2019-05-15T20:18:54.000Z",
  "label": "Transaction ID",
  "setType": {
    "lookupCode": "1",
    "displayValue": "None",
    "id": 3023488688,
    "links": [{
        "rel": "domain",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_SET_TYPE%22%7D%7D"
      }, {
        "rel": "canonical",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues/3023488688"
      }
    ]
  },
  "includeInTotalPrice": true,
  "category": {
    "lookupCode": "7",
    "displayValue": "System",
    "id": 3022799190,
    "links": [{
        "rel": "domain",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_CATEGORY%22%7D%7D"
      }, {
        "rel": "canonical",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues/3022799190"
      }
    ]
  },
  "pricingType": {
    "lookupCode": "1",
    "displayValue": "None",
    "id": 3023488692,
    "links": [{
        "rel": "domain",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_PRICING_TYPE%22%7D%7D"
      }, {
        "rel": "canonical",
        "href": "http:/sitename.oracle.com/rest/v19/lookupValues/3023488692"
      }
    ]
  },
  "links": [{
      "rel": "self",
      "href": "http:/sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/attributes/_transaction_id"
    }, {
      "kind": "",
      "rel": "child",
      "name": "menuItems",
      "href": "http:/sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/attributes/_transaction_id/menuItems"
    }, {
      "rel": "parent",
      "href": "http:/sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles"
    }
  ]
}
Back to Top