Get Array Set Attribute Metadata
get
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}
This service returns the attribute metadata for a specific Commerce array set.
Request
Path Parameters
-
arraySetVarName(required): string
Variable Name of the array set.
-
attributeVarName(required): string
Variable Name of the array set attribute.
-
docVarName(required): string
Variable Name of the parent document.
-
processVarName(required): string
Variable Name of the parent process.
Response
Default Response
Root Schema : CommerceAttributes
Type:
Show Source
object
-
additional:
object Additional
Title:
Additional
Additional fields. -
ajaxSensitive:
boolean
Title:
Ajax Sensitive flag
Boolean to determine if the attribute takes part in any rules that will can potentially change state. -
attributeSet:
object foreignKey
-
autoUpdate:
boolean
Title:
Trigger Auto Update
Auto Update -
dateModified:
string
Title:
Date Last Modified
System field indicating the date on which the object was last modified. -
defaultDataType:
object lookup
-
dependencies:
object dependencies
-
description:
string
Title:
Description
Description -
excludeFromXml:
boolean
Title:
Exclude From XML
-
hideForModels:
boolean
Title:
Hide For Models
Hide For Models -
hideForParts:
boolean
Title:
Hide For Parts
Hide For Parts -
hideForSegments:
string
Title:
Hide For Segments
Hide For Segments -
hideLabel:
boolean
Title:
Hide Label
-
id:
integer
Title:
Id
Primary Key of Commerce Attributes. -
label:
string
Title:
Display Name
Attribute Name -
links:
object attributeLinks
-
orderNumber:
integer
Title:
Order
Order Number -
potentialStates:
object Potential States
Title:
Potential States
Set of states for this attribute. -
required:
boolean
Title:
Required
Required -
systemDefault:
object System Default
Title:
System Default
System Default -
type:
object lookup
-
usageType:
object lookup
-
userDefault:
string
Title:
User Default
User defined default value -
validationMethod:
object lookup
-
variableName:
string
Title:
Variable Name
Variable Name
Nested Schema : Additional
Type:
object
Title:
Additional
Additional fields.
Nested Schema : foreignKey
Type:
Show Source
object
-
id:
integer
Title:
Id
Id -
variableName:
string
Title:
Variable Name
Variable Name
Nested Schema : lookup
Type:
Show Source
object
-
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.
Nested Schema : dependencies
Type:
Show Source
object
-
actions:
object Actions
Title:
Actions
Array of actions -
attributes:
object Attributes
Title:
Attributes
Array of attributes -
resources:
object Resources
Title:
Resources
Array of resources
Nested Schema : attributeLinks
Type:
Show Source
object
-
parent:
string
Link to parent Commerce process document attribute.
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:
string
Title:
Prefix
Prefix for system_variable default data. -
suffix:
string
Title:
Suffix
Suffix for system_variable default data. -
systemVariable:
string
Title:
System Variable
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 array set 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/v16/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes/laborCategory
Response Body Sample
{ "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 }