Headers

• request-id string

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

Path parameters

• spaceId string Required

  The identifier of the Space

• gatewayId string Required

  The identifier of the Gateway

Responses

• 200 application/json

  200 response

  Hide response attributes Show response attributes object

  • numberAssetsInSpace integer(int32)

    The total number of Assets currently in the Space

    Minimum value is 0, maximum value is 1000000.

  • name string Required

    The name of the Space

    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

      Not more than 10000 elements.

      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 Space. Example: '00Es43YBJfNRXNSvLmni'

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

  • createdOn string(date-time)

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

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

  • gateway object

    Additional properties are NOT allowed.

    Hide gateway attributes Show gateway attributes object

    • shortId string

      Short human-readable Gateway identifier. Example: 'AB1D'

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

    • isStatic boolean

      Indicate whether the Gateway is statically located. If so, then longitude and latitude are required.

    • latitude number(float)

      Latitude value of the coordinate. Example: 51.123

      Minimum value is -90, maximum value is 90.

    • hasPendingCommands boolean

      Indicate whether there are pending commands for the Gateway

    • rssiFilter string | integer(int32)

      The RSSI filter value for the Gateway BLE receiver (setting RSSI Filter via the API is only currently supported for Particle Gateways)

      One of:

      string-1 string integer-2 integer(int32)

      Values are FAR, NEAR, or VERY_NEAR.

      Minimum value is -127, maximum value is 0.

    • deviceId string

      Manufacturer identifier for the Gateway device. Example: 'e10fce301222e588e1d7482b'

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

    • gatewayId string Required

      Gateway identifier, which is a combination of manufacturer and deviceId. Example: 'sysLoco_e10fce301222e588e1d7482b'

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

    • productName string

      Name of Gateway product. Example: 'HGD4'

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

    • addedOn string(date-time) Required

      ISO Timestamp of when the Gateway was linked, in UTC. Example: '2023-07-21T17:32:28Z'

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

    • manufacturer string

      Gateway manufacturer. Example: 'sysLoco'

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

    • longitude number(float)

      Longitude value of the coordinate. Example: -0.123

      Minimum value is -180, maximum value is 180.

  • 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]*$.

• 404 application/json

  Space not found

  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]*$.