Get Action
The returned definition contains base data for the action, as well the input parameter's definitions and the output type.
Request
URI
GET
https://{api_host}/vco/api/actions/{categoryName}/{actionName}
COPY
Path Parameters
string
categoryName
Required
categoryName
string
actionName
Required
actionName
Responses
200
The request is successful
Returns action of type(s) application/json
{
"fqn": "string",
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"module": "string",
"name": "string",
"description": "string",
"output-type": "string",
"href": "string",
"id": "string",
"relations": {
"total": 0,
"start": 0,
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"version": "string",
"script": "string"
}
string
fqn
Optional
fqn
string As ^[\p{L}_]+(\.[\p{L}0-9_]+)*$
module
Required
module
string As ^[\p{L}_$][\p{L}0-9_$]*$
name
Required
name
string
description
Optional
description
string
output-type
Optional
output-type
string
href
Optional
href
string
id
Optional
id
string
version
Optional
version
string
script
Optional
script
401
The user is not authorized
Operation doesn't return any data structure
404
Can not find an action with the specified name
Operation doesn't return any data structure
Actions Service Operations
DELETE
Delete Action
DELETE
Delete Permission Rule
DELETE
Delete Permissions For Object
POST
Execute Action By Id
POST
Execute Action By Name
GET
Export Action
GET
Get Action
GET
Get Permission Rule
GET
Get Permissions For Object
POST
Import Action
POST
Insert Permissions For Object
GET
List All Actions
PUT
Update Permission Rule