Read configurations

GET /networks/{network_identifier}/sensors/{sensor_identifier}/configurations

Returns a sensor's configurations in pages of 64 elements sorted ascendingly by revision.

Path parameters

  • network_identifier string Required

    Format should match the following pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$.

  • sensor_identifier string Required

    Format should match the following pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$.

Query parameters

  • direction string

    The direction of the page based on the cursor. If no cursor is provided, next returns the first page and previous returns the last page.

    Values are next or previous. Default value is next.

  • revision integer

    The cursor of the query. Depending on the direction, the request returns the next or previous elements. The element the cursor references is not included in the response.

Responses

  • 200

    OK

    Hide response attributes Show response attributes array[object]
    • value object

      Configurations are JSON objects that are relayed to the sensors over MQTT. Sensors are expected to validate the configurations they receive and respond with positive or negative acknowledgments.

      Hide value attribute Show value attribute object
      • Additional properties are allowed
    • revision integer

      Configurations are assigned monotonically increasing revision numbers. The revision is used as an identifier in the communication with the sensors and can clearly match configurations to measurements and logs.

    • creation_timestamp number
    • publication_timestamp number
    • acknowledgment_timestamp number
    • success boolean
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

GET /networks/{network_identifier}/sensors/{sensor_identifier}/configurations
curl \
 -X GET https://example.com/networks/575a7328-4e2e-4b88-afcc-e0b5ed3920cc/sensors/575a7328-4e2e-4b88-afcc-e0b5ed3920cc/configurations \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "value": {
      "measurement_interval": 8.5,
      "cache": true,
      "strategy": "default"
    },
    "revision": 42,
    "creation_timestamp": 1683644400.0,
    "publication_timestamp": 1683644400.0,
    "acknowledgment_timestamp": 1683644400.0,
    "success": true
  }
]
Response examples (200)
[
  {
    "value": {
      "cache": true,
      "strategy": "default",
      "measurement_interval": 8.5
    },
    "revision": 42,
    "creation_timestamp": 1683644400.0,
    "publication_timestamp": 1683644400.0,
    "acknowledgment_timestamp": 1683644400.0,
    "success": true
  }
]