Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
Top
Top

...

Info
titleBase URL for Environment Instance REST API

http://host:port/flexdeploy/rest/topology/environmentinstance/{environmentId}/{instanceId}

...

Each function returns a JSON environment instance object. The environment object has these attributes:

AttributesTypeDescription
environmentIdLongThe environment id of the environment instance
instanceIdLongThe instance id of the environment instance
isActiveBooleanWhether or not the environment instance is active
endPointsList<EndPoint>List of endpoint ids and their associated resource type ids
propertiesList<Property>List of property names and their values


Back to Top

...


GET

This GET service will find an environment instance with the given environment id and instance id. It returns the JSON representation of the environment instance. 

...

Info
titleAPI URL
http://host:port/flexdeploy/rest/topology/environmentinstance/{environmentId}/{instanceId}

Parameters


Parameter

Type

Required

Description

environmentId

URLYesURL parameter for the environment Id which is used to find and return an environment instance
instanceIdURLYesURL parameter for the instance Id which is used to find and return an environment instance


Example

If we had an environment instance in our database with an environment id of 12347 and an instance id of 12342 with the following attributes,

...

Info
titleAPI URL

http://host:port/flexdeploy/rest/topology/environmentinstance/{environmentId}/{instanceId}

Parameters

Parameter

Type

Required

Description

environmentId

URLYesURL parameter for the environment Id which is used to find and return an environment instance
instanceIdURLYesURL parameter for the instance Id which is used to find and return an environment instance
environmentIdLongNoThe environment id of the environment instance. This parameter is ignored in PUT.
instanceIdLongNoThe instance id of the environment instance. This parameter is ignore in PUT.
isActiveBooleanNoWhether or not the environment instance is active. Defaults to true if not passed in.
endPointsList<EndPoint>NoList of endpoint ids and their associated resource type ids
propertiesList<Property>YesList of property names and their values

Example

If we had an environment instance in our database with an environment id of 12347 and an instance id of 12342 with the following attributes,

...

Back to Top

...

PATCH

This PATCH service will update an existing environment instance with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the environment instance.


Info
titleAPI URL

http://host:port/flexdeploy/rest/topology/environmentinstance/{environmentId}/{instanceId}

...

Tip
titleEnd Points and Resource Types

In PATCH, end points and resource types are added, not replaced


Parameters

Parameter

Type

Required

Description

environmentId

URLYesURL parameter for the environment Id which is used to find and return an environment instance
instanceIdURLYesURL parameter for the instance Id which is used to find and return an environment instance
environmentIdLongNoThe environment id of the environment instance. This parameter is ignored in PATCH.
instanceIdLongNoThe instance id of the environment instance. This parameter is ignore in PATCH.
isActiveBooleanNoWhether or not the environment instance is active
endPointsList<EndPoint>NoList of endpoint ids and their associated resource type ids
propertiesList<Property>NoList of property names and their values

Example

If we had an environment instance in our database with an environment id of 12347 and an instance id of 12342 with the following attributes,

...