Headers

Headers to make a request in Altair SmartWorks.

Warning: This console uses your REAL Altair SmartWorks account based on the APIKEY provided. Each request will be processed accordingly.

Streams

Data streams management

• POST /streams/ Creates a data stream packet associated to a device in Altair SmartWorks.
  More info to create a stream

  Body Parameters

  protocol:

  device:

  at:

  checksum:

  persist:

  data:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

• GET /streams/{id_developer}/ Show data stream data
  More info to show stream

  URL Parameters

  id_developer:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

• GET /streams/ Data stream list with 1000 max elements
  More info to list streams

  URL Parameters

  _t:

  protocol:

  device:

  at:

  owner:

  updater:

  created_at:

  created_at_from:

  created_at_to:

  max:

  sort:

  order:

  offset:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

• DELETE /streams/{id_developer}/ Removes the stream indicated permanently
  More info to delete streams

  URL Parameters

  id_developer:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

Status Streams

Status streams management.

• POST /status/ Creates a status stream packet associated to a device in Altair SmartWorks.
  More info to create status streams

  Body Parameters

  protocol:

  device:

  at:

  checksum:

  persist:

  data:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

• GET /streams/{id_developer}/ Show status stream data.
  More info to show a status stream

  URL Parameters

  id_developer:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

• GET /streams/ Status stream list with 1000 max elements.
  More info to list status streams

  URL Parameters

  _t:

  protocol:

  device:

  at:

  owner:

  updater:

  created_at:

  created_at_from:

  created_at_to:

  max:

  sort:

  order:

  offset:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

• DELETE /streams/{id_developer}/ Removes the status stream indicated permanently.
  More info to delete a status stream

  URL Parameters

  id_developer:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

Triggers

Triggers management in Altair SmartWorks

• POST /triggers/ Create trigger
  More info to create a trigger

  Body Parameters

  name:

  description:

  max_retries:

  push_frequency:

  enabled: true false

  id_service:

  external_configuration:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

• GET /triggers/{id_developer}/ Trigger show
  More info to show a trigger

  URL Parameters

  id_developer:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

• GET /triggers/ Triggers list, max. 1000
  More info to list triggers

  URL Parameters

  name:

  enabled: true false

  owner:

  updater:

  created_at:

  created_at_from:

  created_at_to:

  max:

  sort:

  order:

  offset:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

• PUT /triggers/{id_developer}/ Trigger update
  More info to update a trigger

  URL Parameters

  id_developer:

  Body Parameters

  payload:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body

• DELETE /triggers/{id_developer}/ Trigger delete
  More info to delete a trigger

  URL Parameters

  id_developer:

  * Please provide a valid Apikey in the "Headers" section before sending the request.

  Request

  Response Status

  Response Headers

  Response Body