REST API Services for Oracle CPQ

Get Model Attribute Metadata

get

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

This service returns the metadata for a specific attribute of a Model.

Request

Path Parameters

attributeVarName(required): string

Attribute variable name.
modelVarName(required): string

Model variable name.
prodFamVarName(required): string

Product family variable name.
prodLineVarName(required): string

Product line variable name.

Query Parameters

excludeLinks: string

Exclude links.
expand: string

Allows expansion of relationships.

Response

Supported Media Types

application/json

Default Response

Attribute details defined at model level.

Root Schema : attribute

Type: object

Show Source

additional: object Additional Properties

Title: Additional Properties

Additional properties.
ajaxSensitive: boolean

Title: Ajax Sensitive

Ajax Sensitivity of the attribute.
array: boolean

Title: Array

Array.
arrayControlAttr: boolean

Title: Array Control Attribute

Array control attribute.
autoLock: boolean

Title: Auto Lock

Auto lock.
category: object category
constraintDisplayType: object constraintDisplayType
defaultValue: string

Title: Default Value

Default value.
description: string

Title: Description

Description.
displayType: object displayType
endDate: string

Title: End Date

End Date.
hideInTrans: boolean

Title: Hide In Transaction

Hide in transaction.
id: integer

Title: Id

Primary key of the attribute.
includeLinkedQuantity: boolean

Title: Include Linked Quantity

Indicates if the attribute has a linked quantity attribute
inputTypeCode: object Input Type Code

Title: Input Type Code

Input type code.
itemLevelProcess: boolean

Title: Item Level Process

Item level process.
jetDisplayType: object jetDisplayType
links: object Reference Links

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable
name: string

Title: Name

Name.
orderNumber: integer

Title: Order

Order number.
partComment: string

Title: Part Comment

Part Comment.
partNumber: string

Title: Part Number

Part Number.
potentialStates: array Potential States

Title: Potential States

Set of states for this attribute.
priceItem: object priceItem
propertyClass: object propertyClass
quantityAttributeVarName: string

Title: Quantity Attribute VarName

Linked quantity attribute's variable name
referencePartNumber: string

Title: Reference Part Number

Part number reference for the attribute
required: boolean

Title: Required

Required.
runFilter: boolean

Title: Run Filter

Run Filter.
setType: object setType
ssplProperties: object ssplProperties
startDate: string

Title: Start Date

Start Date.
status: object status
type: object type
validationMethod: object validationMethod
variableName: string

Title: Variable Name

