Get Resource Action 1

Returns an action for the resource specified by its Resource ID and Action ID.

Request

URI

GET

https://{api_host}/deployment/api/deployments/{deploymentId}/resources/{resourceId}/actions/{actionId}

COPY

Path Parameters

string

deploymentId

Required

Deployment ID

string

resourceId

Required

Resource ID

string

actionId

Required

Action ID

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns ResourceAction of type(s) application/json

{
    "actionType": "string",
    "dependents": [
        "string"
    ],
    "description": "string",
    "displayName": "string",
    "formDefinition": {
        "formURI": "string",
        "trackProgressInModal": false
    },
    "id": "string",
    "name": "string",
    "orgId": "string",
    "projectId": "string",
    "schema": {
        "$data": "string",
        "$dynamicDefault": "string",
        "$ref": "string",
        "additionalProperties": false,
        "allOf": [
            "JsonSchemaImpl Object"
        ],
        "anyOf": [
            "JsonSchemaImpl Object"
        ],
        "const": {},
        "default": {},
        "description": "string",
        "encrypted": false,
        "enum": [
            {}
        ],
        "format": "string",
        "formatMaximum": "string",
        "formatMinimum": "string",
        "items": "ObjectOrListJsonSchemaImpl Object",
        "maxItems": 0,
        "maxLength": 0,
        "maxProperties": 0,
        "maximum": "number",
        "minItems": 0,
        "minLength": 0,
        "minProperties": 0,
        "minimum": "number",
        "not": "JsonSchemaImpl Object",
        "oneOf": [
            "JsonSchemaImpl Object"
        ],
        "pattern": "string",
        "patternProperties": {
            "patternProperties": "JsonSchemaImpl Object"
        },
        "properties": {
            "properties": "JsonSchemaImpl Object"
        },
        "readOnly": false,
        "required": [
            "string"
        ],
        "title": "string",
        "type": "string",
        "uniqueItems": false,
        "writeOnly": false
    },
    "valid": false
}

string

actionType

Optional

Resource action type

Possible values are : RESOURCE_ACTION, RESOURCE_EXTENSION,

array of string

dependents

Optional

Dependent resources

string

description

Optional

Resource action description

string

displayName

Optional

Resource action display name

object

formDefinition

Optional

Resource action custom UI definition. Optional

string

Optional

Resource action id

string

name

Optional

Resource action name

string

orgId

Optional

Resource action org ID

string

projectId

Optional

Resource action project ID

object

schema

Optional

Schema describing a policy object of this type

boolean

valid

Optional

Resource action is valid for current state

401

Unauthorized

Returns ResourceAction of type(s) application/json

"ResourceAction Object"

string

actionType

Optional

Resource action type

Possible values are : RESOURCE_ACTION, RESOURCE_EXTENSION,

array of string

dependents

Optional

Dependent resources

string

description

Optional

Resource action description

string

displayName

Optional

Resource action display name

object

formDefinition

Optional

Resource action custom UI definition. Optional

string

Optional

Resource action id

string

name

Optional

Resource action name

string

orgId

Optional

Resource action org ID

string

projectId

Optional

Resource action project ID

object

schema

Optional

Schema describing a policy object of this type

boolean

valid

Optional

Resource action is valid for current state

404

Not Found

Returns ResourceAction of type(s) application/json

"ResourceAction Object"

string

actionType

Optional

Resource action type

Possible values are : RESOURCE_ACTION, RESOURCE_EXTENSION,

array of string

dependents

Optional

Dependent resources

string

description

Optional

Resource action description

string

displayName

Optional

Resource action display name

object

formDefinition

Optional

Resource action custom UI definition. Optional

string

Optional

Resource action id

string

name

Optional

Resource action name

string

orgId

Optional

Resource action org ID

string

projectId

Optional

Resource action project ID

object

schema

Optional

Schema describing a policy object of this type

boolean

valid

Optional

Resource action is valid for current state

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/deployment/api/deployments/{deploymentId}/resources/{resourceId}/actions/{actionId}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Deployment Actions Operations

GET

Get Deployment Actions

GET