Flux operations Documentation
Flux operations
Draft documentation version
Documentation is partial and not validated !
Description
Concepts
Remark
Operations related to Flux, Data, Point and PointGroup
Operations
Verb | Operation | Version | Return | Summary | |
---|---|---|---|---|---|
GET | GetDatas | V1 | DataContainer | Return array of Data. Usefull when you know IDs else use SearchDatas operation | |
GET | GetFlux | V1 | FluxContainer | Return array of Flux. Usefull when you know IDs else use SearchFlux operation | |
GET | GetPointGroupsPeriod | V1 | Array of PointGroup | Return PointGroup: group of Point. Usefull to return limited amount of PointGroup instead of large set of Point. Method applyed by operation group by period. |
|
GET | GetPointGroupsSplit | V1 | Array of PointGroup | Return PointGroup: group of Point. Usefull to return limited amount of PointGroup instead of large set of Point. Method applyed by operation group by period. |
|
GET | GetPoints | V1 | Array of Point | Return array of Point for Data | |
GET | GetPointsFlux | V1 | Array of Point | Return array of Point for all Data owned by Flux | |
GET | SearchDatas | V1 | DataContainer | Search Data | |
GET | SearchFlux | V1 | FluxContainer | Search Flux | |
POST | StorePoints | V1 | Number of Point integrated | Return array of Point for Data | |
PUT | UpdateData | Beta | Updated Data | Update Data name, description and Wums | |
PUT | UpdateFlux | V1 | Updated Flux | Update Flux name, description and Wums | |
PATCH | LocalizeFlux | V1 | Localized Flux on new InfrastructureBase | Localize Flux on Site, Building or Zone | |
PATCH | ShareFlux | Alpha | Shared Flux | Operation allow Flux sharing to outside users: without Authorization on your BusinessAccount. | |
DELETE | DeleteFlux | Beta | Deleted Flux | Delete Flux |