Get Category Details

Get Category Details

Returns supported Orchestrator scripting API for actions grouped by categories.

Request
URI
GET
https://{api_host}/vco/api/server-configuration/api/category/{id}
COPY
Path Parameters
string
id
Required

id

Query Parameters
string
scope
Optional

scope

string
filter
Optional

filter

boolean
isStrict
Optional

isStrict


Responses
200

The request is successful.

Returns category-details of type(s) application/json
{
    "description": "string",
    "icon": "string",
    "name": "string",
    "externalUrl": "string",
    "state": "string",
    "id": "string",
    "actions": [
        {
            "description": "string",
            "icon": "string",
            "name": "string",
            "externalUrl": "string",
            "state": "string",
            "id": "string",
            "resultType": "string",
            "version": "string",
            "categoryId": "string",
            "parameters": [
                {
                    "description": "string",
                    "icon": "string",
                    "name": "string",
                    "externalUrl": "string",
                    "state": "string",
                    "type": "string",
                    "position": 0
                }
            ]
        }
    ]
}
string
description
Optional

description

string
icon
Optional

icon

string
name
Optional

name

string
externalUrl
Optional

externalUrl

string
state
Optional

state

Possible values are : RELEASE, ALPHA, BETA, DEPRECATED,
string
id
Optional

id

actions
Optional

actions


401

User is not authenticated.

Operation doesn't return any data structure

403

User is not authorized.

Operation doesn't return any data structure