action-definition

action-definition
action-definition
JSON Example 
{
    "actionAdapterKindKey": "string",
    "canRecommend": false,
    "contextAdapterKindKey": "string",
    "contextIds": [
        "string"
    ],
    "contextResourceKindKey": "string",
    "displayName": "string",
    "extension": {
        "anyObjects": [
            {}
        ]
    },
    "id": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "type": "string"
}
string
actionAdapterKindKey
Optional

The kind of the adapter that will execute the action

boolean
canRecommend
Optional

This field specifies whether the action can be used in recommendations. This is validated when an action is associated to a recommendation.

string
contextAdapterKindKey
Required

The adapter kind of the context object that the action will be populated with. In other words, the kind of adapter that will be used when populating an action prior to execution. This may be different from the target resource, or the kind of the adapter that the action is executed against

array of string
contextIds
Optional

The ids for the available Action Contexts for this action. Action Contexts are used in multi-step actions, with each id denoting a step in the overall action. Most actions will only have a single step, and this field may be ignored for those.

string
contextResourceKindKey
Required

The resource kind of the context object that the action will be populated with. In other words, the kind of resource that will be used when populating an action prior to execution. This may be different than the kind of resource that the action is executed against, or the target resource.

string
displayName
Optional

The localized name of the action

extension
extension
Optional

extension

string
id
Required

The id of the action

array of link
links
Optional

links

string
type
Optional

The type of the action

Possible values are : READ, UPDATE, UNKNOWN,
Property Of