flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

Account_changePassword

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

OnInit
./lib/actions/Account_changePassword.js
OnStartup
-
OnClose
-

Attributes

-

Account_places

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

OnInit
./lib/actions/Account_places.js
OnStartup
-
OnClose
-

Attributes

-

Account_newPlace

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*.

OnInit
./lib/actions/Account_newPlace.js
OnStartup
-
OnClose
-

Attributes

-

Account_tokens

List the active *Tokens* on the account. **Note:** requires full access to the *Account*.

OnInit
./lib/actions/Account_tokens.js
OnStartup
-
OnClose
-

Attributes

-

Account_revokeToken

Revoke the given *Token*. **Note:** requires full access to the *Account*.

OnInit
./lib/actions/Account_revokeToken.js
OnStartup
-
OnClose
-

Attributes

-

Account_users

Get the list of *Users* of this *Account*.

OnInit
./lib/actions/Account_users.js
OnStartup
-
OnClose
-

Attributes

-

Account_newUser

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

OnInit
./lib/actions/Account_newUser.js
OnStartup
-
OnClose
-

Attributes

-

Account_deleteUser

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

OnInit
./lib/actions/Account_deleteUser.js
OnStartup
-
OnClose
-

Attributes

-

Account_getUser

Get information about a *User* in the same *Account*.

OnInit
./lib/actions/Account_getUser.js
OnStartup
-
OnClose
-

Attributes

-

Account_patchUser

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

OnInit
./lib/actions/Account_patchUser.js
OnStartup
-
OnClose
-

Attributes

-

User_getMetadata

Get the metadata.

OnInit
./lib/actions/User_getMetadata.js
OnStartup
-
OnClose
-

Attributes

-

User_patchMetadata

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.

OnInit
./lib/actions/User_patchMetadata.js
OnStartup
-
OnClose
-

Attributes

-

AuthAccountLogin

Get an access+refresh tokens pair from login and password information. The *access token* obtained with this request can then be used in an `Access-Token` HTTP header or in a `token` URL query parameter in requests that require authentication. The *refresh token* can be used with `/auth/refresh` when the *access token* expires to retrieve a new *access token*. The lifetime of the refresh token is the maximum lifetime of this authentication request. The default lifetime of the *refresh token* is defined by the `appId` used. The `ttl` input parameter allows to request a *refresh token* with a shorter lifetime. To implement *logout*, use `/auth/revoke`.

OnInit
./lib/actions/AuthAccountLogin.js
OnStartup
-
OnClose
-

Attributes

-

AuthRefreshToken

Get a new *access token* using a valid *refresh token*. This is a **replacement** of the *access token*: if an existing *access token* was still not expired, it is invalidated.

OnInit
./lib/actions/AuthRefreshToken.js
OnStartup
-
OnClose
-

Attributes

-

AuthResetPassword

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.

OnInit
./lib/actions/AuthResetPassword.js
OnStartup
-
OnClose
-

Attributes

-

AuthRevokeToken

Invalidate the authentication used for the request. The access token and the refresh token will be invalid after this request. This request is typically called to implement logout.

OnInit
./lib/actions/AuthRevokeToken.js
OnStartup
-
OnClose
-

Attributes

-

Devices_get

Get information about a *Device*.

OnInit
./lib/actions/Devices_get.js
OnStartup
-
OnClose
-

Attributes

-

Devices_patch

Modify information about a *Device*: its name.

OnInit
./lib/actions/Devices_patch.js
OnStartup
-
OnClose
-

Attributes

-

Device_addFunctionality

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*.

OnInit
./lib/actions/Device_addFunctionality.js
OnStartup
-
OnClose
-

Attributes

-

Device_getMetadata

Get the metadata.

OnInit
./lib/actions/Device_getMetadata.js
OnStartup
-
OnClose
-

Attributes

-

Device_patchMetadata

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.

OnInit
./lib/actions/Device_patchMetadata.js
OnStartup
-
OnClose
-

Attributes

-

Device_run

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

OnInit
./lib/actions/Device_run.js
OnStartup
-
OnClose
-

Attributes

-

Device_getTags

Get the tags of a *Device*.

OnInit
./lib/actions/Device_getTags.js
OnStartup
-
OnClose
-

Attributes

-

Device_patchTags

Modify the tags of a *Device*.

OnInit
./lib/actions/Device_patchTags.js
OnStartup
-
OnClose
-

Attributes

-

Functionalities_get

Get the *Functionality*.

OnInit
./lib/actions/Functionalities_get.js
OnStartup
-
OnClose
-

Attributes

-

Functionality_patch

Modify information about a *Functionality*: its name.

OnInit
./lib/actions/Functionality_patch.js
OnStartup
-
OnClose
-

Attributes

-

Functionality_values

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.

OnInit
./lib/actions/Functionality_values.js
OnStartup
-
OnClose
-

Attributes

-

Functionality_value

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

OnInit
./lib/actions/Functionality_value.js
OnStartup
-
OnClose
-

Attributes

-

Functionality_set

Modify the value of the *Attribute*.

OnInit
./lib/actions/Functionality_set.js
OnStartup
-
OnClose
-

Attributes

-

Functionality_getMetadata

Get the metadata.

OnInit
./lib/actions/Functionality_getMetadata.js
OnStartup
-
OnClose
-

Attributes

-

Functionality_patchMetadata

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.

