Get Action

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 
{
    "href": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "attribute": [
                    {
                        "displayValue": "string",
                        "value": "string",
                        "name": "string"
                    }
                ],
                "href": "string",
                "type": "string",
                "rel": "string"
            }
        ]
    },
    "id": "string",
    "parameter": [
        {
            "description": "string",
            "value": {
                "objectType": "string"
            },
            "type": "string",
            "name": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "output-type": "string",
    "name": "string",
    "module": "string",
    "description": "string",
    "version": "string",
    "fqn": "string",
    "script": "string"
}
string
href
Optional

href

Relations
relations
Optional

relations

string
id
Optional

id

array of parameter
parameter
Optional

parameter

string
output-type
Optional

output-type

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

name

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

module

string
description
Optional

description

string
version
Optional

version

string
fqn
Optional

fqn

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

On This Page
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