Environment API
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.
Authentication - Use Basic Authentication for this API.
GET
There are two implementations of GET. One will find an environment with the given Id and return the JSON representation of the environment. The other will find a list of environments matching the parameters supplied to it.
GET by ID
This GET service will find an environment with the given Id and return the JSON representation of the object.
API URL
http://host:port/flexdeploy/rest/v1/topology/environment/{Id}
Request
Parameter | Type | Required | Description |
|---|---|---|---|
Id | URL | Yes | This is a URL parameter for the Id which is used to find and return an environment |
Response
| Attributes | Type | Description |
|---|---|---|
| description | String | This is a description of the environment |
| instances | List<Long> | This is a list of the Instance Ids associated with the environment |
| isActive | Boolean | This is a boolean that tracks whether or not the environment is active |
| environmentCode | String | This is the unique code of the environment |
| sortNumber | Integer | This is a number associated with the environment that sets the environments priority in a list of other environments |
| environmentId | Long | This is the unique Id of the environment |
| isBuildEnvironment | Boolean | This is a boolean that tracks whether or not the environment is a build environment |
| environmentName | String | This is the unique name of the environment |
Response Codes
HTTP Code | Description |
|---|---|
200 | Environment was found and returned |
400 | Bad request |
401 | Unauthorized |
500 | Unexpected internal server error |
Example
If we had an environment in our database with an Id of 11101 and had the following attributes
Environment - 11101
{
"description": "This is Environment 1"
"instances": [15100],
"isActive": true,
"environmentCode": "ENV1",
"sortNumber": 1,
"environmentId": 11101,
"isBuildEnvironment": true,
"environmentName": "Env 1"
}When we run a GET request at the following URL
http://host:port/flexdeploy/rest/v1/topology/environment/11101
The GET request would return the following JSON environment object
Environment GET Return JSON
{
"description": "This is Environment 1",
"instances": [15100],
"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.
API URLs
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}
The query parameters are not case sensitive. Searching by environmentName=NAME is the same as searching by environmentName=name.
Request
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
| Attributes | Type | Description |
|---|---|---|
| description | String | This is a description of the environment |
| instances | List<Long> | This is a list of the Instance Ids associated with the environment |
| isActive | Boolean | This is a boolean that tracks whether or not the environment is active |
| environmentCode | String | This is the unique code of the environment |
| sortNumber | Integer | This is a number associated with the environment that sets the environments priority in a list of other environments |
| environmentId | Long | This is the unique Id of the environment |
| isBuildEnvironment | Boolean | This is a boolean that tracks whether or not the environment is a build environment |
| environmentName | String | This is the unique name of the environment |
Response Codes
HTTP Code | Description |
|---|---|
200 | Environments were found and returned |
400 | Bad request |
401 | Unauthorized |
500 | Unexpected internal server error |
- style