...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Environments can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow for the retrieval, creation, complete update, and partial update of environments.
...
| title | Base URL for Environment REST API |
|---|
...
| Table of Contents | ||
|---|---|---|
|
...
GET (Using Query Parameters)
This GET service will return a list of environments in the form of JSON objects based on the query parameters code and name. Environments are only returned if they match all of the specified query parameters. The name query parameter searches if any environment contains the value given in there name while all other query parameters check if any environment has attributes that are equal to the parameter value. If no query parameters are given this request will return the entire list of environments.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/topology/environment? Append the following character sequences to the above URL to specify Query parameters.Use '&' between successive query parameters:environmentCode={code} environmentName={name} Examples:To search by code only:http://host:port/flexdeploy/rest/v1/topology/environment?environmentCode={code} To search by name only:http://host:port/flexdeploy/rest/v1/topology/environment?environmentName={name} To search by code and name:http://host:port/flexdeploy/rest/v1/topology/environment?environmentCode={code}&environmentName={name} |
...
| Tip |
|---|
The query parameters are not case sensitive. Searching by environmentName=NAME is the same as searching by environmentName=name. |
Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
environmentCode | URL | No | This is a URL query parameter for the code which is used to search the environments. |
| environmentName | URL | No | This is a URL query parameter for the name which is used to search the environments. The environment name parameter checks if any environment name contains the value given. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Environments were found and returned |
| 400 | Bad request |
| 401 | Unauthorized |
| 500 | Unexpected internal server error |
...
PATCH
This PATCH service will update an existing environment with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the environment.
| Info | ||
|---|---|---|
| ||
By having an instance in the JSON request the instance will be added and no instances will be unassigned. |
...
Parameters
Parameters | Type | Required | Description |
|---|---|---|---|
| Id | URL | Yes | This is a URL parameter for the Id which is used to find and return an environment with. |
| description | String | No | This is the description that the environment's description will be updated to. |
| instances | List<Long> | No | This is the list of instance Ids that will be assigned to the environment that is being updated. |
| isActive | Boolean | No | This is the isActive boolean that the environment's isActive boolean will be updated to. |
| environmentCode | String | No | This is the code that the environment's code will be update to. |
| sortNumber | Integer | No | This is the sort number that the environment's sort number will be updated to. |
| environmentId | Long | No | This is the Id place holder. It will not change the environment's Id that is being updated. |
| isBuildEnvironment | Boolean | No | This is the isActive boolean that the environment's isActive boolean will be updated to. |
| environmentName | String | No | This is the name that the environment's name will be updated to. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Environment was found and patched |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Environment not found |
| 500 | Unexpected internal server error |
Example
If we had an environment in our database with an Id of 11101 and had the following attributes
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "This is Environment 1",
"instances": [15101],
"isActive": true,
"environmentCode": "ENV1",
"sortNumber": 1,
"environmentId": 11101,
"isBuildEnvironment": false,
"environmentName": "Env 1"
} |
When we run a PATCH request at the following URL
http://host:port/flexdeploy/rest/v1/topology/environment/11101
And the PATCH request receives the following JSON environment object,
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "This is Patch with some null attributes",
"instances": [15101,15102,15103],
"isActive": null,
"environmentCode": null,
"sortNumber": 7,
"environmentId": null,
"isBuildEnvironment": false,
"environmentName": "Patch with some null"
} |
The PATCH request would then update the environment with Id 11101 and return the following JSON environment object
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "This is Patch with some null attributes",
"instances": [15101,15102,15103],
"isActive": true,
"environmentCode": "ENV1",
"sortNumber": 7,
"environmentId": 11101,
"isBuildEnvironment": false,
"environmentName": "Patch with some null"
} |
...