Get Plugin Api

Get Plugin Api

Returns supported Orchestrator scripting API for a plugin.

Request
URI
GET
https://{api_host}/vco/api/server-configuration/api/plugins/{plugin}/{version}/{build}
COPY
Path Parameters
string
plugin
Required

plugin

string
version
Required

version

integer
build
Required

build

Query Parameters
string
scope
Optional

scope

string
filter
Optional

filter

boolean
isStrict
Optional

isStrict

Responses
200

The request is successful.

Returns plugin-details of type(s) application/json 
{
    "externalUrl": "string",
    "enums": [
        {
            "externalUrl": "string",
            "values": [
                {
                    "externalUrl": "string",
                    "icon": "string",
                    "name": "string",
                    "description": "string",
                    "state": "string"
                }
            ],
            "icon": "string",
            "name": "string",
            "description": "string",
            "state": "string"
        }
    ],
    "types": [
        {
            "externalUrl": "string",
            "icon": "string",
            "name": "string",
            "description": "string",
            "scriptObject": "string",
            "state": "string",
            "events": [
                {
                    "externalUrl": "string",
                    "minValue": "string",
                    "unit": "string",
                    "numberFormat": "string",
                    "maxValue": "string",
                    "icon": "string",
                    "name": "string",
                    "description": "string",
                    "state": "string",
                    "type": "string",
                    "props": [
                        {
                            "externalUrl": "string",
                            "icon": "string",
                            "name": "string",
                            "description": "string",
                            "state": "string",
                            "type": "string"
                        }
                    ]
                }
            ],
            "props": [
                "string"
            ]
        }
    ],
    "build": 0,
    "objects": [
        {
            "externalUrl": "string",
            "constructors": [
                {
                    "externalUrl": "string",
                    "icon": "string",
                    "name": "string",
                    "description": "string",
                    "state": "string",
                    "type": "string",
                    "parameters": [
                        {
                            "externalUrl": "string",
                            "icon": "string",
                            "name": "string",
                            "description": "string",
                            "state": "string",
                            "type": "string"
                        }
                    ]
                }
            ],
            "isNamespace": false,
            "methods": [
                {
                    "externalUrl": "string",
                    "icon": "string",
                    "name": "string",
                    "description": "string",
                    "state": "string",
                    "type": "string",
                    "parameters": [
                        {
                            "externalUrl": "string",
                            "icon": "string",
                            "name": "string",
                            "description": "string",
                            "state": "string",
                            "type": "string"
                        }
                    ]
                }
            ],
            "members": [
                {
                    "externalUrl": "string",
                    "icon": "string",
                    "name": "string",
                    "description": "string",
                    "state": "string",
                    "type": "string"
                }
            ],
            "icon": "string",
            "name": "string",
            "description": "string",
            "attributes": [
                {
                    "externalUrl": "string",
                    "readonly": false,
                    "icon": "string",
                    "name": "string",
                    "description": "string",
                    "state": "string",
                    "type": "string"
                }
            ],
            "state": "string",
            "events": [
                {
                    "externalUrl": "string",
                    "icon": "string",
                    "name": "string",
                    "description": "string",
                    "state": "string"
                }
            ]
        }
    ],
    "icon": "string",
    "name": "string",
    "description": "string",
    "state": "string",
    "version": "string"
}
string
externalUrl
Optional

externalUrl

array of EnumType
enums
Optional

enums

array of SdkType
types
Optional

types

integer As int64 As int64
build
Optional

build

array of ObjectType
objects
Optional

objects

string
icon
Optional

icon

string
name
Optional

name

string
description
Optional

description

string
state
Optional

state

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

version


401

User is not authenticated.

Operation doesn't return any data structure

403

User is not authorized.

Operation doesn't return any data structure

On This Page
Server Configuration Service Operations
GET
Get Category Details
GET
Get O1 1n Types
GET
Get Plugin Api
GET
Get Scripting Api
GET
Get Server Configuration
GET
Get Settings
POST
Import Server Configuration