bitbucket.org/bactosense/bactocloud-api-client

Go API client for bactocloud_client

This is the comprehensive backend API documentation for BactoCloud platform. The API provides access to device management, data collection, alarm monitoring, and organization administration features.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 0.6.0
• Package version: 1.0.0
• Generator version: 7.8.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.bactocloud.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import bactocloud_client "bitbucket.org/bactosense/bactocloud-api-client"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value bactocloud_client.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), bactocloud_client.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value bactocloud_client.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), bactocloud_client.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using bactocloud_client.ContextOperationServerIndices and bactocloud_client.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), bactocloud_client.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), bactocloud_client.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.bactocloud.com

Class	Method	HTTP request	Description
AdminAPI	AdminDeviceTransferPost	Post /admin/device/transfer	Transfer Device Ownership
AdminAPI	AdminLicenceGet	Get /admin/licence	Get all licences
AdminAPI	AdminLicenceLicenceIdDelete	Delete /admin/licence/{licence_id}	Delete licence
AdminAPI	AdminLicencePost	Post /admin/licence	Create licence code
AdminAPI	AdminLoginPost	Post /admin/login	Admin login to organization
AdminAPI	AdminOpenidGet	Get /admin/openid	Get All OpenID Configurations
AdminAPI	AdminOpenidIdDelete	Delete /admin/openid/{id}	Delete OpenID Configuration
AdminAPI	AdminOpenidPost	Post /admin/openid	Add OpenID Configuration
AdminAPI	AdminOpenidPut	Put /admin/openid	Update OpenID Configuration
AdminAPI	AdminOrganizationDelete	Delete /admin/organization	Delete organization
AdminAPI	AdminOrganizationGet	Get /admin/organization	Get organization details (users, roles, devices)
AdminAPI	AdminOrganizationInvitePost	Post /admin/organization/invite	Invite user to organization
AdminAPI	AdminOrganizationLicencePost	Post /admin/organization/licence	Apply a licence code to an organization
AdminAPI	AdminOrganizationRolePost	Post /admin/organization/role	Change user role in organization
AdminAPI	AdminOrganizationUserDelete	Delete /admin/organization/user	Remove user from organization
AdminAPI	AdminOrganizationsGet	Get /admin/organizations	Get all organizations
AdminAPI	AdminSystemGet	Get /admin/system	Get the system info of the server
AdminAPI	AdminTestEmailPost	Post /admin/test-email	Send Test Email
AdminAPI	AdminUserDelete	Delete /admin/user	Delete a user account
AdminAPI	AdminUserPost	Post /admin/user	Modify a user
AdminAPI	AdminUsersGet	Get /admin/users	Get all users and their organizations
AlarmAPI	AlarmAcknowledgeIdPost	Post /alarm/acknowledge/{id}	Acknowledge Single Alarm
AlarmAPI	AlarmAcknowledgeMultiplePost	Post /alarm/acknowledge_multiple	Acknowledge Multiple Alarms
AlarmAPI	AlarmConfigGet	Get /alarm/config	Get Alarm Configurations
AlarmAPI	AlarmConfigIdDelete	Delete /alarm/config/{id}	Delete Alarm Configuration
AlarmAPI	AlarmConfigPatch	Patch /alarm/config	Update Alarm Configuration
AlarmAPI	AlarmConfigPost	Post /alarm/config	Create New Alarm Configuration
AlarmAPI	AlarmPost	Post /alarm	Get Filtered Alarm History
AlarmAPI	ApiV1AlarmAcknowledgeIdPost	Post /api/v1/alarm/acknowledge/{id}	Acknowledge Single Alarm
AlarmAPI	ApiV1AlarmAcknowledgeMultiplePost	Post /api/v1/alarm/acknowledge_multiple	Acknowledge Multiple Alarms
AlarmAPI	ApiV1AlarmGet	Get /api/v1/alarm	Get Alarm Configurations
ApiAPI	HelloGet	Get /hello	Hello
ApiAPI	IotV1CommandAcknowledgePut	Put /iot/v1/command/acknowledge	Acknowledge command execution WIP
ApiAPI	IotV1CommandGet	Get /iot/v1/command	Poll commands
ApiAPI	IotV1ConfigPut	Put /iot/v1/config	Update device configuration
ApiAPI	IotV1DataPost	Post /iot/v1/data	Adds data to the database
ApiAPI	IotV1EnrollDelete	Delete /iot/v1/enroll	Unenroll device
ApiAPI	IotV1EnrollPost	Post /iot/v1/enroll	Enroll device
ApiAPI	IotV1HelloGet	Get /iot/v1/hello	Hello
ApiAPI	IotV1OrganizationGet	Get /iot/v1/organization	Get organization
ApiAPI	IotV1StatusPost	Post /iot/v1/status	Add device status
AuditAPI	AuditExportPost	Post /audit/export	Export Audit Trail as CSV
AuditAPI	AuditIdGet	Get /audit/{id}	Get Single Audit Record
AuditAPI	AuditPost	Post /audit	Get Audit Trail
AuthAPI	ExchangeJwtPost	Post /exchange_jwt	JWT Token Exchange
AuthAPI	GenerateTotpPost	Post /generate_totp	Generate TOTP Configuration
AuthAPI	LoginPost	Post /login	User Login with optional TOTP validation
AuthAPI	VerifyTotpPost	Post /verify_totp	Verify TOTP Token
ComputationAPI	ComputationDelete	Delete /computation	Delete a computation config from the organization
ComputationAPI	ComputationEnablePost	Post /computation/enable	Enable or disable a computation config from the organization
ComputationAPI	ComputationGet	Get /computation	Get the computation configs for the organization
ComputationAPI	ComputationPatch	Patch /computation	Edit a computation config in the organization
ComputationAPI	ComputationPost	Post /computation	Add a computation config to the organization
ComputationAPI	ComputationRecomputePost	Post /computation/recompute	Recompute a computation config from the organization for the last 12 months
ComputationAPI	ComputationSimulatePost	Post /computation/simulate	Simulate a computation from a config and a target data id
DataAPI	ApiV1DataExportPost	Post /api/v1/data/export	Export Data to File
DataAPI	ApiV1DataFcsFileIdGet	Get /api/v1/data/fcs/{file_id}	Get FCS Flow Cytometry Data
DataAPI	ApiV1DataFileFileIdGet	Get /api/v1/data/file/{file_id}	Download Data File
DataAPI	ApiV1DataIdGet	Get /api/v1/data/{id}	Get Single Data Record
DataAPI	ApiV1DataListPost	Post /api/v1/data/list	Get Filtered Device Data
DataAPI	DataExportPost	Post /data/export	Export Data to File
DataAPI	DataFcsFileIdGet	Get /data/fcs/{file_id}	Get FCS Flow Cytometry Data
DataAPI	DataFileFileIdGet	Get /data/file/{file_id}	Download Data File
DataAPI	DataIdDelete	Delete /data/{id}	Delete Data Record
DataAPI	DataIdGet	Get /data/{id}	Get Single Data Record
DataAPI	DataListPost	Post /data/list	Get Filtered Device Data
DataAPI	DataPatch	Patch /data/	Edit Data Record
DeviceAPI	ApiV1DeviceCommandCommandIdDelete	Delete /api/v1/device/command/{command_id}	Cancel Device Command
DeviceAPI	ApiV1DeviceCommandDeviceIdGet	Get /api/v1/device/command/{device_id}	Get Device Command History
DeviceAPI	ApiV1DeviceCommandPost	Post /api/v1/device/command
DeviceAPI	ApiV1DeviceGet	Get /api/v1/device	Get All Devices
DeviceAPI	ApiV1DeviceIdGet	Get /api/v1/device/{id}	Get Device Details
DeviceAPI	DeviceCommandCommandIdDelete	Delete /device/command/{command_id}	Cancel Device Command
DeviceAPI	DeviceCommandDeviceIdGet	Get /device/command/{device_id}	Get Device Command History
DeviceAPI	DeviceCommandPost	Post /device/command
DeviceAPI	DeviceComputationtypesDeviceIdGet	Get /device/computationtypes/{device_id}	Get the active computation types for one device
DeviceAPI	DeviceDataBucketDeviceIdGet	Get /device/data/{bucket}/{device_id}	Get data for only a device, only the last with a limit
DeviceAPI	DeviceGet	Get /device	Get All Devices
DeviceAPI	DeviceIdDelete	Delete /device/{id}	Unenroll Device
DeviceAPI	DevicePackageDeviceIdActivationCodeGet	Get /device/package/{device_id}/{activation_code}	Validate Device Activation Code
DeviceAPI	DevicePatch	Patch /device	Edit Device Information
DeviceAPI	DeviceStatusIdLimitGet	Get /device/status/{id}/{limit}	Get Recent Device Statuses
LoginAPI	ConfirmPasswordForgottenPost	Post /confirm_password_forgotten	Confirm Password Reset
LoginAPI	RequestPasswordForgottenPost	Post /request_password_forgotten	Request Password Reset
Oauth2API	Oauth2CallbackGet	Get /oauth2/callback	OAuth2 Callback Processing
OrganizationAPI	OrganizationApikeyIdDelete	Delete /organization/apikey/{id}	Delete Organization API Key
OrganizationAPI	OrganizationApikeyPost	Post /organization/apikey	Add Organization API Key
OrganizationAPI	OrganizationDelete	Delete /organization	DeleteOrganizationHandler
OrganizationAPI	OrganizationEditPut	Put /organization/edit	edits an organization (names, emails, filters). Returns as data an organization object
OrganizationAPI	OrganizationEnrollIdDelete	Delete /organization/enroll/{id}	deletes the enrollment code for an organization
OrganizationAPI	OrganizationEnrollPost	Post /organization/enroll	creates an enrollment code for an organization
OrganizationAPI	OrganizationGet	Get /organization	GetOrganizationHandler gets the organization
OrganizationAPI	OrganizationInviteCodeGet	Get /organization/invite/{code}	Accept Organization Invite
OrganizationAPI	OrganizationInviteIdDelete	Delete /organization/invite/{id}	Delete Organization Invite
OrganizationAPI	OrganizationInvitePost	Post /organization/invite	Send Organization Invite
OrganizationAPI	OrganizationLeaveDelete	Delete /organization/leave	Leave Organization
OrganizationAPI	OrganizationLicencePost	Post /organization/licence	Add Licence To Organization
OrganizationAPI	OrganizationPost	Post /organization	creates a new organization
OrganizationAPI	OrganizationPushPut	Put /organization/push	Edit Push Settings Handler
OrganizationAPI	OrganizationPushTestPost	Post /organization/push/test	Test Data Push Handler
OrganizationAPI	OrganizationUserDisablePut	Put /organization/user/disable	Disable Organization User
OrganizationAPI	OrganizationUserUserIdDelete	Delete /organization/user/{user_id}	Exclude Organization User
PermissionsAPI	PermissionGet	Get /permission	Returns a list of all permissions
PermissionsAPI	PermissionTreeGet	Get /permission/tree	Get permission tree by roles
UserAPI	CaptchaGet	Get /captcha	Generate CAPTCHA
UserAPI	RegisterPost	Post /register	User Registration
UserAPI	UserConfirmPasswordResetPost	Post /user/confirm_password_reset	Finalize Password Reset
UserAPI	UserGet	Get /user	Retrieve User Profile
UserAPI	UserOrganizationsGet	Get /user/organizations	List User Organizations
UserAPI	UserPut	Put /user	Update User Profile
UserAPI	UserRequestPasswordResetPost	Post /user/request_password_reset	Initiate Password Reset
UserAPI	UserRequestSalesPost	Post /user/request_sales	Submit Sales Request
UserAPI	VerifyEmailPost	Post /verify_email	Email Verification
WsAPI	WsAuthGet	Get /ws/auth	WebSocket authentication
WsAPI	WsGet	Get /ws	WebSocket

