Instances 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 Instances.
...
Request
Parameter | Required | Type | Description |
|---|---|---|---|
| Id | Yes | URL | URL parameter for the Id which is used to find and return an instance |
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Instance was found and returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Instance not found |
| 500 | Unexpected internal server error |
Example
If we had an Instance in our database with an Id of 11004 with the following attributes
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "GET example description",
"environments": [11001],
"workflows": [],
"instanceId": 11004,
"instanceName": "GET Example Name",
"isActive": true, "pluginOperations": [],
"instanceCode": "GETEXAMPLECODE",
"groupCode": "GET example group",
"subGroupCode": "GET example sub group",
"isDeploymentTarget": false
} |
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/v1/topology/instance/11004
The GET request would return the following JSON Instance object
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "GET example description",
"environments": [11001],
"workflows": [],
"instanceId": 11004,
"instanceName": "GET Example Name",
"isActive": true, "pluginOperations": [],
"instanceCode": "GETEXAMPLECODE",
"groupCode": "GET example group",
"subGroupCode": "GET example sub group",
"isDeploymentTarget": false
} |
GET by Query Parameters
This GET service will return a list of Instances in the form of JSON objects based on the query parameters instanceCode, instanceName, groupCode, and subGroupCode. Instances 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 Instances. The instanceName parameter returns instances that contain the specified parameter. The other parameters must be equal to the instance.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/topology/instance? Append the following character sequences to the above URL to specify Query parameters.Use '&' between successive query parameters:instanceCode={instanceCode} instanceName={instanceName} groupCode={groupCode} subGroupCode={subGroupCode} Examples:To Specify the code parameter only:http://host:port/flexdeploy/rest/v1/topology/instance?instanceCode={instanceCode} To Specify the code and group code parameters:http://host:port/flexdeploy/rest/v1/topology/instance?instanceCode={instanceCode}&groupCode={groupCode} To Specify the name, group code, and sub group code parameters:http://host:port/flexdeploy/rest/v1/topology/instance?instanceName={instanceName}&groupCode={groupCode}&subGroupCode={subGroupCode} |
...
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Instances were found Search successful and results returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
...
Attributes | Type | Required | Description |
|---|---|---|---|
| Id | URL | Yes | URL parameter for the Id which is used to find and update an instance |
| description | String | No | Description of the Instance |
| environments | List<Long> | No | List of the environment ids that will be added to the instance. If input environment(s) is not already associated it will be associated to instance but existing environment assignment that are not in PATCH request will not be unassigned. i.e. input list is considered as append to existing assignments. |
| workflows | List<Long> | No | List of the workflow ids that will be added to the instance. If input workflow(s) is not already associated it will be associated to instance but existing workflow assignment that are not in PATCH request will not be unassigned. i.e. input list is considered as append to existing assignments. |
| instanceId | String | No | The instance Id in the request is ignored |
| instanceName | String | No | Name of the instance |
| isActive | Boolean | No | Whether or not this instance is active. |
| plugins | List<Plugin> | No | List of the plugins that will be added to the instance. If input plugin(s) is not already associated it will be associated to instance but existing plugin assignment that are not in PATCH request will not be unassigned. i.e. input list is considered as append to existing assignments. |
| instanceCode | String | No | The code of the Instance |
| groupCode | String | No | The group code of the instance |
| subGroupCode | String | No | The sub group code of the instance |
| isDeploymentTarget | Boolean | No | Whether or not this instance is a deployment target. |
...