v4.0 Views API


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

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

views

{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/views
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

filter.component

query

Filter associated with this component (comboGroup, device, event, group, job, osImage, predefinedJob, rule, ruleSet, template)


string * 
Enum: [
 "comboGroup",
 "device",
 "event",
 "group",
 "job",
 "osImage",
 "predefinedJob",
 "rule",
 "ruleSet",
 "template"
]

includeStandardView

query

Whether to include the standard view for the component type


boolean

orderBy

query

Sort by the specified attribute (name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string 
Enum: [
 "+name",
 "-name"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of views to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

[ 
  ViewDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Green" title="POST"/}}

 /v4.0/views
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new view


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

201

Created: New view successfully added


400

Bad request: Input view DTO is missing or new view is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to add a new view or not allowed to share the view with the selected roles


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/views/{id
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the view 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 accessToken cookie, or the specified user is not logged in


404

Not found: No single matching view found


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Yellow" title="PUT"/}}

 /v4.0/views/{id
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the view to be modified


string *

body

body

Complete new attribute values for the view; anything left out will be considered to be null and will be nulled out in the view


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input DTO is missing or modified view is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to modify the view


404

Not found: No single matching view found


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Red" title="DELETE"/}}

 /v4.0/views/{id
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the view to be deleted


string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

string

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to delete the view


404

Not found: No single matching view found


500

Internal server error: Unexpected exception occurred

Object Definitions

Object

Schema

ComboGroupFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

       DynamicFieldFilterDTO
    ] 

     containsUnresolvableDynamicFieldFiltersFlag: boolean 
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 

     nameMatch: string 
    Search for combo groups whose name matches this wildcard-enabled string 

     realmName: string 
    Search for combo groups that belong to this exact realm 
}

ComboGroupViewDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ViewService$ComboGroupViewDTO"

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 

     filter: ComboGroupFilterDTO*
    How to filter the list of combo groups 
}

ComponentFilterDTO


Click here to expand...

Subclasses:
TemplateFilterDTO
OsImageFilterDTO
DeviceFilterDTO
PredefinedJobFilterDTO
RuleSetFilterDTO
RuleFilterDTO
JobFilterDTO
ComboGroupFilterDTO
GroupFilterDTO

{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

       DynamicFieldFilterDTO
    ] 

     containsUnresolvableDynamicFieldFiltersFlag: boolean 
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (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 and HardwareInventory, 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, DeviceAdapter, DeviceAgent, DeviceSecurityProfile DynamicField, EmailDistributionList, Group, HardwareInventory, JobApprovalType, Keyword, Model, OsImage, PredefinedJob, Realm, RemoteFileServer, 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 and HardwareInventory: key=deviceKey, value=database key of the device the item belongs to, key=deviceName, value=name of the device the item belongs to, key=timestamp, value=creation date/time in server display format; for componentType DeviceAdapter: key=adapterType, value=type of the device adapter, key=parent, value=parent or owner used for organizing certain types of adapters, key=vendorName, value=name of the vendor that owns a device type; 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 
    } 
}

DeviceFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

       DynamicFieldFilterDTO
    ] 

     containsUnresolvableDynamicFieldFiltersFlag: boolean 
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 

     accessModeId: integer 
    Search for devices with this access mode 

     addressMatch: string 
    Search for devices matching this wildcard-enabled IP address or host name 

     autoDspFlag: boolean 
    Search for devices set for device security profile auto-discovery (true) or set to an explicit profile (false); null means do no auto-discovery mode filtering 

     categoryId: integer 
    Search for devices in this category 

     createdTimePeriod: TimePeriodDTO 
    Search for devices created within this time period 

     defaultDeviceAgentNICFlag: boolean 
    Whether or not to search for devices whose interface is set to use the default NIC of its selected device agent; when true, the deviceAgentNICName field is ignored 

     deviceAgentName: string 
    Search for devices whose device agent equals this name 

     deviceAgentNICName: string 
    Search for devices whose NIC equals this name, within the device agent specified by the deviceAgentName field; to search for devices using the "(Default)" NIC, use the defaultDeviceAgentNICFlag field instead 

     deviceSecurityProfileName: string 
    Search for devices whose device security profile equals this name 

     deviceTypeId: ComponentId
    Search for devices whose device type equals this device type 

     filterAuxiliaryInterfaceFlag: boolean 
    Whether or not to examine the auxiliary interface settings when matching on the interface-related fields (access mode, transfer mode, address, NAT address, device agent, NIC, and device security profile) 

     filterPrimaryInterfaceFlag: boolean 
    Whether or not to examine the primary interface settings when matching on the interface-related fields (access mode, transfer mode, address, NAT address, device agent, NIC, and device security profile) 

     groupName: string 
    Search for devices that belong to this group in the realm specified by realmName 

     managerDeviceName: string 
    Search for devices whose manager name equals this name 

     modelNameMatch: string 
    Search for devices whose model name matches this wildcard-enabled string 

     nameMatch: string 
    Search for devices whose name matches this wildcard-enabled string 

     natAddressMatch: string 
    Search for devices whose NAT address or secondary NAT address matches this wildcard-enabled string 

     onlineFlag: boolean 
    Search for either online devices (true) or offline devices (false); null means do not filter on the online/offline state 

     osImageNameMatch: string 
    Search for devices whose OS image name matches this wildcard-enabled string 

     realmName: string 
    Search for devices that belong to this exact realm 

     securityContextTypeId: integer 
    Search for devices set to this type of security context 

     transferModeId: integer 
    Search for devices with this file transfer mode 

     vendorId: ComponentId
    Search for devices whose device type belongs to this vendor 

     noDiscrepanciesFlag: boolean 
    Search for devices that have no discrepancies at all 

     noDiscrepanciesIncludeFlag: boolean 
    Whether to include (true) or exclude (false) devices that have no discrepancies 

     osImageDiscrepancyFlag: boolean 
    Search for devices that have an OS image discrepancy 

     osImageDiscrepancyIncludeFlag: boolean 
    Whether to include (true) or exclude (false) devices that have an OS image discrepancy 

     runningStartupDiscrepancyFlag: boolean 
    Search for devices that have a Running vs Startup discrepancy 

     runningStartupDiscrepancyIncludeFlag: boolean 
    Whether to include (true) or exclude (false) devices that have a Running vs Startup discrepancy 

     runningTrustedDiscrepancyFlag: boolean 
    Search for devices that have a Running vs Trusted Running discrepancy 

     runningTrustedDiscrepancyIncludeFlag: boolean 
    Whether to include (true) or exclude (false) devices that have a Running vs trusted Running discrepancy 

     startupTrustedDiscrepancyFlag: boolean 
    Search for devices that have a Startup vs Trusted Startup discrepancy 

     startupTrustedDiscrepancyIncludeFlag: boolean 
    Whether to include (true) or exclude (false) devices that have a Startup vs trusted Startup discrepancy 

     noViolationsFlag: boolean 
    Search for devices that have no compliance violations 

     noViolationsIncludeFlag: boolean 
    Whether to include (true) or exclude (false) devices that have no compliance violations 

     includedViolationTrailIds: [ 
      Include devices in the results that have a compliance violation in one of these trails 

       ComponentId
    ] 

     excludedViolationTrailIds: [ 
      Exclude devices from the results that have a compliance violation in one of these trails 

       ComponentId
    ] 

     lastAttemptedSpanActionFlag: boolean 
    Search for devices whose last attempted span action matches a particular completion status 

     lastAttemptedSpanActionGuid: string 
    When lastAttemptedSpanActionFlag is true, specifies which span action to examine 

     lastAttemptedSpanActionStatusId: integer 
    When lastAttemptedSpanActionFlag is true, specifies which completion status to search for 

     lastAttemptedSpanActionErrorMatch: string 
    When lastAttemptedSpanActionFlag is true, specifies which completion error message to search for, wildcards allowed 

     lastSuccessfulSpanActionFlag: boolean 
    Search for devices whose last successful span action occurred within a selected time period 

     lastSuccessfulSpanActionGuid: string 
    When lastSuccessfulSpanActionFlag is true, specifies which span action to examine 

     lastSuccessfulSpanActionTimePeriod: TimePeriodDTO 
    When lastSuccessfulSpanActionFlag is true, specifies when the action is to have succeeded 

     noAttemptedSpanActionFlag: boolean 
    Searches for devices that have not attempted a span action within a specified number of days 

     noAttemptedSpanActionGuid: string 
    When noAttemptedSpanActionFlag is true, specifies which span action to examine 

     noAttemptedSpanActionDays: integer 
    When noAttemptedSpanActionFlag is true, specifies when the action is to have been attempted 

     noSuccessfulSpanActionFlag: boolean 
    Searches for devices that have not succeeded executing a span action within a specified number of days 

     noSuccessfulSpanActionGuid: string 
    When noSuccessfulSpanActionFlag is true, specifies which span action to examine 

     noSuccessfulSpanActionDays: integer 
    When noSuccessfulSpanActionFlag is true, specifies when the action is to have succeeded 

     iosHwFilter: IOSHardwareInventoryFilterDTO
    Options for filtering on hardware inventory information obtained from Cisco IOS or IOS-like devices 
}

DeviceViewDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ViewService$DeviceViewDTO"

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 

     filter: DeviceFilterDTO*
    How to filter the list of devices 
}

