Start or load a composition

Start or load a test instance.

Query Params
string
required

Enum Action to take to create an instance, either load or play.

Body Params
string

Name of a server in the server list to be used as the alpha.

string
required

Full path name for the composition.

customProperties
array of objects

Array of custom property values.

customProperties
string

Description for the result. This only applies to the command 'play'.

string

Unique name to use as the result name. This only applies to the command 'play'.

string

Name of the results database to use. If not specified then the test uses the database set by the composition. This only applies to the command 'play'.

seedDataKeys
array of objects

Array of seed data names and decryption keys.

seedDataKeys
systemProperties
array of objects

Array of system property values.

systemProperties
Headers
string
required

All calls to this API require that you pass in the token you get from the Generate a token operation as an X-Auth-Token request header. See Get started for help to initially call the API.

Responses

400

Bad request. The URL or JSON request object is invalid.

401

Unauthorized. The security token is missing or invalid. See Get started for help initially running the API.

404

Not found. The requested object doesn't exist.

Language
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json