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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{
}

string
  Pointer or path to an element or property

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

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

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

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

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

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