Get Action 1

Get Action 1

The returned definition contains base data for the action, as well the input parameter's definitions and the output type. When a request is sent to this endpoint with "application/zip" or "application/octet-stream" as the desired response content type, this operation is the equivalent to "Export an action with given id":

Exports an action by its ID. If the request is successful, the action binary content is available as an attachment with MIME type application/zip (that is, a normal ZIP file) with a default file name {actionname}.action.

It is up to the client application to properly fetch and process this attachment, i.e. by saving it to the local file system.

The exported action has the same internal format as the actions exported by using the VCF Operations Orchestrator client.

Request
URI
GET
https://{api_host}/vco/api/actions/{actionId}
COPY
Path Parameters
string
actionId
Required

actionId

Authentication
This operation uses the following authentication methods.
Responses
200

The request is successful

Returns Action of type(s) application/json 
{
    "relations": {
        "startIndex": 0,
        "count": 0,
        "total": 0,
        "link": [
            {
                "rel": "string",
                "type": "string",
                "attributes": [
                    {
                        "name": "string",
                        "displayName": "string",
                        "value": "string",
                        "displayValue": "string"
                    }
                ],
                "href": "string"
            }
        ]
    },
    "id": "string",
    "name": "string",
    "module": "string",
    "description": "string",
    "version": "string",
    "fqn": "string",
    "script": "string",
    "runtime": "string",
    "outputParameterType": "string",
    "href": "string",
    "input-parameters": [
        {
            "name": "string",
            "type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
            "description": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "output-type": "string",
    "iconId": "string",
    "bundleHasContent": false,
    "runtimeMemoryLimit": 0,
    "runtimeTimeout": 0,
    "entryPoint": "string",
    "actionEnvironmentId": "string",
    "actionEnvironmentName": "string",
    "validationMessage": "string"
}
object
relations
Optional

relations

string
id
Optional

id

string As ^[\p{L}_$][\p{L}0-9_$]*$
name
Required

name

string As ^[\p{L}_][\p{L}0-9_-]*(\.[\p{L}0-9_-]+)*$
module
Required

module

string
description
Optional

description

string
version
Optional

version

string
fqn
Optional

fqn

string
script
Optional

script

string
runtime
Optional

runtime

string
outputParameterType
Optional

outputParameterType

string
href
Optional

href

array of object
input-parameters
Optional

input-parameters

string
output-type
Optional

output-type

string
iconId
Optional

iconId

boolean
bundleHasContent
Optional

bundleHasContent

integer As int64 As int64
runtimeMemoryLimit
Optional

runtimeMemoryLimit

integer As int64 As int64
runtimeTimeout
Optional

runtimeTimeout

string
entryPoint
Optional

entryPoint

string
actionEnvironmentId
Optional

actionEnvironmentId

string
actionEnvironmentName
Optional

actionEnvironmentName

string
validationMessage
Optional

validationMessage


401

The user is not authorized

Returns Action of type(s) application/json 
"Action Object"
object
relations
Optional

relations

string
id
Optional

id

string As ^[\p{L}_$][\p{L}0-9_$]*$
name
Required

name

string As ^[\p{L}_][\p{L}0-9_-]*(\.[\p{L}0-9_-]+)*$
module
Required

module

string
description
Optional

description

string
version
Optional

version

string
fqn
Optional

fqn

string
script
Optional

script

string
runtime
Optional

runtime

string
outputParameterType
Optional

outputParameterType

string
href
Optional

href

array of object
input-parameters
Optional

input-parameters

string
output-type
Optional

output-type

string
iconId
Optional

iconId

boolean
bundleHasContent
Optional

bundleHasContent

integer As int64 As int64
runtimeMemoryLimit
Optional

runtimeMemoryLimit

integer As int64 As int64
runtimeTimeout
Optional

runtimeTimeout

string
entryPoint
Optional

entryPoint

string
actionEnvironmentId
Optional

actionEnvironmentId

string
actionEnvironmentName
Optional

actionEnvironmentName

string
validationMessage
Optional

validationMessage


404

Can not find an action with the specified name

Returns Action of type(s) application/json 
"Action Object"
object
relations
Optional

relations

string
id
Optional

id

string As ^[\p{L}_$][\p{L}0-9_$]*$
name
Required

name

string As ^[\p{L}_][\p{L}0-9_-]*(\.[\p{L}0-9_-]+)*$
module
Required

module

string
description
Optional

description

string
version
Optional

version

string
fqn
Optional

fqn

string
script
Optional

script

string
runtime
Optional

runtime

string
outputParameterType
Optional

outputParameterType

string
href
Optional

href

array of object
input-parameters
Optional

input-parameters

string
output-type
Optional

output-type

string
iconId
Optional

iconId

boolean
bundleHasContent
Optional

bundleHasContent

integer As int64 As int64
runtimeMemoryLimit
Optional

runtimeMemoryLimit

integer As int64 As int64
runtimeTimeout
Optional

runtimeTimeout

string
entryPoint
Optional

entryPoint

string
actionEnvironmentId
Optional

actionEnvironmentId

string
actionEnvironmentName
Optional

actionEnvironmentName

string
validationMessage
Optional

validationMessage


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vco/api/actions/{actionId}
On This Page
Actions Service Operations
PUT
Update Action
GET
Get Debug Info
PUT
Execute Debugger Operation
POST
Control Debugger
GET
List All Actions
POST
Create Action
GET
Download Action Bundle
POST
Update Action Bundle
DELETE
Delete Action Bundle
POST
Execute Action By Name
POST
Execute Action By Id
GET
Download Action Icon
GET
Export Action Logs 1
GET
Get Action
GET
Get Action 1
DELETE
Delete Action 1
GET
Find Action Dependencies
GET
Get Action Execution Result
DELETE
Cancel Action Run