Important

   

Starting from version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about TrueSight Network Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Network Automation 8.9.

Dynamic Fields API

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

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


GET /v3.0/dynamic_fields
 Retrieves dynamic fields, matching any filter criteria


Parameters

Name

Located in

Description

Default

Schema

filter.component

query

Filter for dynamic fields associated with this component (comboGroup, condition, device, deviceAgent, emailList, eventReceiver externalEventFilter, externalLink, globalSubstitutionParameter, group, job, jobApprovalType, keyword, osImage, policy, realm, remoteFileServer, role, rule, ruleSet, securityVulnerabilityImporter, snmpManager, template, or user)


string
Enum: [
  "comboGroup",
  "condition",
  "device",
  "deviceAgent",
  "emailList",
  "eventReceiver",
  "externalEventFilter",
  "externalLink",
  "globalSubstitutionParameter",
  "group",
  "job",
  "jobApprovalType",
  "keyword",
  "osImage",
  "policy",
  "realm",
  "remoteFileServer",
  "role",
  "rule",
  "ruleSet",
  "securityVulnerabilityImporter",
  "snmpManager",
  "template",
  "user"
]

filter.filterable

query

Filter for dynamic fields based on whether or not they are filterable; when true, retrieve only dynamic fields enabled for filtering; when false, retrieve only dynamic fields disabled for filtering; when null, no filtering occurs


boolean

filter.displayInLists

query

Filter for dynamic fields based on whether or not they are displayed in component lists; when true, retrieve only dynamic fields enabled for display in lists; when false, retrieve only dynamic fields disabled for display in lists; when null, no filtering occurs


boolean

orderBy

query

Sort by the specified attribute (assignedNetworkSpans, assignmentMechanism, componentName, defaultValue, enabledFlag, name and valueType) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+componentName"

string
Enum: [
  "+assignedNetworkSpans",
  "-assignedNetworkSpans",
  "+assignmentMechanism",
  "-assignmentMechanism",
  "+componentName",
  "-componentName",
  "+defaultValue",
  "-defaultValue",
  "+enabledFlag",
  "-enabledFlag",
  "+name",
  "-name",
  "+valueType",
  "-valueType"
]

offset

query

Return the specified page number

1

integer

limit

query

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

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

[
   #DynamicFieldDTO
]

401

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


403

Forbidden: Not allowed to access dynamic fields


500

Internal server error: Unexpected exception occurred


POST /v3.0/dynamic_fields
 Adds a new dynamic field


Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new dynamic field


#DynamicFieldDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

201

Created: New dynamic field successfully added


400

Bad request: Input dynamic field DTO is missing or new dynamic field 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 dynamic field


500

Internal server error: Unexpected exception occurred


GET /v3.0/dynamic_fields/{nameOrKey}
 Retrieves one dynamic field either by name or by database key


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the dynamic field of interest


string*

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

#DynamicFieldDTO

401

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


403

Forbidden: Not allowed to access dynamic fields


404

Not found: No single matching accessible dynamic field found


500

Internal server error: Unexpected exception occurred


PUT /v3.0/dynamic_fields/{nameOrKey}
 Modifies all attributes of an existing dynamic field


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the dynamic field to be modified


string*

body

body

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


#DynamicFieldDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

#DynamicFieldDTO

400

Bad request: Input dynamic field DTO is missing or modified dynamic field is invalid


401

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


403

Forbidden: Not allowed to modify the dynamic field


404

Not found: No single matching accessible dynamic field found


500

Internal server error: Unexpected exception occurred


DELETE /v3.0/dynamic_fields/{nameOrKey}
 Deletes an unreferenced dynamic field


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the dynamic field to be deleted


string*

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Dynamic field is auto-grouping and an associated auto-group is in use, or the dynamic field is permanent and thus not deletable


401

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


403

Forbidden: Not allowed to delete the dynamic field


404

Not found: No single matching accessible dynamic field found


500

Internal server error: Unexpected exception occurred


PATCH /v3.0/dynamic_fields/{nameOrKey}
 Modifies only the specified attributes of an existing dynamic filed, where the changes are specified in JSON Patch format (per RFC 6902)


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the dynamic field to be modified


string*

