Perform Action Using POST

Perform Action Using POST


Performing a POST /api/actions/{id} will attempt to trigger the action with specified id. It is considered a best practice to use the actionExecution field from the POST /api/action/{id}/query that has been previously executed to populate the body of the request. Please note that additional values may be required in order to make the populateAction response body valid.

Request
URI
POST
https://{api_host}/api/actions/{id}
COPY
Path Parameters
string
id
Required

The id for the action to be executed (can be retrieved via: GET /api/actiondefinitions)

Request Body

Describe instance data about performing an action.

action-execution of type(s) application/json
Optional

Show optional properties

{
    "parameterGroups": [
        {
            "resourceId": "string"
        }
    ]
}
{
    "contextId": "string",
    "contextResourceId": [
        "string"
    ],
    "parameterGroups": [
        {
            "parameterValue": [
                {
                    "name": "string",
                    "value": "string"
                }
            ],
            "resourceId": "string"
        }
    ]
}
string
contextId
Optional

An optional value naming the action step that will be executed

array of string
contextResourceId
Optional

The UUID list of resources that the action will be performed against

array of action-parameter-group
parameterGroups
Required

The parameters that are used as inputs for the action being performed

Authentication
This operation uses the following authentication methods.
Responses
200

List of Task Ids for the action run.

Returns str-values of type(s) application/json 
{
    "values": [
        "string"
    ]
}
array of string
values
Optional

values


On This Page
Actions Operations
GET
Get Action Status Using GET
GET
Get All Actions Using GET
POST
Perform Action Using POST
POST
Populate Action Using POST