Get Action
The returned definition contains base data for the action, as well the input parameter's definitions and the output type.
categoryName
actionName
params
The request is successful
{
"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"
}
relations
id
name
module
description
version
fqn
script
runtime
outputParameterType
href
input-parameters
output-type
iconId
bundleHasContent
runtimeMemoryLimit
runtimeTimeout
entryPoint
actionEnvironmentId
actionEnvironmentName
validationMessage
The user is not authorized
"Action Object"
relations
id
name
module
description
version
fqn
script
runtime
outputParameterType
href
input-parameters
output-type
iconId
bundleHasContent
runtimeMemoryLimit
runtimeTimeout
entryPoint
actionEnvironmentId
actionEnvironmentName
validationMessage
Can not find an action with the specified name
"Action Object"
relations
id
name
module
description
version
fqn
script
runtime
outputParameterType
href
input-parameters
output-type
iconId
bundleHasContent
runtimeMemoryLimit
runtimeTimeout
entryPoint
actionEnvironmentId
actionEnvironmentName
validationMessage
curl -H 'Authorization: <value>' https://{api_host}/vco/api/actions/{categoryName}/{actionName}