action-definition

action-definition

The paginated list of actions.

JSON Example

{
    "id": "string",
    "displayName": "string",
    "type": "string",
    "actionAdapterKindKey": "string",
    "contextAdapterKindKey": "string",
    "contextResourceKindKey": "string",
    "contextIds": [
        "string"
    ],
    "scheduleEnabled": false,
    "extension": {
        "anyObjects": [
            {}
        ]
    },
    "links": [
        {
            "href": "string",
            "rel": "string",
            "name": "string",
            "description": "string"
        }
    ],
    "canRecommend": false
}

string

id

Required

The id of the action

string

displayName

Optional

The localized name of the action

string

type

Optional

The type of the action

Possible values are : READ, UPDATE, UNKNOWN,

string

actionAdapterKindKey

Optional

The kind of the adapter that will execute the action

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

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.

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.

boolean

scheduleEnabled

Optional

This field specifies whether the action can be scheduled

extension

extension

Optional

extension

array of link

links

Optional

links

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.

Property Of

action-definitions