| Anchor | ||||
|---|---|---|---|---|
|
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 |
...
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 | ||
|---|---|---|
| ||
| http://host:port/flexdeploy/rest/topology/environmentinstance/{environmentId}/{instanceId} |
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 |
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,
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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 | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/topology/environmentinstance/{environmentId}/{instanceId} |
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> | Yes | List 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,
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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 | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/topology/environmentinstance/{environmentId}/{instanceId} |
...
| Tip | ||
|---|---|---|
| ||
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 environment id of 12347 and an instance id of 12342 with the following attributes,
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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"
}
]
} |
...