Information
Space banner This version of the product is in limited support. However, the documentation is available for your convenience. You will not be able to leave comments.

Combo Groups API


TrueSight Network Automation REST API – ComboGroupService
The base URL for the API is:

https://serverName:portNumber/bca-networks/api

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
Enum: [
  "+name",
  "-name",
  "+realm",
  "-realm"
]

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

[
   #ComboGroupDTO
]

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...


{
    id: string
    The device's unique database key
 
    name: string
    The device's unique display name
 
    deviceDetailsLink: string
    Link to get complete details about this device
 
    realmId: string
    The database key of the realm this device belongs to
 
    realmName: string
    The name of the realm this device belongs to
 
    modelName: string
    The discovered model
 
    osImageName: string
    The discovered operating system version
 
    deviceTypeGuid: string
    The GUID of the device type
 
    deviceTypeName: string
    The name of the device type
 
    vendorGuid: string
    The GUID of the vendor
 
    vendorName: string
    The name of the vendor
 
    categoryId: integer
    The category
 
    categoryName: string
    The meaning of the numeric categoryId
 
    onlineFlag: boolean
    Whether or not this device is online
 
    discrepanciesFlag: boolean
    Whether or not this device has discrepancies
 
    violationsFlag: boolean
    Whether or not this device has compliance violations
 
    primaryInterfaceAddress: string
    The primary interface IP address, host name, or URL
 
    primaryInterfaceDeviceAgentId: string
    The database key of the primary interface device agent
 
    primaryInterfaceDeviceAgentName: string
    The name of the primary interface device agent
 
    primaryInterfaceDeviceAgentNIC: string
    The name of the primary interface device agent NIC
 
    primaryInterfaceAccessModeId: integer
    The primary interface access mode
 
    primaryInterfaceAccessModeName: string
    The meaning of the numeric primaryInterfaceAccessModeId
 
    primaryInterfaceTransferModeId: integer
    The primary interface transfer mode
 
    primaryInterfaceTransferModeName: string
    The meaning of the numeric primaryInterfaceTransferModeId
 
    primaryInterfaceDeviceSecurityProfileId: string
    The database key of the primary interface device security profile
 
    primaryInterfaceDeviceSecurityProfileName: string
    The name of the primary interface device security profile
 
    dynamicFields: [
      The dynamic fields
 
       #DynamicFieldValueDTO
    ]
}

BooleanExpressionDTO


Click here to expand...


{
    leftParenFlag: boolean
    Whether or not this expression begins with a left parenthesis
 
    rightParenFlag: boolean
    Whether or not this expression ends with a right parenthesis
 
    booleanExpressionOperatorId: integer*
    How the left and right terms are joined together; when there is only a single term, this should be no operator; when there are two terms, this should be either the AND or the OR operator
 
    left: #TermDTO
   The term or operand to the left of the operator
 
    right: #TermDTO
   The term or operand to the right of the operator
}

ComboGroupDTO


Click here to expand...


{
    id: string
    The combo group's unique database key (read-only)
 
    name: string*
    The combo group's display name
 
    realmId: #ComponentId *
    Identifies the realm this combo group belongs to
 
    realmDetailsLink: string
    Link to get complete details about the parent realm (read-only)
 
    groups: #BooleanExpressionDTO
   How groups are combined to form this combo group; during create or update, must specify either groups or groupsExpression; if both are input, this groups takes precedence and groupsExpression is ignored
 
    groupsExpression: string
    A readable text representation of how groups are combined to form this combo group; the groups field takes precedence over this field if both are input during create or update requests; group names are NOT realm-qualified; group names are enclosed in quotes, to ensure spaces, parentheses, and quotes in the name are not mis-parsed; the string \x022 represents double quotes inside a group name
 
    dynamicFields: [
      The dynamic fields
 
       #DynamicFieldValueDTO
    ]
 
    memberDevicesLink: string
    Link to get a list of the member devices (read-only)
}

ComponentId


Click here to expand...


{
    id: string
    The database key of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; when this database key is present, it takes precedence and componentName and qualifiers(when present) are used to verify the retrieved component
 
    componentName: string
    The name of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; this name is used to verify any component retrieved by database key, and is used if there is no database key or if the database key fails to resolve; for componentType Configuration, componentName is the created timestamp (in milliseconds); for componentType SecurityVulnerability, componentName is the securityVulnerabilityID; for componentType SnmpManagerStation, componentName is the address
 
    componentType: string*
    The type of the component, used to verify what is retrieved by key/name; valid values are: Combogroup, Condition, Configuration, Device, DynamicField, EmailDistributionList, Group, Keyword, Model, OsImage, Realm, Role, Rule, RuleSet, SecurityVulnerability, SnmpManagerStation, Template, and User
 
    qualifiers: {
      Any additional single qualifier needed to identify the component uniquely, when the name alone is not sufficient; the map key is the extra attribute name string; the map value string completes the identification of the component; for componentType Configuration: key=deviceName, value=name of the device the configuration belongs to; for componentType DynamicField: key=type, value=base class name of the component associated with the dynamic field; for componentType Group, ComboGroup: key=realmName, value=name of the realm the group belongs to; for componentType Model: key=vendorGuid, value=the vendor GUID; for componentType OsImage: key=filename, value=name of the file(s) making up the image; for componentType SecurityVulnerability: key=vendorGuid, value=the vendor GUID
    }
}

DynamicFieldValueDTO


Click here to expand...


{
    id: string
    The database key of the dynamic field whose value this is (read-only)
 
    name: string
    The name of the dynamic field (read-only)
 
    values: [
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types
 
      string
    ]
 
    dynamicFieldDetailsLink: string
    Link to get more detailed information about the dynamic field (read-only)
}

JsonPatch


Click here to expand...


[
    A list of JSON Patch operations
 
     #JsonPatch.OneOperation
  ]

JsonPatch.OneOperation

JsonPatch.Pointer


Click here to expand...


string
  Pointer or path to an element or property

JsonPatch.Add


Click here to expand...


{
    op: string*
    Enum: [
      "add"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

JsonPatch.Remove


Click here to expand...


{
    op: string*
    Enum: [
      "remove"
    ]
    path: #JsonPatch.Pointer *
}

JsonPatch.Replace


Click here to expand...


{
    op: string*
    Enum: [
      "replace"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

JsonPatch.Move


Click here to expand...


{
    op: string*
    Enum: [
      "move"
    ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

JsonPatch.Copy


Click here to expand...


{
    op: string*
    Enum: [
      "copy"
    ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

JsonPatch.Test


Click here to expand...


{
    op: string*
    Enum: [
      "test"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

TermDTO


Click here to expand...


{
    notFlag: boolean
    Whether or not the opposite of the operand is to be computed
 
    groupId: #ComponentId
   Identifies the single group that makes up this term; must specify either 'groupId' or 'groups' as an operand in a boolean expression
 
    groupDetailsLink: string
    Link to get complete details about the group (read-only)
 
    groups: #BooleanExpressionDTO
   Complex combination of groups that make up this term
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Network Automation 20.02