Get Action Metadata
get
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs/{actionVarName}
This service returns the metadata for a specific Commerce action.
Request
Path Parameters
-
actionVarName: string
The variable name of a Commerce action
-
docVarName: string
The variable name of the Commerce document
-
processVarName: string
The variable name of the Commerce process
Response
Default Response
Root Schema : CommerceActions
Type:
Show Source
object-
actionSet(optional):
object foreignKey
-
actionTimeout(optional):
integer
Title:
Action TimeoutAction Timeout -
additional(optional):
object Additional
Title:
AdditionalAdditional Fields -
autoUnlockQuote(optional):
boolean
Title:
Automatically Unlock QuoteBoolean property that specifies whether the action will automatically unlock the quote if it is locked for the user who is executing the action. -
dateModified(optional):
string
Title:
Date Last ModifiedSystem field indicating the date on which the object was last modified. -
dependencies(optional):
object dependencies
-
description(optional):
string
Title:
DescriptionDescription -
destinationType(optional):
object lookup
-
evalReasonTree(optional):
boolean
Title:
Eval Reason TreeEval Reason Tree -
id(optional):
integer
Title:
IdPrimary Key of Commerce Actions. -
isRemote(optional):
boolean
Title:
Is RemoteIs Remote -
isShowLoadingDialog(optional):
boolean
Title:
Is Show Loading DialogIs Show Loading Dialog -
label(optional):
string
Title:
Display NameAction Name -
links(optional):
object actionLinks
-
parentAction(optional):
object foreignKey
-
potentialStates(optional):
object Potential States
Title:
Potential StatesSet of states for this attribute. -
resetReasonType(optional):
object lookup
-
type(optional):
object lookup
-
usageType(optional):
object lookup
-
validationType(optional):
object lookup
-
variableName(optional):
string
Title:
Variable NameVariable Name
Nested Schema : foreignKey
Type:
Show Source
object-
id(optional):
integer
Title:
IdId -
variableName(optional):
string
Title:
Variable NameVariable Name
Nested Schema : Additional
Type:
objectTitle:
AdditionalAdditional Fields
Nested Schema : dependencies
Type:
Show Source
object-
actions(optional):
object Actions
Title:
ActionsArray of actions -
attributes(optional):
object Attributes
Title:
AttributesArray of attributes -
groups(optional):
object Groups
Title:
GroupsArray of groups -
resources(optional):
object Resources
Title:
ResourcesArray of resources
Nested Schema : lookup
Type:
Show Source
object-
displayValue(optional):
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
lookupCode(optional):
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : actionLinks
Type:
Show Source
object-
parent(optional):
string
Link to parent Commerce process document.
-
translations(optional):
string
Link to translations for Commerce process document actions.
Nested Schema : Potential States
Type:
objectTitle:
Potential StatesSet of states for this attribute.
Nested Schema : Actions
Type:
objectTitle:
ActionsArray of actions
Nested Schema : Attributes
Type:
objectTitle:
AttributesArray of attributes
Nested Schema : Groups
Type:
objectTitle:
GroupsArray of groups
Nested Schema : Resources
Type:
objectTitle:
ResourcesArray of resources
Examples
The following example shows how to retrieve the metadata for an action defined for the specified Commerce document 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/actionDefs/_update_line_items
Response Body Sample
{
"id": 36244182,
"dateModified": "2015-10-26",
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/actionDefs/_update_line_items"
}, {
"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/actionDefs/_update_line_items/translations"
}
],
"label": "Update Line Items",
"description": "Default action to update Line Items",
"variableName": "_update_line_items",
"isRemote": false,
"evalReasonTree": false,
"actionTimeout": -1,
"usageType": {
"lookupCode": "0",
"displayValue": "System"
},
"type": {
"lookupCode": "CmUpdateLineItemsAction",
"displayValue": "Update Line Item"
},
"destinationType": {
"lookupCode": "1",
"displayValue": "Same Page"
},
"resetReasonType": {
"lookupCode": "1",
"displayValue": "Simple"
},
"validationType": {
"lookupCode": "0",
"displayValue": "Simple Validations"
},
"parentAction": null,
"dependencies": {},
"potentialStates": ["visible", "enabled"],
"additional": null,
"actionSet": null,
"isShowLoadingDialog": true
}