Landscape REST service

The Landscape REST service allows users to retrieve and update landscape entry information using a simple HTTP client.

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

For HTTP, the port is typically 8019. If Orchestra runs on your local computer, you can access the service at http://localhost:8019/OrchDyn/landscape.

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

Method Get LandscapeInfo

Overview

Returns a list of information objects for all landscape entries of a specific scenario.

Attribute	Value
Relative URI	/infos
REST Method	GET
URL Parameters	scenarioId (the ID of the scenario)
Required Role	LandscapeView
Example URL	http://localhost:8019/OrchDyn/landscape/infos/a8aac39e-517d-446e-a2b9-feef3f3f885b
Response	Array of objects representing the properties describing the scenario's landscape entries

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

[
  {
    "scenario": "a8aac39e-517d-446e-a2b9-feef3f3f885b",
    "nodeId": "ORC",
    "reference": "{a8aac39e-517d-446e-a2b9-feef3f3f885b:EnvironmentEntry}26",
    "entryName": "ee_filepath",
    "entryDescription": "Input directory",
    "entryTypeName": "filepath"
  },
  {
    "scenario": "a8aac39e-517d-446e-a2b9-feef3f3f885b",
    "nodeId": "ORC",
    "reference": "{a8aac39e-517d-446e-a2b9-feef3f3f885b:EnvironmentEntry}27",
    "entryName": "ee_foobar",
    "entryDescription": "",
    "entryTypeName": "Uniform resource locator"
  }
]

Method Get LandscapeInfo For Entry

Overview

Returns information about a specific landscape entry.

Attribute	Value
Relative URI	/info
REST Method	GET
URL Parameters	reference (string representation of a reference to the environment entry. Format: <scenarioid>:EnvironmentEntry<entryId>. Note: Special characters must be encoded)
Required Role	LandscapeView
Example URL	http://localhost:8019/OrchDyn/landscape/info/%7Ba8aac39e-517d-446e-a2b9-feef3f3f885b%3AEnvironmentEntry%7D26
Response	An object containing the properties describing a single landscape entry

The result of the method call is a JSON object, similar to the following:

{
  "scenario": "a8aac39e-517d-446e-a2b9-feef3f3f885b",
  "nodeId": "ORC",
  "reference": "{a8aac39e-517d-446e-a2b9-feef3f3f885b:EnvironmentEntry}26",
  "entryName": "ee_filepath",
  "entryDescription": "Input directory",
  "entryTypeName": "filepath"
}

Method Get LandscapeData

Overview

Returns a list of all parameter values stored in a specific landscape entry.

Attribute	Value
Relative URI	/properties
REST Method	GET
URL Parameters	scenarioId (the ID of the scenario) entryID (the numeric ID of the environment entry)
Required Role	LandscapeView
Example URL	http://localhost:8019/OrchDyn/landscape/properties/a8aac39e-517d-446e-a2b9-feef3f3f885b/26
Response	Array of objects representing the properties of the landscape entry. Each property has a unique name and a value.

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

[
  {
    "type": 0,
    "name": "Directory",
    "value": "//localhost/path",
    "description": "Absolute directory path",
    "encrypted": false,
    "disabled": false
  },
  {
    "type": 2,
    "name": "Protocol",
    "value": "SMB",
    "description": "Protocol"
  }
]

Method Store LandscapeData

Overview

Assign new properties to the specified landscape entry.

Attribute	Value
Relative URI	/properties
REST Method	PUT
URL Parameters	scenarioId (the ID of the scenario) entryID (the numeric ID of the environment entry)
Required Role	LandscapeUpdate
Example URL	http://localhost:8019/OrchDyn/landscape/properties/a8aac39e-517d-446e-a2b9-feef3f3f885b/26
Request Content	An array of objects representing the properties of the landscape entry. Only the fields name and value are necessary to identify and update the landscape properties. See method Get LandscapeData for an example.
Response	No data

Method Get Landscape

Overview

Get the landscape configuration of the local Orchestra node, optionally limited to a scenario or a landscape entry.

Attribute	Value
Relative URI	/
REST Method	GET
URL Parameters	scenarioId (optional) – If provided, only landscape entries of that scenario are included in the result. entryID (optional) – The numeric ID of the landscape entry.
Required Role	LandscapeView
Example URLs	http://localhost:8019/OrchDyn/landscape/ http://localhost:8019/OrchDyn/landscape/a8aac39e-517d-446e-a2b9-feef3f3f885b http://localhost:8019/OrchDyn/landscape/a8aac39e-517d-446e-a2b9-feef3f3f885b/26
Response	An array of objects. Each object represents a scenario with a list of landscape entries. The result is limited by the provided parameters.

Example response when a scenario ID is given as a URL parameter:

[
  {
    "scenarioIdentifier": "a8aac39e-517d-446e-a2b9-feef3f3f885b",
    "scenarioName": "sc_landscape-3",
    "landscapeEntryList": [
      {
        "landscapeEntryReference": "{a8aac39e-517d-446e-a2b9-feef3f3f885b:EnvironmentEntry}26",
        "landscapeEntryName": "ee_filepath",
        "landscapeEntryType": "filepath",
        "landscapeEntryProperties": [
          {
            "name": "Directory",
            "value": "//localhost/path",
            "description": "Absolute directory path",
            "type": "0"
          },
          {
            "name": "Protocol",
            "value": "SMB",
            "description": "Protocol",
            "type": "2"
          }
        ]
      },
      {
        "landscapeEntryReference": "{a8aac39e-517d-446e-a2b9-feef3f3f885b:EnvironmentEntry}27",
        "landscapeEntryName": "ee_foobar",
        "landscapeEntryType": "Uniform resource locator",
        "landscapeEntryProperties": [
          {
            "name": "URL",
            "value": "http://localhost/foobar",
            "description": "Uniform resource locator",
            "type": "0"
          },
          {
            "name": "Proxy",
            "description": "Proxy server",
            "type": "2"
          }
        ]
      }
    ]
  }
]

Method Update Landscape

Overview

Update the landscape configuration of the local Orchestra node.

Attribute	Value
Relative URI	/
REST Method	PUT
URL Parameters	No parameters
Required Role	LandscapeUpdate
Example URL	http://localhost:8019/OrchDyn/landscape/
Request Content	An array of objects. Each object represents a scenario with a list of landscape entries. Only the fields name and value of the landscapeEntryProperties are necessary to identify and update the landscape properties. See method Get Landscape for an example.
Response	No data