REST API Services for Oracle CPQ

Get Array Set Attributes Metadata

get

/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}/attributes

This service returns the attributes metadata for a specific Commerce array set.

Request

Path Parameters

arraySetVarName(required): string

Variable Name of the array Set.
docVarName(required): string

Variable Name of the parent document.
processVarName(required): string

Variable Name of the parent process.

Response

Default Response

Root Schema : CommerceArraySets-collection

Type: object

Show Source

items: array items

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

Nested Schema : items

Type: array

Show Source

Array of: object CommerceArraySets

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

Nested Schema : CommerceArraySets

Type: object

Show Source

dateModified: string

Title: Date Last Modified

System field indicating the date on which the object was last modified.
description: string

Title: Description

Description
id: integer

Title: Id

Primary Key of Commerce Attributes.
label: string

Title: Display Name

Attribute Name
links: object arraySetLinks
type: object lookup
variableName: string

Title: Variable Name

Variable Name

{
    "properties":{
        "id":{
            "title":"Id",
            "description":"Primary Key of Commerce Attributes.",
            "type":"integer"
        },
        "dateModified":{
            "title":"Date Last Modified",
            "description":"System field indicating the date on which the object was last modified.",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/arraySetLinks"
        },
        "label":{
            "title":"Display Name",
            "description":"Attribute Name",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "description":"Description",
            "type":"string"
        },
        "variableName":{
            "title":"Variable Name",
            "description":"Variable Name",
            "type":"string"
        },
        "type":{
            "$ref":"#/definitions/lookup"
        }
    }
}

Nested Schema : arraySetLinks

Type: object

Show Source

parent: string

Links to parent Commerce process document, array set translations, and array set attributes.

{
    "properties":{
        "parent":{
            "description":"Links to parent Commerce process document, array set translations, and array set attributes.",
            "type":"string"
        }
    }
}

Nested Schema : lookup

Type: object

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
lookupCode: 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"
        }
    }
}

Examples

The following example shows how to retrieve attributes metadata for the specified array set 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/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes

Response Body Sample