OnInit
./lib/actions/Functionality_patchMetadata.js
OnStartup
-
OnClose
-

Attributes

-

Functionality_run

Run an action on the Functionality.

OnInit
./lib/actions/Functionality_run.js
OnStartup
-
OnClose
-

Attributes

-

Functionality_getTags

Get the tags of a *Functionality*.

OnInit
./lib/actions/Functionality_getTags.js
OnStartup
-
OnClose
-

Attributes

-

Functionality_patchTags

Modify the tags of a *Functionality*.

OnInit
./lib/actions/Functionality_patchTags.js
OnStartup
-
OnClose
-

Attributes

-

Me_get

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*.

OnInit
./lib/actions/Me_get.js
OnStartup
-
OnClose
-

Attributes

-

Me_patch

Update *User* information (locale).

OnInit
./lib/actions/Me_patch.js
OnStartup
-
OnClose
-

Attributes

-

Notification_delete

Delete a *Notification*.

OnInit
./lib/actions/Notification_delete.js
OnStartup
-
OnClose
-

Attributes

-

Notifications_get

Get information about a *Notification*.

OnInit
./lib/actions/Notifications_get.js
OnStartup
-
OnClose
-

Attributes

-

Notification_patch

Modify a *Notification*.

OnInit
./lib/actions/Notification_patch.js
OnStartup
-
OnClose
-

Attributes

-

Notification_getMetadata

Get the metadata of the *Notification*.

OnInit
./lib/actions/Notification_getMetadata.js
OnStartup
-
OnClose
-

Attributes

-

Notification_patchMetadata

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.

OnInit
./lib/actions/Notification_patchMetadata.js
OnStartup
-
OnClose
-

Attributes

-

Me_places

List the *Places* to which the *Token* has access.

OnInit
./lib/actions/Me_places.js
OnStartup
-
OnClose
-

Attributes

-

Places_get

Get information about a *Place*.

OnInit
./lib/actions/Places_get.js
OnStartup
-
OnClose
-

Attributes

-

Place_patch

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

OnInit
./lib/actions/Place_patch.js
OnStartup
-
OnClose
-

Attributes

-

Place_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`).

OnInit
./lib/actions/Place_buses.js
OnStartup
-
OnClose
-

Attributes

-

Place_pairing

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

OnInit
./lib/actions/Place_pairing.js
OnStartup
-
OnClose
-

Attributes

-

Place_openPairing

Open/Close the pairing window. **Note**: requires full access to the *Account*.

OnInit
./lib/actions/Place_openPairing.js
OnStartup
-
OnClose
-

Attributes

-

Place_devices

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

OnInit
./lib/actions/Place_devices.js
OnStartup
-
OnClose
-

Attributes

-

Place_Electricity_autonomy

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

OnInit
./lib/actions/Place_Electricity_autonomy.js
OnStartup
-
OnClose
-

Attributes

-

Place_Electricity_getFlows

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.

OnInit
./lib/actions/Place_Electricity_getFlows.js
OnStartup
-
OnClose
-

Attributes

-

Place_Electricity_getFlowsSetup

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

OnInit
./lib/actions/Place_Electricity_getFlowsSetup.js
OnStartup
-
OnClose
-

Attributes

-

Place_Electricity_selfConsumption

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

OnInit
./lib/actions/Place_Electricity_selfConsumption.js
OnStartup
-
OnClose
-

Attributes

-

Place_functionalities

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

OnInit
./lib/actions/Place_functionalities.js
OnStartup
-
OnClose
-

Attributes

-

Place_getMetadata

Get the metadata.

OnInit
./lib/actions/Place_getMetadata.js
OnStartup
-
OnClose
-

Attributes

-

Place_patchMetadata

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.

OnInit
./lib/actions/Place_patchMetadata.js
OnStartup
-
OnClose
-

Attributes

-

Place_notifications

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

OnInit
./lib/actions/Place_notifications.js
OnStartup
-
OnClose
-

Attributes

-

Place_newNotification

Create a new *Notification*.

OnInit
./lib/actions/Place_newNotification.js
OnStartup
-
OnClose
-

Attributes

-

Place_programs

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

OnInit
./lib/actions/Place_programs.js
OnStartup
-
OnClose
-

Attributes

-

Place_newProgram

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

OnInit
./lib/actions/Place_newProgram.js
OnStartup
-
OnClose
-

Attributes

-

Place_run

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.

OnInit
./lib/actions/Place_run.js
OnStartup
-
OnClose
-

Attributes

-

Program_delete

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

OnInit
./lib/actions/Program_delete.js
OnStartup
-
OnClose
-

Attributes

-

Programs_get

Get information about a *Program*.

OnInit
./lib/actions/Programs_get.js
OnStartup
-
OnClose
-

Attributes

-

Program_patch

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

OnInit
./lib/actions/Program_patch.js
OnStartup
-
OnClose
-

Attributes

-

Program_log

Get the execution history list of this *Program*.

OnInit
./lib/actions/Program_log.js
OnStartup
-
OnClose
-

Attributes

-

Program_getMetadata

Get the metadata of the *Program*.

OnInit
./lib/actions/Program_getMetadata.js
OnStartup
-
OnClose
-

Attributes

-

Program_patchMetadata

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.

OnInit
./lib/actions/Program_patchMetadata.js
OnStartup
-
OnClose
-

Attributes

-

Program_run

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

OnInit
./lib/actions/Program_run.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

No data available for environment