...

Environment Instances can be accessed and modified through this API using three services: GET, PUT, and PATCH. These three services allow for the retrieval, complete update, and partial update of environment instances.

...

Include Page

...

title	Base URL for Environment Instance REST API

...

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

	REST V1 Authentication
	REST V1 Authentication

Table of Contents

maxLevel	2

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

...

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

...

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

title	API URL

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

Parameters

...

Parameter

...

Type

...

Required

...

Description

...

environmentId

...

title	API URL

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

Request

Parameter	Type	Required	Description
environmentId	URL	Yes	URL parameter for the environment Id which is used to find and return an environment instance
instanceId	URL	Yes	URL parameter for the instance Id which is used to find and return an environment instance

Include Page

	REST V1 Environment Instance Response
	REST V1 Environment Instance Response

Response Codes

HTTP Code	Description
200	Environment Instance was found and returned
401	Authentication failure
403	Authorization failure (no access to resource)
404	Environment Instance not found
500	Unexpected internal server error

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,

...

http://host:port/flexdeploy/rest/v1/topology/environmentinstance/12347/12342

...

Code Block

theme	Eclipse
title	Environment Instance: 12347, 12342

{
	"instanceId": 12342,
	"endPoints":
	[
		{
			"endPointId": 10101,
			"resourceIds": [11223,11224]
		},
		{
			"endPointId": 10111,
			"resourceIds": [11223]
		}
	],
	"environmentId": 12347,
	"isActive": true
	"properties":
	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": null
		},
		{
			"propertyName": "FDSOA_REVISIONS_TO_KEEP",
			"propertyValue": "15"
		},
		{
			"propertyName": "FDSOA_SERVER_HOST",
			"propertyValue": "dev-soa.company.local"
		},
		{
			"propertyName": "FDSOA_SERVER_PORT",
			"propertyValue": "8001"
		},
		{
			"propertyName": "FD_ORACLE_SOA_HOME",
			"propertyValue": "/u01/oracle/products/fmw/soa"
		}
	]
}

...

PUT

This PUT service will replace all attributes of an environment instance with the given environment instance corresponding to the environment id and instance id provided in the url.

Info

title	API URL

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

...

Request

Parameter	Type	Required	Description
environmentId	URL	Yes	URL parameter for the environment Id which is used to find and return an environment instance
instanceId	URL	Yes	URL parameter for the instance Id which is used to find and return an environment instance
environmentId	Long	No	The environment id of the environment instance. This parameter is ignored in PUT.
instanceId	Long	No	The instance id of the environment instance. This parameter is ignore in PUT.
isActive	Boolean	No	Whether or not the environment instance is active. Defaults to true if not passed in.
endPoints	List<EndPoint>	No	List of endpoint ids and their associated resource type ids

propertiesList<Property>YesList of property names and their values

. If currently associated Endpoint(s) are not in input list, then those Endpoint(s) will be unassigned from environment instance along with any resource types.

i.e. at the end of successful request, environment instance will have mapped Endpoint(s) matching to input request.

EndPoint contains endpointId and array of resourceIds.

properties

List<PropertyValue>

Yes

List of property names and their values. If environment instance property does not have value in input list, then that property value will be cleared.

PropertyValue contains propertyName and propertyValue.

Include Page

	REST V1 Environment Instance Response
	REST V1 Environment Instance Response

Response Codes

HTTP Code	Description
200	Environment Instance was found and updated
401	Authentication failure
403	Authorization failure (no access to resource)
404	Environment Instance not found
500	Unexpected internal server error

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,

...

http://host:port/flexdeploy/rest/v1/topology/environmentinstance/12347/12342

...

Code Block

theme	Eclipse
title	Environment Instance: 12347, 12342

{
	"instanceId": 12342,
	"endPoints":
	[
		{
			"endPointId": 10101,
			"resourceIds": [11223]
		},
		{
			"endPointId": 10111,
			"resourceIds": []
		}
	],
	"environmentId": 12347,
	"isActive": true
	"properties":
	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": "classpath"
		},
		{
			"propertyName": "FDSOA_REVISIONS_TO_KEEP",
			"propertyValue": "15"
		},
		{
			"propertyName": "FDSOA_SERVER_HOST",
			"propertyValue": "dev-soa.newcompany.local"
		},
		{
			"propertyName": "FDSOA_SERVER_PORT",
			"propertyValue": "8001"
		},
		{
			"propertyName": "FD_ORACLE_SOA_HOME",
			"propertyValue": "/u01/oracle/products/fmw/soa"
		}
	]
}

...

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

title	API URL

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

...

Tip

title	End Points and Resource Types

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

...

Request

Parameter	Type	Required	Description
environmentId	URL	Yes	URL parameter for the environment Id which is used to find and return

an environment instance

an environment instance
instanceId	URL	Yes	URL parameter for the instance Id which is used to find and return an environment instance
environmentId	Long	No	The environment id of the environment instance. This parameter is ignored in PATCH.
instanceId

URL

Long

YesURL parameter for the instance Id which is used to find and return an environment instanceenvironmentIdLongNoThe 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 activeendPointsList<EndPoint>NoList of endpoint ids and their associated resource type idspropertiesList<Property>NoList of property names and their values

No	The instance id of the environment instance. This parameter is ignore in PATCH.
isActive	Boolean	No	Whether or not the environment instance is active
endPoints	List<EndPoint>	No	List of endpoint ids and their associated resource type ids. If provided endpoint is not associated with environment instance, then it will be mapped. Similarly resource types are associated if not already associated to specific endpoint. If already mapped endpoint is not in input list then it will not be removed. EndPoint contains endpointId and array of resourceIds.
properties	List<Property>	No	List of property names and their values. Only values provided in input are updated, other values will not change. PropertyValue contains propertyName and propertyValue.

Include Page

	REST V1 Environment Instance Response
	REST V1 Environment Instance Response

Response Codes

HTTP Code	Description
200	Environment Instance was found and patched
401	Authentication failure
403	Authorization failure (no access to resource)
404	Environment Instance not found
500	Unexpected internal server error

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,

...

http://host:port/flexdeploy/rest/v1/topology/environmentinstance/12347/12342

...

Code Block

theme	Eclipse
title	Environment Instance: 12347, 12342

{
	"instanceId": 12342,
	"endPoints":
	[
		{
			"endPointId": 10101,
			"resourceIds": [11223,11224,12123]
		},
		{
			"endPointId": 10111,
			"resourceIds": [11223]
		},
		{
			"endPointId": 12241,
			"resourceIds": [18612]
		}
	],
	"environmentId": 12347,
	"isActive": true
	"properties":
	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": "new value"
		},
		{
			"propertyName": "FDSOA_REVISIONS_TO_KEEP",
			"propertyValue": "15"
		},
		{
			"propertyName": "FDSOA_SERVER_HOST",
			"propertyValue": "dev-soa.company.local"
		},
		{
			"propertyName": "FDSOA_SERVER_PORT",
			"propertyValue": "8001"
		},
		{
			"propertyName": "FD_ORACLE_SOA_HOME",
			"propertyValue": "/u01/oracle/products/fmw/soa"
		}
	]
}

...

Versions Compared

Old Version 7

New Version Current

Key

GET

GET

Parameters

Request

Response Codes

Example

PUT

Request

Response Codes

Example

PATCH

Request

Response Codes

Example

Page Comparison

Versions Compared

Old Version 7

New Version Current

Key

GET

GET

Parameters

Request

Response Codes

Example

PUT

Request

Response Codes

Example

PATCH

Request

Response Codes

Example