Get Actions Metadata
get
/rest/v16/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs
This service returns the metadata for all actions defined for the specified Commerce document.
Request
Path Parameters
-
docVarName(required): string
The variable name of the Commerce document
-
processVarName(required): string
The variable name of the Commerce process
Response
Default Response
Nested Schema : CommerceActions
Type:
Show Source
object
-
actionSet:
object foreignKey
-
actionTimeout:
integer
Title:
Action Timeout
Action Timeout -
additional:
object Additional
Title:
Additional
Additional Fields -
autoUnlockQuote:
boolean
Title:
Automatically Unlock Quote
Boolean property that specifies whether the action will automatically unlock the quote if it is locked for the user who is executing the action. -
dateModified:
string
Title:
Date Last Modified
System field indicating the date on which the object was last modified. -
dependencies:
object dependencies
-
description:
string
Title:
Description
Description -
destinationType:
object lookup
-
evalReasonTree:
boolean
Title:
Eval Reason Tree
Eval Reason Tree -
id:
integer
Title:
Id
Primary Key of Commerce Actions. -
isRemote:
boolean
Title:
Is Remote
Is Remote -
isShowLoadingDialog:
boolean
Title:
Is Show Loading Dialog
Is Show Loading Dialog -
label:
string
Title:
Display Name
Action Name -
links:
object actionLinks
-
parentAction:
object foreignKey
-
potentialStates:
object Potential States
Title:
Potential States
Set of states for this attribute. -
resetReasonType:
object lookup
-
type:
object lookup
-
usageType:
object lookup
-
validationType:
object lookup
-
variableName:
string
Title:
Variable Name
Variable Name
Nested Schema : foreignKey
Type:
Show Source
object
-
id:
integer
Title:
Id
Id -
variableName:
string
Title:
Variable Name
Variable Name
Nested Schema : Additional
Type:
object
Title:
Additional
Additional Fields
Nested Schema : dependencies
Type:
Show Source
object
-
actions:
object Actions
Title:
Actions
Array of actions -
attributes:
object Attributes
Title:
Attributes
Array of attributes -
groups:
object Groups
Title:
Groups
Array of groups -
resources:
object Resources
Title:
Resources
Array of resources
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 : actionLinks
Type:
Show Source
object
-
parent:
string
Link to parent Commerce process document.
-
translations:
string
Link to translations for Commerce process document actions.
Nested Schema : Potential States
Type:
object
Title:
Potential States
Set of states for this attribute.
Nested Schema : Actions
Type:
object
Title:
Actions
Array of actions
Nested Schema : Attributes
Type:
object
Title:
Attributes
Array of attributes
Nested Schema : Groups
Type:
object
Title:
Groups
Array of groups
Nested Schema : Resources
Type:
object
Title:
Resources
Array of resources
Examples
The following example shows how to retrieve the metadata for all actions 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/v16/commerceProcesses/oraclecpqo/documents/transaction/actionDefs
The following example shows how to retrieve metadata for all "transaction" actions using the 'Expand All' parameter to include translations 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/actionDefs?expand=all*