Get All Actions

Performing a GET /api/actiondefinitions call will query for
available Actions defined in the system. This includes the data needed
to populate an Action in the system.

Request

URI

GET

https://{api_host}/suite-api/api/actiondefinitions

COPY

Query Parameters

boolean

scheduleEnabled

Optional

Filtering action definitions by the availability of being scheduled

integer

page

Optional

Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer

pageSize

Optional

Constraints: default: 1000

Expected number of entries per page

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

List of ActionDefinitions in the system

Returns action-definitions of type(s) application/json

"{\n  \"pageInfo\" : {\n    \"totalCount\" : 2,\n    \"page\" : 0,\n    \"pageSize\" : 10\n  },\n  \"links\" : [ {\n    \"href\" : \"/suite-api/api/actiondefinitions?page=0&amp;pageSize=10\",\n    \"rel\" : \"SELF\",\n    \"name\" : \"current\",\n    \"description\" : \"self\"\n  }, {\n    \"href\" : \"/suite-api/api/actiondefinitions?page=0&amp;pageSize=10\",\n    \"rel\" : \"RELATED\",\n    \"name\" : \"first\",\n    \"description\" : \"first\"\n  }, {\n    \"href\" : \"/suite-api/api/actiondefinitions?page=0&amp;pageSize=10\",\n    \"rel\" : \"RELATED\",\n    \"name\" : \"last\",\n    \"description\" : \"last\"\n  } ],\n  \"actionDefinitions\" : [ {\n    \"id\" : \"VMWARE-Power Off VM\",\n    \"displayName\" : \"Power Off VM\",\n    \"type\" : \"UPDATE\",\n    \"actionAdapterKindKey\" : \"VMWARE\",\n    \"contextAdapterKindKey\" : \"VMWARE\",\n    \"contextResourceKindKey\" : \"VirtualMachine\",\n    \"contextIds\" : [ \"PowerOffVM\" ],\n    \"scheduleEnabled\" : true,\n    \"canRecommend\" : true\n  }, {\n    \"id\" : \"VMWARE-Power On VM\",\n    \"displayName\" : \"Power On VM\",\n    \"type\" : \"UPDATE\",\n    \"actionAdapterKindKey\" : \"VMWARE\",\n    \"contextAdapterKindKey\" : \"VMWARE\",\n    \"contextResourceKindKey\" : \"VirtualMachine\",\n    \"contextIds\" : [ \"PowerOnVM\" ],\n    \"scheduleEnabled\" : true,\n    \"canRecommend\" : true\n  } ]\n}"

object

pageInfo

Optional

Represents page information for a paged result

array of object

links

Optional

Collection of links

array of object

actionDefinitions

Optional

The paginated list of actions.

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/actiondefinitions

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Actions Operations