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

{ 
    clearExistingValueFlag: boolean 
    Whether or not to clear or null out the existing value for the dynamic field; when true, the newValues field must be null, and the current value is set to null; when false, the current value is set to the value(s) specified by newValues, which must not be null 

     id: string * 
    The database key of the dynamic field to be updated 

     newValues: [ 
      When clearExistingValueFlag is false, the new value(s) for the dynamic field; if the dynamic field is a single-value type of field, then only the first entry is used 

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

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

{ 
    id: string 
    The remote file server's unique database key (read-only) 

     name: string * 
    The remote file server's unique display name 

     address: string * 
    Host name or IP address of the remote file server, as it is known to the devices that will access it 

     ftpTransferEnabledFlag: boolean 
    Whether or not the remote file server supports FTP file transfers and has an FTP server running on it; when true, files can be exchanged between devices and the remote file server using the FTP protocol 

     ftpTransferHomeDirectory: string 
    The FTP user's home directory, where transferred files are placed for certain path-aware devices (such as Cisco Nexus and Juniper WX); stored into the %transferPath% property during OS image snapshot and OS image deploy actions 

     ftpTransferPassword: string 
    The FTP user's password 

     ftpTransferPasswordEncryptedFlag: boolean 
    Whether or not the ftpTransferPassword value is encrypted; when false, ftpTransferPassword is in clear text 

     ftpTransferUsername: string 
    The username to be used when making an FTP connection from a device to this remote file server 

     ftpUserRestrictedToHomeDirectoryFlag: boolean 
    whether or not the FTP server is configured to restrict users to their one specific home or root directory; controls whether or not certain path-aware devices (such as Cisco Nexus and Juniper WX) include a full path in FTP copy commands; if the FTP server is unrestricted, a full path is included to ensure the file is saved to the ftpTransferHomeDirectory (stored into the %transferPath% property); if the FTP server is restricted, no full path appears in FTP commands and the file is saved to the user's default permitted directory 

     readOnlyFileSystemFlag: boolean 
    Whether or not files can be written to this remote file server; when false, you will not be able to make OS image snapshots to this server,but will be able to read image files from it for OS image deploy actions 

     scpTransferEnabledFlag: boolean 
    Whether or not the remote file server supports SCP file transfers and has an SSH/SCP server running on it; when true, files can be exchanged between devices and the remote file server using the SCP protocol 

     scpTransferPassword: string 
    The SCP user's password 

     scpTransferPasswordEncryptedFlag: boolean 
    Whether or not the scpTransferPassword value is encrypted; when false, scpTransferPassword is in clear text 

     scpTransferUsername: string 
    The username to be used when making an SCP connection from a device to this remote file server 

     tftpTransferEnabledFlag: boolean 
    Whether or not the remote file server supports TFTP file transfers and has a TFTP server running on it; when true, files can be exchanged between devices and the remote file server using the TFTP protocol 

     dynamicFields: [ 
      The dynamic fields 

       DynamicFieldValueDTO
    ] 
}

{ 
    dynamicFieldUpdates: [ 
      The updates or edits to be made to the dynamic fields in each selected remote file server 

       DynamicFieldEditDTO
    ] 

     itemsToUpdate: [ 
      Which remote file servers are to be updated or edited 

       ComponentId
    ] * 

     staticFieldUpdates: [ 
      The updates or edits to be made to the static fields in each selected remote file server 

       StaticFieldEditDTO
    ] 
}

{ 
    errorMessage: string 
    Reason the update or edit failed 

     remoteFileServer: ComponentId
    The remote file server that was requested to be updated 

     successFlag: boolean 
    Whether or not the requested update was successful 
}

{ 
    clearExistingValueFlag: boolean 
    Whether or not to clear or null out the existing value for this field; when true, the newValue field must be null, and the current value is set to false or null; when false, the current value is set to the value specified by newValue, which must not be null 

     fieldName: string * 
    Which remote file server field is to be updated or edited; the legal field names are: ftptransferenabledflag, ftptransferhomedirectory, ftptransferpassword, ftptransferusername, ftpuserrestrictedtohomedirectoryflag, readonlyfilesystemflag, scptransferenabledflag, scptransferpassword, scptransferusername, tftptransferenabledflag 

     newValue: string 
    When clearExistingValueFlag is false, the new value for the field; if the field is a flag, this value must be either "true" or "false"; if the field is a password, this value must be the cleartext password 
}