{ 
    id: string 
    The device's unique database key 

     name: string 
    The device's unique display name 

     canCopyFlag: boolean 
   {{Whether or not the user is allowed to copy this device }}

     canDeleteFlag: boolean 
   {{Whether or not the user is allowed to delete this device }}

     canEditFlag: boolean 
   {{Whether or not the user is allowed to edit this device }}

     canViewTranscriptFlag: boolean 
    Whether or not the user can view recorded device interaction transcripts 

     deviceDetailsLink: string 
    Link to get complete details about this device 

     realmId: string 
    The database key of the realm this device belongs to 

     realmName: string 
    The name of the realm this device belongs to 

     lastSnapshotErrorMessage: string 
    Reason for the failure of the most recently attempted snapshot action 

     modelName: string 
    The discovered model 

     osImageName: string 
    The full name of the discovered operating system version 

     deviceTypeId: ComponentId 
    Identifies the owning device type and vendor 

     categoryId: integer 
    The category 

     categoryName: string 
    The meaning of the numeric categoryId 

     onlineFlag: boolean 
    Whether or not this device is online 

     discrepanciesFlag: boolean 
    Whether or not this device has discrepancies 

     violationsFlag: boolean 
    Whether or not this device has compliance violations 

     primaryInterfaceAddress: string 
    The primary interface IP address, host name, or URL 

     primaryInterfaceDeviceAgentId: string 
    The database key of the primary interface device agent 

     primaryInterfaceDeviceAgentName: string 
    The name of the primary interface device agent 

     primaryInterfaceDeviceAgentNIC: string 
    The name of the primary interface device agent NIC 

     primaryInterfaceAccessModeId: integer 
    The primary interface access mode 

     primaryInterfaceAccessModeName: string 
    The meaning of the numeric primaryInterfaceAccessModeId 

     primaryInterfaceTransferModeId: integer 
    The primary interface transfer mode 

     primaryInterfaceTransferModeName: string 
    The meaning of the numeric primaryInterfaceTransferModeId 

     primaryInterfaceDeviceSecurityProfileId: string 
    The database key of the primary interface device security profile 

     primaryInterfaceDeviceSecurityProfileName: string 
    The name of the primary interface device security profile 

     dynamicFields: [ 
      The dynamic fields 

       DynamicFieldValueDTO
    ] 

     lastSnapshotTimestamp: date-time 
    The date/time of the most recently attempted snapshot action 
    Example: 2017-01-31T13:45:00.000+0000

     lastSnapshotStatus: string 
    The status of the most recently attempted snapshot action; a null indicates the device has never attempted a snapshot 
}

{ 
    id: string 
    The group's unique database key 

     name: string 
    The group's display name 

     canCopyFlag: boolean 
    Whether or not the user is allowed to copy this group 

     canDeleteFlag: boolean 
    Whether or not the user is allowed to delete this group 

     canEditFlag: boolean 
    Whether or not the user is allowed to edit this group 

     deviceCount: integer 
    The number of devices currently in this group 

     realmId: ComponentId 
    Identifies the realm this group belongs to 

     realmDetailsLink: string 
    Link to get complete details about the parent realm 

     autoGroupFlag: boolean 
    Whether or not this group is an auto-group 

     dynamicFields: [ 
      The dynamic fields 

       DynamicFieldValueDTO
    ] 

     memberDevicesLink: string 
    Link to get a list of the member devices 
}

{ 
    components: [ 
      The components whose access control list is to be updated; components can be groups, rule sets, or templates, which are the types of components that support ACLs 

       ComponentId 
    ] * 

     customRights: { 
      The changes to be made to the rights in each component's ACL; this is a map where the key is a right string appropriate to the components, and the value is a flag indicating the type of change to make to the right; for the flag value, a null means no change, a true means grant the right, and a false means revoke the right; when this field is null, the specified roles are set back to default rights 
    } 

     roles: [ 
      The roles whose rights are to be modified in the access control list of each component 

       ComponentId 
    ] * 
}

{ 
    canEditFlag: boolean 
   {{Whether or not the user is allowed to edit (grant or revoke) the rights for the specified role (read-only) }}

     roleId: ComponentId *
    The role being granted the specified rights 

     rights: [ 
      The rights being granted to the users who belong to the specified role; the right strings used here are specific to the type of component that owns this ACL; when null, means default rights are granted to the role (that is, the rights granted by the role definition, not by this ACL); when non-null but empty, means no rights are granted to the role;otherwise, the specified rights are granted to the role 

       string 
    ] 
}

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

{ 
    availableCustomRights: [ 
      Full set of rights applicable to a component's ACL 

       string 
    ] 

     components: [ 
      The components whose access control list the user is allowed to edit; components can be groups, rule sets, or templates 

       ComponentId 
    ] 

     defaultCustomRights: [ 
      For each role the user is allowed to edit, which of the availableCustomRights are granted by that role 

       PerRoleRightsDTO
    ] 

     grantedCustomRights: [ 
      Of the availableCustomRights, the rights the user is granted, and thus the rights the user is allowed to modify (grant or revoke) in the components 

       string 
    ] 
}

{ 
    id: string 
    The database key of the dynamic field whose value this is (read-only) 

     name: string 
    The name of the dynamic field (read-only) 

     values: [ 
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types 

       string 
    ] 

     dynamicFieldDetailsLink: string 
    Link to get more detailed information about the dynamic field (read-only) 
}

{ 
    id: string 
    The group's unique database key (read-only) 

     name: string * 
    The group's display name 

     acl: [ 
      Which span actions users can execute on this group, for the accessible roles, containing group rights; applicable only when group ACLs are enabled in the system parameters; ignored on input if group ACLs are disabled; if there are multiple entries for the same role, the rights are combined together; during an update, a null value reverts the custom rights of accessible roles back to default rights 

       AclDTO
    ] 

     allowedActions: [ 
      The span actions the user is allowed to perform on this group, containing the GUIDs of these actions (read-only) 

       string 
    ] 

     canCopyFlag: boolean 
    Whether or not the user is allowed to copy this group (read-only) 

     canDeleteFlag: boolean 
    Whether or not the user is allowed to delete this group (read-only) 

     canEditFlag: boolean 
    Whether or not the user is allowed to edit this group (read-only) 

     offlineDeviceCount: integer 
    How many of the member devices are currently offline (read-only) 

     onlineDeviceCount: integer 
    How many of the member devices are currently online (read-only) 

     realmId: ComponentId *
    Identifies the realm this group belongs to 

     realmDetailsLink: string 
    Link to get complete details about the parent realm (read-only) 

     autoGroupFlag: boolean 
    Whether or not this group is an auto-group (read-only) 

     dynamicFields: [ 
      The dynamic fields 
 

• • DynamicFieldValueDTO
        ] 
    
         memberDevicesLink: string 
        Link to get a list of the member devices (read-only) 
    }

[ 
    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*
}

{ 
    role: ComponentId 
    A role that can used for editing an ACL 

     rights: [ 
      The rights granted by the role; in case of groups, these are network rights for the realm that the group belongs to 

       string 
    ] 
}