NOnotefile
device

GET /v1/projects/{projectOrProductUID}/devices

Changed on

Get Devices of a Project

Request

  • Base URL
    https://api.notefile.net
  • URL
    https://api.notefile.net/v1/projects/{projectOrProductUID}/devices
  • Auth
    HTTP bearer

Path parameters

projectOrProductUIDstring required

Query parameters

pageSizeinteger
pageNuminteger
deviceUIDstring[]

A Device UID.

tagstring[]

Tag filter. Matches the whole tag, case-insensitive. Use * as a wildcard and \* to match a literal *; all other characters, including % and _, match literally. For example, 51* matches tags starting with 51.

serialNumberstring[]

Serial number filter. Matches any value containing the filter text. Use * as a wildcard and \* to match a literal *; all other characters, including % and _, match literally.

fleetUIDstring[]
notecardFirmwarestring[]

Firmware version filter. Matches any value containing the filter text. Use * as a wildcard and \* to match a literal *; all other characters, including % and _, match literally.

locationstring[]

Location filter. Matches any value containing the filter text. Use * as a wildcard and \* to match a literal *; all other characters, including % and _, match literally.

hostFirmwarestring[]

Host firmware filter. Matches any value containing the filter text. Use * as a wildcard and \* to match a literal *; all other characters, including % and _, match literally.

productUIDstring[]

Product UID filter. Matches any value containing the filter text, case-insensitive. Use * as a wildcard and \* to match a literal *; all other characters, including % and _, match literally.

skustring[]

SKU filter. Matches any value containing the filter text. Use * as a wildcard and \* to match a literal *; all other characters, including % and _, match literally.

Response

List of Devices

has_moreboolean required

Example response

{
  "devices": [
    {
      "dfu": {
        "card": {
          "began": 1617181920,
          "crc32": 67890,
          "errors": 2,
          "length": 4096,
          "read": 1024,
          "retry": 1,
          "updated": 1617181930
        },
        "user": {
          "began": 1617181920,
          "crc32": 67890,
          "errors": 2,
          "length": 4096,
          "read": 1024,
          "retry": 1,
          "updated": 1617181930
        }
      }
    }
  ]
}

Changes

  • 76dfb036ba7fRevision changes
    • info

      added the optional property // to the response with the status

  • 11b910b6ded4Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status