FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Complex Type: searchDevicesParametersType

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
name  SimpleQueryType  0..1 

Optional. A name contains:

  • value—a string to match part or all of the device name.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS
deviceId  SimpleQueryType  0..1 

Optional. A deviceId contains:

  • value—a string to match part or all of the device ID.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS
deviceIdType  DeviceIdTypeQueryType  0..1 

Device ID type. The value for deviceIdType can be:

  • UNKNOWN

  • STRING

  • ETHERNET

  • FLEXID9

  • FLEXID10

  • EXTENDED

  • INTERNET

  • INTERNET6

  • USER

  • TOLERANT

  • VM_UUID

TOLERANT should only be used to create a device as the result of a capability request sent from the device itself. That is, FNO honors requests with ID type of TOLERANT, but because there is no FNO code to support it, it should never be used to create or update a device.
deviceClasses  deviceClassList  0..1 

One of the following:

  • CLIENT

  • SERVER

  • SERVED_CLIENT
hosted  boolean  0..1  If true, limits the servers and served clients returned to hosted instances.
parentId  SimpleQueryType  0..1 

Optional. A parentId contains:

  • value—a string to match part or all of the parent server ID.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS
hostTypeName  SimpleQueryType  0..1 

Optional. A hostTypeName contains:

  • value—a string to match part or all of the host type name.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS
soldTo  SimpleQueryType  0..1 

Optional. A soldTo account name contains:

  • value—a string to match part or all of the sold to account name.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS
soldToAcctId  SimpleQueryType  0..1 

Optional. A soldToAcctId contains:

  • value—a string to match part or all of the sold to account ID. 

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS 
description  SimpleQueryType  0..1 

Optional. A description contains:

  • value—a string to match part or all of the description.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS
status  DeviceStatusQueryType  0..1  See DeviceStateQueryType.
addOnEntitlementId  SimpleQueryType  0..1 

Optional. An addOnEntitlementId contains:

  • value—a string to match part or all of the add-on-entitlement ID.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS 
addOnActivationId  SimpleQueryType  0..1 

Optional. An addOnActivationId contains:

  • value—a string to match part or all of the add-on activation ID.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS 
addOnProductName  SimpleQueryType  0..1 

Optional. An addOnProductName contains:

  • value—a string to match part or all of the add-on product name.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS 
addOnProductVersion  SimpleQueryType  0..1 

Optional. An addOnProductVersion contains:

  • value—a string to match part or all of the add-on product version number.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS 
addOnPartNumber  SimpleQueryType  0..1 

Optional. An addOnPartNumber contains:

  • value—a string to match part or all of the add-on part number.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS 
featureName  SimpleQueryType  0..1 

Optional. A featureName contains:

  • value—a string to match part or all of the Feature name (for served clients).

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS 
userString  SimpleQueryType  0..1 

Optional. A userString contains:

  • value—a string to match part or all of the device user.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS 
lastModifiedDate  DateQueryType  0..1  Date the device was last modified.
addOnExpirationDate  DateQueryType  0..1 

You can search and filter by addOnExpirationDate. This enhancement enables producers to filter out devices that have expired licenses.

Here is an example request:

<urn:addOnExpirationDate>
  <urn:value>2015-10-10</urn:value>
  <urn:searchType>AFTER</urn:searchType>
</urn:addOnExpirationDate>

The addOnExpirationDate parameter is returned in the response, based on the response config parameter.
hasLicense  boolean  0..1 

You can search and filter by hasLicense. This enhancement enables producers to filter out devices that have invalid licenses.

Here is an example request:

<urn:hasLicense>true</urn:hasLicense>

The hasLicense parameter is returned in the response, based on the response config parameter.
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.

FlexNet Operations SOAP Web Services Guide

July 2025