Orchestrator API Reference

Orchestrator for ScriptX.Services API provides for discovery of the http: port in use by ScriptX.Services for Windows PC for a current user.

Orchestrator is available as:

A built-in component of ScriptX.Services for Windows PC v2.17.0 and later or,
A 1st class Windows Service: Orchestrator as a Service v2.0 or later.

Each implementation provides a simple API endpoint. By definition this is on the local loopback address with a default configured port of 41190.

Orchestrator Version	Supported APIS
Built-in v2.17.x	v1
Built-in v2.18.x and later	v1, v2
As a Service v2.x	v1, v2

Authentication

All endpoints are open; no Authorization header is required.

API Reference v1 (/api/v1)

The version 1 API should be used when it is known that Orchestrator as a Service is not going to be used since Orchestrator as a Service will always return an error.

GET - returns the port in use by the ScriptX.Services for Windows PC instance for the current user.

API Reference v2 (/api/v2)

The version 2 API should be used when it is known that Orchestrator as a Service will/may be used. Built-in Orchestrator implements the v2 API but ignores the key value and so behaves as with the v1 API.

This behaviour enables a single browser javascript codebase to be deployed.

PUT - registers the port for the given key. GET - returns the port in use by the ScriptX.Services for Windows PC instance registered with the keyvalue.

Using Orchestrator with API sample code

Built-in Orchestrator

To download or upgrade to the latest version (2.23.1) of ScriptX.Services for Windows PC with built-in Orchestrator, download and run the installer.

In order for the installer to run, you must be logged on to your computer as an Administrator.

The default URL (as used in the API sample code) for the built in Orchestrator server is http://127.0.0.1:41190.

For a detailed discussion on installation and configuration of ScriptX.Services for Windows PC please follow this link.

Orchestrator as a Service

Orchestrator as a Service must be downloaded and installed separately from ScriptX.Services for Windows PC.

To download or upgrade to the latest version (2.2.1) of Orchestrator as a Service for ScriptX.Services for Windows PC, download and run the installer.

In order for the installer to run, you must be logged on to your computer as an Administrator.

The default URL (as used in the API sample code) for the Orchestrator as a Service server is http://127.0.0.1:41190.