Jump to

• Request
• Response
• Examples

Get Actions Metadata

get

/rest/v19/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

Back to Top

Response

Default Response

Body ()

Root Schema : CommerceActions-collection

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object CommerceActions

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

Nested Schema : CommerceActions

Type: object

Show Source

• 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

{
    "properties":{
        "validationType":{
            "$ref":"#/definitions/lookup"
        },
        "isShowLoadingDialog":{
            "title":"Is Show Loading Dialog",
            "description":"Is Show Loading Dialog",
            "type":"boolean"
        },
        "autoUnlockQuote":{
            "title":"Automatically Unlock Quote",
            "description":"Boolean property that specifies whether the action will automatically unlock the quote if it is locked for the user who is executing the action.",
            "type":"boolean"
        },
        "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"
                },
                "groups":{
                    "title":"Groups",
                    "type":"object",
                    "description":"Array of groups"
                },
                "resources":{
                    "title":"Resources",
                    "type":"object",
                    "description":"Array of resources"
                }
            }
        },
        "label":{
            "title":"Display Name",
            "description":"Action Name",
            "type":"string"
        },
        "id":{
            "title":"Id",
            "description":"Primary Key of Commerce Actions.",
            "type":"integer"
        },
        "resetReasonType":{
            "$ref":"#/definitions/lookup"
        },
        "actionSet":{
            "$ref":"#/definitions/foreignKey"
        },
        "actionTimeout":{
            "title":"Action Timeout",
            "description":"Action Timeout",
            "type":"integer"
        },
        "isRemote":{
            "title":"Is Remote",
            "description":"Is Remote",
            "type":"boolean"
        },
        "variableName":{
            "title":"Variable Name",
            "description":"Variable Name",
            "type":"string"
        },
        "parentAction":{
            "$ref":"#/definitions/foreignKey"
        },
        "evalReasonTree":{
            "title":"Eval Reason Tree",
            "description":"Eval Reason Tree",
            "type":"boolean"
        },
        "usageType":{
            "$ref":"#/definitions/lookup"
        },
        "type":{
            "$ref":"#/definitions/lookup"
        },
        "destinationType":{
            "$ref":"#/definitions/lookup"
        },
        "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/actionLinks"
        }
    }
}

Nested Schema : foreignKey

Type: object

Show Source

• id: integer
  Title: Id

  Id
• variableName: 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 : Additional

Type: object

Title: Additional

Additional Fields

Nested Schema : dependencies

Type: object

Show Source

• 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

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

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"
        }
    }
}

Nested Schema : actionLinks

Type: object

Show Source

• parent: string
  Link to parent Commerce process document.
• translations: string
  Link to translations for Commerce process document actions.

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

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

Back to Top

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 -H "Authorization: Bearer <token>" - H "Content-type: application/json" 
https://sitename.oracle.com/rest/v19/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 -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/commerceProcesses/oraclecpqo/documents/transaction/actionDefs?expand=all*

Back to Top