Get Scripting Api
Returns supported Orchestrator scripting API.
Request
URI
GET
https:///vco/api/server-configuration/api
COPY
Query Parameters
string
scope
Optional
scope
string
filter
Optional
filter
boolean
isStrict
Optional
isStrict
Responses
200
The request is successful.
Returns api-types of type(s) application/json
{
"system": {
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"objects": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"attributes": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string",
"readonly": "boolean"
}
],
"constructors": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string",
"parameters": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string"
}
]
}
],
"methods": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string",
"parameters": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string"
}
]
}
],
"members": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string"
}
],
"events": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string"
}
],
"isNamespace": "boolean"
}
],
"enums": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"values": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string"
}
]
}
],
"types": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"scriptObject": "string",
"props": [
"string"
],
"events": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string",
"minValue": "string",
"maxValue": "string",
"numberFormat": "string",
"unit": "string",
"props": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"type": "string"
}
]
}
]
}
],
"plugins": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"version": "string",
"build": "integer",
"detailsLink": "string"
}
]
},
"plugins": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"version": "string",
"build": "integer",
"detailsLink": "string"
}
],
"scriptCategories": [
{
"description": "string",
"icon": "string",
"name": "string",
"externalUrl": "string",
"state": "string",
"id": "string",
"actionsCount": "integer",
"detailsLink": "string"
}
]
}
401
User is not authenticated.
Operation doesn't return any data structure
403
User is not authorized.
Operation doesn't return any data structure
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