APIs & Developers
\
API Glossary

API Glossary

Switch-api Python Package (switch-api · PyPI)

A Python package for interacting with the Switch Automation Platform to retrieve and ingest data as well as register and deploy Tasks that automate processes to ingest, transfer and/or analyze data.

Dataset Module

A module for interacting with Data Sets from the Switch Automation Platform. Provides the ability to list Data Sets and their folder structure as well as retrieve Data Sets with the option to pass parameters.

Integration Module

A module for integrating data with the Switch Automation Platform. Provides the ability to create, update, and retrieve assets (i.e., devices, sensors, sites, work orders, tags, metadata); ingest and retrieve sensor readings; and ingest and retrieve data from Azure Data Explorer (ADX).

Pipeline Module

Module defining the Task types:

IntegrationTask

  • Base class used to create integrations between the Switch Automation Platform and other platforms, low-level services, or hardware.
  • Examples include:
  • Pulling readings or other types of data from REST APIs
  • Protocol Translators which ingest data sent to the platform via email, ftp, or direct upload within platform.

DiscoverableIntegrationTask

Base class used to create integrations between the Switch Automation Platform and 3rd party APIs.

Similar to the IntegrationTask, but includes a secondary method `run_discovery()` which triggers discovery of available points on the 3rd party API and upserts these records to the Switch Platform backend so that the records are available in Build / Discovery and& Selection UI.

Examples include:

  • Pulling readings or other types of data from REST APIs

AnalyticsTask

Base class used to create specific analytics functionality which may leverage existing data from the platform. Each task may add value to, or supplement, this data and write it back.

Examples include:

  • Anomaly Detection
  • Leaky Pipes
  • Peer Tracking

LogicModuleTask

Base class that handles the running, reprocessing and scheduling of the legacy logic modules in a way which enables integration with other platform functionality.

QueueTask

Base class used to create data pipelines that are fed via a queue.

EventWorkOrderTask

Base class is used to create work orders in 3rd party systems via tasks that are created in the Events UI of the Switch Automation Platform.

Automation Module

A module containing methods used to register, deploy, cancel, and test Tasks. Includes helper functions for retrieving details of existing Tasks and their deployments, including process history and logs, on the Switch Automation Platform.

This is some text inside of a div block.