lb_assets 1.1.0

Logbot assets service to manage assets (plants, groups, devices, gateways, gateway models, device models, device models metrics, licenses, manufacturers, ... etc.)

lb_assets

API documentation including GA plugin

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://your-website.com

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  lb_assets:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  lb_assets:
    path: /path/to/lb_assets

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:lb_assets/api.dart';

// TODO Configure HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = DeviceModelMetricItemsApi();
final xUserId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final xOrgId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final xAuthGid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Path param: id
final deviceModelMetricItemRequest = DeviceModelMetricItemRequest(); // DeviceModelMetricItemRequest | 

try {
    final result = api_instance.gaDeviceModelMetricItemsIdPost(xUserId, xOrgId, xAuthGid, id, deviceModelMetricItemRequest);
    print(result);
} catch (e) {
    print('Exception when calling DeviceModelMetricItemsApi->gaDeviceModelMetricItemsIdPost: $e\n');
}

Documentation for API Endpoints

All URIs are relative to http://localhost:1337/api

Class	Method	HTTP request	Description
DeviceModelMetricItemsApi	gaDeviceModelMetricItemsIdPost	POST /ga/device-model-metric-items/{id}	Create a new device model metric item
DeviceModelMetricItemsApi	gaDeviceModelMetricItemsIdPropIdDelete	DELETE /ga/device-model-metric-items/{id}/{propId}	Delete a device model metric item by ID
DeviceModelMetricItemsApi	gaDeviceModelMetricItemsReplaceAllMetricsIdPost	POST /ga/device-model-metric-items/replace-all-metrics/{id}	Create a new device model metric item
DeviceModelsApi	gaDeviceModelsGet	GET /ga/device-models	Retrieve a list of device models
DeviceModelsApi	gaDeviceModelsIdDelete	DELETE /ga/device-models/{id}	Delete a device model by ID
DeviceModelsApi	gaDeviceModelsIdGet	GET /ga/device-models/{id}	Retrieve a specific device model by ID
DeviceModelsApi	gaDeviceModelsIdPut	PUT /ga/device-models/{id}	Update an existing device model by ID
DeviceModelsApi	gaDeviceModelsPost	POST /ga/device-models	Create a new device model
DevicesApi	gaDevicesGet	GET /ga/devices	List all devices
DevicesApi	gaDevicesIdDelete	DELETE /ga/devices/{id}	Delete device by ID
DevicesApi	gaDevicesIdGet	GET /ga/devices/{id}	Get a single device
DevicesApi	gaDevicesIdPut	PUT /ga/devices/{id}	Update device by ID
DevicesApi	gaDevicesPost	POST /ga/devices	Create a device
GatewayModelsApi	gaGatewayModelsGet	GET /ga/gateway-models	Retrieve a list of gateway models
GatewayModelsApi	gaGatewayModelsIdDelete	DELETE /ga/gateway-models/{id}	Delete a gateway model by ID
GatewayModelsApi	gaGatewayModelsIdGet	GET /ga/gateway-models/{id}	Retrieve a specific gateway model by ID
GatewayModelsApi	gaGatewayModelsIdPut	PUT /ga/gateway-models/{id}	Update an existing gateway model by ID
GatewayModelsApi	gaGatewayModelsPost	POST /ga/gateway-models	Create a new gateway model
GatewaysApi	gaGatewaysAssignLicenseIdPut	PUT /ga/gateways/assignLicense/{id}	Assign a license to a gateway
GatewaysApi	gaGatewaysDisconnectIdPut	PUT /ga/gateways/disconnect/{id}	Disconnect a license from a gateway
GatewaysApi	gaGatewaysGet	GET /ga/gateways	Get all gateways
GatewaysApi	gaGatewaysIdDelete	DELETE /ga/gateways/{id}	Delete a gateway by ID
GatewaysApi	gaGatewaysIdGet	GET /ga/gateways/{id}	Get a gateway by ID
GatewaysApi	gaGatewaysIdPut	PUT /ga/gateways/{id}	Update a gateway by ID
GatewaysApi	gaGatewaysPost	POST /ga/gateways	Create a new gateway
GroupsApi	gaGroupIdGet	GET /ga/group/{id}	Get a group by ID
GroupsApi	gaGroupsGet	GET /ga/groups	Find groups
LicensesApi	gaLicenseIdGet	GET /ga/license/{id}	Retrieve a specific license by ID
LicensesApi	gaLicenseResetLicenseIdGet	GET /ga/license/reset-license/{id}	Reset a license
LicensesApi	gaLicenseRetrieveWithTokenPost	POST /ga/license/retrieve-with-token	Retrieve a license by token
LicensesApi	gaLicensesGet	GET /ga/licenses	Retrieve a list of licenses
ManufacturersApi	gaManufacturersGet	GET /ga/manufacturers	Retrieve a list of manufacturers
ManufacturersApi	gaManufacturersIdDelete	DELETE /ga/manufacturers/{id}	Delete a manufacturer by ID
ManufacturersApi	gaManufacturersIdGet	GET /ga/manufacturers/{id}	Retrieve a specific manufacturer by ID
ManufacturersApi	gaManufacturersIdPut	PUT /ga/manufacturers/{id}	Update an existing manufacturer by ID
ManufacturersApi	gaManufacturersPost	POST /ga/manufacturers	Create a new manufacturer
PlantsApi	gaPlantsGet	GET /ga/plants	Get all plants
PlantsApi	gaPlantsIdDelete	DELETE /ga/plants/{id}	Delete a plant
PlantsApi	gaPlantsIdGet	GET /ga/plants/{id}	Get a specific plant by ID
PlantsApi	gaPlantsIdPut	PUT /ga/plants/{id}	Update a plant
PlantsApi	gaPlantsPost	POST /ga/plants	Create a plant
SupportedGatewaysApi	gaSupportedGatewayIdDelete	DELETE /ga/supported-gateway/{id}	Delete a supported gateway by ID
SupportedGatewaysApi	gaSupportedGatewayIdGet	GET /ga/supported-gateway/{id}	Retrieve a specific supported gateway by ID
SupportedGatewaysApi	gaSupportedGatewayIdPut	PUT /ga/supported-gateway/{id}	Update an existing supported gateway by ID
SupportedGatewaysApi	gaSupportedGatewayPost	POST /ga/supported-gateway	Create a new supported gateway
SupportedGatewaysApi	gaSupportedGatewaysGet	GET /ga/supported-gateways	Retrieve a list of supported gateways
AssetsTransformsApi	gaAssetsTransformsGet	GET /ga/AssetsTransforms	Retrieve a list of AssetsTransforms
AssetsTransformsApi	gaAssetsTransformsIdDelete	DELETE /ga/AssetsTransforms/{id}	Delete a AssetsTransform by ID
AssetsTransformsApi	gaAssetsTransformsIdGet	GET /ga/AssetsTransforms/{id}	Retrieve a specific AssetsTransform by ID
AssetsTransformsApi	gaAssetsTransformsIdPut	PUT /ga/AssetsTransforms/{id}	Update an existing AssetsTransform by ID
AssetsTransformsApi	gaAssetsTransformsPost	POST /ga/AssetsTransforms	Create a new AssetsTransform

Documentation For Models

• AccessLevel
• Device
• DeviceModel
• DeviceModelMetricItemRequest
• DeviceModelMetricItemResponse
• DeviceModelRequestBodyData
• DeviceRequestBodyData
• RequestConnectDisconnectBody
• RequestConnectDisconnectBodyData
• Error
• DeviceModelRequestBody
• DeviceRequestBodyData
• GatewayModelsRequestBody
• GatewayAssignLicenseRequestBody
• GatewayAssignLicenseRequestBodyData
• GatewayDisconnectLicenseRequestBody
• GatewayDisconnectLicenseRequestBodyData
• GaGatewaysPostRequest
• GaLicenseRetrieveWithTokenPostRequest
• ManufacturersRequestBody
• PlantPostRequestBody
• AssetsTransformsRequestBody
• Gateway
• GatewayModel
• GatewayModelRequestBodyData
• GatewayRequestInput
• AssetsGroup
• PlantBasic
• LicenseGateway
• LicenseRequestAssignBody
• LicenseRequestBodyItem
• LicenseRequestDisconnectBody
• LicenseRequestInput
• LicenseRequestInputGateway
• LicenseRequestInputGatewayConnectInner
• LicenseResponse
• LogbotLink
• LogbotLinkRequestBody
• Manufacturer
• ManufacturerRequestBodyData
• MetricCategory
• AssetsMetricModbusRTU
• AssetsMetricModbusRTUResponse
• AssetsMetricModbusTCP
• AssetsMetricModbusTCPRequestBody
• AssetsMetricModbusTCPResponse
• AssetsMetricOPCUA
• AssetsMetricOPCUARequestBody
• AssetsMetricOPCUAResponse
• MetricPermission
• AssetsMetricS7
• AssetsMetricS7RequestBody
• AssetsMetricS7Response
• MetricStaticTag
• MetricTags
• ModbusRTURequestBody
• Plant
• PlantRequestBodyData
• AssetsProtocolEnum
• RetPolicy
• SpecialUuid
• SpecialUuidRequestBody
• SupportedGateway
• SupportedGatewayRequestBody
• AssetsTransform
• AssetsTransformsRequestBodyData
• Unit

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer authentication

Author

[e-mail]