body

body

New attribute values for the dynamic field, in JSON Patch format


#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

#DynamicFieldDTO

400

Bad request: Input JSON patch information is missing or modified dynamic field is invalid


401

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


403

Forbidden: Not allowed to modify the dynamic filed


404

Not found: No single matching accessible dynamic filed found


500

Internal server error: Unexpected exception occurred



Object Definitions

Object

Schema

CaptureAttributeValuesDynamicFieldDTO


 A device dynamic field whose value is parsed out of a configuration

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$CaptureAttributeValuesDynamicFieldDTO"

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
 
    assignedNetworkSpans: [
      The network spans to which this dynamic field applies; when null, the dynamic field applies to the entire network
 
       #ComponentId
    ]*
 
    assignedNetworkSpanNames: string
    The names of the assigned network spans (read-only)
 
    enabledFlag: boolean
    Whether or not this dynamic field is enabled; when true, devices in the assigned network spans (but not in any excluded network spans) are passed through the configuration parsing process to find data that matches the queries; when false, configuration parsing is skipped
 
    excludedNetworkSpans: [
      The network spans to which this dynamic field does NOT apply
 
       #ComponentId
    ]
 
    excludedNetworkSpanNames: string
    The names of the excluded network spans (read-only)
 
    queries: [
      Specifies which types of devices and which configurations are of interest and how the configuration is to be parsed to extract a value
 
       #DynamicFieldQueryDTO
    ]*
 
    substitutionParameterCheckFlag: boolean
    Whether or not substitution parameter usage is validated in the queries
 
    valueWhenAttributeAbsent: string
    The value to assign to devices for this dynamic field when parsing the configuration per the queries fails to extract any value
 
    displayMenuInFilterFlag: boolean
    Whether or not all of the current values assigned to devices for this dynamic field appear in the device filter page as a menu; when true, the values appear in a menu populated from a possibly lengthy database query gathering all the values; when false, the filter exhibits a simple text field for data entry, bypassing the database query
}

ComponentId


 Identifies a component in a form that can be input to either the same TrueSight Network Automation server that emitted it or to a different TrueSight Network Automation server; the name, qualifiers, and type uniquely identify a component; and they verify that anything successfully retrieved by a database key is the right component


{
    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
 
    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
    }
}

ConfigurationProfiledDynamicFieldDTO


 A device dynamic field whose value is derived from parsing a configuration

Subclasses:
#CaptureAttributeValuesDynamicFieldDTO
#DetectAttributePresenceDynamicFieldDTO

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
 
    assignedNetworkSpans: [
      The network spans to which this dynamic field applies; when null, the dynamic field applies to the entire network
 
       #ComponentId
    ]*
 
    assignedNetworkSpanNames: string
    The names of the assigned network spans (read-only)
 
    enabledFlag: boolean
    Whether or not this dynamic field is enabled; when true, devices in the assigned network spans (but not in any excluded network spans) are passed through the configuration parsing process to find data that matches the queries; when false, configuration parsing is skipped
 
    excludedNetworkSpans: [
      The network spans to which this dynamic field does NOT apply
 
       #ComponentId
    ]
 
    excludedNetworkSpanNames: string
    The names of the excluded network spans (read-only)
 
    queries: [
      Specifies which types of devices and which configurations are of interest and how the configuration is to be parsed to extract a value
 
       #DynamicFieldQueryDTO
    ]*
 
    substitutionParameterCheckFlag: boolean
    Whether or not substitution parameter usage is validated in the queries
 
    valueWhenAttributeAbsent: string
    The value to assign to devices for this dynamic field when parsing the configuration per the queries fails to extract any value
}

