Headers

• request-id string

  Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00

Path parameters

• workspaceId string Required

  The identifier of the Workspace

Query parameters

• limit string

  Number of items to return. Default: 10. Maximum: 10000

• nextToken string

  Pagination token to get next page of items

• searchTerm string

  String to match name of Assets

• inSpaceIds string

  Filter the Assets to those currently in a set of Spaces. Comma-separated list, for example: '?inSpaceIds={spaceId1},{spaceId2},{spaceId3}'

Responses

• 200 application/json

  200 response

  Hide response attributes Show response attributes object

  • total integer(int32)

    The total number of items in all pages of results

    Minimum value is 0, maximum value is 1000000.

  • nextToken string

    Pagination token

    Maximum length is 5000. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

  • items array[object] Required
    Hide items attributes Show items attributes object

    • inSpaces array[object]
      Hide inSpaces attributes Show inSpaces attributes object

      • spaceName string Required

        The name of the Space

        Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

      • spaceId string Required

        Unique identifier of the Space. Example: '00Es43YBJfNRXNSvLmni'

        Maximum length is 20. Format should match the following pattern: ^[-_A-Za-z0-9]*$.

      • hasExited boolean

        Indicate whether the Asset has exited the Space

      • enteredOn string(date-time) Required

        Date that the Asset entered the Space. Example: '2019-07-21T17:32:28Z'

        Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

      • exitedOn string(date-time)

        Date that the Asset exited the Space. Example: '2019-07-21T17:32:28Z'

        Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

    • temperatures object

      Additional properties are NOT allowed.

      Hide temperatures attributes Show temperatures attributes object

      • nextToken string

        Pagination token

        Maximum length is 5000. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

      • items array[object] Required
        Hide items attributes Show items attributes object

        • timestamp string(date-time) Required

          Timestamp of the temperature. Example: '2019-07-21T17:32:28Z'

          Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

        • degreesCelsius number(float) Required

          Temperature value rounded to 1 decimal place, for each minute of the hour. Example: -2.1

          Minimum value is -100, maximum value is 500.

    • name string Required

      The name of the Asset

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • locations object

      Additional properties are NOT allowed.

      Hide locations attributes Show locations attributes object

      • nextToken string

        Pagination token

        Maximum length is 5000. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

      • items array[object] Required
        Hide items attributes Show items attributes object

        • lastSeenTimestamp string(date-time)

          Timestamp last seen at the location. Example: '2019-07-21T17:32:28Z'

          Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

        • coordinate object Required

          Additional properties are NOT allowed.

          Hide coordinate attributes Show coordinate attributes object

          • latitude number(float) Required

            Latitude value of the coordinate. Example: 51.123

            Minimum value is -90, maximum value is 90.

          • accuracy integer(int32)

            The horrizontal accuracy in metres

            Minimum value is 0, maximum value is 1000000.

          • longitude number(float) Required

            Longitude value of the coordinate. Example: -0.123

            Minimum value is -180, maximum value is 180.

        • address object

          Additional properties are NOT allowed.

          Hide address attributes Show address attributes object

          • country string

            The country name. Example 'United Kingdom'

            Maximum length is 255.

          • road string

            The road name. Example 'Downing Street'

            Maximum length is 255.

          • city string

            The city name. Example 'London'

            Maximum length is 255.

          • district string

            The district name. Example 'Westminster'

            Maximum length is 255.

          • postalCode string

            The postal code. Example 'SW1A 2AA'

            Maximum length is 10.

          • county string

            The county name. Example 'Greater London'

            Maximum length is 255.

          • state string

            The state name. Example 'England'

            Maximum length is 255.

        • error integer(int32)

          The horrizontal error in metres [Deprecated - use coordinate.accuracy instead]

          Minimum value is 0, maximum value is 1000000.

        • timestamp string(date-time) Required

          Timestamp of the location. Example: '2019-07-21T17:32:28Z'

          Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

    • id string Required

      Unique identifier of the Asset. Example: '00Es43YBJfNRXNSvLmni'

      Maximum length is 20. Format should match the following pattern: ^[-_A-Za-z0-9]*$.

    • label object

      Additional properties are NOT allowed.

      Hide label attributes Show label attributes object

      • bleId integer(int32) Required

        Label BLE identifier. Example: 123

        Minimum value is 0, maximum value is 2147483647.

      • nfcId string Required

        Label NFC identifier, used when creating an Asset and linking a Label at the same time. Example: '0000007B'

        Maximum length is 20. Format should match the following pattern: ^[a-zA-Z0-9]*$.

      • addedOn string(date-time) Required

        Date that the Label was linked to the Asset, in UTC. Example: '2019-07-21T17:32:28Z'

        Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

    • createdOn string(date-time)

      Date that the Asset was created, in UTC. Example: '2019-07-21T17:32:28Z'

      Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

    • workspaceId string(uuid) Required

      Unique identifier of the workspace. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'

      Maximum length is 36. Format should match the following pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$.

• 401 application/json

  Unauthorized

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

• 403 application/json

  Forbidden

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

• 429 application/json

  Too Many Requests

  Hide response attribute Show response attribute object

  • errors array[object] Required
    Hide errors attributes Show errors attributes object

    • code string

      An application-specific error code, expressed as a string value

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • id string

      A unique identifier for this particular occurrence of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

    • detail string

      A human-readable explanation specific to this occurrence of the problem

      Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • title string

      A short, human-readable summary of the problem

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • status string

      The HTTP status code applicable to this problem, expressed as a string value

      Maximum length is 3. Format should match the following pattern: ^[0-9]*$.