Complex Type: getDevicesParametersType

Description

Note: Some elements apply only to served client devices while others apply only to server devices and client devices. Elements that start with feature are specific to served clients. Elements that start with addOn or preBuilt are specifc to server devices and client devices.

Query results can be restricted to one or more device types listed in the deviceTypes element. If deviceTypes is not defined, the query results depend upon whether or not isServer is set and, if so, what that setting is. If isServer is set to true, the query results include only server devices. If isServer is set to false, the query results include only client devices. If neither deviceTypes nor isServer is set, query results include all three types of devices.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
alias	SimpleQueryType	0..1	Optional. An alias for the device ID. An alias element contains a value and a search type. A value is a string to match part or all of the alias, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
deviceId	SimpleQueryType	0..1	Optional. A deviceId element contains a value and search type. A value is a string to match part or all of the deviceId, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
deviceIdType	DeviceIdTypeQueryType	0..1	A deviceIdType element contains a value and search type. The value is a string to match part or all of the deviceIdType: UNKNOWN STRING ETHERNET FLEXID9 FLEXID10 INTERNET INTERNET6 USER TOLERANT VM_UUID NOTE: When using a deviceType of SERVER, this field is mandatory. The searchType is one of the following enumSearchType values: EQUALS NOT_EQUALS
parentId	SimpleQueryType	0..1	Optional. A parentId corresponds to the Served By value for a served client in the admin console UI; it identifies the served client’s parent FlexNet Embedded server device. A parentId element contains a value and a search type. A value is a string to match part or all of the parentId, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
hostTypeName	SimpleQueryType	0..1	Optional. A hostTypeName element contains a value and search type. A value is a string to match part or all of the hostTypeName, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
soldTo	SimpleQueryType	0..1	Optional. A soldTo element contains a value and search type. A value is a string, in the form of the account name, to match part or all of the soldTo, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
soldToAcctId	SimpleQueryType	0..1	Optional. A soldToAcctId element contains a value and search type. A value is a string, in the form of the account ID, to match part or all of the soldToAcctId, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
description	SimpleQueryType	0..1	Optional. A description element contains a value and search type. A value is a string to match part or all of the description, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
status	DeviceStateQueryType	0..1	Optional. The status of the device. See DeviceStateQueryType.
addOnActivationId	SimpleQueryType	0..1	Optional. An addOnActivationID element contains a value and search type. A value is a string to match part or all of the addOnActivationID, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
addOnProductName	SimpleQueryType	0..1	Optional. An addOnProductName element contains a value and search type. A value is a string to match part or all of the addOnProductName, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
addOnProductVersion	SimpleQueryType	0..1	Optional. An addOnProductVersion element contains a value and search type. A value is a string to match part or all of the addOnProductVersion, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
featureName	SimpleQueryType	0..1	Optional. A featureName element contains a value and search type. A value is a string to match part or all of the featureName, and a searchType is one of the following simpleSearchType values: STARTS_WITH CONTAINS ENDS_WITH EQUALS
isServer	boolean	0..1	Optional. True if the device is a FlexNet Embedded server device. (See note about isServer and deviceTypes.)
deviceTypes	deviceTypeList	0..1	Optional. The deviceTypes element contains one or more WSDeviceType elements. These can be CLIENT, SERVER, SERVED_CLIENT. (See note about isServer and deviceTypes.)
userString	SimpleQueryType	0..1	Allows users to request devices with matching Device User. Results for this request depend on how the tenant has configured Device User Option. If the Device User Option is set to Off, the userString field is ignored, and the response states that this criteria is not supported If the Device User Option is set to On with no validation, the userString is matched with string value of the Device User. If the Device User Option is set to On with validation, the userString is matched with the email of the Device User.
siteName	SimpleQueryType	0..1	The getDevice, getDevicesQuery and searchDevices methods can return the siteName attribute value. You can use <responseConfig> to include or exclude the site name in the response. Also, siteName is available as a search parameter for the getDevicesQuery and searchDevices methods.