DetectAttributePresenceDynamicFieldDTO


 A device dynamic field whose value is set based on the presence or absence of some value in a configuration

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DetectAttributePresenceDynamicFieldDTO"

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
 
    assignedNetworkSpans: [
      The network spans to which this dynamic field applies; when null, the dynamic field applies to the entire network
 
       #ComponentId
    ]*
 
    assignedNetworkSpanNames: string
    The names of the assigned network spans (read-only)
 
    enabledFlag: boolean
    Whether or not this dynamic field is enabled; when true, devices in the assigned network spans (but not in any excluded network spans) are passed through the configuration parsing process to find data that matches the queries; when false, configuration parsing is skipped
 
    excludedNetworkSpans: [
      The network spans to which this dynamic field does NOT apply
 
       #ComponentId
    ]
 
    excludedNetworkSpanNames: string
    The names of the excluded network spans (read-only)
 
    queries: [
      Specifies which types of devices and which configurations are of interest and how the configuration is to be parsed to extract a value
 
       #DynamicFieldQueryDTO
    ]*
 
    substitutionParameterCheckFlag: boolean
    Whether or not substitution parameter usage is validated in the queries
 
    valueWhenAttributeAbsent: string
    The value to assign to devices for this dynamic field when parsing the configuration per the queries fails to extract any value
 
    valueWhenAttributePresent: string
    The value to assign to devices for this dynamic field when parsing the configuration per the queries successfully matches a value
}

DynamicAutoDerivedFieldDTO


 A device dynamic field whose value is derived from the device's name or primary address

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DynamicAutoDerivedFieldDTO"

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
 
    derivationMaskPattern: string
    When deriveUsingPatternFlag is true, contains the regular expression to be matched against the device field, with a parenthesized capture group indicating the data to be extracted
 
    derivationMaskRangeFrom: integer
    When deriveUsingPatternFlag is false, contains the character position indicating where the data to be extracted starts within the device field
 
    derivationMaskRangeTo: integer
    When deriveUsingPatternFlag is false, contains the character position indicating where the data to be extracted ends within the device field
 
    deriveFromDeviceNameFlag: boolean
    Whether the dynamic field value is parsed out of the device's name (true) or the device's primary interface IP address or host name (false)
 
    deriveUsingPatternFlag: boolean
    Whether the parsing of the device value is based on a regular expression (true) or on a range of character positions (false); when true, a parenthesized capture group indicates where the value is found in the device field; when false, a range of positions indicates the characters to be extracted
 
    valueForFailedDerivations: string*
    The value to assign to the dynamic field if the parsing of the device value fails (for example, if the value is too short to meet a character range, or if the value does not match the regular expression)
}

DynamicDateFieldDTO


 A dynamic field whose value is a date

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DynamicDateFieldDTO"

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
 
    defaultValueForExistingComponents: date-time
    For a required dynamic field, the value to assign to existing components that have no value already set; required when the requiredFlag is true; used only when requiredFlag is being changed to true or when creating a new required dynamic field (only the date part is significant)
    Example: 12/30/18
 
    defaultValueForNewComponents: date-time
    The value to use as the default for this field when adding a new component (only the date part is significant)
    Example: 12/30/18
 
    minimumValue: date-time
    Minimum value allowed to assign to a component for this dynamic field (only the date part is significant)
    Example: 12/30/18
 
    maximumValue: date-time
    Maximum value allowed to assign to a component for this dynamic field (only the date part is significant)
    Example: 12/30/18
}

DynamicFieldDTO


 Information about a dynamic field

Subclasses:
#DynamicDateFieldDTO
#DynamicAutoDerivedFieldDTO
#DynamicTextFieldDTO
#DynamicIntegerFieldDTO
#ConfigurationProfiledDynamicFieldDTO
#DynamicMenuFieldDTO

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
}

DynamicFieldDomainAnywhereDTO


 Specifies that the entire configuration is to be examined when deriving a dynamic field value

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DynamicFieldDomainAnywhereDTO"

{
    ignoreCommentsFlag: boolean
    Whether or not comments are to be ignored while parsing the configuration
}

DynamicFieldDomainBlocksDTO


 Specifies that lines within selected block boundaries are to be examined when deriving a dynamic field value

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DynamicFieldDomainBlocksDTO"

{
    ignoreCommentsFlag: boolean
    Whether or not comments are to be ignored while parsing the configuration
 
    begin: #DynamicFieldSearchStringDTO *
    Identifies the configuration line where the block boundary starts
 
    caseSensitiveFlag: boolean
    Whether or not block begin/end boundary searching is case-sensitive
 
    end: #DynamicFieldSearchStringDTO *
    Identifies the configuration line where the block boundary ends
 
    ignoreBlocksContainingPattern: string
    Ignore blocks containing any lines that match this regular expression
}

