Composition commands

put

https://{hostname}/concerto/services/rest/composition/instances/v1/{instanceId}

The composition commands you use on a test instance are: play, stop, abort, pause, resume, unload. The return of the command doesn't imply that the action is complete. To get the current state of the instance, use the Get a composition command.

Path Params

instanceId

string

required

Uniquely identifies each composition instance.

Query Params

command

string

enum

required

Enum Action to take on the running instance, either play, stop, abort, pause, resume, or unload.

Allowed:

Body Params

customProperties

array of objects

Array of custom property values.

customProperties

resultDescription

string

Description for the result.

resultName

string

Unique name to use as the result name.

resultsDatabaseName

string

Name of the results database to use. If not specified then the test uses the database set by the composition.

systemProperties

array of objects

Array of system property values.

systemProperties

Headers

X-Auth-Token

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.

405

Method Not Allowed. Invalid method used to access resource.

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Act on a composition instance.