Variable name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary key of the attribute.",
            "title":"Id"
        },
        "name":{
            "type":"string",
            "description":"Name.",
            "title":"Name"
        },
        "description":{
            "type":"string",
            "description":"Description.",
            "title":"Description"
        },
        "variableName":{
            "type":"string",
            "description":"Variable name.",
            "title":"Variable Name"
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order number.",
            "title":"Order"
        },
        "required":{
            "type":"boolean",
            "description":"Required.",
            "title":"Required"
        },
        "itemLevelProcess":{
            "type":"boolean",
            "description":"Item level process.",
            "title":"Item Level Process"
        },
        "autoLock":{
            "type":"boolean",
            "description":"Auto lock.",
            "title":"Auto Lock"
        },
        "hideInTrans":{
            "type":"boolean",
            "description":"Hide in transaction.",
            "title":"Hide In Transaction"
        },
        "defaultValue":{
            "type":"string",
            "description":"Default value.",
            "title":"Default Value"
        },
        "startDate":{
            "type":"string",
            "description":"Start Date.",
            "title":"Start Date"
        },
        "endDate":{
            "type":"string",
            "description":"End Date.",
            "title":"End Date"
        },
        "partNumber":{
            "type":"string",
            "description":"Part Number.",
            "title":"Part Number"
        },
        "partComment":{
            "type":"string",
            "description":"Part Comment.",
            "title":"Part Comment"
        },
        "validationMethod":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "additional":{
            "type":"object",
            "description":"Additional properties.",
            "title":"Additional Properties",
            "properties":{
            }
        },
        "type":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "inputTypeCode":{
            "type":"object",
            "description":"Input type code.",
            "title":"Input Type Code",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                }
            }
        },
        "category":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "status":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "constraintDisplayType":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "setType":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "displayType":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "jetDisplayType":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "runFilter":{
            "type":"boolean",
            "description":"Run Filter.",
            "title":"Run Filter"
        },
        "priceItem":{
            "type":"object",
            "properties":{
                "pricingType":{
                    "type":"object",
                    "properties":{
                        "lookupCode":{
                            "$ref":"#/definitions/lookupCode"
                        },
                        "displayValue":{
                            "$ref":"#/definitions/displayValue"
                        }
                    }
                },
                "pricingDisplayType":{
                    "type":"object",
                    "properties":{
                        "lookupCode":{
                            "$ref":"#/definitions/lookupCode"
                        },
                        "displayValue":{
                            "$ref":"#/definitions/displayValue"
                        }
                    }
                },
                "displayPriceAtBottom":{
                    "type":"boolean",
                    "description":"Display price at bottom.",
                    "title":"Display Price At Bottom"
                },
                "includeInTotalPrice":{
                    "type":"boolean",
                    "description":"Include in total price.",
                    "title":"Include In Total Price"
                }
            }
        },
        "potentialStates":{
            "type":"array",
            "description":"Set of states for this attribute.",
            "title":"Potential States",
            "items":{
                "type":"string"
            }
        },
        "ajaxSensitive":{
            "type":"boolean",
            "description":"Ajax Sensitivity of the attribute.",
            "title":"Ajax Sensitive"
        },
        "arrayControlAttr":{
            "type":"boolean",
            "description":"Array control attribute.",
            "title":"Array Control Attribute"
        },
        "array":{
            "type":"boolean",
            "description":"Array.",
            "title":"Array"
        },
        "ssplProperties":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Identifier",
                    "title":"Id"
                },
                "resourceDomain":{
                    "type":"string",
                    "description":"Resource domain.",
                    "title":"Resource Domain"
                },
                "resAttrDisplayName":{
                    "type":"string",
                    "description":"Resource attribute display name.",
                    "title":"Resource Attribute Display Name"
                },
                "resAttrVarName":{
                    "type":"string",
                    "description":"Unique name to identify the resource attribute.",
                    "title":"Resource Attribute Variable Name."
                },
                "resAttrImage":{
                    "type":"string",
                    "description":"Resource attribute image.",
                    "title":"Resource Attribute Image"
                },
                "filterString":{
                    "type":"string",
                    "description":"Filter string.",
                    "title":"Filter String"
                },
                "type":{
                    "type":"object",
                    "properties":{
                        "lookupCode":{
                            "$ref":"#/definitions/lookupCode"
                        },
                        "displayValue":{
                            "$ref":"#/definitions/displayValue"
                        }
                    }
                },
                "orderByCol":{
                    "type":"string",
                    "description":"Order by column.",
                    "title":"Order By Column"
                },
                "orderByDir":{
                    "type":"object",
                    "properties":{
                        "lookupCode":{
                            "$ref":"#/definitions/lookupCode"
                        },
                        "displayValue":{
                            "$ref":"#/definitions/displayValue"
                        }
                    }
                },
                "pickMaps":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "description":"Pick maps.",
                        "title":"Pick Maps"
                    }
                }
            }
        },
        "includeLinkedQuantity":{
            "type":"boolean",
            "description":"Indicates if the attribute has a linked quantity attribute",
            "title":"Include Linked Quantity"
        },
        "quantityAttributeVarName":{
            "type":"string",
            "description":"Linked quantity attribute's variable name",
            "title":"Quantity Attribute VarName"
        },
        "propertyClass":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "referencePartNumber":{
            "type":"string",
            "description":"Part number reference for the attribute",
            "title":"Reference Part Number"
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : Additional Properties

Type: object

Title: Additional Properties

Additional properties.

Show Source

{
    "type":"object",
    "description":"Additional properties.",
    "title":"Additional Properties",
    "properties":{
    }
}

Nested Schema : category

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : constraintDisplayType

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : displayType

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Input Type Code

Type: object

Title: Input Type Code

Input type code.

Show Source

lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "description":"Input type code.",
    "title":"Input Type Code",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        }
    }
}

Nested Schema : jetDisplayType

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Reference Links

Type: object

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

href: string

Title: href

URL to the related object
rel: string

Title: Link

Link relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relationship to the current object",
            "title":"Link"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"href"
        }
    },
    "title":"Reference Links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Nested Schema : Potential States

Type: array

Title: Potential States

Set of states for this attribute.

Show Source

Array of: string

{
    "type":"array",
    "description":"Set of states for this attribute.",
    "title":"Potential States",
    "items":{
        "type":"string"
    }
}

Nested Schema : priceItem

Type: object

Show Source

displayPriceAtBottom: boolean

Title: Display Price At Bottom

Display price at bottom.
includeInTotalPrice: boolean

Title: Include In Total Price

