Anchor

	Top
	Top

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.

...

Attributes	Type	Description
environmentId	Long	The environment id of the environment instance
instanceId	Long	The instance id of the environment instance
isActive	Boolean	Whether or not the environment instance is active
endPoints	List<EndPoint>	List of endpoint ids and their associated resource type ids
properties	List<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.

...

Example

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

{ "description": "This is Environment 1" "instances": [15100], "isActive": true, "environmentCode": "ENV1", "sortNumber": 1, "environmentId": 11101, "isBuildEnvironment": true, "environmentName": "Env 1"

Code Block

theme	Eclipse
title	Environment - 11101

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"
		}
	]
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/topology/environmentinstance/environment12347/1110112342

The GET request would return the following JSON environment instance object:

Code Block

theme	Eclipse
title	Environment GET Return JSONInstance: 12347, 12342

{
   "description": "This is Environment 1",
   "instances": [15100],
   "isActive": true,
   "environmentCode": "ENV1",
   "sortNumber": 1,
   "environmentId": 11101,
   "isBuildEnvironment": true,
   "environmentName": "Env 1"	"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"
		}
	]
}

Back to Top

...

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.

...

Eclipse

Info

title	API URL

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

Code Block

theme

title

Sample PUT JSON Request

{
   "description": "This is Put 1",
   "instances": [15100],
   "isActive": false,
   "environmentCode": "PUT1",
   "sortNumber": 6,
   "environmentId": 00000,
   "isBuildEnvironment": true,
   "environmentName": "Put 1"
}

Parameters

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
properties	List<Property>

No

Yes	List of property names and their values

Example

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

{ "description": "This is Environment 1" "instances": [15100], "isActive": true, "environmentCode": "ENV1", "sortNumber": 1, "environmentId": 11101, "isBuildEnvironment": true, "environmentName": "Env 1"

Code Block

theme	Eclipse
title	Environment PUT JSON

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"
		}
	]
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/topology/environmentenvironmentinstance/12347/1110112342

And the PUT request receives the following JSON environment instance object,

{ "description": "This is the updated Environment 1", "instances": [15101], "isActive": true, "environmentCode": "PUT2", "sortNumber": 2, "environmentId": 11101, "isBuildEnvironment": false, "environmentName": "PUT 2"

Code Block

theme	Eclipse
title	Environment PUT Receive JSON

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"
		}
	]
}

The PUT request would then update the environment instance with Id 11101 and return the the environment 12347 and the instance 12342. It will return the following JSON environment object:

Code Block

theme	Eclipse
title	Environment PUT Return JSONInstance: 12347, 12342

{
   "description": "This is the updated Environment 1",
   "instances": [15101],
   "isActive": true,
   "environmentCode": "PUT2",
   "sortNumber": 2,
   "environmentId": 11101,
   "isBuildEnvironment": false,
   "environmentName": "PUT 2"
}
	"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"
		}
	]
}

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. Note: end points and resource types will be added, not replaced.

Info

title	API URL

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

Tip

title	End Points and Resource Types

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

Parameters

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 PATCH.
instanceId	Long	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
properties	List<Property>	No	List of property names and their values

Example

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

Code Block

theme	Eclipse
title	Environment PATCH JSONInstance: 12347, 12342

{
   "description": "This is Environment 1",
   "instances": [15101],
   "isActive": true,
   "environmentCode": "ENV1",
   "sortNumber": 1,
   "environmentId": 11101,
   "isBuildEnvironment": false,
   "environmentName": "Env 1"
	"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"
		}
	]
}

When we run a PATCH request at the following URL

http://host:port/flexdeploy/rest/topology/environmentinstance/environment12347/1110112342

And the PATCH request receives the following JSON environment instance object,

Code Block

theme	Eclipse
title	Environment PATCH Receive JSONInstance: 12347, 12342

{
   	"descriptionendPoints":
"This is Patch with some null attributes",
   "instances	[
		{
			"endPointId": 10101,
			"resourceIds": [15102,15103]12123]
		},
   "isActive		{
			"endPointId": null12241,
   "environmentCode			"resourceIds": null,
   "sortNumber[18612]
		}
	],
	"properties":
7,
   "environmentId": null,
   "isBuildEnvironment": false,
   "environmentName	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": "Patchnew with some null"value"
		}
	]
}

The PATCH request would then update the environment instance with Id 11101 and return the the environment 12347 and the instance 12342. It will return the following JSON environment object:

{ "description": "This is Patch with some null attributes", "instances": [15102,15103], "isActive": true, "environmentCode": "ENV1", "sortNumber": 7, "environmentId": 11101, "isBuildEnvironment": false, "environmentName": "Patch with some null"

Code Block

theme	Eclipse
title	Environment PATCH Return JSON

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"
		}
	]
}

Back to Top

...

Versions Compared

Old Version 1

New Version 2

Key

GET

Example

PUT

Parameters

Example

PATCH

Parameters

Example

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

GET

Example

PUT

Parameters

Example

PATCH

Parameters

Example