| Anchor | ||||
|---|---|---|---|---|
|
...
GET (Using Query Parameters)
This GET service will return a list of Endpoints in the form of JSON objects based on the query parameters name, address, group and subgroup. Endpoints are only returned if they match ALL of the specified query parameters. If no query parameters are given this request will return the entire list of Endpoints.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/topology/endpoint? Append the following character sequences to the above URL to specify Query parameters.Use '&' between successive query parameters:nameendpointName={name} addressendpointAddress={address} groupendpointGroup={group} subgroupendpointSubgroup={subgroup} Examples:To Specify the name parameter only:http://host:port/flexdeploy/rest/topology/endpoint?nameendpointName={name} To Specify the name and group parameters:http://host:port/flexdeploy/rest/topology/endpoint?nameendpointName={name}&groupendpointGroup={group} To Specify the name, address and group parameters:http://host:port/flexdeploy/rest/topology/endpoint?nameendpointName={name}&addressendpointAddress={address}&groupendpointGroup={group} |
| Tip |
|---|
The query parameters are not case sensitive. Searching by name=NAME is the same as searching by name=name. |
...
Parameter | Required | Type | Description |
|---|---|---|---|
| nameendpointName | No | URL | This is a URL query parameter for the name which is used to search the endpoints. |
| addressendpointAddress | No | URL | This is a URL query parameter for the address which is used to search the endpoints. |
| groupendpointGroup | No | URL | This is a URL query parameter for the group which is used to search the endpoints. |
| subgroupendpointSubgroup | No | URL | This is a URL query parameter for the sub group which is used to search the endpoints. |
Response Codes
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Motel6",
"endpointAddress": "localhost",
"endpointId": 14517,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Munich"
"runAsUserName": null
} |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Raddison Hotel",
"endpointAddress": "localhost",
"endpointId": 14518,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Berlin",
"runAsUserName": null
} |
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/topology/endpoint?groupendpointGroup=Germany
The GET request would return the following JSON environment object
| Code Block | ||
|---|---|---|
| ||
[
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Motel6",
"endpointAddress": "localhost",
"endpointId": 14517,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Munich"
"runAsUserName": null
},
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Raddison Hotel",
"endpointAddress": "localhost",
"endpointId": 14518,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Berlin",
"runAsUserName": null
}
] |
...
PATCH
This PATCH service will update an existing endpoint with the information passed through a JSON object. If an attribute is absent of it's its value is null it will not be updated in the Endpoint.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/topology/endpoint/{Id} |
...