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.

Rules

Rules management in Altair SmartWorks

• POST /rules/ Create rule
  More info to create a rule

  Body Parameters

  name:

  description:

  enabled: true false

  script:

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

  Request

  Response Status

  Response Headers

  Response Body

• GET /rules/{id_developer}/ Show a rule
  More info to show a rule

  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 /rules/ Rules list, max 1000
  More info to list rules

  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 /rules/{id_developer}/ Rule update
  More info to update a rule

  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 /rules/{id_developer}/ Rule delete
  More info to delete a rule

  URL Parameters

  id_developer:

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

  Request

  Response Status

  Response Headers

  Response Body

Listeners

Listeners management in Altair SmartWorks

• POST /listeners/ Create listener
  More info to create a listener

  Body Parameters

  name:

  description:

  event: Event CronEvent Data Persisted Event Data Received Event Device Change State Event Status Data Persisted Event Status Data Received Event Stream Data Persisted Event Stream Data Received

  enabled: true false

  entity:

  if_expression:

  then_expression:

  then_rule:

  else_expression:

  else_rule:

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

  Request

  Response Status

  Response Headers

  Response Body

• GET /listeners/{id_developer}/ Show listener
  More info to show a listener

  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 /listeners/ Listener list, max. 1000
  More info to list listeners

  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 /listeners/{id_developer}/ Update a service
  More info to update a listener

  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 /listeners/{id_developer}/ Delete a service
  More info to delete a listener

  URL Parameters

  id_developer:

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

  Request

  Response Status

  Response Headers

  Response Body