Deployment REST service

The Deployment REST service allows users to retrieve information about deployed scenarios, as well as to deploy and redeploy scenarios using a simple HTTP client.

The base URL for the service is:
http://<host>:<port>/OrchDyn/deployment or
https://<host>:<port>/OrchDyn/deployment

For HTTP, the port is typically 8019. Therefore, if Orchestra is running on your local computer, you can access the service at http://localhost:8019/OrchDyn/deployment.

Note that you must authenticate using Basic Authentication with an Orchestra monitor user who has the required roles to access the service.

Method getAllDeployedScenarios

Returns a list of information objects for all scenarios deployed on the Orchestra node.

Attribute	Value
Relative URI	/scenarioInfos
REST method	GET
URL Parameters	No parameters
Required role	list
Example URL	http://localhost:8019/OrchDyn/deployment/scenarioInfos
Response	Array of objects containing information about the deployed scenarios

The result of the method call is a JSON array similar to the following example:

[
   {
      "serviceState": 1,
      "persistentSubscription": 1,
      "signalState": 1,
      "timerState": 1,
      "inboundChannelState": 1,
      "scenarioID": "ceb71f02-3a69-4b3b-8e73-2edb1c07186c",
      "nodeId": "ORC",
      "name": "scTest47SoapWS",
      "description": "",
      "deployedAt": "2019-08-14 16:42:40",
      "modifiedAt": "2019-08-14 16:42:40",
      "userID": "admin",
      "userName": "Administrator",
      "active": false,
      "versionTag": "V000000000000000221",
      "comment": "scTest47SoapWS",
      "groups": [],
      "deploymentMessage": "",
      "errorOnStartup": false,
      "exportedAt": "2018-10-26 15:04:36"
   },
   {
      "serviceState": 1,
      "persistentSubscription": 1,
      "signalState": 1,
      "timerState": 1,
      "inboundChannelState": 1,
      "scenarioID": "54482a82-dbe9-4ac2-9919-0915375d1153",
      "nodeId": "ORC",
      "name": "scTest42SoapWS",
      "description": "",
      "deployedAt": "2019-08-14 16:42:37",
      "modifiedAt": "2019-08-14 16:42:37",
      "userID": "admin",
      "userName": "Administrator",
      "active": false,
      "versionTag": "V000000000000000220",
      "comment": "scTest42SoapWS",
      "groups": [],
      "deploymentMessage": "",
      "errorOnStartup": false,
      "exportedAt": "2018-10-26 15:04:16"
   }
]

Method getScenarioFile

Provides the psc file of a deployed scenario for download.

Attribute	Value
Relative URI	/scenarios
REST method	GET
URL Parameters	versionTag (optional query parameter, allows specifying an older scenario version for download) attachDocumentation (optional query parameter, when true, the scenario documentation will be attached for older scenarios)
Required roles	Scenario.Download
Example URLs	http://localhost:8019/OrchDyn/deployment/scenarios/1b6b0765-6f3d-4744-8ece-5d4131c7950b http://localhost:8019/OrchDyn/deployment/scenarios/1b6b0765-6f3d-4744-8ece-5d4131c7950b?versionTag=V000000000000000251
Response	If the scenario (with the correct version tag) is present and the user has the correct role: a stream containing the psc content