DynamicFieldDomainDTO


 Which part of the configuration is to be examined for the purpose of deriving a dynamic field value

Subclasses:
#DynamicFieldDomainAnywhereDTO
#DynamicFieldDomainBlocksDTO

{
    ignoreCommentsFlag: boolean
    Whether or not comments are to be ignored while parsing the configuration
}

DynamicFieldQueryDTO


 Specifies what in a configuration is of interest for populating a dynamic field value


{
    applicableSecurityContextTypeId: integer
    Selects only devices of this type of security context
 
    applicableSecurityContextTypeName: string
    The meaning of the numeric applicableSecurityContextTypeId (read-only
 
    applicableTrailGuid: string*
    Selects the current configuration of this trail
 
    applicableTrailName: string
    The name of the applicable trail (read-only)
 
    deviceTypeGuid: string
    Selects only devices of this device type; when null, selects devices of any device type
 
    deviceTypeName: string
    The name of the device type (read-only)
 
    domain: #DynamicFieldDomainDTO *
    Which part of the configuration is to be examined
 
    minRelease: string*
    Selects only devices whose current OS image is at least this version; use ..* to make this open-ended
 
    maxRelease: string*
    Selects only devices whose current OS image is at most this version; use ..* to make this open-ended
 
    subject: #DynamicFieldSubjectDTO *
    The configuration data to be extracted
}

DynamicFieldSearchStringDTO


 For a block domain in a dynamic field query, specifies the configuration data to be matched


{
    patternFlag: boolean
    Whether or not the 'string' field contains a regular expression; when true, 'string' contains a regular expression to be matched by a configuration line; when false, 'string' contains an exact line to be located in the configuration
 
    string: string*
    The text to be searched for in the configuration
}

DynamicFieldSubjectDTO


 How to extract configuration data into a dynamic field value

Subclasses:
#DynamicFieldSubjectLineDTO
#DynamicFieldSubjectPatternDTO

{
    caseSensitiveFlag: boolean
    Whether or not the search for the command line of interest in the configuration is case-sensitive
 
    string: string*
    The command line to be searched for within the selected domain
}

DynamicFieldSubjectLineDTO


 Extracts configuration data into a dynamic field value based on matching a command line exactly

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DynamicFieldSubjectLineDTO"

{
    caseSensitiveFlag: boolean
    Whether or not the search for the command line of interest in the configuration is case-sensitive
 
    string: string*
    The command line to be searched for within the selected domain
 
    ignoreWhitespaceFlag: boolean
    Whether or not leading and trailing whitespace in a configuration command line is to be ignored
}

DynamicFieldSubjectPatternDTO


 Extracts configuration data into a dynamic field value based on matching a regular expression, that includes a parenthesized capture group indicating the data to be extracted

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DynamicFieldSubjectPatternDTO"

{
    caseSensitiveFlag: boolean
    Whether or not the search for the command line of interest in the configuration is case-sensitive
 
    string: string*
    The command line to be searched for within the selected domain
}

DynamicIntegerFieldDTO


 A dynamic field whose value is a number

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DynamicIntegerFieldDTO"

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
 
    defaultValueForExistingComponents: integer
    For a required dynamic field, the value to assign to existing components that have no value already set; required when the requiredFlag is true; used only when requiredFlag is being changed to true or when creating a new required dynamic field
 
    defaultValueForNewComponents: integer
    The value to use as the default for this field when adding a new component
 
    minimumValue: integer
    Minimum value allowed to assign to a component for this dynamic field
 
    maximumValue: integer
    Maximum value allowed to assign to a component for this dynamic field
}

DynamicMenuFieldDTO


 A dynamic field whose value is selected from a list of menu options

Subclasses:
#DynamicSingleSelectMenuFieldDTO
#DynamicMultiSelectMenuFieldDTO

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
 
    options: [
      The allowed values or the menu options for this dynamic fields
 
      string
    ]*
}

