REST API Services for CPQ Cloud

Get Attribute Metadata

get

/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}

This service returns the metadata for a specific Commerce attribute.

Request

Path Parameters

attributeVarName: string

Variable Name of the attribute.
docVarName: string

Variable Name of the parent document.
processVarName: string

Variable Name of the parent process.

Response

Default Response

Root Schema : CommerceAttributes

Type: object

Show Source

additional(optional): object Additional

Title: Additional

Additional fields.
ajaxSensitive(optional): boolean

Title: Ajax Sensitive flag

Boolean to determine if the attribute takes part in any rules that will can potentially change state.
attributeSet(optional): object foreignKey
autoUpdate(optional): boolean

Title: Trigger Auto Update

Auto Update
dateModified(optional): string

Title: Date Last Modified

System field indicating the date on which the object was last modified.
defaultDataType(optional): object lookup
dependencies(optional): object dependencies
description(optional): string

Title: Description

Description
excludeFromXml(optional): boolean

Title: Exclude From XML
hideForModels(optional): boolean

Title: Hide For Models

Hide For Models
hideForParts(optional): boolean

Title: Hide For Parts

Hide For Parts
hideForSegments(optional): string

Title: Hide For Segments

Hide For Segments
hideLabel(optional): boolean

Title: Hide Label
id(optional): integer

Title: Id

Primary Key of Commerce Attributes.
label(optional): string

Title: Display Name

Attribute Name
links(optional): object attributeLinks
orderNumber(optional): integer

Title: Order

Order Number
potentialStates(optional): object Potential States

Title: Potential States

Set of states for this attribute.
required(optional): boolean

Title: Required

Required
systemDefault(optional): object System Default

Title: System Default

System Default
type(optional): object lookup
usageType(optional): object lookup
userDefault(optional): string

Title: User Default

User defined default value
validationMethod(optional): object lookup
variableName(optional): string

Title: Variable Name

Variable Name

{
    "properties":{
        "userDefault":{
            "title":"User Default",
            "description":"User defined default value",
            "type":"string"
        },
        "hideForSegments":{
            "title":"Hide For Segments",
            "description":"Hide For Segments",
            "type":"string"
        },
        "dateModified":{
            "title":"Date Last Modified",
            "description":"System field indicating the date on which the object was last modified.",
            "type":"string"
        },
        "dependencies":{
            "properties":{
                "actions":{
                    "title":"Actions",
                    "type":"object",
                    "description":"Array of actions"
                },
                "attributes":{
                    "title":"Attributes",
                    "type":"object",
                    "description":"Array of attributes"
                },
                "resources":{
                    "title":"Resources",
                    "type":"object",
                    "description":"Array of resources"
                }
            }
        },
        "autoUpdate":{
            "title":"Trigger Auto Update",
            "description":"Auto Update",
            "type":"boolean"
        },
        "label":{
            "title":"Display Name",
            "description":"Attribute Name",
            "type":"string"
        },
        "defaultDataType":{
            "$ref":"#/definitions/lookup"
        },
        "id":{
            "title":"Id",
            "description":"Primary Key of Commerce Attributes.",
            "type":"integer"
        },
        "excludeFromXml":{
            "title":"Exclude From XML",
            "description":"",
            "type":"boolean"
        },
        "ajaxSensitive":{
            "title":"Ajax Sensitive flag",
            "description":"Boolean to determine if the attribute takes part in any rules that will can potentially change state.",
            "type":"boolean"
        },
        "validationMethod":{
            "$ref":"#/definitions/lookup",
            "type":"object"
        },
        "variableName":{
            "title":"Variable Name",
            "description":"Variable Name",
            "type":"string"
        },
        "required":{
            "title":"Required",
            "description":"Required",
            "type":"boolean"
        },
        "usageType":{
            "$ref":"#/definitions/lookup"
        },
        "type":{
            "$ref":"#/definitions/lookup"
        },
        "hideLabel":{
            "title":"Hide Label",
            "description":"",
            "type":"boolean"
        },
        "attributeSet":{
            "$ref":"#/definitions/foreignKey"
        },
        "systemDefault":{
            "title":"System Default",
            "description":"System Default",
            "type":"object",
            "properties":{
                "prefix":{
                    "title":"Prefix",
                    "type":"string",
                    "description":"Prefix for system_variable default data."
                },
                "suffix":{
                    "title":"Suffix",
                    "type":"string",
                    "description":"Suffix for system_variable default data."
                },
                "systemVariable":{
                    "title":"System Variable",
                    "type":"string",
                    "description":"System Variable"
                }
            }
        },
        "hideForModels":{
            "title":"Hide For Models",
            "description":"Hide For Models",
            "type":"boolean"
        },
        "orderNumber":{
            "title":"Order",
            "description":"Order Number",
            "type":"integer"
        },
        "hideForParts":{
            "title":"Hide For Parts",
            "description":"Hide For Parts",
            "type":"boolean"
        },
        "additional":{
            "title":"Additional",
            "description":"Additional fields.",
            "type":"object"
        },
        "potentialStates":{
            "title":"Potential States",
            "description":"Set of states for this attribute.",
            "type":"object"
        },
        "description":{
            "title":"Description",
            "description":"Description",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/attributeLinks"
        }
    }
}

Nested Schema : Additional

Type: object

Title: Additional

Additional fields.

Nested Schema : foreignKey

Type: object

Show Source

id(optional): integer

Title: Id

Id
variableName(optional): string

Title: Variable Name

Variable Name

{
    "properties":{
        "id":{
            "title":"Id",
            "description":"Id",
            "type":"integer"
        },
        "variableName":{
            "title":"Variable Name",
            "description":"Variable Name",
            "type":"string"
        }
    }
}

Nested Schema : lookup

Type: object

Show Source

displayValue(optional): string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
lookupCode(optional): string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "properties":{
        "lookupCode":{
            "title":"Lookup Code",
            "description":"Language independent code of the fixed list of value.",
            "type":"string"
        },
        "displayValue":{
            "title":"Display Value",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "type":"string"
        }
    }
}

Nested Schema : dependencies

Type: object

Show Source

actions(optional): object Actions

Title: Actions

Array of actions
attributes(optional): object Attributes

Title: Attributes

Array of attributes
resources(optional): object Resources

Title: Resources

Array of resources

{
    "properties":{
        "actions":{
            "title":"Actions",
            "type":"object",
            "description":"Array of actions"
        },
        "attributes":{
            "title":"Attributes",
            "type":"object",
            "description":"Array of attributes"
        },
        "resources":{
            "title":"Resources",
            "type":"object",
            "description":"Array of resources"
        }
    }
}

Nested Schema : attributeLinks

Type: object

Show Source

parent(optional): string

Link to parent Commerce process document attribute.

{
    "properties":{
        "parent":{
            "description":"Link to parent Commerce process document attribute.",
            "type":"string"
        }
    }
}

Nested Schema : Potential States

Type: object

Title: Potential States

Set of states for this attribute.

Nested Schema : System Default

Type: object

Title: System Default

System Default

Show Source

prefix(optional): string

Title: Prefix

Prefix for system_variable default data.
suffix(optional): string

Title: Suffix

Suffix for system_variable default data.
systemVariable(optional): string

Title: System Variable

System Variable

{
    "title":"System Default",
    "description":"System Default",
    "type":"object",
    "properties":{
        "prefix":{
            "title":"Prefix",
            "type":"string",
            "description":"Prefix for system_variable default data."
        },
        "suffix":{
            "title":"Suffix",
            "type":"string",
            "description":"Suffix for system_variable default data."
        },
        "systemVariable":{
            "title":"System Variable",
            "type":"string",
            "description":"System Variable"
        }
    }
}

Nested Schema : Actions

Type: object

Title: Actions

Array of actions

Nested Schema : Attributes

Type: object

Title: Attributes

Array of attributes

Nested Schema : Resources

Type: object

Title: Resources

Array of resources

Examples

The following example shows how to retrieve metadata for the specified attribute by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/_customer_t_email

Response Body Sample

{
   "id": 36244262,
   "dateModified": "2014-02-24",
   "links": [{
         "rel": "self",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/_customer_t_email"
      }, {
         "rel": "parent",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction"
      }, {
         "rel": "child",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/_customer_t_email/translations"
      }, {
         "rel": "child",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/_customer_t_email/menuItems"
      }
   ],
   "description": "",
   "label": "Customer Email",
   "userDefault": null,
   "variableName": "_customer_t_email",
   "required": false,
   "autoUpdate": false,
   "hideForModels": false,
   "hideForParts": false,
   "hideForSegments": "",
   "orderNumber": 18,
   "excludeFromXml": false,
   "hideLabel": false,
   "systemDefault": null,
   "type": {
      "lookupCode": "CmTextAttribute",
      "displayValue": "Text"
   },
   "usageType": {
      "lookupCode": "14",
      "displayValue": "Additional Address"
   },
   "validationMethod": null,
   "defaultDataType": {
      "lookupCode": "0",
      "displayValue": "None"
   },
   "dependencies": {},
   "potentialStates": ["updatable"],
   "additional": {
      "max_length": 255,
      "field_width": 30
   },
   "attributeSet": {
      "id": 36244225,
      "variableName": "customer_t"
   }
}