{
  "items": [{
      "id": 36641145,
      "dateModified": "2019-01-28",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/laborCategory"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/laborCategory/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/laborCategory/menuItems"
        }
      ],
      "label": "Labor Category",
      "description": "",
      "userDefault": null,
      "variableName": "laborCategory",
      "required": false,
      "autoUpdate": false,
      "hideForModels": false,
      "hideForParts": false,
      "hideForSegments": "",
      "orderNumber": 161,
      "excludeFromXml": false,
      "hideLabel": false,
      "systemDefault": null,
      "type": {
        "lookupCode": "CmMenuAttribute",
        "displayValue": "Menu"
      },
      "usageType": {
        "lookupCode": "1",
        "displayValue": "General"
      },
      "validationMethod": null,
      "defaultDataType": {
        "lookupCode": "0",
        "displayValue": "None"
      },
      "dependencies": {},
      "potentialStates": [],
      "additional": {
        "menu_type": {
          "lookupCode": "0",
          "displayValue": "Single-Select Menu"
        },
        "constraint_behavior": {
          "lookupCode": "0",
          "displayValue": "Hide"
        }
      },
      "attributeSet": null,
      "ajaxSensitive": false
    }, {
      "id": 36641199,
      "dateModified": "2019-01-28",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/description"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/description/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/description/menuItems"
        }
      ],
      "label": "Description",
      "description": "",
      "userDefault": null,
      "variableName": "description",
      "required": false,
      "autoUpdate": false,
      "hideForModels": false,
      "hideForParts": false,
      "hideForSegments": "",
      "orderNumber": 162,
      "excludeFromXml": false,
      "hideLabel": false,
      "systemDefault": null,
      "type": {
        "lookupCode": "CmTextAreaAttribute",
        "displayValue": "Text Area"
      },
      "usageType": {
        "lookupCode": "1",
        "displayValue": "General"
      },
      "validationMethod": null,
      "defaultDataType": {
        "lookupCode": "0",
        "displayValue": "None"
      },
      "dependencies": {},
      "potentialStates": [],
      "additional": {},
      "attributeSet": null,
      "ajaxSensitive": false
    }, {
      "id": 36641250,
      "dateModified": "2019-01-28",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/region"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/region/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/region/menuItems"
        }
      ],
      "label": "Region",
      "description": "",
      "userDefault": null,
      "variableName": "region",
      "required": false,
      "autoUpdate": false,
      "hideForModels": false,
      "hideForParts": false,
      "hideForSegments": "",
      "orderNumber": 163,
      "excludeFromXml": false,
      "hideLabel": false,
      "systemDefault": null,
      "type": {
        "lookupCode": "CmTextAttribute",
        "displayValue": "Text"
      },
      "usageType": {
        "lookupCode": "1",
        "displayValue": "General"
      },
      "validationMethod": null,
      "defaultDataType": {
        "lookupCode": "0",
        "displayValue": "None"
      },
      "dependencies": {},
      "potentialStates": [],
      "additional": {
        "field_width": 30,
        "max_length": 255
      },
      "attributeSet": null,
      "ajaxSensitive": false
    }, {
      "id": 36641301,
      "dateModified": "2019-01-28",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/language"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/language/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/language/menuItems"
        }
      ],
      "label": "Language",
      "description": "",
      "userDefault": null,
      "variableName": "language",
      "required": false,
      "autoUpdate": false,
      "hideForModels": false,
      "hideForParts": false,
      "hideForSegments": "",
      "orderNumber": 164,
      "excludeFromXml": false,
      "hideLabel": false,
      "systemDefault": null,
      "type": {
        "lookupCode": "CmLanguageAttribute",
        "displayValue": "Language"
      },
      "usageType": {
        "lookupCode": "1",
        "displayValue": "General"
      },
      "validationMethod": null,
      "defaultDataType": {
        "lookupCode": "0",
        "displayValue": "None"
      },
      "dependencies": {},
      "potentialStates": [],
      "additional": {
        "menu_type": {
          "lookupCode": "0",
          "displayValue": "Single-Select Menu"
        },
        "constraint_behavior": {
          "lookupCode": "0",
          "displayValue": "Hide"
        }
      },
      "attributeSet": null,
      "ajaxSensitive": false
    }, {
      "id": 36641352,
      "dateModified": "2019-01-28",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/hours"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/hours/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/hours/menuItems"
        }
      ],
      "label": "Hours",
      "description": "",
      "userDefault": null,
      "variableName": "hours",
      "required": false,
      "autoUpdate": false,
      "hideForModels": false,
      "hideForParts": false,
      "hideForSegments": "",
      "orderNumber": 165,
      "excludeFromXml": false,
      "hideLabel": false,
      "systemDefault": null,
      "type": {
        "lookupCode": "CmNumberAttribute",
        "displayValue": "Integer"
      },
      "usageType": {
        "lookupCode": "1",
        "displayValue": "General"
      },
      "validationMethod": {
        "lookupCode": "0",
        "displayValue": "Check Numeric"
      },
      "defaultDataType": {
        "lookupCode": "0",
        "displayValue": "None"
      },
      "dependencies": {},
      "potentialStates": [],
      "additional": {
        "attributeE": "",
        "attributeD": "",
        "field_width": 30,
        "scoreMethod": "1",
        "attributeF": "",
        "attributeA": "",
        "priceScoreWeightingAttr": "1",
        "attributeC": "",
        "attributeB": "",
        "attributeAValue": "0",
        "unit_price_var": "",
        "max_val": "",
        "net_price_var": "",
        "min_val": "",
        "attributeEValue": "0",
        "list_price_var": "",
        "attributeBValue": "0",
        "max_length": 255,
        "attributeCValue": "0",
        "boundaryMin": "1",
        "attributeFValue": "0",
        "enablePriceScore": "0",
        "priceScoreLineAttr": "1",
        "attributeDValue": "0",
        "boundaryMax": "9",
        "basis_price_var": "",
        "priceScoreSelection": "1",
        "boundaryUndefined": "1"
      },
      "attributeSet": null,
      "ajaxSensitive": false
    }, {
      "id": 36641403,
      "dateModified": "2019-01-28",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/hourlyRate"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/hourlyRate/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/hourlyRate/menuItems"
        }
      ],
      "label": "Hourly Rate",
      "description": "",
      "userDefault": null,
      "variableName": "hourlyRate",
      "required": false,
      "autoUpdate": false,
      "hideForModels": false,
      "hideForParts": false,
      "hideForSegments": "",
      "orderNumber": 166,
      "excludeFromXml": false,
      "hideLabel": false,
      "systemDefault": null,
      "type": {
        "lookupCode": "CmCurrencyAttribute",
        "displayValue": "Currency"
      },
      "usageType": {
        "lookupCode": "1",
        "displayValue": "General"
      },
      "validationMethod": {
        "lookupCode": "0",
        "displayValue": "Check Currency"
      },
      "defaultDataType": {
        "lookupCode": "0",
        "displayValue": "None"
      },
      "dependencies": {},
      "potentialStates": [],
      "additional": {
        "field_width": 30,
        "customerField": "",
        "dateField": "",
        "precision_GBP": "",
        "duration": "",
        "max_val": "",
        "netPriceField": "",
        "filterValue": "",
        "filterAttribute": "",
        "dealNegotiation": "",
        "precision_EUR": "",
        "min_val": "",
        "precision_USD": "2",
        "max_length": 255
      },
      "attributeSet": null,
      "ajaxSensitive": false
    }, {
      "id": 36641454,
      "dateModified": "2019-01-28",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/requiredService"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/requiredService/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/requiredService/menuItems"
        }
      ],
      "label": "Required Service",
      "description": "",
      "userDefault": "false",
      "variableName": "requiredService",
      "required": false,
      "autoUpdate": false,
      "hideForModels": false,
      "hideForParts": false,
      "hideForSegments": "",
      "orderNumber": 167,
      "excludeFromXml": false,
      "hideLabel": false,
      "systemDefault": null,
      "type": {
        "lookupCode": "CmBooleanAttribute",
        "displayValue": "Boolean"
      },
      "usageType": {
        "lookupCode": "1",
        "displayValue": "General"
      },
      "validationMethod": {
        "lookupCode": "0",
        "displayValue": "None"
      },
      "defaultDataType": {
        "lookupCode": "2",
        "displayValue": "Data"
      },
      "dependencies": {},
      "potentialStates": [],
      "additional": {
        "_display_type": {
          "lookupCode": "0",
          "displayValue": "Radio Buttons"
        }
      },
      "attributeSet": null,
      "ajaxSensitive": false
    }, {
      "id": 36641508,
      "dateModified": "2019-01-28",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/startDate"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/startDate/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/startDate/menuItems"
        }
      ],
      "label": "Start Date",
      "description": "",
      "userDefault": null,
      "variableName": "startDate",
      "required": false,
      "autoUpdate": false,
      "hideForModels": false,
      "hideForParts": false,
      "hideForSegments": "",
      "orderNumber": 168,
      "excludeFromXml": false,
      "hideLabel": false,
      "systemDefault": null,
      "type": {
        "lookupCode": "CmDateAttribute",
        "displayValue": "Date"
      },
      "usageType": {
        "lookupCode": "1",
        "displayValue": "General"
      },
      "validationMethod": {
        "lookupCode": "0",
        "displayValue": "None"
      },
      "defaultDataType": {
        "lookupCode": "0",
        "displayValue": "None"
      },
      "dependencies": {},
      "potentialStates": [],
      "additional": {
        "end_date": "",
        "date_time": "false",
        "field_width": 16,
        "max_length": 25,
        "start_date": ""
      },
      "attributeSet": null,
      "ajaxSensitive": false
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes"
    }
  ]
}