Scripting services
The scripting engine is a work in progress and updates are being introduced regularly. If you've somehow ended up on this page (possibly through a direct link sent to you or a search result) then congratulations, you are now in on one of our roadmap secrets. Let's keep it that way, and we'll make sure to announce it with a bang once it's fully up and running.
Explore more about scripting.
All scripting dialects will use the same set of services, these currently are:
CreateScript - Creates a new script. For the sake of terminology, lets keep in mind that the created script is then called a Type.
Name: string;
Source: string;
Dialect: string;
IsActive: boolean;
UpdateScript - Updates an existing script. For the sake of terminology, lets keep in mind that the updated script is then called a Type.
ID: number;
Name: string;
Source: string;
Dialect: string;
IsActive: boolean;
DeleteScript - Deletes an existing script.
ID: number;
GetScript - Gets a script by ID.
ID: number;
ListScripts - List all existing scripts and can optionally be filtered.
The request has no body - but optional filters available
For terminology purposes, the GetScript and ListScripts services return a Type. Type is the output of the services CreateScript or UpdateScript, both referred to above.
ParseScript - Is used during editing for auto-complete and validation.
Source: string;
Dialect: string;
Type: ParseTypes;
IncludeAST: boolean;
IncludeCompletionSuggestions: boolean;
CompletionSource: string;
ExplainScript - Attempts to explain the given script in plain English.
Source: string;
Dialect: string;
GetScriptDialects - Retrieves a list of supported script dialects.
The request has no body
GetScriptExtensionPoints - Retrieves a list of all available extension points.
The request has no body