← Back to catalog

Other

IoE² IoT API - to create end-user applications

auto-generated
swirls add ijenko
actionPOSTv1.0.0

Add dynamically a functionality

Add a *Functionality* to the device. Required parameters are : - functionality class - endpoint Each device class has its own restrictions on which Functionality classes can be added and on which endpoints. Only a few devices allow to add Functionalities. |Device class|Functionality class|Endpoints| |------------|-------------------|---------| |MINT |CurrentPeriod |1,2,3 | |MINT |ElectricityRates |1,2,3 | |MINT |GenericRate |1,2,3 | **Note**: requires full access to the *Account*.

Source
actionPOSTv1.0.0

Ask for a new password

Trigger the request of a new password. The account administrator will receive an e-mail with an URL pointing to a form to allow him/her to enter a new password. The old password is still functional until a new one is submitted. Either the login or e-mail of the account must be given.

Source
actionPOSTv1.0.0

Change the password

Set a new password for the account. **Note**: requires full access to the *Account*.

Source
actionPOSTv1.0.0

Create a Place

Create a new *Place*. A *Device* (`class`: `MINT`, `address`: `0`) is automatically created and attached to the new *Place*. **Note:** requires full access to the *Account*.

Source
actionPOSTv1.0.0

Create a Program

Create a new *Program*. **Note**: requires full access to the *Account*.

Source
actionDELETEv1.0.0

Delete a Program

Delete a *Program*. **Note**: requires full access to the *Account*.

Source
actionDELETEv1.0.0

Delete a User

Delete a *User* from this *Account*, and revoke all his/her *Tokens*. **Note**: requires full access to the *Account*.

Source
actionGETv1.0.0

Get an Attribute value

Get the *Attribute* value and the last time when it changed.

Source
actionGETv1.0.0

Get autonomy rate of the place

Compute the autonomy rate of the *Place* on a time period. `autonomy = 1 - (elec_drawn / elec_total_usage)`

Source
actionGETv1.0.0

Get electricity flows setup

Get the mapping of functionalities to electricity flows. A functionality is attached to *at most* one flow.

Source
actionGETv1.0.0

Get electricity virtual flows

Get the mapping of virtual electricity flows to functionalities. Some rules are applied to expand the virtual flows using the concrete flows available. The `factor` tells how each energy value coming from a functionality must be added with values from other functionality to compute the energy of the virtual flow. Factors are usually `1` or `-1`. The `code` property gives the result which may be partial: - If all flows are available, `200000` is returned. - If no flows are available (indicating that the place has no electricity functionality or that no functionality has been attached to a flow), the `code` is `200001`. The `missing` property contains all the requested flows. - If some flows are missing, the `code` is `200002` and the `missing` property lists them.

Source
actionGETv1.0.0

Get history of multiple attributes

Get the values of multiple *Attributes* and their history. If the `names` parameter is not given, all the attributes of the *Functionality* are returned. As the list may be huge, this must be avoided. If the `to` parameter is set, `from` must also be set. If `from` is not set, only the last value is returned. The `surround` parameter allows to ask also for one value beyond each interval boundaries. The request may fail if too many values are asked.

Source
actionGETv1.0.0

Get self-consumption rate of the place

Compute the self-consumption rate of the *Place* on a time period. `selfConsumption = 1 - (elec_feed_in / elec_total_usage)`

Source
actionGETv1.0.0

Information about the User

Get information on the authenticated *User* who does the request. The *login* property is returned only if the *User* is the administrator of the *Account*.

Source
actionGETv1.0.0

List Buses

Get the list of *Buses* available on the gateway of this *Place*. If `withPairing` is `true`, return only buses that allow device pairing (see `/places/{placeId}/buses/{busId}/pairing`).

Source
actionGETv1.0.0

List Functionalities

Get the list of *Functionalities* available in this *Place*.

Source
actionGETv1.0.0

List metadata

Get the metadata.

Source
actionGETv1.0.0

List metadata

Get the metadata of the *Notification*.

Source
actionGETv1.0.0

List metadata

Get the metadata of the *Program*.

Source
actionGETv1.0.0

List Notifications

Get the list of *Notifications* available in this *Place*.

Source
actionGETv1.0.0

List of Devices

Get the list of *Devices* available in this *Place*.

Source
actionGETv1.0.0

List Places of the Account

List the *Places* of the account. **Note:** requires full access to the *Account*.

Source
actionGETv1.0.0

List Programs

Get the list of *Programs* available in this *Place*.

Source
actionGETv1.0.0

List tags

Get the tags of a *Device*.

Source
actionGETv1.0.0

List tags

Get the tags of a *Functionality*.

Source
actionPATCHv1.0.0

Modify a Program

Modify a *Program*: - name - status (enabled/disabled) - code **Note**: requires full access to the *Account*.

Source
actionPATCHv1.0.0

Modify a User

Modify a *User*. **Note**: requires full access to the *Account*.

Source
actionPATCHv1.0.0

Modify metadata

Modify the metadata. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON value.

Source
actionPATCHv1.0.0

Modify metadata

Modify the metadata. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON value.

Source
actionPATCHv1.0.0

Modify metadata

Modify the metadata. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON value.

Source
actionPATCHv1.0.0

Modify metadata

Modify the metadata. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON value.

Source
actionPATCHv1.0.0

Modify metadata of a Notification

Modify the metadata of a *Notification*. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON value.

Source
actionPATCHv1.0.0

Modify metadata of a Program

Modify the metadata of a *Program*. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON value.

Source
actionPATCHv1.0.0

Modify tags

Modify the tags of a *Device*.

Source
actionPATCHv1.0.0

Modify tags

Modify the tags of a *Functionality*.

Source
actionPOSTv1.0.0

New User

Add a *User*. **Note**: requires full access to the *Account*.

Source
actionPOSTv1.0.0

Run actions

Run an *Action* on zero, one or multiple Functionalities selected with tags.

Source
actionPOSTv1.0.0

Run actions

Run an *Action* on zero, one or multiple *Functionalities* selected with tags. *Device* and *Functionality* selection are combined with « AND ». If no functionality is matched by the device/functionality selection, an empty array is returned.

Source
actionPOSTv1.0.0

Run an action

Run an action on the Functionality.

Source
actionPOSTv1.0.0

Run the Program

Launch the *Program*. The result will be available later in the run history.

Source
actionGETv1.0.0

State of the pairing window

Get the state of the pairing window of the *Bus*. **Note**: requires full access to the *Account*.

Source
actionPATCHv1.0.0

Update a Device

Modify information about a *Device*: its name.

Source
actionPATCHv1.0.0

Update a Place

Change information about a *Place*. **Note**: requires full access to the *Account*.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec