Search for Devices in the System

List devices

GET /api/v1/search/device/

List all the devices in the System matching some filter criteria.

Example request:

GET /api/v1/search/device/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "sensitiveDeviceNameContains": "Test"
}

Request JSON Object:

• sensitiveDeviceTenantIdEquals (string) – See sensitiveDeviceTenantIdEquals from Search criteria.

• sensitiveDeviceTypeEquals (string) – See sensitiveDeviceTypeEquals from Search criteria.

• sensitiveDeviceGroupIdStarts (string) – See sensitiveDeviceGroupIdStarts from Search criteria.

• sensitiveDeviceGroupIdContains (string) – See sensitiveDeviceGroupIdContains from Search criteria.

• sensitiveDeviceGroupIdEquals (string) – See sensitiveDeviceGroupIdEquals from Search criteria.

• insensitiveDeviceGroupIdStarts (string) – See insensitiveDeviceGroupIdStarts from Search criteria.

• insensitiveDeviceGroupIdContains (string) – See insensitiveDeviceGroupIdContains from Search criteria.

• insensitiveDeviceGroupIdEquals (string) – See insensitiveDeviceGroupIdEquals from Search criteria.

• sensitiveDeviceNameStarts (string) – See sensitiveDeviceNameStarts from Search criteria.

• sensitiveDeviceNameContains (string) – See sensitiveDeviceNameContains from Search criteria.

• sensitiveDeviceNameEquals (string) – See sensitiveDeviceNameEquals from Search criteria.

• insensitiveDeviceNameStarts (string) – See insensitiveDeviceNameStarts from Search criteria.

• insensitiveDeviceNameContains (string) – See insensitiveDeviceNameContains from Search criteria.

• insensitiveDeviceNameEquals (string) – See insensitiveDeviceNameEquals from Search criteria.

• sensitiveDeviceNetAddressStarts (string) – See sensitiveDeviceNetAddressStarts from Search criteria.

• sensitiveDeviceNetAddressContains (string) – See sensitiveDeviceNetAddressContains from Search criteria.

• sensitiveDeviceNetAddressEquals (string) – See sensitiveDeviceNetAddressEquals from Search criteria.

• insensitiveDeviceNetAddressStarts (string) – See insensitiveDeviceNetAddressStarts from Search criteria.

• insensitiveDeviceNetAddressContains (string) – See insensitiveDeviceNetAddressContains from Search criteria.

• insensitiveDeviceNetAddressEquals (string) – See insensitiveDeviceNetAddressEquals from Search criteria.

• sensitiveDeviceMacAddressStarts (string) – See sensitiveDeviceMacAddressStarts from Search criteria.

• sensitiveDeviceMacAddressContains (string) – See sensitiveDeviceMacAddressContains from Search criteria.

• sensitiveDeviceMacAddressEquals (string) – See sensitiveDeviceMacAddressEquals from Search criteria.

• insensitiveDeviceMacAddressStarts (string) – See insensitiveDeviceMacAddressStarts from Search criteria.

• insensitiveDeviceMacAddressContains (string) – See insensitiveDeviceMacAddressContains from Search criteria.

• insensitiveDeviceMacAddressEquals (string) – See insensitiveDeviceMacAddressEquals from Search criteria.

• responseSizeLimit (integer) – See responseSizeLimit from Search criteria.

• backendName (string) – See backendName from Search criteria.

• backendExternalName (string) – See backendExternalName from Search criteria.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "devices": [
      { "tenantId": "ServiceProvider1", "isEnterprise": true, "groupId": "GroupExample1", "deviceName": "DeviceNameExample1", "deviceType": "DeviceTypeExample1", "netAddress": "", "macAddress": "", "status": "Online" },
      { "tenantId": "ServiceProvider2", "isEnterprise": true, "groupId": "GroupExample2", "deviceName": "DeviceNameExample2", "deviceType": "DeviceTypeExample2", "netAddress": "", "macAddress": "", "status": "Online" },
      ]
}

Response JSON Object:

• devices (array) – a list of device objects as defined as Device in List attributes.

Status Codes:

• 200 OK – no error

The behaviour of the search API is controlled by the following configuration settings:

"MULTI_AS_BACKEND_IN_SYSTEM_SEARCH_RESULTS": true

Explanation of the parameters:

• MULTI_AS_BACKEND_IN_SYSTEM_SEARCH_RESULTS: if true, the backendName and backendExternal name of the AS hosting the device will be added in each element of the answer. The default value is true as by default a multi-as user is allowed to see what backend is used.