Include in total price.
pricingDisplayType: object pricingDisplayType
pricingType: object pricingType

{
    "type":"object",
    "properties":{
        "pricingType":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "pricingDisplayType":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "displayPriceAtBottom":{
            "type":"boolean",
            "description":"Display price at bottom.",
            "title":"Display Price At Bottom"
        },
        "includeInTotalPrice":{
            "type":"boolean",
            "description":"Include in total price.",
            "title":"Include In Total Price"
        }
    }
}

Nested Schema : propertyClass

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : setType

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : ssplProperties

Type: object

Show Source

filterString: string

Title: Filter String

Filter string.
id: integer

Title: Id

Identifier
orderByCol: string

Title: Order By Column

Order by column.
orderByDir: object orderByDir
pickMaps: array pickMaps
resAttrDisplayName: string

Title: Resource Attribute Display Name

Resource attribute display name.
resAttrImage: string

Title: Resource Attribute Image

Resource attribute image.
resAttrVarName: string

Title: Resource Attribute Variable Name.

Unique name to identify the resource attribute.
resourceDomain: string

Title: Resource Domain

Resource domain.
type: object type

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Identifier",
            "title":"Id"
        },
        "resourceDomain":{
            "type":"string",
            "description":"Resource domain.",
            "title":"Resource Domain"
        },
        "resAttrDisplayName":{
            "type":"string",
            "description":"Resource attribute display name.",
            "title":"Resource Attribute Display Name"
        },
        "resAttrVarName":{
            "type":"string",
            "description":"Unique name to identify the resource attribute.",
            "title":"Resource Attribute Variable Name."
        },
        "resAttrImage":{
            "type":"string",
            "description":"Resource attribute image.",
            "title":"Resource Attribute Image"
        },
        "filterString":{
            "type":"string",
            "description":"Filter string.",
            "title":"Filter String"
        },
        "type":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "orderByCol":{
            "type":"string",
            "description":"Order by column.",
            "title":"Order By Column"
        },
        "orderByDir":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "$ref":"#/definitions/lookupCode"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "pickMaps":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Pick maps.",
                "title":"Pick Maps"
            }
        }
    }
}

Nested Schema : status

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : type

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : validationMethod

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : pricingDisplayType

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : pricingType

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : orderByDir

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : pickMaps

Type: array

Show Source

Array of: string

Title: Pick Maps

Pick maps.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Pick maps.",
        "title":"Pick Maps"
    }
}

Nested Schema : type

Type: object

Show Source

displayValue: string

Title: Display Value

Display value.
lookupCode: string

Title: Lookup Code

Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "$ref":"#/definitions/lookupCode"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Examples

The following example shows how to retrieve the metadata for the specified Configuration item 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/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices

Translations

The following components can be appended to the end of this endpoint to return translation metadata:

/translations - This returns all language translations for the requested entity.
/translations/{langCode} - This returns a specific language translation for the requested entity. Example: /translations/es

Response Body Sample

{
  "id": 36735252,
  "links": [{
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/unityINC/productLines/mergedServices/models/converge"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices/translations"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices/menuItems"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices/calculatorTabs"
    }
  ],
  "name": "Number of Services",
  "description": "",
  "variableName": "numberOfServices",
  "orderNumber": 1,
  "required": false,
  "itemLevelProcess": false,
  "autoLock": false,
  "hideInTrans": false,
  "defaultValue": "1",
  "startDate": "",
  "endDate": "",
  "additional": {
    "maximum": "200",
    "minimum": "1"
  },
  "type": {
    "lookupCode": "3",
    "displayValue": "Integer"
  },
  "category": {
    "lookupCode": "2",
    "displayValue": "Configurable Attributes"
  },
  "status": {
    "lookupCode": "1",
    "displayValue": "Active"
  },
  "constraintDisplayType": {
    "lookupCode": "1",
    "displayValue": "Marked"
  },
  "setType": {
    "lookupCode": "1",
    "displayValue": "None"
  },
  "displayType": {
    "lookupCode": "1",
    "displayValue": "Text"
  },
  "validationMethod": {
    "lookupCode": "3",
    "displayValue": "Range Check"
  },
  "priceItem": {
    "pricingType": {
      "lookupCode": "1",
      "displayValue": "None"
    },
    "pricingDisplayType": {
      "lookupCode": "1",
      "displayValue": "None"
    },
    "displayPriceAtBottom": true,
    "includeInTotalPrice": true
  },
  "potentialStates": ["visible", "updatable"],
  "ajaxSensitive": false,
  "arrayControlAttr": true,
  "array": false
}