Devices

The Devices Query operation takes one or more query parameters to return the matching devices. If no specific query parameters are provided in the queryParams element, all devices are returned

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.

Endpoint

<HOST>/flexnet/operations/manageDevice/devices

Method

POST

URL Params

None

Data Params

None

Example

{"queryParams":

     {"alias":

          {"value":"[Optional. A string to match part or all of the alias value]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "deviceId":

          {"value":"[Optional. A string to match part or all of the device ID]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "deviceIdType":

          {"value":"[A string to match part or all of the device ID Type value. For

                    example: UNKNOWN, STRING, ETHERNET, FLEXID9, FLEXID10, INTERNET, INTERNET6,

                    USER, TOLERANT, CONTAINER_ID, or VM_UUID.

                    When using a deviceType of SERVER, this field is mandatory.]",

          "searchType":"[One of the following: EQUALS or NOT_EQUALS]"

     },

     "parentId":

          {"value":"[Optional. A string to match part or all of the parentId which 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.]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "hostTypeName":

          {"value":"[Optional. A string to match part or all of the hostTypeName]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "soldTo":

          {"value":"[Optional. A string, in the form of the account ID, to match part or all of the

                   soldTo value]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "soldToOrgId":

          {"value":"[Optional. A string, in the form of the account ID, to match part or all of the

                   soldToOrgID value.]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "description":

          {"value":"[Optional. A string to match part or all of the description value]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "status":[The status of the device. One of the following: ACTIVE, OBSOLETE, or RETURNED],

     "addOnActivationId":

          {"value":"[Optional. A string to match part or all of the addOnActivationID value]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "addOnProductName":

          {"value":"[Optional. A string to match part or all of the addOnProductName value]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "addOnProductVersion":

          {"value":"[Optional. A string to match part or all of the addOnProductVersion value]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "featureName":

          {"value":"[Optional. A string to match part or all of the featureName value]",

          "searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"

     },

     "isServer":[Optional. True if the device is a FlexNet Embedded server device, otherwise

                       False. See Note about isServer and device types.],

     "deviceTypes":[Optional. The deviceTypes element contains one or more WSDeviceType elements.

                    One of the following: CLIENT, SERVER, SERVED_CLIENT. See Note about isServer

                    and device types.],

     "userString":[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.],

     "deviceResponseConfig":

          {"alias":[true or false],

          "description":[true or false],

          "status":[true or false],

          "servedStatus":[true or false],

          "hostTypeName":[true or false],

          "soldTo":[true or false],

          "soldToOrgId":[true or false],

          "channelPartners":[true or false],

          "preBuiltLicense":[true or false],

          "addOnActivationId":[true or false],

          "addOnCounts":[true or false],

          "addOnProduct":[true or false],

          "addOnLicense":[true or false],

          "publisherIdentity":[true or false],

          "parent":[true or false],

          "machineType":[true or false],

          "vmDetails":[true or false],

          "vmInfo":[true or false],

          "vendorDictionary":[true or false],

          "deviceUser":[true or false]},

          "updates":[true or false]},

     "batchSize":[Required. Maximum number of records to return in the response. e.g. 100],

     "pageNumber":[Defaults to 1. For example: If query returns 100 records and the batch size is

                   set to 50, enter 2 to see the second page .]

}

Response

{

   "statusInfo":    {

      "status": "SUCCESS",

      "reason": null

   },

   "failedData": null,

   "responseData": {"device": [   {

      "deviceIdentifier":       {

         "deviceType": "SERVER",

         "uniqueId": null,

         "deviceId": "HV195HYU9F92",

         "serverIds": {"serverId":          [

            "HV195HYU9F92",

            null

         ]},

         "deviceIdType": "STRING",

         "publisherName": "fnedemo"

      },

      "alias": null,

      "description": null,

      "hostTypeName": null,

      "deviceStatus": null,

      "deviceServedStatus": null,

      "channelPartners": null,

      "soldTo":       {

         "displayName": "ACC-ANU-MY19-1",

         "id": "ACC-ANU-MY19-1",

         "name": "ACC-ANU-MY19-1"

      },

      "soldToOrgId":       {

         "displayName": "ACC-ANU-MY19-1",

         "id": "ACC-ANU-MY19-1",

         "name": "ACC-ANU-MY19-1"

      },

      "hasPrebuiltLicense": null,

      "prebuiltLicense": null,

      "hasAddonLicense": null,

      "addonLicense": null,

      "publisherIdName": null,

      "addonLineItemData": [],

      "featureData": null,

      "parentIdentifier": null,

      "machineType": null,

      "vmInfo": null,

      "updates": [

          {

              "updateId": "Notif4",

              "downloadPackageId": "12",

              "platform": "Windows",

              "language": "English"

           }

      ],

      "vendorDictionary": null,

      "deviceUser": null,

      "deviceUserIdentifier": null

   }]}

}