DynamicMultiSelectMenuFieldDTO


 A dynamic field whose one or more values are selected from a menu of legal options

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DynamicMultiSelectMenuFieldDTO"

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
 
    options: [
      The allowed values or the menu options for this dynamic fields
 
      string
    ]*
 
    defaultValueForExistingComponents: [
      For a required dynamic field, the value(s) to assign to existing components that have no value already set; required when the requiredFlag is true; used only when requiredFlag is being changed to true or when creating a new required dynamic field
 
      string
    ]
 
    defaultValueForNewComponents: [
      The value(s) to use as the default for this field when adding a new component
 
      string
    ]
}

DynamicSingleSelectMenuFieldDTO


 A dynamic field whose single value is selected from a menu of legal options

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DynamicSingleSelectMenuFieldDTO"

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
 
    options: [
      The allowed values or the menu options for this dynamic fields
 
      string
    ]*
 
    defaultValueForExistingComponents: string
    For a required dynamic field, the value to assign to existing components that have no value already set; required when the requiredFlag is true; used only when requiredFlag is being changed to true or when creating a new required dynamic field
 
    defaultValueForNewComponents: string
    The value to use as the default for this field when adding a new component
 
    permanentOptions: [
      Menu options that are fixed or static; when this is not null, the dynamic field is permanent and cannot be deleted (read-only)
 
      string
    ]
}

DynamicTextFieldDTO


 A dynamic field whose value is a text string

Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.DynamicFieldService$DynamicTextFieldDTO"

{
    id: string
    The dynamic field's unique database key (read-only)
 
    name: string*
    The dynamic field's display name, where the name is unique within the component type
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableDeviceTypeGuids: [
      For a device dynamic field, the applicable device types; when null, then this dynamic field is applicable to devices of any device type
 
      string
    ]
 
    assignmentMechanism: string
    The dynamic field's assignment mechanism (read-only)
 
    autoGroupFlag: boolean
    For a device dynamic field, whether or not auto-grouping is performed based on the value of this field in each device
 
    componentId: integer*
    Identifies the type of component to which this dynamic field applies
 
    componentName: string
    The meaning of the numeric componentId (read-only)
 
    displayInListsFlag: boolean
    Whether or not the value of this dynamic field is displayed as a column in lists of the associated components
 
    exportToDataWarehouseFlag: boolean
    Whether or not the value of this dynamic field is exported to the external data warehouse when associated components are so exported
 
    filterableFlag: boolean
    Whether or not you can filter on this dynamic field's values when filtering the associated components
 
    requiredFlag: boolean
    Whether or not a value must be specified for this dynamic field in each associated component
 
    systemAssignedFlag: boolean
    For a device dynamic field, whether the value for the dynamic field is system-assigned (true) or user-assigned (false); when true, the value can be changed only via device import, custom actions, or this API; when true, the dynamic field cannot be required (requiredFlag must be false); applies only to Text, Integer, Date, Single Select Menu, and Multi Select Menu types; for configuration profiled and auto derived type dynamic fields and for non-device dynamic fields, this flag is read-only
 
    valueType: string
    The dynamic field's value type (read-only)
 
    defaultValueForExistingComponents: string
    For a required dynamic field, the value to assign to existing components that have no value already set; required when the requiredFlag is true; used only when requiredFlag is being changed to true or when creating a new required dynamic field
 
    defaultValueForNewComponents: string
    The value to use as the default for this field when adding a new component
 
    maximumLength: integer*
    Maximum length of the value for this dynamic field
}

JsonPatch


 A list of JSON Patch operations


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

JsonPatch.OneOperation

JsonPatch.Pointer


 Pointer or path to an element or property


string
  Pointer or path to an element or property

JsonPatch.Add


 Add a value to an object or inserts it into an array. In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array. The value can be any JSON value.


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

JsonPatch.Remove


 Remove a value from an object or array.


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

JsonPatch.Replace


 Replace an existing value. THe value can be any JSON value.


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

JsonPatch.Move


 Move a value from one location to the other. "path" is the destination.


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

JsonPatch.Copy


 Copy a value from one location to another. "path" is the destination.


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

JsonPatch.Test


 Test that the specified value is set in the document at the specified path. If the test fails, then the patch as a whole is not applied. The Value can be any JSON value.


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

Was this page helpful? Yes No Submitting... Thank you

Comments