Submit Resource Action Request Using POST

Submit Resource Action Request Using POST

Submit a resource action request.

Request
URI
POST
https://{api_host}//api.mgmt.cloud.vmware.com/deployment/api/deployments/{depId}/resources/{resourceId}/requests
COPY
Path Parameters
string
depId
Required

Deployment ID

string
resourceId
Required

Resource ID

Request Body
ResourceActionRequest of type(s) application/json
Optional 
{
    "actionId": "string",
    "reason": "string"
}
string
actionId
Optional

The id of the action to perform.

object
inputs
Optional

Resource action request inputs

string
reason
Optional

Reason for requesting a day2 operation

Responses
200

OK

Returns DeploymentRequest of type(s) */* 
{
    "actionId": "string",
    "blueprintId": "string",
    "catalogItemId": "string",
    "completedTasks": 0,
    "createdAt": "string",
    "deploymentId": "string",
    "details": "string",
    "id": "string",
    "name": "string",
    "parentId": "string",
    "requestedBy": "string",
    "requester": "string",
    "resourceName": "string",
    "resourceType": "string",
    "status": "string",
    "statusDetails": "string",
    "totalTasks": 0,
    "updatedAt": "string"
}
string
actionId
Optional

Identifier of the requested action

string
blueprintId
Optional

Identifier of the requested blueprint in the form 'UUID:version'

string
catalogItemId
Optional

Identifier of the requested catalog item in the form 'UUID:version'

integer As int32 As int32
completedTasks
Optional

The number of tasks completed while fulfilling this request.

string As date-time As date-time
createdAt
Optional

Creation time (e.g. date format '2019-07-13T23:16:49.310Z').

string As uuid As uuid
deploymentId
Optional

Deployment id to which the event applies to

string
details
Optional

Longer user-friendly details of the event.

string As uuid As uuid
id
Optional

Event identifier

object
inputs
Optional

Request inputs

string
name
Optional

Short user-friendly label of the event (e.g. 'shuting down myVM')

string As uuid As uuid
parentId
Optional

Parent event/request identifier

string
requestedBy
Optional

User that initiated the request

string
requester
Optional

requester

string
resourceName
Optional

Optional resource name to which the event applies to

string
resourceType
Optional

Optional resource type to which the event applies to

string
status
Optional

Request overall execution status.

Possible values are : PENDING, REJECTED, INPROGRESS, ABORTED, SUCCESSFUL, PARTIALLY_SUCCESSFUL, FAILED, CREATED,
string
statusDetails
Optional

statusDetails

integer As int32 As int32
totalTasks
Optional

The total number of tasks need to be completed to fulfil this request.

string As date-time As date-time
updatedAt
Optional

Last update time (e.g. date format '2019-07-13T23:16:49.310Z').


201

Created

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Deployment Actions Operations
POST
Action Deployment Request Using POST
GET
Get Deployment Actions Using GET
GET
Get Deployment Action Using GET
GET
Get Resource Actions Using GET
GET
Get Resource Action Using GET
POST
Submit Deployment Action Request Using POST
POST
Submit Resource Action Request Using POST