Get Category Details

Get Category Details
Get scripting API for actions grouped by categories

Returns supported VCF Operations Orchestrator scripting API for actions grouped by categories.

Request
URI
GET
https://{api_host}/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

Authentication
This operation uses the following authentication methods.
Responses
200

The request is successful.

Returns ScriptModuleCategoryDetails 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

array of object
actions
Optional

actions


401

User is not authenticated.

Returns ScriptModuleCategoryDetails of type(s) application/json 
"ScriptModuleCategoryDetails Object"
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

array of object
actions
Optional

actions


403

User is not authorized.

Returns ScriptModuleCategoryDetails of type(s) application/json 
"ScriptModuleCategoryDetails Object"
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

array of object
actions
Optional

actions


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/server-configuration/api/category/{id}
On This Page
Server Configuration Service Operations
GET
Get Server Configuration
POST
Import Server Configuration
GET
Get O1 1n Types
GET
Get Settings
GET
Get O1 1n Polyglot Runtimes
GET
Get Scripting Api
GET
Get Plugin Api
GET
Get Category Details