Documentation For Models

• HandlersAcknowledgeAlarmsHandlerQuery
• HandlersAcknowledgeCommandRequest
• HandlersAddLicenceToOrganizationRequest
• HandlersAddLicenceToOrganizationResponse
• HandlersAddOrganizationAPIKeyRequest
• HandlersAdminAddOpenIDConfigRequest
• HandlersAdminApplyLicenceToOrganizationHandlerRequest
• HandlersAdminChangeUserRoleInOrganizationRequest
• HandlersAdminDeleteAccountRequest
• HandlersAdminDeleteOrganizationRequest
• HandlersAdminDeleteUserFromOrganizationHandlerRequest
• HandlersAdminInviteEmailToOrganizationHandlerRequest
• HandlersAdminLoginHandlerRequest
• HandlersAdminModifyUserHandlerRequest
• HandlersAuditTrailFilter
• HandlersCaptchaResponse
• HandlersChangePasswordRequest
• HandlersCreateLicenceRequest
• HandlersDeleteComputationRequest
• HandlersDeviceDataPayload
• HandlersDisableOrganizationUserRequest
• HandlersEditOrganizationRequest
• HandlersEnableDisableComputationRequest
• HandlersEnrollDeviceRequest
• HandlersEnrollDeviceResponse
• HandlersGetAuditTrailResponse
• HandlersGetDataResponse
• HandlersGetOrganizationResponse
• HandlersJWTExchangeRequest
• HandlersLoginInput
• HandlersLoginTOTPResponse
• HandlersOrganizationCreateRequest
• HandlersOrganizationDetailsResponse
• HandlersOrganizationInviteRequest
• HandlersPasswordForgottenRequest
• HandlersPollCommandsResponse
• HandlersRecomputeComputationRequest
• HandlersRegisterInput
• HandlersRequestSalesRequest
• HandlersResponseMessage
• HandlersSimulationResponse
• HandlersSystemInfoResponse
• HandlersTestEmailRequest
• HandlersTransferDeviceOwnershipHandlerRequest
• HandlersUserRoleInfo
• HandlersUserUpdateRequest
• HandlersVerifiyTotpRequest
• ServerAlarm
• ServerAlarmHistoryFilter
• ServerAlarmSeverity
• ServerAuditLog
• ServerAuditLogAction
• ServerBeadsFitDetail
• ServerBucket
• ServerCalculationType
• ServerCartridgeStatus
• ServerChangeIntervalConfiguration
• ServerCloudAPIKey
• ServerCloudAlarm
• ServerCloudAlarmConfig
• ServerCommandArgs
• ServerCommandProtocolName
• ServerCommandProtocolParameters
• ServerCommandStatus
• ServerCommandType
• ServerComparisonOperator
• ServerComputation
• ServerComputationConfig
• ServerComputationFilterConfig
• ServerComputationResultDataType
• ServerComputationResultLog
• ServerComputationType
• ServerCurrentLicenceInfo
• ServerCurrentMeasurement
• ServerDOCallConfiguration
• ServerData
• ServerDataFilter
• ServerDataFilterConfig
• ServerDataPushConfig
• ServerDataType
• ServerDevice
• ServerDeviceCommand
• ServerDeviceConfig
• ServerDeviceState
• ServerDeviceStatus
• ServerEnrollSecret
• ServerErrorCode
• ServerErrorResponse
• ServerExportConfig
• ServerExportMetadata
• ServerExportType
• ServerFCSData
• ServerFCSMetadata
• ServerFCSParameter
• ServerFilterType
• ServerGateDefinition
• ServerGateSetDefinition
• ServerGateSetType
• ServerGroup
• ServerInvitationCode
• ServerLicence
• ServerLicencePlanType
• ServerMessageConfiguration
• ServerMetricType
• ServerMonitoringData
• ServerOpenIDConfig
• ServerOrganization
• ServerOrganizationApplication
• ServerOrganizationRole
• ServerPermission
• ServerPermissionCode
• ServerPushAPIConfiguration
• ServerReferenceDataInfo
• ServerRetryStrategy
• ServerRole
• ServerSavedDataFilter
• ServerServiceStatus
• ServerSosdConfigDefinition
• ServerSosdStatus
• ServerSystemStatus
• ServerThresholdPair
• ServerUser
• ServerVirtualDeviceInfo
• ServerWarning
• ServerWebsocketMessage
• ServerWebsocketMessageType

Documentation For Authorization

Authentication schemes defined for the API:

BactosenseApiKey

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		bactocloud_client.ContextAPIKeys,
		map[string]bactocloud_client.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

JWT

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		bactocloud_client.ContextAPIKeys,
		map[string]bactocloud_client.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

[e-mail]