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.
...
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 | ||||
|---|---|---|---|---|
|
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 |
...
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. 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, their values, and credential id for encrypted properties. If environment instance property does not have value in input list, then that property value will be cleared. PropertyValue contains propertyName, propertyValue, and credentialId. |
| Include Page | ||||
|---|---|---|---|---|
|
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 |
...
| 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,
"credentialId": null,
"isExpression": false
},
{
"propertyName": "FDSOA_REVISIONS_TO_KEEP",
"propertyValue": 15,
"credentialId": null,
"isExpression": false
},
{
"propertyName": "FDSOA_SERVER_HOST",
"propertyValue": "dev-soa.company.local",
"credentialId": null,
"isExpression": false
},
{
"propertyName": "FDSOA_SERVER_PORT",
"propertyValue": 8001,
"credentialId": null,
"isExpression": false
},
{
"propertyName": "FD_ORACLE_SOA_HOME",
"propertyValue": "/u01/oracle/products/fmw/soa",
"credentialId": null,
"isExpression": false
},
{
"propertyName": "MDS_PASS",
"propertyValue": "*****",
"credentialId": 74952,
"isExpression": false
}
]
} |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"instanceId": 12342,
"endPoints":
[
{
"endPointId": 10101,
"resourceIds": [11223]
},
{
"endPointId": 10111,
"resourceIds": []
}
],
"environmentId": 12347,
"isActive": true,
"properties":
[
{
"propertyName": "FDSOA_EXT_CLASSPATH",
"propertyValue": "classpath",
"credentialId": null,
"isExpression": false
},
{
"propertyName": "FDSOA_REVISIONS_TO_KEEP",
"propertyValue": 15,
"credentialId": null,
"isExpression": false
},
{
"propertyName": "FDSOA_SERVER_HOST",
"propertyValue": "dev-soa.newcompany.local",
"credentialId": null,
"isExpression": false
},
{
"propertyName": "FDSOA_SERVER_PORT",
"propertyValue": 8001,
"credentialId": null,
"isExpression": false
},
{
"propertyName": "FD_ORACLE_SOA_HOME",
"propertyValue": "/u01/oracle/products/fmw/soa",
"credentialId": null,
"isExpression": false
},
{
"propertyName": "MDS_PASS",
"propertyValue": "*****",
"credentialId": 74952,
"isExpression": false
}
]
} |
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/v1/topology/environmentinstance/{environmentId}/{instanceId} |
...
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. 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, their values, and credential id for encrypted properties. Only values provided in input are updated, other values will not change. PropertyValue contains propertyName, propertyValue, and credentialId. |
| Include Page | ||||
|---|---|---|---|---|
|
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 |
...