Environment Instance API
- Cole Chronowski (Unlicensed)
- Keith Ecker (Unlicensed)
- Ben Hoffman
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.
Authentication - Use Basic Authentication for this API.
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.
API URL
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 |
Response
| 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<PropertyValue> | List of property names and their values |
Endpoint, relative to Environment Instance is defined as shown below.
| Attributes | Type | Description |
|---|---|---|
| endPointId | Long | Endpoint id mapped to environment instance. |
| resourceTypeIds | List<Long> | List of resource type id for endpoint mapping. |
Property value, relative to Environment Instance is defined as shown below.
| Attributes | Type | Description |
|---|---|---|
| propertyName | String | Property code |
| propertyValue | String | Property value |
| credentialId | Long | Id for the credential associated with property. Applicable only for encrypted properties |
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, we can run a GET request at the following URL: http://host:port/flexdeploy/rest/v1/topology/environmentinstance/12347/12342
The GET request would return the following JSON environment instance object:
{
"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
},
{
"propertyName": "FDSOA_REVISIONS_TO_KEEP",
"propertyValue": 15,
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_HOST",
"propertyValue": "dev-soa.company.local",
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_PORT",
"propertyValue": 8001,
"credentialId": null
},
{
"propertyName": "FD_ORACLE_SOA_HOME",
"propertyValue": "/u01/oracle/products/fmw/soa",
"credentialId": null
},
{
"propertyName": "MDS_PASS",
"propertyValue": "*****",
"credentialId": 74952
}
]
}
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.
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. 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. |
Response
| 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<PropertyValue> | List of property names and their values |
Endpoint, relative to Environment Instance is defined as shown below.
| Attributes | Type | Description |
|---|---|---|
| endPointId | Long | Endpoint id mapped to environment instance. |
| resourceTypeIds | List<Long> | List of resource type id for endpoint mapping. |
Property value, relative to Environment Instance is defined as shown below.
| Attributes | Type | Description |
|---|---|---|
| propertyName | String | Property code |
| propertyValue | String | Property value |
| credentialId | Long | Id for the credential associated with property. Applicable only for encrypted properties |
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,
{
"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
},
{
"propertyName": "FDSOA_REVISIONS_TO_KEEP",
"propertyValue": 15,
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_HOST",
"propertyValue": "dev-soa.company.local",
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_PORT",
"propertyValue": 8001,
"credentialId": null
},
{
"propertyName": "FD_ORACLE_SOA_HOME",
"propertyValue": "/u01/oracle/products/fmw/soa",
"credentialId": null
},
{
"propertyName": "MDS_PASS",
"propertyValue": "*****",
"credentialId": 74952
}
]
}
When we run a PUT request at the following URL: http://host:port/flexdeploy/rest/v1/topology/environmentinstance/12347/12342
And the PUT request receives the following JSON environment instance object,
{
"instanceId": 12342,
"endPoints":
[
{
"endPointId": 10101,
"resourceIds": [11223]
},
{
"endPointId": 10111,
"resourceIds": []
}
],
"environmentId": 12347,
"isActive": true,
"properties":
[
{
"propertyName": "FDSOA_EXT_CLASSPATH",
"propertyValue": "classpath",
"credentialId": null
},
{
"propertyName": "FDSOA_REVISIONS_TO_KEEP",
"propertyValue": 15,
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_HOST",
"propertyValue": "dev-soa.newcompany.local",
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_PORT",
"propertyValue": 8001,
"credentialId": null
},
{
"propertyName": "FD_ORACLE_SOA_HOME",
"propertyValue": "/u01/oracle/products/fmw/soa",
"credentialId": null
},
{
"propertyName": "MDS_PASS",
"propertyValue": "newPass",
"credentialId": null
}
]
}
The PUT request would then update the environment instance with the environment 12347 and the instance 12342. It will return the following JSON object:
{
"instanceId": 12342,
"endPoints":
[
{
"endPointId": 10101,
"resourceIds": [11223]
},
{
"endPointId": 10111,
"resourceIds": []
}
],
"environmentId": 12347,
"isActive": true,
"properties":
[
{
"propertyName": "FDSOA_EXT_CLASSPATH",
"propertyValue": "classpath",
"credentialId": null
},
{
"propertyName": "FDSOA_REVISIONS_TO_KEEP",
"propertyValue": 15,
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_HOST",
"propertyValue": "dev-soa.newcompany.local",
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_PORT",
"propertyValue": 8001,
"credentialId": null
},
{
"propertyName": "FD_ORACLE_SOA_HOME",
"propertyValue": "/u01/oracle/products/fmw/soa",
"credentialId": null
},
{
"propertyName": "MDS_PASS",
"propertyValue": "*****",
"credentialId": 74952
}
]
}
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.
API URL
http://host:port/flexdeploy/rest/v1/topology/environmentinstance/{environmentId}/{instanceId}
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 |
| 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. |
Response
| 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<PropertyValue> | List of property names and their values |
Endpoint, relative to Environment Instance is defined as shown below.
| Attributes | Type | Description |
|---|---|---|
| endPointId | Long | Endpoint id mapped to environment instance. |
| resourceTypeIds | List<Long> | List of resource type id for endpoint mapping. |
Property value, relative to Environment Instance is defined as shown below.
| Attributes | Type | Description |
|---|---|---|
| propertyName | String | Property code |
| propertyValue | String | Property value |
| credentialId | Long | Id for the credential associated with property. Applicable only for encrypted properties |
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,
{
"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
},
{
"propertyName": "FDSOA_REVISIONS_TO_KEEP",
"propertyValue": 15,
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_HOST",
"propertyValue": "dev-soa.company.local",
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_PORT",
"propertyValue": 8001,
"credentialId": null
},
{
"propertyName": "FD_ORACLE_SOA_HOME",
"propertyValue": "/u01/oracle/products/fmw/soa",
"credentialId": null
},
{
"propertyName": "MDS_PASS",
"propertyValue": "*****",
"credentialId": 74952
}
]
}
When we run a PATCH request at the following URL: http://host:port/flexdeploy/rest/v1/topology/environmentinstance/12347/12342
And the PATCH request receives the following JSON environment instance object,
{
"endPoints":
[
{
"endPointId": 10101,
"resourceIds": [12123]
},
{
"endPointId": 12241,
"resourceIds": [18612]
}
],
"properties":
[
{
"propertyName": "FDSOA_EXT_CLASSPATH",
"propertyValue": "new value",
"credentialId": null
},
{
"propertyName": "MDS_PASS",
"propertyValue": "",
"credentialId": 52268
}
]
}
The PATCH request would then update the environment instance with the environment 12347 and the instance 12342. It will return the following JSON object:
{
"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",
"credentialId": null
},
{
"propertyName": "FDSOA_REVISIONS_TO_KEEP",
"propertyValue": 15,
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_HOST",
"propertyValue": "dev-soa.company.local",
"credentialId": null
},
{
"propertyName": "FDSOA_SERVER_PORT",
"propertyValue": 8001,
"credentialId": null
},
{
"propertyName": "FD_ORACLE_SOA_HOME",
"propertyValue": "/u01/oracle/products/fmw/soa",
"credentialId": null
},
{
"propertyName": "MDS_PASS",
"propertyValue": "*****",
"credentialId": 52268
}
]
}
- style