REST API Services for Oracle CPQ

Get a Model Attribute

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}

Use this endpoint to retrieve the specified Model attribute.

Request

Supported Media Types

application/json

Path Parameters

allProdFamsVarName(required): string

Variable Name
attributeVarName(required): string

Variable Name of the Attribute
modelVarName(required): string

Variable Name of the Product Line
prodFamVarName(required): string

Variable Name
prodLineVarName(required): string

Variable Name of the Product Line

Query Parameters

expand: string

Allows expansion of relationships.

Response

Supported Media Types

application/json

Default Response

Root Schema : Attributes

Type: object

Title: Attributes

Show Source

attributeType: object Attribute Array Type

Title: Attribute Array Type

Indicates if Attribute is Array Type
category: object Attribute Category

Title: Attribute Category

Category Attribute Belongs To
dataType: object Data Type

Title: Data Type

Data Type of the Attribute
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.
description: string

Title: Description

Description of the Attribute
displayType: object Display Type

Title: Display Type

Display Type of the Attribute
id: integer

Title: Id

Primary Key Of The Resource
label: string

Title: Attribute Name

Name of the Attribute
menuType: object Attribute Menu Type

Title: Attribute Menu Type

Indicates if Attribute is Menu Type
orderNumber: integer

Title: Order Number

Order Number of the Attribute
refType: object Reference Type

Title: Reference Type

Type of the Reference
variableName: string

Title: Variable Name

Variable Name of the Attribute

{
    "type":"object",
    "properties":{
        "attributeType":{
            "type":"object",
            "description":"Indicates if Attribute is Array Type",
            "title":"Attribute Array Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "category":{
            "type":"object",
            "description":"Category Attribute Belongs To",
            "title":"Attribute Category",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "dataType":{
            "type":"object",
            "description":"Data Type of the Attribute",
            "title":"Data Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "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"
        },
        "description":{
            "type":"string",
            "description":"Description of the Attribute",
            "title":"Description"
        },
        "displayType":{
            "type":"object",
            "description":"Display Type of the Attribute",
            "title":"Display Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "id":{
            "type":"integer",
            "description":"Primary Key Of The Resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Name of the Attribute",
            "title":"Attribute Name"
        },
        "menuType":{
            "type":"object",
            "description":"Indicates if Attribute is Menu Type",
            "title":"Attribute Menu Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order Number of the Attribute",
            "title":"Order Number"
        },
        "refType":{
            "type":"object",
            "description":"Type of the Reference",
            "title":"Reference Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the Attribute",
            "title":"Variable Name"
        }
    },
    "title":"Attributes"
}

Nested Schema : Attribute Array Type

Type: object

Title: Attribute Array Type

Indicates if Attribute is Array Type

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Indicates if Attribute is Array Type",
    "title":"Attribute Array Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Attribute Category

Type: object

Title: Attribute Category

Category Attribute Belongs To

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Category Attribute Belongs To",
    "title":"Attribute Category",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Data Type

Type: object

Title: Data Type

Data Type of the Attribute

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Data Type of the Attribute",
    "title":"Data Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Display Type

Type: object

Title: Display Type

Display Type of the Attribute

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Display Type of the Attribute",
    "title":"Display Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Attribute Menu Type

Type: object

Title: Attribute Menu Type

Indicates if Attribute is Menu Type

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Indicates if Attribute is Menu Type",
    "title":"Attribute Menu Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Reference Type

Type: object

Title: Reference Type

Type of the Reference

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Type of the Reference",
    "title":"Reference Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Examples

The following example shows how to retrieve a definition for the specified Model 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/productLines/consumerVehicles/models/sUV/attributes/sPackages

Response Body Sample

{
  "orderNumber": 1,
  "endDate": null,
  "defaultValue": null,
  "inputTypeCode": "SingleSelectMenu",
  "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": "2023-05-03T04:59:38.000Z",
  "required": false,
  "id": 3022993188,
  "displayPriceAtBottom": true,
  "jetDisplayTypeLookupValue": "Cards",
  "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": "5",
    "displayValue": "Radio Button Horizontal",
    "id": 3022799221,
    "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/3022799221"
      }
    ]
  },
  "isImageMenu": true,
  "menuType": {
    "lookupCode": "1",
    "displayValue": "Menu",
    "id": 3022799207,
    "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/3022799207"
      }
    ]
  },
  "startDate": null,
  "hidden": false,
  "additional": "{image_menu_size_type:2,jet_constrained_display:1,text_area_rows:5,text_area_cols:20,image_menu_jet_height:350,image_menu_jet_value:2,image_menu_value:3,image_menu_cols:3,image_menu_rows:1,image_menu_size:300,image_menu_layout:1,image_menu_jet_width:300}",
  "autoLock": false,
  "refType": {
    "lookupCode": "4",
    "displayValue": "Model",
    "id": 3022799213,
    "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/3022799213"
      }
    ]
  },
  "description": null,
  "displayTypeLookupValue": "Grid",
  "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": "6",
    "displayValue": "Cards",
    "id": 3023488705,
    "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/3023488705"
      }
    ]
  },
  "itemLevelProcess": false,
  "variableName": "sPackages",
  "dateModified": "2023-05-03T04:59:39.000Z",
  "label": "Maintenance Packages",
  "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": "2",
    "displayValue": "Configurable",
    "id": 3022799186,
    "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/3022799186"
      }
    ]
  },
  "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/productLines/consumerVehicles/models/sUV/attributes/sPackages"
    }, {
      "kind": "",
      "rel": "child",
      "name": "menuItems",
      "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles/models/sUV/attributes/sPackages/menuItems"
    }, {
      "rel": "parent",
      "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles/models/sUV"
    }
  ]
}