DynamicFieldFilterDTO


Click here to expand...


{ 
    dynamicField: ComponentId*
    The dynamic field whose value is being searched for 

     value: string * 
    The filter string (the value to be matched); if this value is null or empty, no filtering is done on the specified dynamic field; menu-type dynamic fields support only exact matching; the filter string must be formatted properly when the dynamic field is a Date or Integer type 
}

EventFilterDTO


Click here to expand...


{ 
    categoryId: integer 
    Search for events in this category; a null or a zero value means do not filter on this field 

     descriptionMatch: string 
    Search for events whose description matches this wildcard-enabled string; a null means do not filter on this field 

     groupId: string 
    Search for events related to the group or the combo group specified by this database key; this field can be used only in transient filters (not in any views), as it is an input-only field and is not persisted to the database 

     maxEvents: integer 
    The maximum number of events returned by a database query that uses this filter, from which a selected page is extracted; setting a value improves performance when there are many events in the database; a value of zero or less means an unlimited number of events are returned 

     realmNameMatch: string 
    Search for events whose realm matches this wildcard-enabled string; a null means do not filter on this field 

     rootThreadId: integer 
    Search for events that were logged in this parent or root database session; a null or a zero value means do not filter on this field 

     severityIds: [ 
      Search for events of this severity; a null or an empty list means do not filter on this field 

       integer 
    ] 

     sourceNameMatch: string 
    Search for events whose source matches this wildcard-enabled string; a null means do not filter on this field 

     targetNameMatch: string 
    Search for events whose target matches this wildcard-enabled string; a null means do not filter on this field 

     timestamp: TimePeriodDTO 
    Search for events that occurred within this time period; a null means do not filter on this field 

     typeId: integer 
    Search for events of this type; a null or a zero value means do not filter on this field 
}

EventViewDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ViewService$EventViewDTO"

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 

     filter: EventFilterDTO*
    How to filter the list of events 
}

GroupFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

       DynamicFieldFilterDTO
    ] 

     containsUnresolvableDynamicFieldFiltersFlag: boolean 
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 

     nameMatch: string 
    Search for groups whose name matches this wildcard-enabled string 

     realmName: string 
    Search for groups that belong to this exact realm 

     showAutoGroupsFlag: boolean 
    Whether or not to include auto-groups in the results 

     showSimpleGroupsFlag: boolean 
    Whether or not to include manually-created groups in the results 

     showEmptyAutoGroupsFlag: boolean 
    Whether or not to include empty auto-groups in the results 
}

GroupViewDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ViewService$GroupViewDTO"

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 

     filter: GroupFilterDTO*
    How to filter the list of groups 
}

IOSHardwareInventoryFilterDTO


Click here to expand...


{ 
    entityNameMatch: string 
    Search for devices matching this wildcard-enabled hardware entity name 

     entityDescrMatch: string 
    Search for devices matching this wildcard-enabled hardware entity descr 

     entityPidMatch: string 
    Search for devices matching this wildcard-enabled hardware entity PID 

     entityVidMatch: string 
    Search for devices matching this wildcard-enabled hardware entity VID 

     entitySnMatch: string 
    Search for devices matching this wildcard-enabled hardware entity SN 

     fileSystemFreeSizeIntegerRange: string 
    Search for devices with a file system free size matching this range specification 

     fileSystemNameMatch: string 
    Search for devices matching this wildcard-enabled file system name 

     fileSystemTotalSizeIntegerRange: string 
    Search for devices with a file system total size matching this range specification 

     memoryNameMatch: string 
    Search for devices matching this wildcard-enabled memory name 

     memorySizeIntegerRange: string 
    Search for devices with a memory size matching this range specification 
}

JobFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

       DynamicFieldFilterDTO
    ] 

     containsUnresolvableDynamicFieldFiltersFlag: boolean 
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 

     actionGuids: [ 
      Search for jobs that include one of these actions 

       string 
    ] 

     changeIdMatch: string 
    Search for jobs whose change ID matches this wildcard-enabled string 

     creationTime: TimePeriodDTO 
    Search for jobs whose creation date/time falls within this date/time range 

     editorNameMatch: string 
    Search for jobs with a creator or an editor matching this wildcard-enabled string 

     jobIdMatch: string 
    Search for jobs whose job ID matches this wildcard-enabled string 

     jobApprovalModeId: integer 
    Search for jobs with this job approval mode 

     jobApprovalTypeName: string 
    Search for jobs whose job approval type matches this exact name 

     networkSpanNameMatch: string 
    Search for jobs that have actions acting on a network span whose name matches this wildcard-enabled string 

     originatorMatch: string 
    Search for jobs whose originator matches this wildcard-enabled string 

     originatorTypeId: integer 
    Search for jobs with this type of originator 

     preparedFromPredefinedJobNameMatch: string 
    Search for jobs which were prepared from a predefined job whose name matches this wildcard-enabled string 

     reconciliationStatusId: integer 
    Search for jobs with this reconciliation status 

     showOnlyJobsICanApproveFlag: boolean 
    When searching for jobs with status "waiting for approval", whether or not to only include jobs that the user for this session can approve 

     statusIds: [ 
      Search for jobs whose current status matches one of these statuses 

       integer 
    ] 

     taskIdMatch: string 
    Search for jobs whose task ID matches this wildcard-enabled string 
}

JobViewDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ViewService$JobViewDTO"

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 

     filter: JobFilterDTO*
    How to filter the list of jobs 
}

OsImageFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

       DynamicFieldFilterDTO
    ] 

     containsUnresolvableDynamicFieldFiltersFlag: boolean 
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 

     deviceTypeId: ComponentId
    Search for OS images associated with this device type 

     fileNameMatch: string 
    Search for OS images with filenames that match this wildcard-enabled string 

     modelNameMatch: string 
    Search for OS images associated with a model whose name matches this wildcard-enabled string 

     nameMatch: string 
    Search for OS images whose name matches this wildcard-enabled string 

     vendorId: ComponentId
    Search for OS images whose device type belongs to this vendor 
}

OsImageViewDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ViewService$OsImageViewDTO"

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 

     filter: OsImageFilterDTO*
    How to filter the list of OS images 
}

PredefinedJobFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

       DynamicFieldFilterDTO
    ] 

     containsUnresolvableDynamicFieldFiltersFlag: boolean 
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 

     actionGuids: [ 
      Search for predefined jobs that include one of these actions 

       string 
    ] 

     nameMatch: string 
    Search for predefined jobs whose name matches this wildcard-enabled string 

     networkSpanNameMatch: string 
    Search for predefined jobs that have actions acting on a network span whose name matches this wildcard-enabled string 
}

PredefinedJobViewDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ViewService$PredefinedJobViewDTO"

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 

     filter: PredefinedJobFilterDTO*
    How to filter the list of predefined jobs 
}

RuleFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

       DynamicFieldFilterDTO
    ] 

     containsUnresolvableDynamicFieldFiltersFlag: boolean 
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 

     activationTimePeriod: TimePeriodDTO 
    Search for rules whose activation date/time falls within this date/time range 

     contentsMatch: string 
    Search for rules whose trigger, subject, or domain contains text that matches this wildcard-enabled string 

     cveIDs: [ 
      Search for rules whose associated CVE IDs include one of these CVE IDs 

       string 
    ] 

     deactivationTimePeriod: TimePeriodDTO 
    Search for rules whose deactivation date/time falls within this date/time range 

     deviceTypeId: ComponentId
    Search for rules associated with this device type 

     excludeRulesWithAllDeviceTypesFlag: boolean 
    When searching for rules of a particular device type, whether or not rules associated with all device types are included in what matches or are excluded 

     includeNonCorrectableRulesFlag: boolean 
    Search for rules that cannot be corrected (that is, a rule that has no corrective actions, is in a disabled rule set, is not currently activated, or has a grammar whose violation cannot be automatically corrected); when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs 

     includeRulesCorrectableViaDeployToActiveFlag: boolean 
    Search for rules that can be corrected by running a Deploy to Active action; when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs 

     includeRulesCorrectableViaDeployToStoredFlag: boolean 
    Search for rules that can be corrected by running a Deploy to Stored action; when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs 

     includeRulesCorrectableViaRemediateFlag: boolean 
    Search for rules that can be corrected by running a Remediate action; when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs 

     isNullSecurityVulnerabilityFlag: boolean 
    Whether or not to search for rules that have no associated security vulnerability; when true, search only for such rules; when false or null, do not filter on associated security vulnerability; this flag cannot be used and must be null when this filter is used in a job, predefined job, policy, or view 

     ruleNameMatch: string 
    Search for rules whose name matches this wildcard-enabled string 

     ruleSetNameMatch: string 
    Search for rules whose parent rule set name matches this wildcard-enabled string 

     severityIds: [ 
      Search for rules whose severity matches one of these severities 

       integer 
    ] 

     vendorId: ComponentId
    Search for rules whose device type belongs to this vendor 
}

RuleSetFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

       DynamicFieldFilterDTO
    ] 

     containsUnresolvableDynamicFieldFiltersFlag: boolean 
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 

     nameMatch: string 
    Search for rule sets whose name matches this wildcard-enabled string 

     enabledFlag: boolean 
    Search for rule sets that are enabled (true) or disabled (false); null means do not filter on the enabled/disabled state 
}

RuleSetViewDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ViewService$RuleSetViewDTO"

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 

     filter: RuleSetFilterDTO*
    How to filter the list of rule sets 
}

RuleViewDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ViewService$RuleViewDTO"

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 

     filter: RuleFilterDTO*
    How to filter the list of rules 
}

TemplateFilterDTO

Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

       DynamicFieldFilterDTO
    ] 

     containsUnresolvableDynamicFieldFiltersFlag: boolean 
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 

     containerBlueprintName: string 
    Search for templates referenced by this exact container blueprint 

     contentsMatch: string 
    Search for templates whose content matches this wildcard-enabled string 

     deviceTypeId: ComponentId
    Search for templates associated with this device type 

     nameMatch: string 
    Search for templates whose name matches this wildcard-enabled string 

     vendorId: ComponentId
    Search for templates whose device type belongs to this vendor 
}

TemplateViewDTO

Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ViewService$TemplateViewDTO"

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 

     filter: TemplateFilterDTO*
    How to filter the list of templates 
}

TimePeriodDTO

Click here to expand...


{ 
    timePeriodTypeId: integer * 
    What sort of time period this is 

     timePeriodTypeName: string 
    The meaning of the numeric timePeriodTypeId (read-only) 

     startTimestamp: date-time 
    The start date/time. Required only for certain user-defined time period types of After and Range; when the timestamp is missing the timezone, the server local timezone is assumed 
    Example: 2017-01-31T13:45:00.000+0000

     endTimestamp: date-time 
    The end date/time. Required only for certain user-defined time period types of Before and Range; when the timestamp is missing the timezone, the server local timezone is assumed 
    Example: 2017-01-31T13:45:00.000+0000
}

ViewDTO

Click here to expand...

Subclasses:
RuleViewDTO
JobViewDTO
DeviceViewDTO
ComboGroupViewDTO
TemplateViewDTO
GroupViewDTO
RuleSetViewDTO
EventViewDTO
OsImageViewDTO
PredefinedJobViewDTO

{ 
    id: string 
    The view's unique database key; a standard view has no database key (read-only) 

     name: string * 
    The view's display name; names are unique within the views for a particular component 

     descendingSortOrderFlag: boolean 
    Whether or not the component list is sorted in descending order when this view is applied; when false, the list is sorted in ascending order; when true, the list is sorted in descending order 

     isDefaultViewFlag: boolean 
    Whether or not the view is the default view for the component list 

     isSharedViewFlag: boolean 
    Whether or not the view is shared 

     isStandardViewFlag: boolean 
    Whether or not this view is a standard or canned view; each component list has one system-defined standard view that is the default view (until another view is designated as the default); when true, this view cannot be edited, deleted, or shared (read-only) 

     sharedWithRoles: [ 
      Roles with which this view is shared, when it is a shared view; a null value means the view is shared with all users 

       ComponentId
    ] 

     sortColumn: string 
    By which column to sort the component list when this view is applied; when null, the component list is sorted by its default column, which varies from list to list; the column names that are recognized for a specific component list are documented in the GET multiple service for that component 
}

 

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

TrueSight Network Automation 25.1