Combo Groups API
TrueSight Network Automation REST API – ComboGroupService
The base URL for the API is:
combo_groups
{{status colour="Blue" title="GET"/}}
/v3.0/combo_groups
Click here to expand...
Description
Retrieves combo groups, matching any filter criteria; may filter by filterable combo group dynamic fields by including query parameters in the form 'filter.dynamicFieldName=value'
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
query | Filter for combo groups matching this name, asterisk wildcards allowed | string | ||
filter.realm | query | Filter for combo groups that belong to this realm | string | |
orderBy | query | Sort by the specified attribute (name, realm, or a listable combo group dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending) | "+name" | string |
offset | query | Return the specified page number | 1 | integer |
limit | query | Define the number of rows in a page or the maximum number of combo groups to return | 25 | integer |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | [ |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access combo groups | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Green" title="POST"/}}
/v3.0/combo_groups
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
body | body | Complete attributes of the new combo group | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
201 | Created: New combo group successfully added | |
400 | Bad request: Input combo group DTO is missing or new combo group is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to add a new combo group | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Yellow" title="PUT"/}}
/v3.0/combo_groups/{id}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
id | path | Database key of the combo group to be modified | string * | |
body | body | Complete new attribute values for the combo group; anything left out will be considered to be null and will be nulled out in the combo group; any required dynamic fields missing or null in the input will revert to default values; to change the realm a combo group belongs to, must first remove all groups from the combo group or specify new groups in the new realm | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
400 | Bad request: Input combo group DTO is missing, modified combo group is invalid, or a change of realm is not allowed | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the combo group | |
404 | Not found: No single matching accessible combo group found | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Red" title="DELETE"/}}
/v3.0/combo_groups/{id}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
id | path | Database key of the combo group to be deleted | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | string |
400 | Bad request: combo group is currently in use | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to delete the combo group | |
404 | Not found: No single matching accessible combo group found | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Yellow" title="PATCH"/}}
/v3.0/combo_groups/{id}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
id | path | Database key of the combo group to be modified | string * | |
body | body | New attribute values for the combo group, in JSON Patch format | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
400 | Bad request: Input JSON patch information is missing, modified combo group is invalid, or a realm change is not allowed | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the combo group | |
404 | Not found: No single matching accessible combo group found | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Blue" title="GET"/}}
/v3.0/combo_groups/{id}/devices
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
id | path | Database key of the combo group of interest | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access combo groups | |
404 | Not found: No single matching accessible combo group found | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Blue" title="GET"/}}
/v3.0/combo_groups/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the combo group of interest; a name must be unique across all realms for a combo group to be returned | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access combo groups | |
404 | Not found: No single matching accessible combo group found | |
500 | Internal server error: Unexpected exception occurred |
Object Definitions
Object | Schema |
|---|---|
AbbreviatedDeviceDTO | Click here to expand...{ |
BooleanExpressionDTO | Click here to expand...{ |
ComboGroupDTO | Click here to expand...{ |
ComponentId | Click here to expand...{ |
DynamicFieldValueDTO | Click here to expand...{ |
JsonPatch | Click here to expand...[ |
JsonPatch.OneOperation | Click here to expand... |
JsonPatch.Pointer | Click here to expand...string |
JsonPatch.Add | Click here to expand...{ |
JsonPatch.Remove | Click here to expand...{ |
JsonPatch.Replace | Click here to expand...{ |
JsonPatch.Move | Click here to expand...{ |
JsonPatch.Copy | Click here to expand...{ |
JsonPatch.Test | Click here to expand...{ |
TermDTO | Click here to expand...{ |