JUMP TOThe BioT APIThe BioT API - Getting StartedBioT User Management ServiceUser APISearch User entities by filtergetCreate a new UserpostGenerate a new password for a UserpostGet User by IDgetDelete UserdeleteUpdate UserpatchLogin APIRefresh JWT tokenpostLogin with refresh tokenpostLogoutpostLogin with credentialspostSelf User APISelf get usergetSelf registration of UserpostSelf delete userdeleteSelf update userpatchForgot password API, if the username exists - reset password message will be sent to mailpostMFA Login APIMFA loginpostResend SMS for MFA verificationpostService User APICreate a new Service UserpostCreate a new Service User Secret KeypostService User LoginpostGet Service User by IDgetDelete Service UserdeleteUpdate Service UserpatchDelete secret key of a service user by service user id and secret key iddeleteRole APISearch Role entities by filtergetCreate a new RolepostDissociate Permissions from RolepostAssociate Permissions to RolepostDelete RoledeleteUpdate RolepatchGroup APISearch Group entities by filtergetCreate a new GrouppostDissociate Roles from GrouppostAssociate Roles to GrouppostDelete GroupdeleteUpdate GrouppatchTemporary Token Operation APIValidation token operationgetExecute token operationpostpermissions-controller/v1/permissions/syncpostSelf Permission APIGet ui permissions for the connected usergetPermission APISearch Permission entities by filtergetTemporary Credentials APIGet MQTT temporary credentials for receiving notification for all entities in an organization.getSettings APIGet password SettingsgetSecurity APIGet public keygetDevice APIDevice LogingetHealth Check APIService Health check APIgetBioT Organization ServicePatient APISearch Patient entities by filtergetCreate a new PatientpostEnable or Disable Patient UserpostGet Patient by IDgetDelete PatientdeleteUpdate PatientpatchGet self Patient by ID from access tokengetPatient Alert APICreate a new Patient AlertpostCreate a new Patient AlertpostGet Patient Alert by IDgetDelete Patient AlertdeleteUpdate Patient AlertpatchSearch open patient's alerts entities by filtergetSearch Patient Alert entities by filtergetOrganization User APISearch Organization User entities by filtergetCreate a new Organization UserpostEnable or Disable Organization UserpostGet Organization User by IDgetDelete Organization UserdeleteUpdate Organization UserpatchGet self Organization User by ID from access tokengetCaregiver APISearch Caregiver entities by filtergetCreate a new CaregiverpostEnable or Disable Caregiver UserpostGet Caregiver by IDgetDelete CaregiverdeleteUpdate CaregiverpatchGet self Caregiver by ID from access tokengetTemporary Token Operation APIValidation token operationgetExecute token operationpostOrganization APISearch Organization entities by filtergetCreate a new OrganizationpostCreate First OrganizationpostUpdate OrganizationpostGet Organization by IDgetDelete OrganizationdeleteUpdate OrganizationpatchInvitation APIResend Invitation by IDpostInterception APIUnsubscribe a specific endpoint from intercepting API(s)postSubscribe for intercepting APIspostSearch for active interception subscriptionsgetUser APIGet self User by ID from access tokengetInternal Entity APICheck if custom/built-in attributes and template are in use.getCheck if the service has only built in data.getBuilt In Templates APIGet built in templates idsgetHealth Check APIService Health check APIgetBioT Device ServiceDevice APISearch Device entities by filtergetCreate a new DevicepostGet Device by IDgetDelete DevicedeleteUpdate DevicepatchGet Device Connection Details by IDgetDevice Certificate APICreate new Certificate for DevicepostDelete Certificate for DevicedeleteActivate Certificate for DevicepostTemporary Token Operation APIValidation token operationgetExecute token operationpostInterception APIUnsubscribe a specific endpoint from intercepting API(s)postSubscribe for intercepting APIspostSearch for active interception subscriptionsgetUsage Session APICreate a new Usage SessionpostCreate a new Usage Session by usageTypepostGet Usage Session by IDgetDelete Usage SessiondeleteUpdate Usage SessionpatchSearch Usage Session entities by filtergetSearch currently in progress devices' sessions entities by filtergetUsage Session Remote Control APIStop an existing Usage SessionpostResume a paused Usage SessionpostPause an existing Usage SessionpostCreate and start a Usage SessionpostCommand APIStart a new command by namepostStop an existing CommandpostStart a new commandpostGet Command by IDgetDelete CommanddeleteSearch Command entities by filtergetDevice Alert APICreate a new Device AlertpostCreate a new Device AlertpostGet Device Alert by IDgetDelete Device AlertdeleteUpdate Device AlertpatchSearch open device's alerts entities by filtergetSearch Device Alert entities by filtergetTemporary Credentials APIGet mqtt temporary credentials for device gatewaygetGet mqtt temporary credentials for receiving device measurements and notifications. Internal API, Should be used by FE application onlygetGet mqtt temporary credentials for receiving device measurements for all devices in an organization.getInternal Entity APICheck if custom/built-in attributes and template are in use.getCheck if the service has only built in data.getEndpoint APIGet endpointgetHealth Check APIService Health check APIgetBioT Measurement ServiceMeasurements APIPost measurementpostGet raw measurementsgetGet aggregated measurementsgetMeasurement Schema APIActivate current schemapostGet current schemagetDelete current schema from DBdeleteInterception APIUnsubscribe a specific endpoint from intercepting API(s)postSubscribe for intercepting APIspostSearch for active interception subscriptionsgetMeasurements V2 APISearch Raw Measurements entities by filtergetLast Measurements APISearch Last Measurements entities by filtergetInternal Entity APICheck if custom/built-in attributes and template are in use.getCheck if the service has only built in data.getHealth Check APIService Health check APIgetBioT Settings ServiceTemplate APIGet Template by IDgetUpdate TemplateputDelete TemplatedeleteSearch Template entities by filtergetCreate a new TemplatepostSearch Template entities by filtergetPortal Builder APIPortal Builders View by IDgetUpdate a view, by setting the selected itemsputGet All Portal Builders Views for a specific portalgetGet view with selected items full detailsgetPlugin APIGet Plugin by IDgetUpdate PluginputDelete PlugindeleteSearch Plugin entities by filtergetCreate a new PluginpostSystem APIReset systempostExport Import Configuration APIStart import configurationpostStart export configurationpostGet the last import executiongetGet exported files metadatagetGet the last export executiongetInterception Configuration APISearch Interception Configurations entities by filtergetEntity APIGet all Entity typesgetAttributes APISearch Attribute entities by filterget/v1/attributes/types/{typeName}/metadatagetSearch ReferenceAttributeTemplate entities by filtergetGet Attribute by IDgetHealth Check APIService Health check APIgetBioT Notification ServiceConfiguration APIGet service configurationgetSet service configurationputGet is sms provider configuredgetSMS APISend smspostEmail APISend emailpostAdd attachmentpostHealth Check APIService Health check APIgetBioT File Service ServerInterception APIUnsubscribe a specific endpoint from intercepting API(s)postSubscribe for intercepting APIspostSearch for active interception subscriptionsgetFile APICreate a new FilepostSearch File entities by filtergetGet File by IDgetGet file metadata by IDgetHealth Check APIService Health check APIgetBioT Generic Entity ServerInterception APIUnsubscribe a specific endpoint from intercepting API(s)postSubscribe for intercepting APIspostSearch for active interception subscriptionsgetGeneric Entity APISearch Generic Entity entities by filtergetCreate a new Generic EntitypostGet Generic Entity by IDgetDelete Generic EntitydeleteUpdate Generic EntitypatchInternal Template APICheck if custom/built-in attributes and template are in use.getHealth Check APIService Health check APIgetBioT Dispatcher ServerSubscription API/v1/hooks/notifications/unsubscribepostSubscribe to get notifications for actionspostSearch Subscription entities by filtergetHealth Check APIService Health check APIgetBioT Data Management ServerInterception APIUnsubscribe a specific endpoint from intercepting API(s)postSubscribe for intercepting APIspostSearch for active interception subscriptionsgetReport APICreate a new ReportpostSearch Report entities by filtergetGet Report by IDgetDelete ReportdeleteHealth Check APIService Health check APIgetPowered by Get Plugin by IDget https://example.com/settings/v1/plugins/{name}Get Plugin by ID The below table describes the request parameters: ParameterTypeMandatoryDescriptionnameStringtrueThe name of the plugin with the prefix "Plugin-" included This API requires SETTINGS_PLUGIN_GET permission(s).
