Itron

opencollection: 1.0.0
info:
  name: Itron Starfish Data Platform API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Tokens
    type: folder
  items:
  - info:
      name: Issue Short-Lived Bearer Token
      type: http
    http:
      method: POST
      url: https://api.data.sentience.ssni.com/api/tokens
      body:
        type: json
        data: '{}'
    docs: 'Exchange client credentials for a short-lived bearer token suitable for use

      in a browser. Per SDK docs: "You can get a token directly from the Tokens API

      using valid credentials. This token is suitable for use in a browser as it

      is short lived."

      '
- info:
    name: Devices
    type: folder
  items:
  - info:
      name: List Devices
      type: http
    http:
      method: GET
      url: https://api.data.sentience.ssni.com/api/devices
      headers:
      - name: X-Starfish-Solution
        value: ''
    docs: Retrieve all devices visible to the authenticated solution.
  - info:
      name: Register Device
      type: http
    http:
      method: POST
      url: https://api.data.sentience.ssni.com/api/devices
      headers:
      - name: X-Starfish-Solution
        value: ''
      body:
        type: json
        data: '{}'
    docs: Register a new device against the authenticated solution.
  - info:
      name: Query Devices
      type: http
    http:
      method: POST
      url: https://api.data.sentience.ssni.com/api/devices/query
      headers:
      - name: X-Starfish-Solution
        value: ''
      body:
        type: json
        data: '{}'
    docs: Query devices by filter criteria (e.g., `deviceType`).
- info:
    name: Observations
    type: folder
  items:
  - info:
      name: Get Device Observations
      type: http
    http:
      method: GET
      url: https://api.data.sentience.ssni.com/api/devices/:deviceId/observations
      headers:
      - name: X-Starfish-Solution
        value: ''
      params:
      - name: deviceId
        value: ''
        type: path
        description: Unique identifier of the device.
    docs: Fetch observations for a specific device.
  - info:
      name: Post Device Observation
      type: http
    http:
      method: POST
      url: https://api.data.sentience.ssni.com/api/devices/:deviceId/observations
      headers:
      - name: X-Starfish-Solution
        value: ''
      params:
      - name: deviceId
        value: ''
        type: path
        description: Unique identifier of the device.
      body:
        type: json
        data: '{}'
    docs: Submit sensor data for a specific device.
  - info:
      name: Query Device Observations
      type: http
    http:
      method: POST
      url: https://api.data.sentience.ssni.com/api/devices/:deviceId/observations/query
      headers:
      - name: X-Starfish-Solution
        value: ''
      params:
      - name: deviceId
        value: ''
        type: path
        description: Unique identifier of the device.
      body:
        type: json
        data: '{}'
    docs: Query observations for a specific device with filtering and pagination.
  - info:
      name: Get Latest Observations
      type: http
    http:
      method: GET
      url: https://api.data.sentience.ssni.com/api/observations
      headers:
      - name: X-Starfish-Solution
        value: ''
    docs: Retrieve the latest observations across all devices in the solution.
  - info:
      name: Query Observations
      type: http
    http:
      method: POST
      url: https://api.data.sentience.ssni.com/api/observations/query
      headers:
      - name: X-Starfish-Solution
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Query observations across all devices. Supported filters: `limit`,

      `after` (cursor), `from` (ISO-8601 inclusive), `to` (ISO-8601 exclusive),

      and a single `tags` filter.

      '
- info:
    name: Device Templates
    type: folder
  items:
  - info:
      name: List Device Templates
      type: http
    http:
      method: GET
      url: https://api.data.sentience.ssni.com/api/device-templates
      headers:
      - name: X-Starfish-Solution
        value: ''
    docs: Retrieve all device templates for the solution.
  - info:
      name: Create Device Template
      type: http
    http:
      method: POST
      url: https://api.data.sentience.ssni.com/api/device-templates
      headers:
      - name: X-Starfish-Solution
        value: ''
      body:
        type: json
        data: '{}'
    docs: Create a new device template.
  - info:
      name: Update Device Template
      type: http
    http:
      method: PUT
      url: https://api.data.sentience.ssni.com/api/device-templates/:templateId
      headers:
      - name: X-Starfish-Solution
        value: ''
      params:
      - name: templateId
        value: ''
        type: path
        description: Unique identifier of the device template.
      body:
        type: json
        data: '{}'
    docs: Update an existing device template.
  - info:
      name: Get Static Device Templates
      type: http
    http:
      method: GET
      url: https://api.data.sentience.ssni.com/api/device-templates/static
      headers:
      - name: X-Starfish-Solution
        value: ''
    docs: Retrieve platform-provided static device templates.
bundled: true