Environments can be accessed and modified 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.
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 | ||
|---|---|---|
| ||
In version 2 of this API, targetGroups are the same as what instances were in version 1. |
| Include Page | ||||
|---|---|---|---|---|
|
...
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"
"targets": [],
"isActive": true,
"environmentCode": "ENV1",
"sortNumber": 1,
"environmentId": 11101,
"isBuildEnvironment": true,
"environmentName": "Env 1"
} |
http://host:port/flexdeploy/rest/v2/topology/environment/11101
The GET request would return the following JSON environment object
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "This is Environment 1",
"targets": [],
"isActive": true,
"environmentCode": "ENV1",
"sortNumber": 1,
"environmentId": 11101,
"isBuildEnvironment": true,
"environmentName": "Env 1"
} |
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/v2/topology/environment? Append the following character sequences to the above URL to specify Query parameters.Use '&' between successive query parameters:environmentId={id} environmentCode={code} environmentName={name} isActive={boolean} isBuildEnvironment={boolean} sortNumber={number} Examples:To search by code only:http://host:port/flexdeploy/rest/v2/topology/environment?environmentCode={code} To search by name only:http://host:port/flexdeploy/rest/v2/topology/environment?environmentName={name} To search by code and name: |
...
| Tip |
|---|
The query parameters are not case sensitive. Searching by environmentName=NAME is the same as searching by environmentName=name. |
Request
Parameter | Type | Required | Description |
|---|---|---|---|
| environmentId | Query - Long | No | This is a URL query parameter for id which is used to search the environments. Equals search |
environmentCode | Query - String | No | This is a URL query parameter for the code which is used to search the environments. Equals ignore case search |
| environmentName | Query - String | 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. Contains ignore case search |
| isActive | Query - Boolean | No | This is a URL query parameter for is active which is used to search the environments. Equals search |
| isBuildEnvironment | Query - Boolean | No | This is a URL query parameter for is build environment which is used to search the environments. Equals search |
| sortNumber | Query - Integer | No | This is a URL query parameter for the sort number which is used to search the environments. Equals search |
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Search successful and results returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
Example
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "This is the updated Environment 1",
"targets":
[
{
"targetGroupId": 15101,
"isActive": true,
"targetId": 10002,
"environmentId": 11101,
}
],
"isActive": true,
"environmentCode": "PUT2",
"sortNumber": 2,
"environmentId": 11101,
"isBuildEnvironment": false,
"environmentName": "PUT 2"
} |
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 a target in the JSON request the target will be added and no targetGroups will be unassigned. |
...
Request
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. |
| targets | List<Target> | No | This is the list of targetGroups that will be assigned to the environment that is being updated. If input targetGroup(s) is not already assigned it will be assigned to environment but existing targetGroups assignment that are not in PATCH request will not be unassigned. If a targetGroup is not found, it will be considered a bad request. i.e. input list is considered as append to existing assignments. |
| 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. |
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Environment was found and patched |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 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",
"targets":
[
{
"targetGroupId": 15100,
"isActive": true,
"targetId": 10001,
"environmentId": 11101,
}
],
"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/v2/topology/environment/11101
And the PATCH request receives the following JSON environment object,
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "This is Patch with some null attributes",
"targets":
[
{
"targetGroupId": 15101
},
{
"targetGroupId": 15102
}
],
"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",
"targets":
[
{
"targetGroupId": 15100,
"isActive": true,
"targetId": 10001,
"environmentId": 11101,
},
{
"targetGroupId": 15101,
"isActive": true,
"targetId": 10002,
"environmentId": 11101,
},
{
"targetGroupId": 15102,
"isActive": true,
"targetId": 10003,
"environmentId": 11101,
}
],
"isActive": true,
"environmentCode": "ENV1",
"sortNumber": 7,
"environmentId": 11101,
"isBuildEnvironment": false,
"environmentName": "Patch with some null"
} |