Target Groups 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 Target Groups.
Authentication - Use Basic Authentication for this API.
| Table of Contents | ||
|---|---|---|
|
...
There are two implementations of GET. One will find a Target Group with the given Id and return the JSON representation of the Target Group. The other will find a list of Target Groups matching the parameters supplied to it.
GET by ID
This GET service will find a Target Group with the given Id and return the JSON representation of the object.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v2/topology/targetgroup/{Id} |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "PATCH example description",
"targets": null,
"workflowPropertySets": null,
"targetGroupId": null,
"targetGroupName": null,
"isActive": null,
"pluginOperationPropertySets": null,
"targetGroupCode": "PATCHEXAMPLECODE",
"groupCode": null,
"subGroupCode":
null,
"isDeploymentTarget": null
} |
The PATCH request would then update the Target Group with Id 11104 and return the following JSON Target Group object.
| Info |
|---|
Only the fields present in the PATCH JSON will modify the original JSON Target Group object. All other fields will remain unchanged. |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "PATCH example description",
"targets": [],
"workflowPropertySets": [],
"targetGroupId": 11104,
"targetGroupName": "Example Name",
"isActive": false,
"pluginOperationPropertySets": [],
"targetGroupCode": "PATCHEXAMPLECODE",
"groupCode": "Group",
"subGroupCode": "Sub Group",
"isDeploymentTarget": false
} |
...