# BioT Documentation > Documentation for BioT ## Guides - [Welcome to BioT!](https://docs.biot-med.com/docs/general.md) - [Overview](https://docs.biot-med.com/docs/overview.md) - [Technical FAQ](https://docs.biot-med.com/docs/faq.md) - [Architecture](https://docs.biot-med.com/docs/architecture-overview.md) - [System Concepts](https://docs.biot-med.com/docs/system-concepts.md) - [No-Code (Templates)](https://docs.biot-med.com/docs/templates.md) - [Low-Code: UI Code Snippets](https://docs.biot-med.com/docs/ui-code-snippets.md) - [Plugins](https://docs.biot-med.com/docs/plugins.md) - [BioT Portals](https://docs.biot-med.com/docs/portals.md) - [BioT Console](https://docs.biot-med.com/docs/biot-consl.md) - [Templates General Concept](https://docs.biot-med.com/docs/template-general-concept.md) - [Device Template](https://docs.biot-med.com/docs/device-template.md) - [Organization Template](https://docs.biot-med.com/docs/organization-template.md) - [Organization User Template](https://docs.biot-med.com/docs/organization-user-template.md) - [Caregiver Template](https://docs.biot-med.com/docs/caregiver-template.md) - [Patient Template](https://docs.biot-med.com/docs/patient-template.md) - [Generic Entity Template](https://docs.biot-med.com/docs/generic-entity-template.md) - [Portal Builder](https://docs.biot-med.com/docs/portal-builder.md) - [Manufacturer Portal](https://docs.biot-med.com/docs/manufacturer-portal.md) - [Organization Portal](https://docs.biot-med.com/docs/clinician-organization-portal.md) - [API Overview](https://docs.biot-med.com/docs/api-overview.md) - [Regulatory and Security](https://docs.biot-med.com/docs/security-architecture.md) - [HIPAA and FDA GxP (21 CFR Parts 11 and 820)](https://docs.biot-med.com/docs/hipaa-and-fda-gxp-21-cfr-parts-11-and-820.md) - [GDPR](https://docs.biot-med.com/docs/gdpr.md) - [Cloud Security Validation](https://docs.biot-med.com/docs/cloud-security-validation.md) - [Certifications and Compliance](https://docs.biot-med.com/docs/other-certifications-and-validations.md) - [Device – Cloud Security](https://docs.biot-med.com/docs/device-cloud-security.md) - [Web Services Security](https://docs.biot-med.com/docs/web-services-security.md) - [Code Validation and Code Segregation](https://docs.biot-med.com/docs/biot-cicd-process.md) - [Data Privacy](https://docs.biot-med.com/docs/data-privacy.md) - [Data Resiliency](https://docs.biot-med.com/docs/data-resiliency.md) - [Password Policy](https://docs.biot-med.com/docs/password-policy.md) - [Verification & Validation (DHF)](https://docs.biot-med.com/docs/verification-validation.md) - [eSTAR Submission Support](https://docs.biot-med.com/docs/estar-submission-support.md) - [SaaS Update Policy](https://docs.biot-med.com/docs/saas-versioning-policy.md) - ["Hello World" with BioT](https://docs.biot-med.com/docs/getting-started-1.md) - [System Concepts](https://docs.biot-med.com/docs/system-concepts-1.md) - [Let's Implement a "Hello World"](https://docs.biot-med.com/docs/start-with-a-hello-world-implementation.md) - [Adding Bio Markers to the "Hello World"](https://docs.biot-med.com/docs/adding-bio-markers-to-our-hello-world.md) - [Welcome to the Managing BioT Portals Guide!](https://docs.biot-med.com/docs/user-manual.md) - [Managing Devices in BioT](https://docs.biot-med.com/docs/getting-started-with-device-management.md) - [Viewing the Device List](https://docs.biot-med.com/docs/viewing-the-device-list.md) - [Adding a New Device](https://docs.biot-med.com/docs/adding-a-new-device.md) - [Viewing and Editing Devices](https://docs.biot-med.com/docs/viewing-and-editing-devices.md) - [Linking Entities (Assigning a Device to an Organization)](https://docs.biot-med.com/docs/linking-entities-devices.md) - [Generate and Download a Permanent Device Security Certificate](https://docs.biot-med.com/docs/generate-and-download-a-permanent-device-security-certificate.md) - [Revoke a Permanent Device Security Certificate](https://docs.biot-med.com/docs/revoke-a-permanent-device-security-certificate.md) - [Deleting a Device](https://docs.biot-med.com/docs/deleting-a-device.md) - [Managing the Device Operation Center](https://docs.biot-med.com/docs/managing-the-device-operation-center.md): The Decive Operation Center tab displays all the devices enlisted in the system and their statuses. - [Managing Patients in BioT](https://docs.biot-med.com/docs/getting-started-with-patient-management.md) - [Viewing the Patients List](https://docs.biot-med.com/docs/viewing-the-patients-list.md): The Patients List is the first page displayed when you login to the Organization Portal. - [Adding a New Patient](https://docs.biot-med.com/docs/adding-a-new-patient.md): This page explains how organization users can add new patients to an organization using the BioT Organization Portal. - [Viewing and Editing Patient Details](https://docs.biot-med.com/docs/viewing-patient-details.md) - [Verifying Your BioT Account](https://docs.biot-med.com/docs/verifying-your-biot-account.md) - [Linking Entities (Assigning a Caregiver to a Patient)](https://docs.biot-med.com/docs/linking-entities.md) - [Viewing Live Measurements](https://docs.biot-med.com/docs/viewing-patient-measurements.md) - [Viewing Historical Measurements](https://docs.biot-med.com/docs/viewing-historical-measurements.md) - [Activating a Usage Type (Using the Remote Controller)](https://docs.biot-med.com/docs/remote-controlling-a-patients-device.md) - [Deleting a Patient](https://docs.biot-med.com/docs/deleting-a-patient.md) - [Managing the Patient Monitoring Station](https://docs.biot-med.com/docs/managing-the-nursing-station.md): The Patient Monitoring Station tab displays a list of all the patients monitored in the Organization Portal and their vital signs. - [Managing Caregivers in BioT](https://docs.biot-med.com/docs/getting-started-with-caregivers.md) - [Viewing the Caregivers List](https://docs.biot-med.com/docs/viewing-the-caregivers-list.md) - [Adding a New Caregiver](https://docs.biot-med.com/docs/adding-a-new-caregiver.md) - [Viewing and Editing Caregivers](https://docs.biot-med.com/docs/viewing-and-editing-caregivers.md) - [Linking Entities (Caregivers)](https://docs.biot-med.com/docs/linking-entities-caregivers.md) - [Deleting a Caregiver](https://docs.biot-med.com/docs/deleting-a-caregiver.md) - [Managing Users in BioT](https://docs.biot-med.com/docs/getting-started-with-organization-users.md): This article shows how you can add and manage Users. - [Viewing the Organization Users List](https://docs.biot-med.com/docs/viewing-the-organization-users-list.md) - [Adding a New Organization User](https://docs.biot-med.com/docs/adding-a-new-organization-user.md) - [Viewing and Editing Organization Users](https://docs.biot-med.com/docs/viewing-and-editing-organization-users.md) - [Deleting an Organization User](https://docs.biot-med.com/docs/deleting-an-organization-user.md) - [Managing Organizations in BioT](https://docs.biot-med.com/docs/getting-started-with-organizations.md) - [Viewing the Organization List](https://docs.biot-med.com/docs/viewing-the-organization-list.md) - [Adding a New Organization](https://docs.biot-med.com/docs/adding-a-new-organization.md) - [Viewing and Editing Organizations](https://docs.biot-med.com/docs/viewing-and-editing-organizations.md) - [Deleting an Organization](https://docs.biot-med.com/docs/deleting-an-organization.md) - [Adding a Device Template](https://docs.biot-med.com/docs/adding-a-device-template.md): This page will help you add a new device template. - [Attribute Types](https://docs.biot-med.com/docs/attribute-types.md): This page explains the different attribute types and how to use them. - [Editing a Device Template](https://docs.biot-med.com/docs/editing-a-device-template.md) - [Editing the Patient Template](https://docs.biot-med.com/docs/editing-the-patient-template.md) - [Adding a Caregiver Template](https://docs.biot-med.com/docs/adding-a-caregiver-template.md): This page will help you add a new caregiver template. - [Editing a Caregiver Template](https://docs.biot-med.com/docs/editing-a-caregiver-template.md) - [Adding an Organization User Template](https://docs.biot-med.com/docs/adding-an-organization-user-template.md): This page will help you add a new organization user template. - [Editing Organization User Templates](https://docs.biot-med.com/docs/editing-organization-user-templates.md) - [Editing the Organization Template](https://docs.biot-med.com/docs/editing-the-organization-template.md) - [Adding a Generic Entity Template](https://docs.biot-med.com/docs/adding-a-generic-entity-template.md) - [Editing a Generic Entity Template](https://docs.biot-med.com/docs/editing-a-generic-entity-template.md) - [Working with Generic Entities](https://docs.biot-med.com/docs/working-with-generic-entities.md) - [Working with the Portal Builder](https://docs.biot-med.com/docs/getting-started-with-the-portal-builder.md) - [Customizing Manufacturer Portal Layouts](https://docs.biot-med.com/docs/configuring-the-manufacturer-portal-layout.md) - [Customizing Organization Portal Layouts](https://docs.biot-med.com/docs/customizing-organization-portal-layouts.md) - [Managing BioT Settings](https://docs.biot-med.com/docs/managing-biot-settings.md) - [Managing Languages in BioT](https://docs.biot-med.com/docs/managing-languages-in-biot.md) - [Requesting a New Feature](https://docs.biot-med.com/docs/requesting-a-new-feature.md) - [Exporting Data from BioT](https://docs.biot-med.com/docs/exporting-data-from-biot.md) - [Linking Entities in BioT](https://docs.biot-med.com/docs/linking-entities-organization-users.md) - [The BioT Developer Guide - Device Integration](https://docs.biot-med.com/docs/device-integration.md) - [Best Practices For Working With a Cloud Environment](https://docs.biot-med.com/docs/best-practices-for-working-with-a-cloud-environment.md) - [Communication from/to BioT Cloud](https://docs.biot-med.com/docs/communication-fromto-biot-cloud.md) - [MQTT Infrastructure](https://docs.biot-med.com/docs/connect-to-biot.md) - [Using MQTTX to Simulate Device MQTT Connectivity](https://docs.biot-med.com/docs/using-mqttx-to-simulate-device-mqtt-connectivity.md) - [Direct Device Connection](https://docs.biot-med.com/docs/direct-device-connection.md) - [Device API access](https://docs.biot-med.com/docs/device-api-access.md) - [Gateway Connection](https://docs.biot-med.com/docs/gateway-connection.md) - [Login to BioT](https://docs.biot-med.com/docs/login-to-biot.md) - [Platform Technical Information](https://docs.biot-med.com/docs/technical-information.md) - [Sending Measurements](https://docs.biot-med.com/docs/sending-observations.md) - [Start a Session](https://docs.biot-med.com/docs/start-a-session.md) - [Start a Remote Session](https://docs.biot-med.com/docs/start-a-remote-session.md) - [Sending Measurements via MQTT](https://docs.biot-med.com/docs/sending-measurements.md) - [Sending Measurements via HTTP API](https://docs.biot-med.com/docs/sending-measurements-via-api.md) - [Sending Measurements in Bulk](https://docs.biot-med.com/docs/sending-measurements-in-bulk.md) - [Waveform Measurements](https://docs.biot-med.com/docs/waveform-measurements.md) - [Session Summary](https://docs.biot-med.com/docs/session-summary.md) - [Stop a Session](https://docs.biot-med.com/docs/stop-a-session.md) - [Stop a Remote Session](https://docs.biot-med.com/docs/stop-a-remote-session.md) - [Sending Mesurements From Gateway](https://docs.biot-med.com/docs/gateway-observation-flow.md) - [Sending Statuses](https://docs.biot-med.com/docs/sending-statuses-measurements.md) - [Communicating with the Device Shadow](https://docs.biot-med.com/docs/communicating-with-the-device-shadow.md) - [Sending Commands](https://docs.biot-med.com/docs/sending-commands.md) - [Command Configuration & Status](https://docs.biot-med.com/docs/command-configuration-status.md) - [Remote Configuration](https://docs.biot-med.com/docs/remote-configuration.md) - [How the Configuration is Structured](https://docs.biot-med.com/docs/how-configuration-is-structured.md) - [Receiving Configuration](https://docs.biot-med.com/docs/receiving-configuration.md) - [Receiving Configuration Update Requests](https://docs.biot-med.com/docs/receiving-configuration-update-requests.md) - [Sync Device State After Device Connection](https://docs.biot-med.com/docs/sync-device-state-after-device-connection.md) - [Sending Emails via BioT API](https://docs.biot-med.com/docs/sending-email-via-api.md) - [Sending and Receiving SMS Messages](https://docs.biot-med.com/docs/sending-and-receiving-sms-messages.md) - [Using Terraform to Configure BioT](https://docs.biot-med.com/docs/using-terraform-to-configure-biot.md) - [Branding & Customization](https://docs.biot-med.com/docs/branding.md) - [Landing Pages](https://docs.biot-med.com/docs/landing-pages.md): This is relevant for versions 2.3.27 and above - [BioT Look and Feel Customization](https://docs.biot-med.com/docs/biot-look-and-feel-customization.md) - [Full CSS Example](https://docs.biot-med.com/docs/full-css-example.md) - [BioT REST API](https://docs.biot-med.com/docs/biot-rest-api.md) - [API Common Flows Samples (Postman)](https://docs.biot-med.com/docs/api-common-flows-samples.md) - [BioT SDK](https://docs.biot-med.com/docs/biot-sdk.md) - [Request Headers & WAF](https://docs.biot-med.com/docs/request-headers-waf.md) - [Using BioT Search APIs](https://docs.biot-med.com/docs/using-biot-search-apis.md) - [eq & not: Search Examples](https://docs.biot-med.com/docs/eq-search-exmaple.md) - [like: Search Examples](https://docs.biot-med.com/docs/like-search-example.md) - [from & to: Search Examples](https://docs.biot-med.com/docs/from-to-search-example.md) - [lt & gt & lte & gte: Search Examples](https://docs.biot-med.com/docs/lt-gt-lte-gte-search-examples.md) - [isNull & isNotNull: Search Example](https://docs.biot-med.com/docs/isnull-isnotnull-search-example.md) - [in & notIn: Search Examples](https://docs.biot-med.com/docs/in-not-search-examples.md) - [freeTextSearch: Search Example](https://docs.biot-med.com/docs/freetextsearch-search-example.md) - [Advanced Filters](https://docs.biot-med.com/docs/advanced-filters.md) - [Using Generic Entities](https://docs.biot-med.com/docs/using-generic-entities.md) - [Generic Entity Usage Example - Log File](https://docs.biot-med.com/docs/generic-entity-usage-example-log-file.md) - [Linking Entities](https://docs.biot-med.com/docs/linking-entities-1.md): One to Many / Many to One relationship between entities - [File Upload](https://docs.biot-med.com/docs/file-upload.md) - [Multipart File Upload](https://docs.biot-med.com/docs/multipart-file-upload.md) - [Multipart File Download](https://docs.biot-med.com/docs/multipart-file-download.md) - [Recovering From Device Disconnection](https://docs.biot-med.com/docs/bulk-measurements-offline-devices.md) - [Attribute Based Access Control (ABAC)](https://docs.biot-med.com/docs/attribute-based-access-control.md) - [Best practices for implementing HIPAA compliance using BioT](https://docs.biot-med.com/docs/phi-data-and-access-control.md) - [Managing Access Control Rules](https://docs.biot-med.com/docs/managing-access-control-rules.md) - [ABAC Conditions](https://docs.biot-med.com/docs/conditions.md) - [ABAC Actions](https://docs.biot-med.com/docs/abac-actions.md) - [ABAC Rules](https://docs.biot-med.com/docs/rules.md) - [Patient Self Signup](https://docs.biot-med.com/docs/patient-self-registration.md) - [OTP Login](https://docs.biot-med.com/docs/otp-login.md) - [Reset Password](https://docs.biot-med.com/docs/reset-password.md) - [Alerts Generation](https://docs.biot-med.com/docs/alerts-generation.md) - [Data Extraction APIs](https://docs.biot-med.com/docs/data-extraction-apis.md) - [Exporting Data](https://docs.biot-med.com/docs/exporting-data.md): How to export data from the BioT platform - [Get Raw Measurement Data](https://docs.biot-med.com/docs/get-raw-measurement-data.md) - [Get Aggregated Measurement Data](https://docs.biot-med.com/docs/get-aggregated-measurement-data.md) - [Language and Translations](https://docs.biot-med.com/docs/language-and-translations.md) - [Subscribing to Device Measurement Messages](https://docs.biot-med.com/docs/subscribing-to-device-measurement-messages.md) - [Embedding Web Content (iFrame)](https://docs.biot-med.com/docs/embedding-web-content-iframe.md) - [Optional URL Parameters](https://docs.biot-med.com/docs/optional-url-parameters.md) - [What are BioT Plugins?](https://docs.biot-med.com/docs/biot-plugins.md) - [BioT Notification Plugins](https://docs.biot-med.com/docs/biot-notification-plugins.md) - [BioT Interceptor Plugins](https://docs.biot-med.com/docs/biot-plugins-development.md) - [BioT Non-Specific Plugins](https://docs.biot-med.com/docs/biot-non-specific-plugins.md) - [Interceptors - Modifying All Service Responses](https://docs.biot-med.com/docs/modifying-all-service-responses.md) - [External Service Subscriptions (Dispatcher)](https://docs.biot-med.com/docs/interception-and-notification-subscription.md) - [Sample Plugin Code](https://docs.biot-med.com/docs/sample-plugin-code.md) - [Custom Plugin Deployment](https://docs.biot-med.com/docs/custom-lambda-deployment.md) - [Plugin Configuration Management](https://docs.biot-med.com/docs/plugin-configurations.md) - [Creating a Service User for Your Plugin](https://docs.biot-med.com/docs/creating-a-service-user-for-your-plugin.md) - [Debugging Your Plugin](https://docs.biot-med.com/docs/debugging-your-plugin.md) - [Setting up AWS 2FA](https://docs.biot-med.com/docs/setting-up-aws-2fa.md) - [Making API calls from the Plugin](https://docs.biot-med.com/docs/making-api-calls-from-the-plugin.md) - [Interceptors - Blocking API Calls](https://docs.biot-med.com/docs/interceptors-blocking-api-calls.md) - [Over-the-Air (OTA) Update Module](https://docs.biot-med.com/docs/over-the-air-ota-update-module.md) - [EHR Integration Module](https://docs.biot-med.com/docs/ehr-integration-module.md) - [Integration with the BioT Analytics DB](https://docs.biot-med.com/docs/working-with-the-biot-analytics-db.md) - [Analytics DB Structure](https://docs.biot-med.com/docs/analytics-db-structure.md) - [Grafana Integration](https://docs.biot-med.com/docs/grafana-integration.md) - [Working on your dashboard](https://docs.biot-med.com/docs/working-on-your-dashboard.md) - [Using Macros](https://docs.biot-med.com/docs/using-macros.md) - [Using Variables](https://docs.biot-med.com/docs/using-variables.md) - [Embed Grafana Dashboards in Portals](https://docs.biot-med.com/docs/embed-grafana-dashboards-in-portals.md): Learn how to embed Grafana dashboards into BioT portals and external portals with proper authentication and user token setup. - [Customer Support](https://docs.biot-med.com/docs/customer-support.md) - [Technical Evaluation](https://docs.biot-med.com/docs/technical-evaluation.md) - [Solution Architecture](https://docs.biot-med.com/docs/solution-architecture.md) - [Deployment Options](https://docs.biot-med.com/docs/deployment-options.md) - [Going Forward](https://docs.biot-med.com/docs/going-forward.md) - [Providing Feedback on BioT Documentation](https://docs.biot-med.com/docs/providing-feedback-to-biot.md) - [End of Life/Support](https://docs.biot-med.com/docs/end-of-lifesupport.md) ## API Reference - [The BioT API - Getting Started](https://docs.biot-med.com/reference/getting-started.md) - [Generate a new password for a User](https://docs.biot-med.com/reference/generateuserpassword.md): Generate a new password for a User Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|User ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **UMS_USERS_GENERATE_USER_PASSWORD** permission(s). - [Validate user credentials](https://docs.biot-med.com/reference/validateusercredentials.md): Validate user credentials This API can be used in order to validate the username and password are in a correct format before calling the create user API. If the credentials are valid the success field will be true. The API also returns the password strength. The minimum score is determined by an environment variable. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |username|string|true|user's username. If the credential type is OTP, should be a valid phone (An E.164 formatted phone number e.g +12345678901)|| |password|string|true||| |credentialType|string|false| Values:PASSWORD,OTP|| This API is **public**. - [Get User by ID](https://docs.biot-med.com/reference/getuser.md): Get User by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|User ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **UMS_USERS_GET_USER** permission(s). - [Delete User](https://docs.biot-med.com/reference/delete.md): Delete User Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|User ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **UMS_USERS_DELETE_USER** permission(s). - [Update User](https://docs.biot-med.com/reference/updateuser.md): Update User Performs partial update, if a field is specified in the request it will be updated (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |username|string|false|user's username. If the credential type is OTP, should be a valid phone (An E.164 formatted phone number e.g +12345678901)|| |locked|boolean|false||| |active|boolean|false||| |groupIds|array|false||| |idPs|array|false||| |mfa|object|false||| |mfa.enabled|boolean|true(*)||| |mfa.phone|string|true(*)|An E.164 formatted phone number|+12345678901| |mfa.expirationInMinutes|integer|false||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|User ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **UMS_USERS_UPDATE_USER** permission(s). - [Search User entities by filter](https://docs.biot-med.com/reference/search.md): Search User entities by filter Returns list of User, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *id*,*username*,*active*,*locked* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *id*,*username*,*active*,*locked*,*creationTime* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **UMS_USERS_SEARCH_USER** permission(s). - [Refresh JWT token](https://docs.biot-med.com/reference/refreshtoken.md): Refresh JWT token Create new access token with refresh token in request Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |refreshToken|string|true||| This API is **public**. - [Login with refresh token](https://docs.biot-med.com/reference/tokenlogin.md): Login with refresh token Creates a new pair of access and refresh tokens. Used in 'remember my password' flow Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |refreshToken|string|true||| This API is **public**. - [Login with OTP](https://docs.biot-med.com/reference/otplogin.md): Login with OTP Login with one time passcode and request id. Relevant for users with credential type=OTP. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |requestId|string|true|The request id you received when calling to the generate otp login code API|3fa85f64-5717-4562-b3fc-2c963f66afa6| |code|string|true|The code you received in the SMS sent to you when calling to the /otp/generate API|649551| This API is **public**. - [Generate login OTP](https://docs.biot-med.com/reference/generateotp.md): Generate login OTP This API is used by users with OTP credential type Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |phone|string|true|An E.164 formatted phone number|+12345678901| This API is **public**. - [Logout](https://docs.biot-med.com/reference/logout.md): Logout Logout by providing refresh token This API is **public**. - [Login with credentials](https://docs.biot-med.com/reference/login.md): Login with credentials Login with username and password. Relevant for users with credential type=PASSWORD. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |username|string|true||| |password|string|false||| This API is **public**. - [Self get user](https://docs.biot-med.com/reference/selfgetuser.md): Self get user User ID is taken from the JWT token This API requires **UMS_USERS_SELF_GET_USER** permission(s). - [Self registration of User](https://docs.biot-med.com/reference/selfregisteruser.md): Self registration of User password is mandatory only for ***PASSWORD*** credentialType This API is **public**. - [Self delete user](https://docs.biot-med.com/reference/selfdeleteuser.md): Self delete user User ID is taken from the JWT token This API requires **UMS_USERS_SELF_DELETE_USER** permission(s). - [Self update user](https://docs.biot-med.com/reference/selfupdateuser.md): Self update user User ID is taken from the JWT token This API requires **UMS_USERS_SELF_UPDATE_USER** permission(s). - [Send reset password message](https://docs.biot-med.com/reference/forgotpassword.md): Send reset password message If the username exists - a reset password message will be sent to the user's mail. The landing page link set in the email can be set globally or per organization in the Landing Page APIs. For further details please refer to the documentation at https://docs.biot-med.com/docs/landing-pages. This API is **public**. - [MFA login](https://docs.biot-med.com/reference/mfalogin.md): MFA login Login by verification code sent by SMS. In case a password reset is required (i.e. passwordResetRequired=true), the refreshJwt field will be null This API requires **UMS_MFA_LOGIN** permission(s). - [Resend SMS for MFA verification](https://docs.biot-med.com/reference/mfaresend.md): Resend SMS for MFA verification Used to send the second-factor authentication by SMS containing the verification code This API requires **UMS_RESEND_MFA_SMS** permission(s). - [Search Service User entities by filter](https://docs.biot-med.com/reference/searchserviceusers.md): Search Service User entities by filter Returns list of Service User, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *id*,*active*,*type*,*ownerOrganizationId*,*name*,*accessTokenExpirationInMinutes* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *id*,*active*,*type*,*ownerOrganizationId*,*name*,*accessTokenExpirationInMinutes* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **UMS_USERS_SEARCH_SERVICE_USERS** permission(s). - [Create a new Service User](https://docs.biot-med.com/reference/createserviceuser.md): Create a new Service User Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |active|boolean|false||| |roleId|string|true|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |type|string|true| Values:INTERNAL_SERVICE,EXTERNAL_SERVICE|| |ownerOrganizationId|string|false|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |name|string|false||| |accessTokenExpirationInMinutes|integer|false||| This API requires **UMS_SERVICES_CREATE_SERVICE_USER** permission(s). - [Create a new Service User](https://docs.biot-med.com/reference/createsecretkey.md): Create a new Service User Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Service User ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **UMS_USERS_CREATE_SECRET_KEY_BY_SERVICE_USER_ID** permission(s). - [Service User Login](https://docs.biot-med.com/reference/serviceuserlogin.md): Service User Login Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |secretKey|string|true||| This API is **public**. - [Get Service User by ID](https://docs.biot-med.com/reference/getserviceuserbyid.md): Get Service User by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Service User ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **UMS_USERS_GET_SERVICE_USER_BY_ID** permission(s). - [Delete Service User](https://docs.biot-med.com/reference/deleteserviceuser.md): Delete Service User Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Service User ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **UMS_SERVICES_DELETE_SERVICE_USER** permission(s). - [Update Service User](https://docs.biot-med.com/reference/updateserviceuser.md): Update Service User Performs partial update, if a field is specified in the request it will be updated Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |active|boolean|false||| |roleId|string|false|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Service User ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **UMS_SERVICES_UPDATE_SERVICE_USER** permission(s). - [Delete secret key of a service user by service user id and secret key id](https://docs.biot-med.com/reference/deletesecretkey.md): Delete secret key of a service user by service user id and secret key id Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Service User ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| |secretKeyId|string|true|Secret Key ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **UMS_USERS_DELETE_SECRET_KEY_BY_ID** permission(s). - [Validation token operation](https://docs.biot-med.com/reference/validatetokenoperation.md): Validation token operation Validate that token, operation and entity ID are valid and not expired. This API is **public**. - [Execute token operation](https://docs.biot-med.com/reference/executetokenoperation.md): Execute token operation Execute operation by specifying a temp token instead of jwt token This API is **public**. - [Execute token operation](https://docs.biot-med.com/reference/executetokenoperationget-1.md): Execute token operation Execute operation by specifying a temp token instead of jwt token This API is **public**. - [Get MQTT temporary credentials for receiving notification for all entities in an organization.](https://docs.biot-med.com/reference/gettempcredentialsfororganization.md): Get MQTT temporary credentials for receiving notification for all entities in an organization. Also returns a single topic formatted '[ownerOrganizationId]/+/+'. [ownerOrganizationId] will be filled from the access token and should not be changed. The first [+] represents entityType and can be changed to any entityType. this topic will include only messages from that entity type. [+] can be used to listen to all entity types. The second [+] represents entityId and can be changed to any entityId in the organization, this topic will include only messages from that entity. [+] can be used to listen to all entities. E.g. The topic for an organization with id [64a454f0-352f-4373-a39f-5bded3cf58e9] and entity with type device listening to all notification will be '64a454f0-352f-4373-a39f-5bded3cf58e9/device/+'. This API requires **PROTECTED_API** permission(s). - [Get public key](https://docs.biot-med.com/reference/getpublickey.md): Get public key This API is **public**. - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-6.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Get Template by ID](https://docs.biot-med.com/reference/gettemplate.md): Get Template by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateId|string|true|null|| This API requires **SETTINGS_GET_TEMPLATE** permission(s). - [Update Template](https://docs.biot-med.com/reference/updatetemplate.md): Update Template Important notice: This is a full update API (PUT), all existing attributes must be specified in the request body. Attributes that are not specified will be deleted from the updated record (receive a NULL value). Performs full update, the values will be replaced with values that are specified in the request (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |displayName|string|true||| |name|string|true| Pattern:[a-zA-Z]\w*|| |description|string|false||| |ownerOrganizationId|string|false||| |analyticsDbConfiguration|object|false||| |analyticsDbConfiguration.name|string|false||| |forceUpdate|boolean|false|Deprecated. Use the 'force' query parameter instead.|| |customAttributes|array|true|Custom attributes definitions for this template. Empty list means no custom attributes.|| |customAttributes[index]|array|false|Custom attributes definitions for this template. Empty list means no custom attributes.|| |customAttributes[index].displayName|string|true(*)||| |customAttributes[index].phi|boolean|false||| |customAttributes[index].referenceConfiguration|object|false||| |customAttributes[index].referenceConfiguration.uniquely|boolean|false||| |customAttributes[index].referenceConfiguration.referencedSideAttributeName|string|false||| |customAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName|string|false||| |customAttributes[index].referenceConfiguration.validTemplatesToReference|array|false||| |customAttributes[index].referenceConfiguration.entityType|string|true(*)||| |customAttributes[index].linkConfiguration|object|false||| |customAttributes[index].linkConfiguration.entityTypeName|string|true(*)||| |customAttributes[index].linkConfiguration.templateId|string|true(*)||| |customAttributes[index].linkConfiguration.attributeId|string|true(*)||| |customAttributes[index].name|string|true(*)| Pattern:[a-zA-Z]\w*|| |customAttributes[index].type|string|true(*)| Values:LABEL,PARAGRAPH,INTEGER,DECIMAL,BOOLEAN,SINGLE_SELECT,MULTI_SELECT,ADDRESS,NAME,PHONE,EMAIL,DATE_TIME,DATE,REFERENCE,TIMEZONE,LOCALE,FILE,IMAGE,LINK,WAVEFORM|| |customAttributes[index].validation|object|false||| |customAttributes[index].validation.mandatory|boolean|true(*)||| |customAttributes[index].validation.unique|boolean|false| Default:false|false| |customAttributes[index].validation.defaultValue|object|false||| |customAttributes[index].validation.min|number|false||| |customAttributes[index].validation.max|number|false||| |customAttributes[index].validation.regex|string|false||| |customAttributes[index].validation.supportedMimeTypes|array|false|For FILE and IMAGE attributes: the exact MIME types accepted for this attribute. When set, the uploaded file's MIME type must be in this list (in addition to passing the type-level whitelist for IMAGE).|| |customAttributes[index].numericMetaData|object|false||| |customAttributes[index].numericMetaData.units|string|false||| |customAttributes[index].numericMetaData.upperRange|number|false||| |customAttributes[index].numericMetaData.lowerRange|number|false||| |customAttributes[index].numericMetaData.subType|string|false| Values:INTEGER,DECIMAL|| |customAttributes[index].uiConfiguration|object|false||| |customAttributes[index].uiConfiguration.date|object|false||| |customAttributes[index].uiConfiguration.date.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |customAttributes[index].uiConfiguration.dateTime|object|false||| |customAttributes[index].uiConfiguration.dateTime.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |customAttributes[index].uiConfiguration.dateTime.timeStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |customAttributes[index].analyticsDbConfiguration|object|false||| |customAttributes[index].analyticsDbConfiguration.name|string|false||| |customAttributes[index].id|string|false||| |customAttributes[index].selectableValues|array|false||| |customAttributes[index].selectableValues[index]|array|false||| |customAttributes[index].selectableValues[index].name|string|true(*)| Pattern:[a-zA-Z]\w*|| |customAttributes[index].selectableValues[index].displayName|string|true(*)||| |customAttributes[index].selectableValues[index].id|string|false||| |customAttributes[index].category|string|true(*)||| |builtInAttributes|array|true|Built-in attributes definitions for this template. Empty list is allowed.|| |builtInAttributes[index]|array|false|Built-in attributes definitions for this template. Empty list is allowed.|| |builtInAttributes[index].id|string|true(*)||| |builtInAttributes[index].displayName|string|true(*)||| |builtInAttributes[index].phi|boolean|false||| |builtInAttributes[index].referenceConfiguration|object|false||| |builtInAttributes[index].referenceConfiguration.uniquely|boolean|false||| |builtInAttributes[index].referenceConfiguration.referencedSideAttributeName|string|false||| |builtInAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName|string|false||| |builtInAttributes[index].referenceConfiguration.validTemplatesToReference|array|false||| |builtInAttributes[index].referenceConfiguration.entityType|string|true(*)||| |builtInAttributes[index].linkConfiguration|object|false||| |builtInAttributes[index].linkConfiguration.entityTypeName|string|true(*)||| |builtInAttributes[index].linkConfiguration.templateId|string|true(*)||| |builtInAttributes[index].linkConfiguration.attributeId|string|true(*)||| |builtInAttributes[index].validation|object|false||| |builtInAttributes[index].validation.mandatory|boolean|true(*)||| |builtInAttributes[index].validation.unique|boolean|false| Default:false|false| |builtInAttributes[index].validation.defaultValue|object|false||| |builtInAttributes[index].validation.min|number|false||| |builtInAttributes[index].validation.max|number|false||| |builtInAttributes[index].validation.regex|string|false||| |builtInAttributes[index].validation.supportedMimeTypes|array|false|For FILE and IMAGE attributes: the exact MIME types accepted for this attribute. When set, the uploaded file's MIME type must be in this list (in addition to passing the type-level whitelist for IMAGE).|| |builtInAttributes[index].numericMetaData|object|false||| |builtInAttributes[index].numericMetaData.units|string|false||| |builtInAttributes[index].numericMetaData.upperRange|number|false||| |builtInAttributes[index].numericMetaData.lowerRange|number|false||| |builtInAttributes[index].numericMetaData.subType|string|false| Values:INTEGER,DECIMAL|| |builtInAttributes[index].uiConfiguration|object|false||| |builtInAttributes[index].uiConfiguration.date|object|false||| |builtInAttributes[index].uiConfiguration.date.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |builtInAttributes[index].uiConfiguration.dateTime|object|false||| |builtInAttributes[index].uiConfiguration.dateTime.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |builtInAttributes[index].uiConfiguration.dateTime.timeStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |templateAttributes|array|true|Template-level attributes definitions. Empty list is allowed.|| |templateAttributes[index]|array|false|Template-level attributes definitions. Empty list is allowed.|| |templateAttributes[index].id|string|true(*)||| |templateAttributes[index].displayName|string|true(*)||| |templateAttributes[index].phi|boolean|false||| |templateAttributes[index].referenceConfiguration|object|false||| |templateAttributes[index].referenceConfiguration.uniquely|boolean|false||| |templateAttributes[index].referenceConfiguration.referencedSideAttributeName|string|false||| |templateAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName|string|false||| |templateAttributes[index].referenceConfiguration.validTemplatesToReference|array|false||| |templateAttributes[index].referenceConfiguration.entityType|string|true(*)||| |templateAttributes[index].linkConfiguration|object|false||| |templateAttributes[index].linkConfiguration.entityTypeName|string|true(*)||| |templateAttributes[index].linkConfiguration.templateId|string|true(*)||| |templateAttributes[index].linkConfiguration.attributeId|string|true(*)||| |templateAttributes[index].value|object|false||| |templateAttributes[index].uiConfiguration|object|false||| |templateAttributes[index].uiConfiguration.date|object|false||| |templateAttributes[index].uiConfiguration.date.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |templateAttributes[index].uiConfiguration.dateTime|object|false||| |templateAttributes[index].uiConfiguration.dateTime.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |templateAttributes[index].uiConfiguration.dateTime.timeStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |templateAttributes[index].organizationSelectionConfiguration|object|false||| |templateAttributes[index].organizationSelectionConfiguration.selected|array|false||| |templateAttributes[index].organizationSelectionConfiguration.selected[index]|array|false||| |templateAttributes[index].organizationSelectionConfiguration.selected[index].id|string|true(*)||| |templateAttributes[index].organizationSelectionConfiguration.all|boolean|false||| |parentTemplateId|string|false|The parent template id if this template inherits from another template.|123e4567-e89b-12d3-a456-426614174000| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateId|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |force|boolean|false|Sometimes modifying the system's templates can cause side effects to other components. The 'force' flag indicates whether or not to force the template changes even if those side effects were to occur. For example: changing templates will cause Analytics DB to exit syncing data mode. If 'force' is not provided fallback is the 'forceUpdate' value inside 'templateRequest'|true| This API requires **SETTINGS_UPDATE_TEMPLATE** permission(s). - [Delete Template](https://docs.biot-med.com/reference/deletetemplate.md): Delete Template Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateId|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |force|boolean|false|Sometimes modifying the system's templates can cause side effects to other components. The 'force' flag indicates whether or not to force the template changes even if those side effects were to occur. For example: changing templates will cause Analytics DB to exit syncing data mode.|true| This API requires **SETTINGS_DELETE_TEMPLATE** permission(s). - [Search Template entities by filter](https://docs.biot-med.com/reference/search_1.md): Search Template entities by filter Returns list of Template, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *id*,*name*,*entityTypeName*,*parentTemplateId*,*ownerOrganizationId*,*parentTemplate.id*,*analyticsDbConfiguration.name* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *id*,*entityTypeName*,*creationTime* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **SETTINGS_SEARCH_TEMPLATE** permission(s). - [Create a new Template](https://docs.biot-med.com/reference/createtemplate.md): Create a new Template (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |displayName|string|true||| |name|string|true| Pattern:[a-zA-Z]\w*|| |description|string|false||| |ownerOrganizationId|string|false||| |analyticsDbConfiguration|object|false||| |analyticsDbConfiguration.name|string|false||| |customAttributes|array|false||| |customAttributes[index]|array|false||| |customAttributes[index].displayName|string|true(*)||| |customAttributes[index].phi|boolean|false||| |customAttributes[index].referenceConfiguration|object|false||| |customAttributes[index].referenceConfiguration.uniquely|boolean|false||| |customAttributes[index].referenceConfiguration.referencedSideAttributeName|string|false||| |customAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName|string|false||| |customAttributes[index].referenceConfiguration.validTemplatesToReference|array|false||| |customAttributes[index].referenceConfiguration.entityType|string|true(*)||| |customAttributes[index].linkConfiguration|object|false||| |customAttributes[index].linkConfiguration.entityTypeName|string|true(*)||| |customAttributes[index].linkConfiguration.templateId|string|true(*)||| |customAttributes[index].linkConfiguration.attributeId|string|true(*)||| |customAttributes[index].name|string|true(*)| Pattern:[a-zA-Z]\w*|| |customAttributes[index].type|string|true(*)| Values:LABEL,PARAGRAPH,INTEGER,DECIMAL,BOOLEAN,SINGLE_SELECT,MULTI_SELECT,ADDRESS,NAME,PHONE,EMAIL,DATE_TIME,DATE,REFERENCE,TIMEZONE,LOCALE,FILE,IMAGE,LINK,WAVEFORM|| |customAttributes[index].validation|object|false||| |customAttributes[index].validation.mandatory|boolean|true(*)||| |customAttributes[index].validation.unique|boolean|false| Default:false|false| |customAttributes[index].validation.defaultValue|object|false||| |customAttributes[index].validation.min|number|false||| |customAttributes[index].validation.max|number|false||| |customAttributes[index].validation.regex|string|false||| |customAttributes[index].validation.supportedMimeTypes|array|false|For FILE and IMAGE attributes: the exact MIME types accepted for this attribute. When set, the uploaded file's MIME type must be in this list (in addition to passing the type-level whitelist for IMAGE).|| |customAttributes[index].numericMetaData|object|false||| |customAttributes[index].numericMetaData.units|string|false||| |customAttributes[index].numericMetaData.upperRange|number|false||| |customAttributes[index].numericMetaData.lowerRange|number|false||| |customAttributes[index].numericMetaData.subType|string|false| Values:INTEGER,DECIMAL|| |customAttributes[index].uiConfiguration|object|false||| |customAttributes[index].uiConfiguration.date|object|false||| |customAttributes[index].uiConfiguration.date.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |customAttributes[index].uiConfiguration.dateTime|object|false||| |customAttributes[index].uiConfiguration.dateTime.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |customAttributes[index].uiConfiguration.dateTime.timeStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |customAttributes[index].analyticsDbConfiguration|object|false||| |customAttributes[index].analyticsDbConfiguration.name|string|false||| |customAttributes[index].selectableValues|array|false||| |customAttributes[index].selectableValues[index]|array|false||| |customAttributes[index].selectableValues[index].name|string|true(*)| Pattern:[a-zA-Z]\w*|| |customAttributes[index].selectableValues[index].displayName|string|true(*)||| |customAttributes[index].category|string|true(*)||| |builtInAttributes|array|false||| |builtInAttributes[index]|array|false||| |builtInAttributes[index].name|string|true(*)||| |builtInAttributes[index].basePath|string|false||| |builtInAttributes[index].displayName|string|true(*)||| |builtInAttributes[index].phi|boolean|false||| |builtInAttributes[index].referenceConfiguration|object|false||| |builtInAttributes[index].referenceConfiguration.uniquely|boolean|false||| |builtInAttributes[index].referenceConfiguration.referencedSideAttributeName|string|false||| |builtInAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName|string|false||| |builtInAttributes[index].referenceConfiguration.validTemplatesToReference|array|false||| |builtInAttributes[index].referenceConfiguration.entityType|string|true(*)||| |builtInAttributes[index].linkConfiguration|object|false||| |builtInAttributes[index].linkConfiguration.entityTypeName|string|true(*)||| |builtInAttributes[index].linkConfiguration.templateId|string|true(*)||| |builtInAttributes[index].linkConfiguration.attributeId|string|true(*)||| |builtInAttributes[index].validation|object|false||| |builtInAttributes[index].validation.mandatory|boolean|true(*)||| |builtInAttributes[index].validation.unique|boolean|false| Default:false|false| |builtInAttributes[index].validation.defaultValue|object|false||| |builtInAttributes[index].validation.min|number|false||| |builtInAttributes[index].validation.max|number|false||| |builtInAttributes[index].validation.regex|string|false||| |builtInAttributes[index].validation.supportedMimeTypes|array|false|For FILE and IMAGE attributes: the exact MIME types accepted for this attribute. When set, the uploaded file's MIME type must be in this list (in addition to passing the type-level whitelist for IMAGE).|| |builtInAttributes[index].numericMetaData|object|false||| |builtInAttributes[index].numericMetaData.units|string|false||| |builtInAttributes[index].numericMetaData.upperRange|number|false||| |builtInAttributes[index].numericMetaData.lowerRange|number|false||| |builtInAttributes[index].numericMetaData.subType|string|false| Values:INTEGER,DECIMAL|| |builtInAttributes[index].uiConfiguration|object|false||| |builtInAttributes[index].uiConfiguration.date|object|false||| |builtInAttributes[index].uiConfiguration.date.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |builtInAttributes[index].uiConfiguration.dateTime|object|false||| |builtInAttributes[index].uiConfiguration.dateTime.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |builtInAttributes[index].uiConfiguration.dateTime.timeStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |templateAttributes|array|false||| |templateAttributes[index]|array|false||| |templateAttributes[index].name|string|true(*)||| |templateAttributes[index].basePath|string|false||| |templateAttributes[index].displayName|string|true(*)||| |templateAttributes[index].phi|boolean|false||| |templateAttributes[index].referenceConfiguration|object|false||| |templateAttributes[index].referenceConfiguration.uniquely|boolean|false||| |templateAttributes[index].referenceConfiguration.referencedSideAttributeName|string|false||| |templateAttributes[index].referenceConfiguration.referencedSideAttributeDisplayName|string|false||| |templateAttributes[index].referenceConfiguration.validTemplatesToReference|array|false||| |templateAttributes[index].referenceConfiguration.entityType|string|true(*)||| |templateAttributes[index].linkConfiguration|object|false||| |templateAttributes[index].linkConfiguration.entityTypeName|string|true(*)||| |templateAttributes[index].linkConfiguration.templateId|string|true(*)||| |templateAttributes[index].linkConfiguration.attributeId|string|true(*)||| |templateAttributes[index].value|object|false||| |templateAttributes[index].uiConfiguration|object|false||| |templateAttributes[index].uiConfiguration.date|object|false||| |templateAttributes[index].uiConfiguration.date.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |templateAttributes[index].uiConfiguration.dateTime|object|false||| |templateAttributes[index].uiConfiguration.dateTime.dateStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |templateAttributes[index].uiConfiguration.dateTime.timeStyle|string|false| Values:SHORT,MEDIUM,LONG,FULL|| |templateAttributes[index].organizationSelectionConfiguration|object|false||| |templateAttributes[index].organizationSelectionConfiguration.selected|array|false||| |templateAttributes[index].organizationSelectionConfiguration.selected[index]|array|false||| |templateAttributes[index].organizationSelectionConfiguration.selected[index].id|string|true(*)||| |templateAttributes[index].organizationSelectionConfiguration.all|boolean|false||| |entityType|string|true||| |parentTemplateId|string|false||| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |force|boolean|false|Sometimes modifying the system's templates can cause side effects to other components. The 'force' flag indicates whether or not to force the template changes even if those side effects were to occur. For example: changing templates will cause Analytics DB to exit syncing data mode.|true| This API requires **SETTINGS_CREATE_TEMPLATE** permission(s). - [Get template overview](https://docs.biot-med.com/reference/gettemplateoverview.md): Get template overview Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateId|string|true|null|| This API requires **SETTINGS_GET_TEMPLATE_OVERVIEW** permission(s). - [Search Template entities by filter](https://docs.biot-med.com/reference/minimalsearch.md): Search Template entities by filter Returns Minimized search response Returns list of Template, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *id*,*name*,*entityTypeName, parentTemplateId*,*parentTemplate.id*,*ownerOrganizationId*,*analyticsDbConfiguration.name* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *id*,*entityTypeName*,*creationTime* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **SETTINGS_MINIMIZED_SEARCH_TEMPLATE** permission(s). - [Search Plugin entities by filter](https://docs.biot-med.com/reference/search-1.md): Search Plugin entities by filter Returns list of Plugin, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *name*,*displayName*,*version*,*endpointUrl*,*timeout*,*runtime*,*handler*,*memorySize*,*enabledState*,*creationTime*,*lastModifiedTime*,*deploymentPackageType*,*ephemeralStorage* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *name*,*displayName*,*version*,*endpointUrl*,*timeout*,*runtime*,*handler*,*memorySize*,*enabledState*,*creationTime*,*lastModifiedTime*,*deploymentPackageType*,*ephemeralStorage* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **SETTINGS_PLUGIN_SEARCH** permission(s). - [Create a new Plugin](https://docs.biot-med.com/reference/create.md): Create a new Plugin Will create a service user in the UMS, upload the code file if sent, publish the plugin, create an accessible endpoint for it and subscribe all requested notifications and interceptions to that endpoint. For ZIP deployment package type, if code is not sent it will use a seed code instead. The imageTag field is relevant only for deploymentPackageType = IMAGE. Specify the tag you used when you uploaded the image using the docker push command. After being attach to the plugin, the image will be managed by the server. The imageTag has no meanings after a successful call and will not be returned as part of the response, the imageTag is only a way to provide the plugin code when the deploymentPackageType is IMAGE (instead of using the code parameter). If the imageTag field is not sent it will use a seed code instead, based on the runtime parameter. If this API fails, it will roll back the changes it made. This is a "multipart/form-data" request that includes both the binary zip file and configuration information. The form should include 2 parameters: 1. "code": Non-mandatory binary zip file. 2. "config": Mandatory JSON configuration of the plugin. For more detailed information regarding the plugins, please visit the following page: https://docs.biot-med.com/docs/biot-plugins This API requires **SETTINGS_PLUGIN_CREATE** permission(s). - [Get plugin by name](https://docs.biot-med.com/reference/get.md): Get plugin by name Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |name|string|true|null|| This API requires **SETTINGS_PLUGIN_GET** permission(s). - [Delete Plugin](https://docs.biot-med.com/reference/delete-1.md): Delete Plugin Will delete the plugin, its service user in the UMS, unsubscribe from all subscriptions, and delete its code if uploaded. If the plugin deployment package type is IMAGE, the related docker image will be removed (only if not being used by other plugins) If this API fails, it will roll back the changes it made. For more detailed information regarding the plugins, please visit the following page: https://docs.biot-med.com/docs/biot-plugins Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |name|string|true|null|| This API requires **SETTINGS_PLUGIN_DELETE** permission(s). - [Update Plugin](https://docs.biot-med.com/reference/partialupdate.md): Update Plugin Will upload the code file and publish the plugin if code is sent, and subscribe to all requested notifications and interceptions to the endpoint. Environment variables update rules: - The environmentVariables map is optional. Omitting it keeps every existing custom entry as-is. - When the map is provided, treat it as the full desired set: any key you do not include is removed (system-managed keys are added automatically). Sending {} clears all custom environment variables. Subscriptions update rules: - Omit subscriptions (or set to null) to leave all subscriptions unchanged. An empty object ({}) also makes no changes. - When subscriptions is provided: * subscriptions.interceptions: - Omit to keep existing - [] removes all - A list replaces existing (unmentioned items removed) * subscriptions.notifications: - Omit to keep existing - [] removes all - A list replaces existing (unmentioned items removed) CORS update rules: - The cors object is optional. Omitting it keeps the existing browser access configuration. - Each list inside cors (allowOrigins, allowMethods, allowHeaders, exposeHeaders) is a full replacement list: omit the list to keep its current value, send [] to remove all entries, or provide a populated list to replace the existing one. These semantics apply to every array/list field in this API: omit the field to leave it untouched; send [] (or {}) to clear its entries; provide values to fully replace the collection. If runtime is changed to a different language and a seed is already deployed, a seed of the new language will be used. If runtime is changed to a different language and custom code is already deployed, the code will not change. The imageTag field is relevant only for deploymentPackageType = IMAGE. Specify the tag you used when you uploaded the image using the docker push command. After being attach to the plugin, the image will be managed by the server. The imageTag has no meanings after a successful call and will not be returned as part of the response, the imageTag is only a way to provide the plugin code when the deploymentPackageType is IMAGE (instead of using the code parameter). If this API fails, it will roll back the changes it made. This is a "multipart/form-data" request that includes both the binary zip file and configuration information. The form should include 2 parameters: 1. "code": Non-mandatory binary zip file. 2. "config": Mandatory JSON configuration of the plugin. For more detailed information regarding the plugins, please visit the following page: https://docs.biot-med.com/docs/biot-plugins Performs partial update, if a field is specified in the request it will be updated Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |name|string|true|null|| This API requires **SETTINGS_PLUGIN_UPDATE** permission(s). - [Get temporary credentials for the docker repository](https://docs.biot-med.com/reference/getdockerrepositorytempcredentials.md): Get temporary credentials for the docker repository This API should be used before creating a plugin with a deployment package type IMAGE, in order to get the appropriate credentials for pushing an image to the docker repository. For more detailed information regarding the plugins, please visit the following page: https://docs.biot-med.com/docs/biot-plugins This API requires **SETTINGS_PLUGIN_GET_DOCKER_REPOSITORY_TEMP_CREDENTIALS** permission(s). - [Validate translations for locale](https://docs.biot-med.com/reference/validatelocaletranslations.md): Validate translations for locale This API behaves exactly the same as the update API except that this API does not make any actual changes. The purpose of this API is to be able to validate all of the provided translation keys, before calling the update API, and get an error information for each invalid translation key, without ending with a partial success as happens when calling to the update API. The file that is being uploaded should be in a csv format, as returned from the /download API. The provided locale must be one of the available locales configured in the system via the Locale API and cannot be the system locale (en-us). Providing only part of the translation keys is allowed. The following headers must be exist, and only once: Translation Key,System Locale (en-us) Translation,{providedLocale} Translation. If all of the translation records are valid, a 200 status code will be returned and the invalidTranslations field will be empty. If one or more of the translation records are invalid, a 206 status code will be returned with a list of the invalid translations. The following are the cases where a translation record will be considered as invalid: [invalid translation key / the system locale translation value does not match the current value in the system] Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |locale|string|true|null|| This API requires **SETTINGS_VALIDATE_LOCALE_TRANSLATIONS** permission(s). - [Update translations for locale](https://docs.biot-med.com/reference/updatelocaletranslations.md): Update translations for locale The file that is being uploaded should be in a csv format, as returned from the /download API. The provided locale must be one of the available locales configured in the system via the Locale API and cannot be the system locale (en-us). Providing only part of the translation keys is allowed. The following headers must be exist, and only once: Translation Key,System Locale (en-us) Translation,{providedLocale} Translation. In order to remove a translation for a single key, put an empty string. If all of the translation records are valid, a 200 status code will be returned and the invalidTranslations field will be empty. If one or more of the translation records are invalid, the rest of the valid translations will be saved and a 206 status code will be returned with a list of the invalid translations that were ignored. The following are the cases where a translation record will be considered as invalid: [invalid translation key / the system locale translation value does not match the current value in the system] Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |locale|string|true|null|| This API requires **SETTINGS_UPDATE_LOCALE_TRANSLATIONS** permission(s). - [Download locale translation file](https://docs.biot-med.com/reference/downloadlocaletranslationfile.md): Download locale translation file Will return a CSV file with the following headers: Translation Key,System Locale (en-us) Translation,{providedLocale} Translation. The provided locale must be one of the available locales configured in the system via the Locale API Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |locale|string|true|null|| This API requires **SETTINGS_DOWNLOAD_LOCALE_TRANSLATION_FILE** permission(s). - [Search Locale translations overview entities by filter](https://docs.biot-med.com/reference/searchlocaletranslationoverviews.md): Search Locale translations overview entities by filter coverage.numberOfAvailableKeys is the number of available keys that require a translation (i.e. the number of the system locale en-us translation keys but only those which have a non empty value). coverage.numberOfTranslatedKeys is the number of the translated keys that are a subset of the available keys that require a translation (as defined above) Returns list of Locale translations overview, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *locale* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *locale* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **SETTINGS_SEARCH_LOCALE_TRANSLATION_OVERVIEWS** permission(s). - [Delete all translations for locale](https://docs.biot-med.com/reference/deletelocaletranslations.md): Delete all translations for locale The provided locale must be one of the available locales configured in the system via the Locale API. Cannot remove translations of the default locale Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |locale|string|true|null|| This API requires **SETTINGS_DELETE_LOCALE_TRANSLATIONS** permission(s). - [Backup](https://docs.biot-med.com/reference/backup.md): Backup This backup will be saved in an S3 bucket in AWS. The name parameter in the request will be the folder the backup is saved in the s3 bucket. The full path in which it will be saved is s3://-backup// E.g. for customer id 123456, biot version 2.3.11 and backup name backup1, the backup will be saved in the s3 path s3://123456-backup/2.3.11/backup1 Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |name|string|true|The name of the backup, it will also be the folder in which the backup is saved|Backup-01-02-2024| |description|string|false|The description of the backup|Backup after entity creation| This API requires **SETTINGS_START_BACKUP** permission(s). - [Search Restore entities by filter](https://docs.biot-med.com/reference/searchrestoreexecutions.md): Search Restore entities by filter Returns list of Restore, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *name*,*backupVersion*,*buildNumber*,*errorMessage*,*status*,*creationTime*,*lastModifiedTime* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *name*,*backupVersion*,*buildNumber*,*errorMessage*,*status*,*creationTime*,*lastModifiedTime* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **SETTINGS_SEARCH_RESTORES** permission(s). - [Search Backup entities by filter](https://docs.biot-med.com/reference/searchbackupexecutions.md): Search Backup entities by filter Returns list of Backup, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *name*,*description*,*backupVersion*,*buildNumber*,*errorMessage*,*status*,*creationTime*,*lastModifiedTime* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *name*,*description*,*backupVersion*,*buildNumber*,*errorMessage*,*status*,*creationTime*,*lastModifiedTime* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **SETTINGS_SEARCH_BACKUPS** permission(s). - [Add locale to the available locales](https://docs.biot-med.com/reference/addlocale.md): Add locale to the available locales Locale codes are lowercase formatted and using '-' between country code and language, for example: 'en-us' Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |code|string|true|Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |hidden|boolean|false||false| |translationFallbackTypes|array|false|Valid array values: DEFAULT_LOCALE,SYSTEM_LOCALE. Allow to control the fallback mechanism. If not provided(null) then the default behavior is the following fallback order: -> DEFAULT_LOCALE -> SYSTEM_LOCALE. The recommended value is null. When all of the fallback types return an empty value, no translation will be made, i.e. the original value will be retained|| This API requires **SETTINGS_CREATE_LOCALE** permission(s). - [Get available locales, the default locale and the system locale](https://docs.biot-med.com/reference/getlocales.md): Get available locales, the default locale and the system locale Locale codes are lowercase formatted and using '-' between country code and language, for example: 'en-us' This API is **public**. - [Update available locales and/or the system default locale.](https://docs.biot-med.com/reference/updatelocales.md): Update available locales and/or the system default locale. Locale codes are lowercase formatted and using '-' between country code and language, for example: 'en-us'. If the availableLocales was provided it must contain the system locale en-us because it cannot be removed. IF 'defaultLocale' was provided it must be exist in the availableLocales list. If availableLocales is not provided the default locale must be exist before setting it as default Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |availableLocales|object|false||| |availableLocales.present|boolean|false||| |defaultLocaleCode|string|false|Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| This API requires **SETTINGS_UPDATE_LOCALES** permission(s). - [Remove a locale from the available locales](https://docs.biot-med.com/reference/deletelocale.md): Remove a locale from the available locales Path param 'id' refers to the locale code. If the provided id not exist status 200 is returned. Cannot delete the system locale. Cannot delete the default locale. If you wish to delete the default locale First you need to change the default to another one. Locale codes are lowercase formatted and using '-' between country code and language, for example: 'en-us' Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Locale ID|| This API requires **SETTINGS_DELETE_LOCALE** permission(s). - [Search Code snippet entities by filter](https://docs.biot-med.com/reference/search_2.md): Search Code snippet entities by filter freeTextSearch will work on the code field Returns list of Code snippet, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *id*,*name*,*language*,*creationTime* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *name*,*language*,*creationTime* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **SETTINGS_SEARCH_CODE_SNIPPETS** permission(s). - [Search Interception Configurations entities by filter](https://docs.biot-med.com/reference/search_3.md): Search Interception Configurations entities by filter Returns list of Interception Configurations, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *apiId*,*entityTypeName*,*servicePrefix* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *apiId*,*entityTypeName*,*servicePrefix* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **SETTINGS_SEARCH_INTERCEPTION_SUBSCRIPTION_CONFIGURATIONS** permission(s). - [Create a new Code snippet](https://docs.biot-med.com/reference/createcodesnippet.md): Create a new Code snippet Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |name|string|false|The name of the code snippet|User is nurse| |description|string|false|The description of the code snippet|Returns true if the user template name is called nurse| |language|string|true|The code language Values:JAVASCRIPT|JAVASCRIPT| |code|string|true|The actual code snippet|user._template.name === 'nurse'| This API requires **SETTINGS_CREATE_CODE_SNIPPET** permission(s). - [Get Code snippet by ID](https://docs.biot-med.com/reference/getcodesnippet.md): Get Code snippet by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Code snippet ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **SETTINGS_GET_CODE_SNIPPET** permission(s). - [Delete Code snippet](https://docs.biot-med.com/reference/deletecodesnippet.md): Delete Code snippet Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Code snippet ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **SETTINGS_DELETE_CODE_SNIPPET** permission(s). - [Get all Entity types](https://docs.biot-med.com/reference/searchentitytypes.md): Get all Entity types Get all Entity types that support templates This API requires **SETTINGS_SEARCH_ENTITY_TYPES** permission(s). - [Get all notifiable actions](https://docs.biot-med.com/reference/getnotifiableactions.md): Get all notifiable actions Get all entity types names that their action have enabled notification This API requires **SETTINGS_GET_ENTITY_TYPES** permission(s). - [Get all Entity types](https://docs.biot-med.com/reference/getentitytypes.md): Get all Entity types Get all Entity types that support templates This API requires **SETTINGS_GET_ENTITY_TYPES** permission(s). - [Get all notifiable actions](https://docs.biot-med.com/reference/getnotifiableactions_1.md): Get all notifiable actions Get all entity types names that their action have enabled notification This API requires **SETTINGS_GET_ENTITY_TYPES** permission(s). - [Get system properties](https://docs.biot-med.com/reference/getsystemproperties.md): Get system properties This API returns the system properties. This API is **public**. - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-8.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Search Device entities by filter](https://docs.biot-med.com/reference/searchdevices.md): Search Device entities by filter Returns list of Device, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_ownerOrganization.id*,*_description*,*_timezone*,*_patient.id*,*_status._fwVersion*,*_status._hwVersion*,*_status._bootTime*,*_status._connection._connected*,*_status._connection._ipAddress*,*_status._operational._status*,*_status._operational._message*,*_templateId*,*_templateName*,*_lastModifiedTime*,*_creationTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_ownerOrganization.id*,*_description*,*_timezone*,*_patient.id*,*_status._fwVersion*,*_status._hwVersion*,*_status._bootTime*,*_status._connection._connected*,*_status._connection._ipAddress*,*_status._operational._status*,*_status._operational._message*,*_lastModifiedTime*,*_creationTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Create a new Device by Template id](https://docs.biot-med.com/reference/registerdevice.md): Create a new Device by Template id (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_description|string|false|Device description|| |_id|string|true| Pattern:[a-zA-Z0-9:_-]+|| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_patient|object|false||| |_patient.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_registrationCode|object|false||| |_registrationCode.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_timezone|string|false|A java time zone supported by the java runtime environment|Europe/Oslo| This API requires **PROTECTED_API** permission(s). - [Create a new Device by Template name](https://docs.biot-med.com/reference/registerdevicewithtemplatename.md): Create a new Device by Template name (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_description|string|false|Device description|| |_id|string|true| Pattern:[a-zA-Z0-9:_-]+|| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_patient|object|false||| |_patient.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_registrationCode|object|false||| |_registrationCode.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_timezone|string|false|A java time zone supported by the java runtime environment|Europe/Oslo| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Get Device by ID](https://docs.biot-med.com/reference/getdevice.md): Get Device by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device ID that needs to be fetched|| This API requires **PROTECTED_API** permission(s). - [Delete Device](https://docs.biot-med.com/reference/deletedevice.md): Delete Device Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device ID that needs to be deleted|| This API requires **PROTECTED_API** permission(s). - [Update Device](https://docs.biot-med.com/reference/updatedevice.md): Update Device Performs partial update, if a field is specified in the request it will be updated (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_description|string|false|Device description|| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_patient|object|false||| |_patient.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_registrationCode|object|false||| |_registrationCode.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_timezone|string|false|A java time zone supported by the java runtime environment|Europe/Oslo| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device ID that needs to be updated|| This API requires **PROTECTED_API** permission(s). - [Get Device Connection Details by ID](https://docs.biot-med.com/reference/getconnectiondetails.md): Get Device Connection Details by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device id|device1| This API requires **PROTECTED_API** permission(s). - [Create new Certificate for Device](https://docs.biot-med.com/reference/createcertificate.md): Create new Certificate for Device type - ***BOOTSTRAP*** or ***PRODUCTION*** - default ***PRODUCTION*** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device id|device1| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |type|string|false|Supported values are: BOOTSTRAP, PRODUCTION, default value: PRODUCTION. BOOTSTRAP - temporary certificate for factory tests only. PRODUCTION - certificate for production devices|| This API requires **PROTECTED_API** permission(s). - [Delete Certificate for Device](https://docs.biot-med.com/reference/deletecertificate.md): Delete Certificate for Device type - ***BOOTSTRAP*** or ***PRODUCTION*** - default ***PRODUCTION*** This API requires **PROTECTED_API** permission(s). - [Activate Certificate for Device](https://docs.biot-med.com/reference/activatecertificate.md): Activate Certificate for Device type - ***BOOTSTRAP*** or ***PRODUCTION*** - default ***PRODUCTION*** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device id|device1| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |type|string|false|null|| This API requires **PROTECTED_API** permission(s). - [Validation token operation](https://docs.biot-med.com/reference/validatetokenoperation-1.md): Validation token operation Validate that token, operation and entity ID are valid and not expired. This API is **public**. - [Execute token operation](https://docs.biot-med.com/reference/executetokenoperation-1.md): Execute token operation Execute operation by specifying a temp token instead of jwt token This API is **public**. - [Execute token operation](https://docs.biot-med.com/reference/executetokenoperationget.md): Execute token operation Execute operation by specifying a temp token instead of jwt token This API is **public**. - [Create a new Usage Session by Template id](https://docs.biot-med.com/reference/createsession.md): Create a new Usage Session by Template id If patient is null in the request, the patient id will be read from the device entity (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_endTime|string|false|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_name|string|false|The name of the session|| |_patient|object|false||| |_patient.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_startTime|string|true|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_state|string|true|The Sessions state Values:ACTIVE,DONE,PAUSED,ACTIVATING,PAUSING,RESUMING,STOPPING|ACTIVE| |_summary|object|false||| |_summary.<customAttribute1>|<customAttribute1Type>|false|Summary custom attribute 1 value|| |_summary.<customAttributeN>|<customAttributeNType>|false|Summary custom attribute N value|| |_summary._stopReason|string|false|The reason the session was stopped|Manual Stop| |_summary._stopReasonCode|string|false|The code of the stop reason Values:COMPLETION,GENERAL_DEVICE_ERROR,TIMEOUT|COMPLETION| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Create a new Usage Session by Template name](https://docs.biot-med.com/reference/createsessionbyusagetype.md): Create a new Usage Session by Template name If patient is null in the request, the patient id will be read from the device entity. (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_endTime|string|false|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_name|string|false|The name of the session|| |_patient|object|false||| |_patient.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_startTime|string|true|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_state|string|true|The Sessions state Values:ACTIVE,DONE,PAUSED,ACTIVATING,PAUSING,RESUMING,STOPPING|ACTIVE| |_summary|object|false||| |_summary.<customAttribute1>|<customAttribute1Type>|false|Summary custom attribute 1 value|| |_summary.<customAttributeN>|<customAttributeNType>|false|Summary custom attribute N value|| |_summary._stopReason|string|false|The reason the session was stopped|Manual Stop| |_summary._stopReasonCode|string|false|The code of the stop reason Values:COMPLETION,GENERAL_DEVICE_ERROR,TIMEOUT|COMPLETION| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |usageType|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Get Usage Session by ID](https://docs.biot-med.com/reference/getsession.md): Get Usage Session by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Usage Session ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Delete Usage Session](https://docs.biot-med.com/reference/deletesession.md): Delete Usage Session Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Usage Session ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Usage Session](https://docs.biot-med.com/reference/updatesession.md): Update Usage Session Performs partial update, if a field is specified in the request it will be updated Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_endTime|string|false|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_name|string|false|The name of the session|| |_startTime|string|true|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_state|string|true|The Sessions state Values:ACTIVE,DONE,PAUSED,ACTIVATING,PAUSING,RESUMING,STOPPING|ACTIVE| |_summary|object|false||| |_summary.<customAttribute1>|<customAttribute1Type>|false|Summary custom attribute 1 value|| |_summary.<customAttributeN>|<customAttributeNType>|false|Summary custom attribute N value|| |_summary._stopReason|string|false|The reason the session was stopped|Manual Stop| |_summary._stopReasonCode|string|false|The code of the stop reason Values:COMPLETION,GENERAL_DEVICE_ERROR,TIMEOUT|COMPLETION| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Usage Session ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Search Usage Session entities by filter](https://docs.biot-med.com/reference/searchsessions.md): Search Usage Session entities by filter Returns list of Usage Session, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_templateId*,*_templateName*,*_id*,*_patient.id*,*_device.id*,*_startTime*,*_endTime*,*_initiator*,*_state*,*_ownerOrganization.id*,*_requiredMeasurementIntervalMilliseconds*,*_summary._stopReason*,*_summary._stopReasonCode*,*_name*,*_creationTime*,*_lastModifiedTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_patient.id*,*_device.id*,*_startTime*,*_endTime*,*_initiator*,*_state*,*_ownerOrganization.id*,*_requiredMeasurementIntervalMilliseconds*,*_summary._stopReason*,*_summary._stopReasonCode*,*_name*,*_creationTime*,*_lastModifiedTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Search currently in progress devices' sessions entities by filter](https://docs.biot-med.com/reference/searchdevicesessions.md): Search currently in progress devices' sessions entities by filter Returns list of currently in progress devices' sessions, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_ownerOrganization.id*,*_id(device)*,*_patient.id* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Delete Usage Session](https://docs.biot-med.com/reference/deleteorphansessions.md): Delete Usage Session This api will delete up to 500 sessions that have a null value in the requested field. Supported Values: DEVICE, PATIENT Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deleteOrphanSessionsEnum|string|true|null|| This API requires **SESSION_DELETE_ORPHANS** permission(s). - [Stop an existing Usage Session](https://docs.biot-med.com/reference/stopsession.md): Stop an existing Usage Session Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|The device ID|device1| |id|string|true|Usage Session ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Resume a paused Usage Session](https://docs.biot-med.com/reference/resumesession.md): Resume a paused Usage Session Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Usage Session ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Pause an existing Usage Session](https://docs.biot-med.com/reference/pausesession.md): Pause an existing Usage Session Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Usage Session ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Create and start a Usage Session](https://docs.biot-med.com/reference/startsession.md): Create and start a Usage Session If patient is null in the request, the patient id will be read from the device entity (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_name|string|false|The name of the session|| |_patient|object|false||| |_patient.id|string|true(*)|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_summary.<customAttribute1>|<customAttribute1Type>|false|Summary custom attribute 1 value|| |_summary.<customAttributeN>|<customAttributeNType>|false|Summary custom attribute N value|| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Start a new command by name](https://docs.biot-med.com/reference/startcommandbytemplatename.md): Start a new command by name Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_configuration|object|false|An object that holds the entity configuration attributes|| |_name|string|false|The name of the command|| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |templateName|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Stop an existing Command](https://docs.biot-med.com/reference/stopcommand.md): Stop an existing Command Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Command ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Start a new command](https://docs.biot-med.com/reference/startcommand.md): Start a new command Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_name|string|false|The name of the command|| |_status.<customAttribute1>|<customAttribute1Type>|false|Status custom attribute 1 value|| |_status.<customAttributeN>|<customAttributeNType>|false|Status custom attribute N value|| |_summary.<customAttribute1>|<customAttribute1Type>|false|Summary custom attribute 1 value|| |_summary.<customAttributeN>|<customAttributeNType>|false|Summary custom attribute N value|| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Get Command by ID](https://docs.biot-med.com/reference/getcommand.md): Get Command by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Command ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Delete Command](https://docs.biot-med.com/reference/deletecommand.md): Delete Command Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Command ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Search Command entities by filter](https://docs.biot-med.com/reference/searchcommands.md): Search Command entities by filter Returns list of Command, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_templateId*,*_templateName*,*_id*,*_device.id*,*_startTime*,*_endTime*,*_state*,*_ownerOrganization.id*,*_supportStop*,*_timeoutInSeconds*,*_name*,*_creationTime*,*_lastModifiedTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_device.id*,*_startTime*,*_endTime*,*_state*,*_ownerOrganization.id*,*_supportStop*,*_timeoutInSeconds*,*_name*,*_creationTime*,*_lastModifiedTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Create a new Device Alert by Template id](https://docs.biot-med.com/reference/createalert.md): Create a new Device Alert by Template id Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_clearNotes|string|false|Clear notes|| |_name|string|false|The name of the alert|| |_severity|string|false|The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO Default:INFO|MAJOR| |_state|string|false|The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED Default:ACTIVE|ACTIVE| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Create a new Device Alert by Template name](https://docs.biot-med.com/reference/createalertbytemplatename.md): Create a new Device Alert by Template name Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_clearNotes|string|false|Clear notes|| |_name|string|false|The name of the alert|| |_severity|string|false|The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO Default:INFO|MAJOR| |_state|string|false|The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED Default:ACTIVE|ACTIVE| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |templateName|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Get Device Alert by ID](https://docs.biot-med.com/reference/getalert.md): Get Device Alert by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Device Alert ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Delete Device Alert](https://docs.biot-med.com/reference/deletealert.md): Delete Device Alert Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Device Alert ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Device Alert](https://docs.biot-med.com/reference/updatealert.md): Update Device Alert Performs partial update, if a field is specified in the request it will be updated Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_clearNotes|string|false|Clear notes|| |_name|string|false|The name of the alert|| |_severity|string|false|The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO|MAJOR| |_state|string|false|The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED|ACTIVE| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Device Alert ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Search open device's alerts entities by filter](https://docs.biot-med.com/reference/searchcurrentalerts.md): Search open device's alerts entities by filter Returns list of open device's alerts, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_ownerOrganization.id* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Search Device Alert entities by filter](https://docs.biot-med.com/reference/searchalerts.md): Search Device Alert entities by filter Returns list of Device Alert, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_templateId*,*_templateName*,*_device.id*,*_ownerOrganization.id*,*_severity*,*_state*,*_setDateTime*,*_clearDateTime*,*_clearTrigger*,*_clearedBy.id*,*_clearNotes*,*_name*,*_creationTime*,*_lastModifiedTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_device.id*,*_ownerOrganization.id*,*_severity*,*_state*,*_setDateTime*,*_clearDateTime*,*_clearTrigger*,*_clearedBy.id*,*_clearNotes*,*_name*,*_creationTime*,*_lastModifiedTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Get mqtt temporary credentials for device gateway](https://docs.biot-med.com/reference/gettempcredentialsfordevice.md): Get mqtt temporary credentials for device gateway Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Credentials ID|| This API requires **PROTECTED_API** permission(s). - [Get mqtt temporary credentials for receiving device measurements for all devices in an organization.](https://docs.biot-med.com/reference/gettempcredentialsfororganizationclient.md): Get mqtt temporary credentials for receiving device measurements for all devices in an organization. Also returns a single topic formatted '[ownerOrganizationId]/+/+'. [ownerOrganizationId] will be filled from the access token and should not be changed. The first [+] represents deviceId and can be changed to any deviceId in the organization, this topic will include only messages from that device. [+] can be used to listen to all devices. The second [+] represents notification type and can be changed, this topic will include only messages from that notification type. [+] can be used for all notification types. E.g. The topic for an organization with id [00000000-0000-0000-0000-000000000000] and device with id [device-id] listening to all notification types will be '00000000-0000-0000-0000-000000000000/device-id/+'. This API requires **PROTECTED_API** permission(s). - [Get endpoint](https://docs.biot-med.com/reference/getendpoint.md): Get endpoint This API requires **PROTECTED_API** permission(s). - [Service Health check API](https://docs.biot-med.com/reference/healthcheck.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Unsubscribe from notifications for actions](https://docs.biot-med.com/reference/unsubscribe.md): Unsubscribe from notifications for actions Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |entityTypeName|string|true| Values:device,organization,organization-user,caregiver,patient,usage-session,generic-entity,command,device-alert,patient-alert,registration-code|| |actionName|string|true| Values:_create,_update,_delete,_list,_command,_generateCertificate,_activateCertificate,_revokeCertificate,_operate,_read,_start,_stop,_remoteStart,_remoteStop,_remoteResume,_remotePause,_updateAdmin,_updateEnabledState,_login,_logout,_clear,_manage,_assign,_saveMeasurement,_monitor,_view,_saveMeasurementBulk,_incomingSms|| |endpoint|string|true||| |templateName|string|false||| This API requires **DISPATCHER_SUBSCRIPTIONS_UNSUBSCRIBE** permission(s). - [Subscribe to get notifications for actions](https://docs.biot-med.com/reference/subscribe.md): Subscribe to get notifications for actions If a subscription (to same action entity and endpoint) is already exist, the call will result in a CONFLICT response Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |entityTypeName|string|true| Values:device,organization,organization-user,caregiver,patient,usage-session,generic-entity,command,device-alert,patient-alert,registration-code|| |actionName|string|true| Values:_create,_update,_delete,_list,_command,_generateCertificate,_activateCertificate,_revokeCertificate,_operate,_read,_start,_stop,_remoteStart,_remoteStop,_remoteResume,_remotePause,_updateAdmin,_updateEnabledState,_login,_logout,_clear,_manage,_assign,_saveMeasurement,_monitor,_view,_saveMeasurementBulk,_incomingSms|| |endpoint|string|true||| |templateName|string|false||| This API requires **DISPATCHER_SUBSCRIPTIONS_SUBSCRIBE** permission(s). - [Search Subscription entities by filter](https://docs.biot-med.com/reference/searchsubscriptions.md): Search Subscription entities by filter Returns list of Subscription, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *id*,*actionName*,*entityTypeName*,*endpoint*,*templateName* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *actionName*,*entityTypeName* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **DISPATCHER_SUBSCRIPTIONS_SEARCH** permission(s). - [Unsubscribe a specific endpoint from intercepting API(s)](https://docs.biot-med.com/reference/deleteinterception.md): Unsubscribe a specific endpoint from intercepting API(s) Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |type|string|true| Values:PRE_REQUEST,POST_REQUEST,ADAPT_ENTITY|| |apiId|string|true|Should only be provided if type=PRE_REQUEST or type=POST_REQUEST|POST/device/v1/devices| |entityName|string|true|Should only be provided if type=ADAPT_ENTITY|device| |endpoint|string|true||https://api.dev.biot-med.com/device-plugin/v1/devices/create-device-pre-interception| |pathFilters|object|false|Path parameter filters for template-specific interception subscriptions. Keys are path parameter names, values are concrete values to match.|{templateName=device-log-file}| This API requires **HOOKS_INTERCEPTION_DELETE** permission(s). - [Subscribe for intercepting APIs](https://docs.biot-med.com/reference/createinterception.md): Subscribe for intercepting APIs Multiple subscriptions with different endpoints is allowed for the same type and apiId. Multiple subscriptions with different endpoints of type ADAPT_ENTITY is allowed for the entityName. If a subscription already exists, it will be overridden with the new executionOrder (if provided in the request). If an interception is created or updated to have the same executionOrder as an existing interception (including existing ones with default executionOrder), It will be set with that executionOrder and the existing interception's executionOrder will be incremented. If that interception's new executionOrder clashes with another the other one will be incremented as well, and so forth. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |type|string|true| Values:PRE_REQUEST,POST_REQUEST,ADAPT_ENTITY|| |apiId|string|true|Should only be provided if type=PRE_REQUEST or type=POST_REQUEST|POST/device/v1/devices| |entityName|string|true|Should only be provided if type=ADAPT_ENTITY|device| |endpoint|string|true||https://api.dev.biot-med.com/device-plugin/v1/devices/create-device-pre-interception| |pathFilters|object|false|Path parameter filters for template-specific interception subscriptions. Keys are path parameter names, values are concrete values to match.|{templateName=device-log-file}| |executionOrder|integer|false|If not provided, the default value will be taken from the environment variable: EXECUTIONORDER_DEFAULT. Subscription with the same executionOrder cannot exist simultaneously. If an interception is created or updated to have the same executionOrder as an existing interception (including existing ones with default executionOrder), It will be set with that executionOrder and the existing interception's executionOrder will be incremented. If that interception's new executionOrder clashes with another the other one will be incremented as well, and so forth.|1| This API requires **HOOKS_INTERCEPTION_CREATE** permission(s). - [Search for active interception subscriptions](https://docs.biot-med.com/reference/searchinterceptions.md): Search for active interception subscriptions Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **HOOKS_INTERCEPTION_SEARCH** permission(s). - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-1.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Validation token operation](https://docs.biot-med.com/reference/validatetokenoperation-2.md): Validation token operation Validate that token, operation and entity ID are valid and not expired. This API is **public**. - [Execute token operation](https://docs.biot-med.com/reference/executetokenoperation-2.md): Execute token operation Execute operation by specifying a temp token instead of jwt token This API is **public**. - [Execute token operation](https://docs.biot-med.com/reference/executetokenoperationget-2.md): Execute token operation Execute operation by specifying a temp token instead of jwt token This API is **public**. - [Cancel Report](https://docs.biot-med.com/reference/cancelreport.md): Cancel Report Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Report ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Create a new Report](https://docs.biot-med.com/reference/createreport.md): Create a new Report The following API create a new snapshot of the system's DB state (report) according to the parameters provided to the API. After the export process finishes the data will be accessible to the user by getting the report created in the system (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |queries|array|true|A list that containing queries (filter) on the wanted data export. Supported filters: [_lastModifiedTime, _creationTime, _templateId]. Supported sorts: [_creationTime]|| |queries[index]|array|false|A list that containing queries (filter) on the wanted data export. Supported filters: [_lastModifiedTime, _creationTime, _templateId]. Supported sorts: [_creationTime]|| |queries[index].dataType|string|true(*)|Data Type to be exported. Values:device,device-alert,usage-session,command,organization,patient,organization-user,caregiver,patient-alert,generic-entity,measurements,registration-code|device| |queries[index].filter|object|false|Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field. When multiple conditions are specified, they are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned|| |queries[index].sort|array|false|Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort.The first field is the primary sort, the second is used when two values of the first field are the same, and so forth|| |queries[index].sort[index]|array|false|Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort.The first field is the primary sort, the second is used when two values of the first field are the same, and so forth|| |queries[index].sort[index].prop|string|true(*)|The property name for the sort|| |queries[index].sort[index].order|string|false|The direction of sort. Default DESC Values:ASC,DESC|ASC| |outputMetadata|object|true||| |outputMetadata.maxFileSizeInBytes|integer|false|The maximum size (in bytes) that each output file should not exceed|500000| |outputMetadata.exportFormat|string|true(*)|The format in which to export the report Values:JSON,CSV|JSON| |callbackEndpoint|string|false|URL endpoint to call when export process is finished|https://my-url.com/| |name|string|false|Name of the report|BioT Devices Export| This API requires **PROTECTED_API** permission(s). - [Search Report entities by filter](https://docs.biot-med.com/reference/searchreports.md): Search Report entities by filter Returns list of Report, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *id*,*callbackEndpoint*,*status*,*maxFileSizeInBytes*,*fullReference*,*lastModifiedTime*,*creationTime*,*name*,*reportInitiator.userId*,*reportInitiator.ownerOrganizationId*,*reportInitiator.userEntityType*,*reportInitiator.templateId* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *id*,*callbackEndpoint*,*name*,*status*,*maxFileSizeInBytes*,*fullReference*,*lastModifiedTime*,*creationTime* ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Get Report by ID](https://docs.biot-med.com/reference/getreport.md): Get Report by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Report ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Delete Report](https://docs.biot-med.com/reference/deletereport.md): Delete Report Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Report ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Stop Analytics DB Synchronization](https://docs.biot-med.com/reference/stopanalyticsdbsynchronizationold.md): Stop Analytics DB Synchronization The following API stop the synchronization of analytics DB. After the user calls this API the analytics DB will be static until the next call to start initialization API This API can be called when analytics DB deployment state is: [DEPLOYED] and activation state is: [ACTIVE_AND_SYNC_ON]. After this API is called the activation state will be changed to: [INACTIVE] This API requires **DMS_STOP_ANALYTICS_DB_SYNCHRONIZATION** permission(s). - [Stop Analytics DB Initialization](https://docs.biot-med.com/reference/stopanalyticsdbinitializationold.md): Stop Analytics DB Initialization The following API stop the process of creating analytics DB. This API can be called when analytics DB deployment state is: [DEPLOYED] and activation state is: [INITIALIZING]. After this API is called the activation state will be changed to: [STOPPING_INITIALIZATION] and when the analytics DB initialization process is stopped completely the state will be: [INACTIVE] This API requires **DMS_STOP_ANALYTICS_DB_INITIALIZATION** permission(s). - [Start Analytics DB Initialization](https://docs.biot-med.com/reference/startanalyticsdbinitializationold.md): Start Analytics DB Initialization The following API starts the process of creating analytics DB. After the process is finished the analytics DB will be available for queries. This API can be called when analytics DB deployment state is: [DEPLOYED] and activation state is: [INACTIVE]. After this API is called the activation state will be changed to: [INITIALIZING] and when the analytics DB initialization process is finished the state will be: [ACTIVE_AND_SYNC_ON] The database structure will be as follow: The table name will be in the following format: For entities without parent: {templateName}_{entityTypeName} Example: DeviceType1_device For entities with parent: {templateName}_{entityTypeName}_{parentTemplateName}_{parentEntityType} Example: Reboot_command_DeviceType1_device For observations: Observations_{patientTemplateName}_{patientEntityTypeName} Example: Observations_Patient_patient Basically each attribute will have a column or multiple columns (depends on the attribute type) Examples: Regular attribute - the column name will be the attribute full path: _email --> _email Object attribute - each field of the object will have a column and the name is the name of the attribute + field: _address -> _address.city, _address.state, etc. File and Image attribute - will have 4 columns: [fileAttributeName] --> [fileAttributeName].id, [fileAttributeName].size, [fileAttributeName].name, [fileAttributeName].mimeType Name attribute - will have 2 columns: _name --> _name.firstName, _name.lastName Reference attribute - will have 2 columns: _patient --> _patient.id, _patient.templateName Each table will have additional columns except for the attribute columns: _id, _templateName For observations tables, each table will consist of all observation attributes as well as the following columns: [timestamp, patientId, sessionId, sourceEntityId] Waveform attributes are represented as integer/decimal columns with explicit value at each interval All current tables are dropped before starting the init process. This API requires **DMS_START_ANALYTICS_DB_INITIALIZATION** permission(s). - [Get Analytics DB Information by ID](https://docs.biot-med.com/reference/getanalyticsdbinformationold.md): Get Analytics DB Information by ID Returns information about the analytics DB in the system (such as deployment state, activation state and more) This API requires **PROTECTED_API** permission(s). - [Get Analytics DB Connection Details by ID](https://docs.biot-med.com/reference/getanalyticsdbconnectiondetailsold.md): Get Analytics DB Connection Details by ID Returns connection details according to the user's permission. * Caregivers from Manufacturer Organization get "without phi" permission * Caregivers from custom organization get "with phi" permission * Organization users get "without phi" permission * Patients cannot use the Analytics DB, they will get "access denied" This API requires **PROTECTED_API** permission(s). - [Stop Analytics DB Synchronization](https://docs.biot-med.com/reference/stopanalyticsdbsynchronization.md): Stop Analytics DB Synchronization The following API stop the synchronization of analytics DB. After the user calls this API the analytics DB will be static until the next call to start initialization API This API can be called when analytics DB deployment state is: [DEPLOYED] and activation state is: [ACTIVE_AND_SYNC_ON]. After this API is called the activation state will be changed to: [INACTIVE] This API requires **DMS_STOP_ANALYTICS_DB_SYNCHRONIZATION** permission(s). - [Stop Analytics DB Initialization](https://docs.biot-med.com/reference/stopanalyticsdbinitialization.md): Stop Analytics DB Initialization The following API stop the process of creating analytics DB. This API can be called when analytics DB deployment state is: [DEPLOYED] and activation state is: [INITIALIZING]. After this API is called the activation state will be changed to: [STOPPING_INITIALIZATION] and when the analytics DB initialization process is stopped completely the state will be: [INACTIVE] This API requires **DMS_STOP_ANALYTICS_DB_INITIALIZATION** permission(s). - [Start Analytics DB Initialization](https://docs.biot-med.com/reference/startanalyticsdbinitialization.md): Start Analytics DB Initialization The following API starts the process of creating analytics DB. After the process is finished the analytics DB will be available for queries. This API can be called when analytics DB deployment state is: [DEPLOYED] and activation state is: [INACTIVE]. After this API is called the activation state will be changed to: [INITIALIZING] and when the analytics DB initialization process is finished the state will be: [ACTIVE_AND_SYNC_ON] The database structure will be as follow: The table name will be as follows: For each template, a table will be created and its name will be taken from the template.analyticsDbConfiguration.name field Observations: for each patient template, an observation table will be created and its name will be Observations_{patientTemplate.analyticsDbConfiguration.name} Example: If the patientTemplate.analyticsDbConfiguration.name field is "Patient" then the observation table name will be "Observations_Patient" Basically each attribute will have a column or multiple columns (depends on the attribute type) Examples: Regular attribute - the column name will be taken from the attribute.analyticsDbConfiguration.name field Object attribute - each field of the object will have a column and the name is the analyticsDbConfiguration.name of the attribute + field: Assuming the analyticsDbConfiguration.name of the attribute is "_address" then the column names will be _address.city, _address.state, etc. File and Image attribute - will have 4 columns: file1.id, file1.size, file1.name, file1.mimeType Name attribute - will have 2 columns: _name.firstName, _name.lastName Reference attribute - will have 2 columns: _patient.id, _patient.templateName Each entity table will have additional columns except for the attribute columns: _id, _templateName, __validTo For observations tables, each table will consist of all observation attributes as well as the following columns: [timestamp, patientId, sessionId, sourceEntityId] Waveform attributes are represented as integer/decimal columns with explicit value at each interval All current tables are dropped before starting the init process. This API requires **DMS_START_ANALYTICS_DB_INITIALIZATION** permission(s). - [Get Analytics DB State](https://docs.biot-med.com/reference/getanalyticsdbstate.md): Get Analytics DB State Returns information about the analytics DB in the system (such as deployment state, activation state and more) This API requires **PROTECTED_API** permission(s). - [Get Analytics DB Connection Details by ID](https://docs.biot-med.com/reference/getanalyticsdbconnectiondetails.md): Get Analytics DB Connection Details by ID Returns connection details according to the user's permission. * Caregivers get full access permission * Organization users get without phi permission * Organization users from developer template get full access permission * Patients cannot use the Analytics DB, they will get "access denied" This API requires **PROTECTED_API** permission(s). - [Download PDF](https://docs.biot-med.com/reference/getdashboardpdf.md): Download PDF Generates PDF file from Grafana's dashboard using dashboard name and dashboard unique id. Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |dashboardUniqueId|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |from|string|false|A UTC date-time in the ISO-8601 format. Send Timezone parameter if you wish to change from UTC.|2007-12-20T10:15:30Z| |to|string|false|A UTC date-time in the ISO-8601 format. Send Timezone parameter if you wish to change from UTC.|2007-12-20T10:15:30Z| |timezone|string|false|A java time zone supported by the java runtime environment. Will be used for displaying time in the PDF. (default UTC)|Europe/Oslo| |dashboardVariables|object|true|null|{"var1":"value1","var2":"value2"}| This API requires **PROTECTED_API** permission(s). - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-2.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Self sign up for patients](https://docs.biot-med.com/reference/patientselfsignup.md): Self sign up for patients **Note:** Patient self-signup is not enabled by default. To activate this feature for your environment, please contact BioT Support or submit a request through our support portal. This API is used by a patient to sign up. The patient will be created with the provided information. If registration code is provided - the patient will be assigned to the device linked to the provided registration code. The Registration code must exist and be linked to a device. That device should not be assigned to any patient, and be in the same organization as the patient or in the manufacturer's organization. (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|object|true||| |_name.firstName|string|true(*)|A person's first name|John| |_name.lastName|string|true(*)|A person's last name|Smith| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_email|string|true|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_phone|string|false|A person's phone An E.164 formatted phone number|+12345678901| |_locale|string|false|A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_dateOfBirth|string|false|A person's date of birth A UTC date in the ISO-8601 format|Thu Dec 20 00:00:00 UTC 2007| |_address|object|false||| |_address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_address.state|string|false|A state|Massachusetts| |_address.city|string|false|A city|Boston| |_address.zipCode|string|false|A zipcode|02101| |_address.address1|string|false|An address|11 Main St.| |_address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_mfa|object|false||| |_mfa.enabled|boolean|true(*)|MFA login enabled or disabled|| |_mfa.expirationInMinutes|integer|false|MFA expiration time in minutes|| |_credentialType|string|false|What type of credentials is used when logging in to the system. Default:PASSWORD Values:PASSWORD,OTP|| |_additionalPhone|string|false|An E.164 formatted phone number|+12345678901| |_nationalId|string|false|A person's national ID|123456789| |_username|string|true|User's username. Can be an email or a regular username. With this username you login to the system.|john@biotmail.com or john123| |_password|string|true|A password|Aa123456| |_deviceRegistrationCode|string|false|The registration code entity that is attached to the device|RegistrationCode123| |_ownerOrganization|object|true||| |_ownerOrganization.id|string|true(*)||| |_caregiver|object|false||| |_caregiver.id|string|true(*)||| This API is **public**. - [Anonymous self sign up for patients](https://docs.biot-med.com/reference/patientanonymousselfsignup.md): Anonymous self sign up for patients **Note:** Patient self-signup is not enabled by default. To activate this feature for your environment, please contact BioT Support or submit a request through our support portal. This API is used by a patient to anonymously sign up. The patient will be created with the provided information. The patient's Organization Id will be taken from the Registration Code's Organization Id. The patient will be assigned to the device linked to the provided registration code. The Registration code must exist and be linked to a device. That device should not be assigned to any patient. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_username|string|true|User's username. Can be an email or a regular username. With this username you login to the system.|john@biotmail.com or john123| |_password|string|true|A password|Aa123456| |_nickname|string|false|The nickname of the user|Nicky123| |_deviceRegistrationCode|string|true|The registration code entity that is attached to the device|RegistrationCode123| This API is **public**. - [Assign a device to a patient](https://docs.biot-med.com/reference/assigndevice.md): Assign a device to a patient **Note:** Patient self-signup is not enabled by default. To activate this feature for your environment, please contact BioT Support or submit a request through our support portal. The patient from the token will be assigned to the device linked to the provided registration code. The Registration code must exist and be linked to a device. That device should either not be assigned to any patient or already assigned to this patient, and either be in the same organization as the patient or be in the manufacturer's organization. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceRegistrationCode|string|true|The registration code entity that is attached to the device|RegistrationCode123| This API requires **PROTECTED_API** permission(s). - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-3.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Search Generic Entity entities by filter](https://docs.biot-med.com/reference/searchgenericentities.md): Search Generic Entity entities by filter > ❗ **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.** Returns list of Generic Entity, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_ownerOrganization.id*,*_name*,*_templateId*,*_templateName*,*_lastModifiedTime*,*_creationTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_ownerOrganization.id*,*_name*,*_lastModifiedTime*,*_creationTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **GENERIC_ENTITY_SEARCH_GENERIC_ENTITY_V, PROTECTED_API** permission(s). - [Create a new Generic Entity by Template id](https://docs.biot-med.com/reference/creategenericentity.md): Create a new Generic Entity by Template id > ❗ **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.** (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|string|true||| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| This API requires **PROTECTED_API** permission(s). - [Create a new Generic Entity by Template name](https://docs.biot-med.com/reference/creategenericentitybytemplatename.md): Create a new Generic Entity by Template name > ❗ **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.** (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|string|true||| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Get Generic Entity by ID](https://docs.biot-med.com/reference/getgenericentity.md): Get Generic Entity by ID > ❗ **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Generic Entity ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Delete Generic Entity](https://docs.biot-med.com/reference/deletegenericentity.md): Delete Generic Entity > ❗ **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Generic Entity ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Generic Entity](https://docs.biot-med.com/reference/updategenericentity.md): Update Generic Entity Performs partial update, if a field is specified in the request it will be updated > ❗ **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.** (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|string|true||| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Generic Entity ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-4.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Search Generic Entity entities by filter](https://docs.biot-med.com/reference/searchgenericentitiesv3.md): Search Generic Entity entities by filter > ❗ **The V3 Generic Entity API is available from BioT platform version 2.3.40 and requires the GENERIC_ENTITIES_API_V3 flag to be enabled. Contact Customer Success to request activation.** Returns list of Generic Entity, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_ownerOrganization.id*,*_name*,*_lastModifiedTime*,*_creationTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_ownerOrganization.id*,*_name*,*_lastModifiedTime*,*_creationTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Create a new Generic Entity by Template name](https://docs.biot-med.com/reference/creategenericentityv3.md): Create a new Generic Entity by Template name > ❗ **The V3 Generic Entity API is available from BioT platform version 2.3.40 and requires the GENERIC_ENTITIES_API_V3 flag to be enabled. Contact Customer Success to request activation.** (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|string|true||| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Get Generic Entity by ID](https://docs.biot-med.com/reference/getgenericentityv3.md): Get Generic Entity by ID > ❗ **The V3 Generic Entity API is available from BioT platform version 2.3.40 and requires the GENERIC_ENTITIES_API_V3 flag to be enabled. Contact Customer Success to request activation.** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| |id|string|true|Generic Entity ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Delete Generic Entity](https://docs.biot-med.com/reference/deletegenericentityv3.md): Delete Generic Entity > ❗ **The V3 Generic Entity API is available from BioT platform version 2.3.40 and requires the GENERIC_ENTITIES_API_V3 flag to be enabled. Contact Customer Success to request activation.** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| |id|string|true|Generic Entity ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Generic Entity](https://docs.biot-med.com/reference/updategenericentityv3.md): Update Generic Entity Performs partial update, if a field is specified in the request it will be updated > ❗ **The V3 Generic Entity API is available from BioT platform version 2.3.40 and requires the GENERIC_ENTITIES_API_V3 flag to be enabled. Contact Customer Success to request activation.** (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|string|true||| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| |id|string|true|Generic Entity ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Save measurement](https://docs.biot-med.com/reference/savemeasurement.md): Save measurement Data sent in this manner cannot be monitored via the patient live observation window. The historical view is not affected. The session must be created before calling this API. This is done with the create or start session APIs. (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |metadata|object|false||| |metadata.timestamp|string|true(*)|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |metadata.deviceId|string|false|The device id that sent the measurement|device12345| |metadata.patientId|string|false|The patient id that the measurement belongs to|3fa85f64-5717-4562-b3fc-2c963f66afa6| |metadata.sessionId|string|false|The session id that the measurement belongs to|6b52af6e-92c8-4827-aaf2-d8805586ab5f| |data|object|false||| This API requires **PROTECTED_API** permission(s). - [Save measurements in bulk](https://docs.biot-med.com/reference/savemeasurementsbulk.md): Save measurements in bulk Data sent in this manner cannot be monitored via the patient live observation window. The historical view is not affected. The session must be created before calling this API. This is done with the create or start session APIs. (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |measures|array|false|List of measurement to be written to the DB|| |measures[index]|array|false|List of measurement to be written to the DB|| |measures[index].metadata|object|false||| |measures[index].metadata.timestamp|string|true(*)|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |measures[index].metadata.deviceId|string|false|The device id that sent the measurement|device12345| |measures[index].metadata.patientId|string|false|The patient id that the measurement belongs to|3fa85f64-5717-4562-b3fc-2c963f66afa6| |measures[index].metadata.sessionId|string|false|The session id that the measurement belongs to|6b52af6e-92c8-4827-aaf2-d8805586ab5f| |measures[index].data|object|false||| This API requires **PROTECTED_API** permission(s). - [Get raw measurements](https://docs.biot-med.com/reference/getrawmeasurements.md): Get raw measurements Get all measurements for requested attributes, patient, in a predefined time range, in an raw format. attributes must have at least one value. sourceEntityId may be empty, in which case it will return measurements from all sourceEntities. sessionId may be empty, in which case it will return measurements from all sessions. endTime must be after startTime. Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |attributes|array|false|null|| |patientId|string|true|The patient's ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| |sourceEntityId|string|false|The ID of the source entity who entered the measurements. Can be a device's id, a doctor's id, etc. If not sent all sources will be returned|device1| |sessionId|string|false|The session's Id. If not sent all sessions will be returned|6b52af6e-92c8-4827-aaf2-d8805586ab5f| |startTime|string|true|The wanted start time for the historical measurements. In ISO8601 format|2007-12-20T10:15:30Z| |endTime|string|true|The wanted end time for the historical measurements. In ISO8601 format|2007-12-20T10:15:30Z| This API requires **PROTECTED_API** permission(s). - [Get aggregated measurements](https://docs.biot-med.com/reference/getmeasurements.md): Get aggregated measurements Get all measurements for requested attributes, patient, in a predefined time range, in an aggregated format. attributes must have at least one value. sourceEntityId may be empty, in which case it will return measurements from all sourceEntities. sessionId may be empty, in which case it will return measurements from all sessions. endTime must be after startTime. Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |binIntervalSeconds|integer|true|This number defines the aggregation time in seconds. If 6 is provided, it will aggregate all measurements in a 6 seconds interval|1| |attributes|array|false|null|| |patientId|string|true|The patient's ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| |sourceEntityId|string|false|The ID of the source entity who entered the measurements. Can be a device's id, a doctor's id, etc. If not sent all sources will be returned|device1| |sessionId|string|false|The session's Id. If not sent all sessions will be returned|6b52af6e-92c8-4827-aaf2-d8805586ab5f| |startTime|string|true|The wanted start time for the historical measurements. In ISO8601 format|2007-12-20T10:15:30Z| |endTime|string|true|The wanted end time for the historical measurements. In ISO8601 format|2007-12-20T10:15:30Z| This API requires **PROTECTED_API** permission(s). - [Search Raw Measurements entities by filter (token-based pagination)](https://docs.biot-med.com/reference/getrawmeasurements2.md): Search Raw Measurements entities by filter (token-based pagination) timestamp operators are mandatory. _patient.id, _sourceEntity.id, _session.id support only 'eq' operator. timestamp support only 'from' & 'to' operators. attributes supports only 'in' operator Returns list of Raw Measurements, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_patient.id - Eq only*,*_sourceEntity.id - Eq only*,*_session.id - Eq only*,*timestamp*,*attributes - in only* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ ] If sort was not specified, the result will be sorted by: creationTime DESC ## Page ***limitPerPage*** optional maximum number of results to return per page. When omitted, a service-defined default page size is used. ***nextToken*** opaque cursor from the previous response for the next page. Omit or set to null for the first page. For each subsequent page, the request body and query parameters must be exactly the same as the original search (same filter, sort, and limitPerPage); only `nextToken` should change. ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||true|Search request parameters: filter, sort, nextToken and limitPerPage|| This API requires **PROTECTED_API** permission(s). - [Search Aggregated Measurements entities by filter (token-based pagination)](https://docs.biot-med.com/reference/getaggregatedmeasurements.md): Search Aggregated Measurements entities by filter (token-based pagination) The result will be sorted by the timestamp range field. Due to the paging mechanism, the timestamp range of the last item in the array might not contain aggregation data for all attributes, the rest of the attributes will be provided in the next page (which also means the last timestamp range will appear again in the next page as the first item with the rest of the attributes aggregation data). If a time range has no data, nothing will be returned for this time range Returns list of Aggregated Measurements, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_patient.id - eq operator only - mandatory*,*timestamp - from & to operators only - mandatory*,*attributes - in operator only - optional*,*binIntervalSeconds - eq operator only - mandatory* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ ] If sort was not specified, the result will be sorted by: creationTime DESC ## Page ***limitPerPage*** optional maximum number of results to return per page. When omitted, a service-defined default page size is used. ***nextToken*** opaque cursor from the previous response for the next page. Omit or set to null for the first page. For each subsequent page, the request body and query parameters must be exactly the same as the original search (same filter, sort, and limitPerPage); only `nextToken` should change. ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||true|Search request parameters: filter, sort, nextToken and limitPerPage|| This API requires **PROTECTED_API** permission(s). - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-5.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Get service configuration](https://docs.biot-med.com/reference/getconfiguration.md): Get service configuration Retrieves the service configuration properties that are supported by this API This API requires **NOTIFICATION_CONFIGURATION_GET_CONFIGURATION** permission(s). - [Set service configuration](https://docs.biot-med.com/reference/setconfiguration.md): Set service configuration Set values to the service configuration properties that are support by this API This API requires **NOTIFICATION_CONFIGURATION_SET_CONFIGURATION** permission(s). - [Get is sms provider configured](https://docs.biot-med.com/reference/getsmsproviderconfiguration.md): Get is sms provider configured Return whether the service has configuration values for sms provider usage (e.g. Twilio) This API requires **NOTIFICATION_CONFIGURATION_GET_SMS_PROVIDER_CONFIGURATION** permission(s). - [Send sms](https://docs.biot-med.com/reference/sendsms.md): Send sms When using AWS as the sms provider you are limited to 1 message per second by default. This can be changed This API requires **NOTIFICATION_SEND_SMS** permission(s). - [Send email](https://docs.biot-med.com/reference/sendemail.md): Send email Send email with email template This API requires **EMAIL_SEND_EMAIL** permission(s). - [Add attachment](https://docs.biot-med.com/reference/addattachment.md): Add attachment Add an attachment to be used in emails This API requires **EMAIL_SEND_EMAIL** permission(s). - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-7.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Get landing pages by type](https://docs.biot-med.com/reference/getlandingpages.md): Get landing pages by type Will return all the landing pages for a given landing page type. Landing pages with a null value in the organizationId field are considered as global landing pages. Those with a value in the organizationId field are overrides for that specific organization. Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |landingPageType|string|true|The type of the landing page. Could be one of the following: [ACCEPT_INVITATION, FORGOT_PASSWORD]|ACCEPT_INVITATION| This API requires **LANDING_PAGE_GET_LANDING_PAGES** permission(s). - [Set a landing page](https://docs.biot-med.com/reference/setlandingpages.md): Set a landing page Landing pages with a null value in the organizationId field are considered as global landing pages. Those with a value in the organizationId field are overrides for that specific organization. If an override exists for an organization, it will be used instead of the global landing page, if not, the global landing page will be used. By default, BioT appends token query parameters as a standard query string per RFC 3986 (e.g. `https://example.com/page?token=...`). If your application reads query parameters from a different position in the URL, add a `{params}` placeholder after a `?` or `&` at the exact point where the parameters should be injected (e.g. `https://example.com/#/complete-account?{params}`). If no placeholder is present, the default RFC 3986 behaviour applies (backward compatible). Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |userType|string|true|The type of the user. Can be one of the following: [patient, caregiver, organization-user]|patient| |organizationId|string|false|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| |url|string|true|The landing page URL. By default, BioT appends token query parameters as a standard query string per RFC 3986 (e.g. https://example.com/page?token=...). If your application reads query parameters from a different position in the URL, add a {params} placeholder after a '?' or '&' at the exact point where the parameters should be injected. Examples: - https://example.com/auth/invitation?{params} - https://example.com/#/complete-account?{params} If no {params} placeholder is present, parameters are appended using the default RFC 3986 behaviour |https://example.com/auth/invitation| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |landingPageType|string|true|The type of the landing page. Could be one of the following: [ACCEPT_INVITATION, FORGOT_PASSWORD]|ACCEPT_INVITATION| This API requires **LANDING_PAGE_SET_LANDING_PAGE** permission(s). - [Delete landing pages by type](https://docs.biot-med.com/reference/deletelandingpages.md): Delete landing pages by type Landing pages with a null value in the organizationId cannot be deleted, as they are considered as global landing pages, although they can be updated with the set landing page API. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |userType|string|true|The type of the user. Can be one of the following: [patient, caregiver, organization-user]|patient| |organizationId|string|false|A UUID formatted string|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |landingPageType|string|true|The type of the landing page. Could be one of the following: [ACCEPT_INVITATION, FORGOT_PASSWORD]|ACCEPT_INVITATION| This API requires **LANDING_PAGE_DELETE_LANDING_PAGE** permission(s). - [Search Patient entities by filter](https://docs.biot-med.com/reference/searchpatients.md): Search Patient entities by filter The latest values and timestamps of each bio-marker measurement will added to the response Returns list of Patient, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_email*,*_phone*,*_description*,*_locale*,*_gender*,*_name.firstName*,*_name.lastName*,*_address.countryCode*,*_address.state*,*_address.city*,*_address.zipCode*,*_address.address1*,*_address.address2*,*_dateOfBirth*,*_ownerOrganization.id*,*_templateId*,*_templateName*,*_additionalPhone*,*_nationalId*,*_caregiver.id*,*_enabled*,*_creationTime*,*_lastModifiedTime*,*_mfa.enabled*,*_mfa.expirationInMinutes*,*_canLogin*,*_username* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_email*,*_phone*,*_description*,*_locale*,*_gender*,*_name.firstName*,*_name.lastName*,*_address.countryCode*,*_address.state*,*_address.city*,*_address.zipCode*,*_address.address1*,*_address.address2*,*_dateOfBirth*,*_ownerOrganization.id*,*_additionalPhone*,*_nationalId*,*_caregiver.id*,*_enabled*,*_creationTime*,*_lastModifiedTime*,*_mfa.enabled*,*_mfa.expirationInMinutes*,*_canLogin*,*_username* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Patient by Template id](https://docs.biot-med.com/reference/createpatient.md): Create a new Patient by Template id Email confirmation landing page is required as a header (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|object|true||| |_name.firstName|string|true(*)|A person's first name|John| |_name.lastName|string|true(*)|A person's last name|Smith| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_phone|string|false|A person's phone An E.164 formatted phone number|+12345678901| |_locale|string|false|A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_dateOfBirth|string|false|A person's date of birth A UTC date in the ISO-8601 format|2007-12-20| |_address|object|false||| |_address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_address.state|string|false|A state|Massachusetts| |_address.city|string|false|A city|Boston| |_address.zipCode|string|false|A zipcode|02101| |_address.address1|string|false|An address|11 Main St.| |_address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_mfa|object|false||| |_mfa.enabled|boolean|false|MFA login enabled or disabled. When omitted, the template's configured default is applied.|| |_mfa.expirationInMinutes|integer|false|MFA expiration time in minutes|| |_credentialType|string|false|What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP|| |_additionalPhone|string|false|An E.164 formatted phone number|+12345678901| |_nationalId|string|false|A person's national ID|123456789| |_canLogin|boolean|false|Determine whether a patient has the ability to login to the system or not. When omitted, the patient template's configured default is applied.|| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_ownerOrganization|object|true||| |_ownerOrganization.id|string|true(*)||| |_caregiver|object|false||| |_caregiver.id|string|true(*)||| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Enable or Disable Patient User](https://docs.biot-med.com/reference/changepatientenabledstate.md): Enable or Disable Patient User The latest values and timestamps of each bio-marker measurement will added to the response Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Patient ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| |state|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Create a new Patient by Template name](https://docs.biot-med.com/reference/createpatientbytemplatename.md): Create a new Patient by Template name Email confirmation landing page is required as a header (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|object|true||| |_name.firstName|string|true(*)|A person's first name|John| |_name.lastName|string|true(*)|A person's last name|Smith| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_phone|string|false|A person's phone An E.164 formatted phone number|+12345678901| |_locale|string|false|A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_dateOfBirth|string|false|A person's date of birth A UTC date in the ISO-8601 format|2007-12-20| |_address|object|false||| |_address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_address.state|string|false|A state|Massachusetts| |_address.city|string|false|A city|Boston| |_address.zipCode|string|false|A zipcode|02101| |_address.address1|string|false|An address|11 Main St.| |_address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_mfa|object|false||| |_mfa.enabled|boolean|false|MFA login enabled or disabled. When omitted, the template's configured default is applied.|| |_mfa.expirationInMinutes|integer|false|MFA expiration time in minutes|| |_credentialType|string|false|What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP|| |_additionalPhone|string|false|An E.164 formatted phone number|+12345678901| |_nationalId|string|false|A person's national ID|123456789| |_canLogin|boolean|false|Determine whether a patient has the ability to login to the system or not. When omitted, the patient template's configured default is applied.|| |_ownerOrganization|object|true||| |_ownerOrganization.id|string|true(*)||| |_caregiver|object|false||| |_caregiver.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Patient by ID](https://docs.biot-med.com/reference/getpatient.md): Get Patient by ID The latest values and timestamps of each bio-marker measurement will added to the response Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Patient ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Patient](https://docs.biot-med.com/reference/deletepatient.md): Delete Patient Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Patient ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Patient](https://docs.biot-med.com/reference/updatepatient.md): Update Patient The latest values and timestamps of each bio-marker measurement will added to the response Performs partial update, if a field is specified in the request it will be updated (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|object|false||| |_name.firstName|string|true(*)|A person's first name|John| |_name.lastName|string|true(*)|A person's last name|Smith| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_phone|string|false|An E.164 formatted phone number|+12345678901| |_locale|string|false|Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_dateOfBirth|string|false|A UTC date in the ISO-8601 format|2007-12-20| |_address|object|false||| |_address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_address.state|string|false|A state|Massachusetts| |_address.city|string|false|A city|Boston| |_address.zipCode|string|false|A zipcode|02101| |_address.address1|string|false|An address|11 Main St.| |_address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_mfa|object|false||| |_mfa.enabled|boolean|false|Is mfa enabled in login|| |_mfa.expirationInMinutes|integer|false|Mfa expiration in minutes|5| |_additionalPhone|string|false|An E.164 formatted phone number|+12345678901| |_nationalId|string|false|A person's national ID|123456789| |_canLogin|boolean|false|Determine whether a patient has the ability to login to the system or not|| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| |_caregiver|object|false||| |_caregiver.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Patient ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Search available organizations for sign up entities by filter](https://docs.biot-med.com/reference/searchavailableorganizationsforsignup.md): Search available organizations for sign up entities by filter The available organizations will be returned according to what was defined in the sign up attribute of the patient template Returns list of available organizations for sign up, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_name* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_name* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API is **public**. - [Get self Patient by ID from access token](https://docs.biot-med.com/reference/getpatientself.md): Get self Patient by ID from access token The latest values and timestamps of each bio-marker measurement will added to the response This API requires **PROTECTED_API** permission(s). - [Create a new Patient Alert by Template id](https://docs.biot-med.com/reference/createalert-1.md): Create a new Patient Alert by Template id Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_state|string|false|The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED Default:ACTIVE|ACTIVE| |_severity|string|false|The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO Default:INFO|MAJOR| |_clearNotes|string|false|Clear notes|| |_name|string|false|The name of the alert|| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |patientId|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Patient Alert by Template name](https://docs.biot-med.com/reference/createalertbytemplatename-1.md): Create a new Patient Alert by Template name Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_state|string|false|The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED Default:ACTIVE|ACTIVE| |_severity|string|false|The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO Default:INFO|MAJOR| |_clearNotes|string|false|Clear notes|| |_name|string|false|The name of the alert|| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |patientId|string|true|null|| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Patient Alert by ID](https://docs.biot-med.com/reference/getalert-1.md): Get Patient Alert by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |patientId|string|true|null|| |id|string|true|Patient Alert ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Patient Alert](https://docs.biot-med.com/reference/deletealert-1.md): Delete Patient Alert Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |patientId|string|true|null|| |id|string|true|Patient Alert ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Patient Alert](https://docs.biot-med.com/reference/updatealert-1.md): Update Patient Alert Performs partial update, if a field is specified in the request it will be updated Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_state|string|false|The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED|ACTIVE| |_severity|string|false|The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO|MAJOR| |_clearNotes|string|false|Clear notes|| |_name|string|false|The name of the alert|| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |patientId|string|true|null|| |id|string|true|Patient Alert ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Search open patient's alerts entities by filter](https://docs.biot-med.com/reference/searchcurrentalerts-1.md): Search open patient's alerts entities by filter Returns list of open patient's alerts, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_ownerOrganization.id* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Search Patient Alert entities by filter](https://docs.biot-med.com/reference/searchalerts-1.md): Search Patient Alert entities by filter Returns list of Patient Alert, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_templateId*,*_templateName*,*_patient.id*,*_ownerOrganization.id*,*_severity*,*_state*,*_setDateTime*,*_clearDateTime*,*_clearTrigger*,*_clearedBy.id*,*_clearNotes*,*_name*,*_creationTime*,*_lastModifiedTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_patient.id*,*_ownerOrganization.id*,*_severity*,*_state*,*_setDateTime*,*_clearDateTime*,*_clearTrigger*,*_clearedBy.id*,*_clearNotes*,*_name*,*_creationTime*,*_lastModifiedTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Search Organization User entities by filter](https://docs.biot-med.com/reference/searchorganizationusers.md): Search Organization User entities by filter Returns list of Organization User, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_email*,*_phone*,*_description*,*_locale*,*_gender*,*_name.firstName*,*_name.lastName*,*_address.countryCode*,*_address.state*,*_address.city*,*_address.zipCode*,*_address.address1*,*_address.address2*,*_dateOfBirth*,*_ownerOrganization.id*,*_templateId*,*_templateName*,*_enabled*,*_employeeId*,*_creationTime*,*_lastModifiedTime*,*_mfa.enabled*,*_mfa.expirationInMinutes* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_email*,*_phone*,*_description*,*_locale*,*_gender*,*_name.firstName*,*_name.lastName*,*_address.countryCode*,*_address.state*,*_address.city*,*_address.zipCode*,*_address.address1*,*_address.address2*,*_dateOfBirth*,*_ownerOrganization.id*,*_enabled*,*_employeeId*,*_creationTime*,*_lastModifiedTime*,*_mfa.enabled*,*_mfa.expirationInMinutes* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Organization User by Template id](https://docs.biot-med.com/reference/createorganizationuser.md): Create a new Organization User by Template id Email confirmation landing page is required as a header (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_address|object|false||| |_address.address1|string|false|An address|11 Main St.| |_address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_address.city|string|false|A city|Boston| |_address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_address.state|string|false|A state|Massachusetts| |_address.zipCode|string|false|A zipcode|02101| |_credentialType|string|false|What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP|| |_dateOfBirth|string|false|A person's date of birth A UTC date in the ISO-8601 format|2007-12-20| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_employeeId|string|false||| |_gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_locale|string|false|A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_mfa|object|false||| |_mfa.enabled|boolean|false|MFA login enabled or disabled. When omitted, the template's configured default is applied.|| |_mfa.expirationInMinutes|integer|false|MFA expiration time in minutes|| |_name|object|true||| |_name.firstName|string|true(*)|A person's first name|John| |_name.lastName|string|true(*)|A person's last name|Smith| |_ownerOrganization|object|true||| |_ownerOrganization.id|string|true(*)||| |_phone|string|false|A person's phone An E.164 formatted phone number|+12345678901| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Enable or Disable Organization User](https://docs.biot-med.com/reference/changeorganizationuserenabledstate.md): Enable or Disable Organization User Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Organization User ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| |state|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Create a new Organization User by Template name](https://docs.biot-med.com/reference/createorganizationuserbytemplatename.md): Create a new Organization User by Template name Email confirmation landing page is required as a header (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_address|object|false||| |_address.address1|string|false|An address|11 Main St.| |_address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_address.city|string|false|A city|Boston| |_address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_address.state|string|false|A state|Massachusetts| |_address.zipCode|string|false|A zipcode|02101| |_credentialType|string|false|What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP|| |_dateOfBirth|string|false|A person's date of birth A UTC date in the ISO-8601 format|2007-12-20| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_employeeId|string|false||| |_gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_locale|string|false|A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_mfa|object|false||| |_mfa.enabled|boolean|false|MFA login enabled or disabled. When omitted, the template's configured default is applied.|| |_mfa.expirationInMinutes|integer|false|MFA expiration time in minutes|| |_name|object|true||| |_name.firstName|string|true(*)|A person's first name|John| |_name.lastName|string|true(*)|A person's last name|Smith| |_ownerOrganization|object|true||| |_ownerOrganization.id|string|true(*)||| |_phone|string|false|A person's phone An E.164 formatted phone number|+12345678901| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Organization User by ID](https://docs.biot-med.com/reference/getorganizationuser.md): Get Organization User by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Organization User ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Organization User](https://docs.biot-med.com/reference/deleteorganizationuser.md): Delete Organization User Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Organization User ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Organization User](https://docs.biot-med.com/reference/updateorganizationuser.md): Update Organization User Performs partial update, if a field is specified in the request it will be updated (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_address|object|false||| |_address.address1|string|false|An address|11 Main St.| |_address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_address.city|string|false|A city|Boston| |_address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_address.state|string|false|A state|Massachusetts| |_address.zipCode|string|false|A zipcode|02101| |_dateOfBirth|string|false|A UTC date in the ISO-8601 format|2007-12-20| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_employeeId|string|false||| |_gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_locale|string|false|Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_mfa|object|false||| |_mfa.enabled|boolean|false|Is mfa enabled in login|| |_mfa.expirationInMinutes|integer|false|Mfa expiration in minutes|5| |_name|object|false||| |_name.firstName|string|true(*)|A person's first name|John| |_name.lastName|string|true(*)|A person's last name|Smith| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| |_phone|string|false|An E.164 formatted phone number|+12345678901| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Organization User ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get self Organization User by ID from access token](https://docs.biot-med.com/reference/getorganizationuserself.md): Get self Organization User by ID from access token Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Search Caregiver entities by filter](https://docs.biot-med.com/reference/searchcaregivers.md): Search Caregiver entities by filter Returns list of Caregiver, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_email*,*_phone*,*_description*,*_locale*,*_gender*,*_name.firstName*,*_name.lastName*,*_address.countryCode*,*_address.state*,*_address.city*,*_address.zipCode*,*_address.address1*,*_address.address2*,*_dateOfBirth*,*_ownerOrganization.id*,*_templateId*,*_templateName*,*_degree*,*_enabled*,*_employeeId*,*_creationTime*,*_lastModifiedTime*,*_mfa.enabled*,*_mfa.expirationInMinutes* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_email*,*_phone*,*_description*,*_locale*,*_gender*,*_name.firstName*,*_name.lastName*,*_address.countryCode*,*_address.state*,*_address.city*,*_address.zipCode*,*_address.address1*,*_address.address2*,*_dateOfBirth*,*_ownerOrganization.id*,*_degree*,*_enabled*,*_employeeId*,*_creationTime*,*_lastModifiedTime*,*_mfa.enabled*,*_mfa.expirationInMinutes* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Caregiver by Template id](https://docs.biot-med.com/reference/createcaregiver.md): Create a new Caregiver by Template id Email confirmation landing page is required as a header (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_address|object|false||| |_address.address1|string|false|An address|11 Main St.| |_address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_address.city|string|false|A city|Boston| |_address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_address.state|string|false|A state|Massachusetts| |_address.zipCode|string|false|A zipcode|02101| |_credentialType|string|false|What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP|| |_dateOfBirth|string|false|A person's date of birth A UTC date in the ISO-8601 format|2007-12-20| |_degree|string|false|An caregiver's name Values:MEDICAL_DOCTOR,DOCTOR_OF_OSTEOPATHY,PHYSICIAN_ASSISTANT,REGISTERED_NURSE,CLINICAL_NURSE_SPECIALISTS,NURSE_PRACTITIONER,LICENSED_PRACTICAL_NURSE,MEDICAL_ASSISTANT,NO_DEGREE,OTHER|PHYSICIAN_ASSISTANT| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_employeeId|string|false||| |_gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_locale|string|false|A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_mfa|object|false||| |_mfa.enabled|boolean|false|MFA login enabled or disabled. When omitted, the template's configured default is applied.|| |_mfa.expirationInMinutes|integer|false|MFA expiration time in minutes|| |_name|object|true||| |_name.firstName|string|true(*)|A person's first name|John| |_name.lastName|string|true(*)|A person's last name|Smith| |_ownerOrganization|object|true||| |_ownerOrganization.id|string|true(*)||| |_phone|string|false|A person's phone An E.164 formatted phone number|+12345678901| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Enable or Disable Caregiver User](https://docs.biot-med.com/reference/changecaregiverenabledstate.md): Enable or Disable Caregiver User Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Caregiver ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| |state|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Create a new Caregiver by Template name](https://docs.biot-med.com/reference/createcaregiverbytemplatename.md): Create a new Caregiver by Template name Email confirmation landing page is required as a header (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_address|object|false||| |_address.address1|string|false|An address|11 Main St.| |_address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_address.city|string|false|A city|Boston| |_address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_address.state|string|false|A state|Massachusetts| |_address.zipCode|string|false|A zipcode|02101| |_credentialType|string|false|What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP|| |_dateOfBirth|string|false|A person's date of birth A UTC date in the ISO-8601 format|2007-12-20| |_degree|string|false|An caregiver's name Values:MEDICAL_DOCTOR,DOCTOR_OF_OSTEOPATHY,PHYSICIAN_ASSISTANT,REGISTERED_NURSE,CLINICAL_NURSE_SPECIALISTS,NURSE_PRACTITIONER,LICENSED_PRACTICAL_NURSE,MEDICAL_ASSISTANT,NO_DEGREE,OTHER|PHYSICIAN_ASSISTANT| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_employeeId|string|false||| |_gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_locale|string|false|A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_mfa|object|false||| |_mfa.enabled|boolean|false|MFA login enabled or disabled. When omitted, the template's configured default is applied.|| |_mfa.expirationInMinutes|integer|false|MFA expiration time in minutes|| |_name|object|true||| |_name.firstName|string|true(*)|A person's first name|John| |_name.lastName|string|true(*)|A person's last name|Smith| |_ownerOrganization|object|true||| |_ownerOrganization.id|string|true(*)||| |_phone|string|false|A person's phone An E.164 formatted phone number|+12345678901| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Caregiver by ID](https://docs.biot-med.com/reference/getcaregiver.md): Get Caregiver by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Caregiver ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Caregiver](https://docs.biot-med.com/reference/deletecaregiver.md): Delete Caregiver Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Caregiver ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Caregiver](https://docs.biot-med.com/reference/updatecaregiver.md): Update Caregiver Performs partial update, if a field is specified in the request it will be updated (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_address|object|false||| |_address.address1|string|false|An address|11 Main St.| |_address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_address.city|string|false|A city|Boston| |_address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_address.state|string|false|A state|Massachusetts| |_address.zipCode|string|false|A zipcode|02101| |_dateOfBirth|string|false|A UTC date in the ISO-8601 format|2007-12-20| |_degree|string|false|An caregiver's name Values:MEDICAL_DOCTOR,DOCTOR_OF_OSTEOPATHY,PHYSICIAN_ASSISTANT,REGISTERED_NURSE,CLINICAL_NURSE_SPECIALISTS,NURSE_PRACTITIONER,LICENSED_PRACTICAL_NURSE,MEDICAL_ASSISTANT,NO_DEGREE,OTHER|PHYSICIAN_ASSISTANT| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_employeeId|string|false||| |_gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_locale|string|false|Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_mfa|object|false||| |_mfa.enabled|boolean|false|Is mfa enabled in login|| |_mfa.expirationInMinutes|integer|false|Mfa expiration in minutes|5| |_name|object|false||| |_name.firstName|string|true(*)|A person's first name|John| |_name.lastName|string|true(*)|A person's last name|Smith| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| |_phone|string|false|An E.164 formatted phone number|+12345678901| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Caregiver ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get self Caregiver by ID from access token](https://docs.biot-med.com/reference/getcaregiverself.md): Get self Caregiver by ID from access token Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Validation token operation](https://docs.biot-med.com/reference/validatetokenoperation-3.md): Validation token operation Validate that token, operation and entity ID are valid and not expired. This API is **public**. - [Execute token operation](https://docs.biot-med.com/reference/executetokenoperation-3.md): Execute token operation Execute operation by specifying a temp token instead of jwt token This API is **public**. - [Execute token operation](https://docs.biot-med.com/reference/executetokenoperationget-3.md): Execute token operation Execute operation by specifying a temp token instead of jwt token This API is **public**. - [Search Registration Code entities by filter](https://docs.biot-med.com/reference/searchregistrationcodes.md): Search Registration Code entities by filter Returns list of Registration Code, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_code*,*_ownerOrganizationId*,*_templateId*,*_creationTime*,*_lastModifiedTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_code*,*_ownerOrganizationId*,*_creationTime*,*_lastModifiedTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Registration Code by Template id](https://docs.biot-med.com/reference/createregistrationcode.md): Create a new Registration Code by Template id (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_code|string|true|The registration code entity that is attached to the device|RegistrationCode123| |_ownerOrganization|object|true||| |_ownerOrganization.id|string|true(*)||| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Registration Code by Template name](https://docs.biot-med.com/reference/createregistrationcodebytemplatename.md): Create a new Registration Code by Template name (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_code|string|true|The registration code entity that is attached to the device|RegistrationCode123| |_ownerOrganization|object|true||| |_ownerOrganization.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Registration Code by ID](https://docs.biot-med.com/reference/getregistrationcode.md): Get Registration Code by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Registration Code ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Registration Code](https://docs.biot-med.com/reference/deleteregistrationcode.md): Delete Registration Code Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Registration Code ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Registration Code](https://docs.biot-med.com/reference/updateregistrationcode.md): Update Registration Code Performs partial update, if a field is specified in the request it will be updated (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_code|string|false|The registration code entity that is attached to the device|RegistrationCode123| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Registration Code ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Search Organization entities by filter](https://docs.biot-med.com/reference/searchorganizations.md): Search Organization entities by filter Returns list of Organization, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_name*,*_description*,*_phone*,*_timezone*,*_locale*,*_primaryAdministrator.id*,*_templateId*,*_templateName*,*_creationTime*,*_lastModifiedTime*,*_headquarters.countryCode*,*_headquarters.state*,*_headquarters.city*,*_headquarters.zipCode*,*_headquarters.address1*,*_headquarters.address2* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_name*,*_description*,*_phone*,*_timezone*,*_locale*,*_primaryAdministrator.id*,*_creationTime*,*_lastModifiedTime*,*_headquarters.countryCode*,*_headquarters.state*,*_headquarters.city*,*_headquarters.zipCode*,*_headquarters.address1*,*_headquarters.address2* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Organization by Template id](https://docs.biot-med.com/reference/createorganization.md): Create a new Organization by Template id Organization admin will be created and set as the admin for the created organization.
Confirmation email with configured landing page will be sent. (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_branding|object|false||| |_branding.<customAttribute1>|<customAttribute1Type>|false|Branding custom attribute 1 value|| |_branding.<customAttributeN>|<customAttributeNType>|false|Branding custom attribute N value|| |_branding._favicon|object|false||| |_branding._favicon.id|string|true(*)|File id (uuid format)|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_branding._favicon.mimeType|string|false|File mime type|text| |_branding._favicon.name|string|false|File name|my_file.txt| |_branding._favicon.publicUrl|string|false|Public URL when the file's attribute is publicAccess=true; null otherwise.|https://-file-public.s3.us-east-1.amazonaws.com/| |_branding._favicon.size|integer|false|File size in bytes|1024| |_branding._logo|object|false||| |_branding._logo.id|string|true(*)|File id (uuid format)|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_branding._logo.mimeType|string|false|File mime type|text| |_branding._logo.name|string|false|File name|my_file.txt| |_branding._logo.publicUrl|string|false|Public URL when the file's attribute is publicAccess=true; null otherwise.|https://-file-public.s3.us-east-1.amazonaws.com/| |_branding._logo.size|integer|false|File size in bytes|1024| |_branding._theme|object|false||| |_branding._theme.id|string|true(*)|File id (uuid format)|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_branding._theme.mimeType|string|false|File mime type|text| |_branding._theme.name|string|false|File name|my_file.txt| |_branding._theme.publicUrl|string|false|Public URL when the file's attribute is publicAccess=true; null otherwise.|https://-file-public.s3.us-east-1.amazonaws.com/| |_branding._theme.size|integer|false|File size in bytes|1024| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_headquarters|object|false||| |_headquarters.address1|string|false|An address|11 Main St.| |_headquarters.address2|string|false|An address's specifics|Entry B, Apartment 1| |_headquarters.city|string|false|A city|Boston| |_headquarters.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_headquarters.state|string|false|A state|Massachusetts| |_headquarters.zipCode|string|false|A zipcode|02101| |_locale|string|false|Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_name|string|true|An organization's name|Example Inc.| |_phone|string|false|An E.164 formatted phone number|+12345678901| |_primaryAdministrator|object|true||| |_primaryAdministrator._address|object|false||| |_primaryAdministrator._address.address1|string|false|An address|11 Main St.| |_primaryAdministrator._address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_primaryAdministrator._address.city|string|false|A city|Boston| |_primaryAdministrator._address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_primaryAdministrator._address.state|string|false|A state|Massachusetts| |_primaryAdministrator._address.zipCode|string|false|A zipcode|02101| |_primaryAdministrator._credentialType|string|false|What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP|| |_primaryAdministrator._dateOfBirth|string|false|A person's date of birth A UTC date in the ISO-8601 format|2007-12-20| |_primaryAdministrator._description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_primaryAdministrator._email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_primaryAdministrator._employeeId|string|false||| |_primaryAdministrator._gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_primaryAdministrator._locale|string|false|A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_primaryAdministrator._mfa|object|false||| |_primaryAdministrator._mfa.enabled|boolean|false|MFA login enabled or disabled. When omitted, the template's configured default is applied.|| |_primaryAdministrator._mfa.expirationInMinutes|integer|false|MFA expiration time in minutes|| |_primaryAdministrator._name|object|true(*)||| |_primaryAdministrator._name.firstName|string|true(*)|A person's first name|John| |_primaryAdministrator._name.lastName|string|true(*)|A person's last name|Smith| |_primaryAdministrator._phone|string|false|A person's phone An E.164 formatted phone number|+12345678901| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_timezone|string|false|A java time zone supported by the java runtime environment|Europe/Oslo| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Organization by Template name](https://docs.biot-med.com/reference/createorganizationbytemplatename.md): Create a new Organization by Template name Organization admin will be created and set as the admin for the created organization.
Confirmation email with provided landing page will be sent. (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_branding|object|false||| |_branding.<customAttribute1>|<customAttribute1Type>|false|Branding custom attribute 1 value|| |_branding.<customAttributeN>|<customAttributeNType>|false|Branding custom attribute N value|| |_branding._favicon|object|false||| |_branding._favicon.id|string|true(*)|File id (uuid format)|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_branding._favicon.mimeType|string|false|File mime type|text| |_branding._favicon.name|string|false|File name|my_file.txt| |_branding._favicon.publicUrl|string|false|Public URL when the file's attribute is publicAccess=true; null otherwise.|https://-file-public.s3.us-east-1.amazonaws.com/| |_branding._favicon.size|integer|false|File size in bytes|1024| |_branding._logo|object|false||| |_branding._logo.id|string|true(*)|File id (uuid format)|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_branding._logo.mimeType|string|false|File mime type|text| |_branding._logo.name|string|false|File name|my_file.txt| |_branding._logo.publicUrl|string|false|Public URL when the file's attribute is publicAccess=true; null otherwise.|https://-file-public.s3.us-east-1.amazonaws.com/| |_branding._logo.size|integer|false|File size in bytes|1024| |_branding._theme|object|false||| |_branding._theme.id|string|true(*)|File id (uuid format)|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_branding._theme.mimeType|string|false|File mime type|text| |_branding._theme.name|string|false|File name|my_file.txt| |_branding._theme.publicUrl|string|false|Public URL when the file's attribute is publicAccess=true; null otherwise.|https://-file-public.s3.us-east-1.amazonaws.com/| |_branding._theme.size|integer|false|File size in bytes|1024| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_headquarters|object|false||| |_headquarters.address1|string|false|An address|11 Main St.| |_headquarters.address2|string|false|An address's specifics|Entry B, Apartment 1| |_headquarters.city|string|false|A city|Boston| |_headquarters.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_headquarters.state|string|false|A state|Massachusetts| |_headquarters.zipCode|string|false|A zipcode|02101| |_locale|string|false|Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_name|string|true|An organization's name|Example Inc.| |_phone|string|false|An E.164 formatted phone number|+12345678901| |_primaryAdministrator|object|true||| |_primaryAdministrator._address|object|false||| |_primaryAdministrator._address.address1|string|false|An address|11 Main St.| |_primaryAdministrator._address.address2|string|false|An address's specifics|Entry B, Apartment 1| |_primaryAdministrator._address.city|string|false|A city|Boston| |_primaryAdministrator._address.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_primaryAdministrator._address.state|string|false|A state|Massachusetts| |_primaryAdministrator._address.zipCode|string|false|A zipcode|02101| |_primaryAdministrator._credentialType|string|false|What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP|| |_primaryAdministrator._dateOfBirth|string|false|A person's date of birth A UTC date in the ISO-8601 format|2007-12-20| |_primaryAdministrator._description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_primaryAdministrator._email|string|false|An email address in the RFC-5322 specification|john.smith@biot-med.com| |_primaryAdministrator._employeeId|string|false||| |_primaryAdministrator._gender|string|false|A persons gender Values:MALE,FEMALE,UNDISCLOSED|FEMALE| |_primaryAdministrator._locale|string|false|A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_primaryAdministrator._mfa|object|false||| |_primaryAdministrator._mfa.enabled|boolean|false|MFA login enabled or disabled. When omitted, the template's configured default is applied.|| |_primaryAdministrator._mfa.expirationInMinutes|integer|false|MFA expiration time in minutes|| |_primaryAdministrator._name|object|true(*)||| |_primaryAdministrator._name.firstName|string|true(*)|A person's first name|John| |_primaryAdministrator._name.lastName|string|true(*)|A person's last name|Smith| |_primaryAdministrator._phone|string|false|A person's phone An E.164 formatted phone number|+12345678901| |_timezone|string|false|A java time zone supported by the java runtime environment|Europe/Oslo| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Update Organization](https://docs.biot-med.com/reference/changeorganizationadmin.md): Update Organization Performs partial update, if a field is specified in the request it will be updated Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |newAdminId|string|true|null|| This API requires **ORGANIZATION_CHANGE_ADMIN** permission(s). - [Get Organization by ID](https://docs.biot-med.com/reference/getorganization.md): Get Organization by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Organization ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Organization](https://docs.biot-med.com/reference/deleteorganization.md): Delete Organization All users that belong to this organization will be deleted as well Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Organization ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Organization](https://docs.biot-med.com/reference/updateorganization.md): Update Organization Performs partial update, if a field is specified in the request it will be updated (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_branding|object|false||| |_branding.<customAttribute1>|<customAttribute1Type>|false|Branding custom attribute 1 value|| |_branding.<customAttributeN>|<customAttributeNType>|false|Branding custom attribute N value|| |_branding._favicon|object|false||| |_branding._favicon.present|boolean|false||| |_branding._logo|object|false||| |_branding._logo.present|boolean|false||| |_branding._theme|object|false||| |_branding._theme.present|boolean|false||| |_description|string|false|A description, can be up to 5000 characters long|Lorem Ipsum| |_headquarters|object|false||| |_headquarters.address1|string|false|An address|11 Main St.| |_headquarters.address2|string|false|An address's specifics|Entry B, Apartment 1| |_headquarters.city|string|false|A city|Boston| |_headquarters.countryCode|string|true(*)|A 2-letter country code defined in ISO-3166|US| |_headquarters.state|string|false|A state|Massachusetts| |_headquarters.zipCode|string|false|A zipcode|02101| |_locale|string|false|Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.|en-us| |_name|string|false|An organization's name|Example Inc.| |_phone|string|false|An E.164 formatted phone number|+12345678901| |_timezone|string|false|A java time zone supported by the java runtime environment|Europe/Oslo| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Organization ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get the current organization's branding](https://docs.biot-med.com/reference/getbrandingforcurrentorganization.md): Get the current organization's branding This API requires **PROTECTED_API** permission(s). - [Get default organization branding](https://docs.biot-med.com/reference/getbrandingfordefaultorganization.md): Get default organization branding This API is **public**. - [Resend Invitation by ID](https://docs.biot-med.com/reference/resendinvitation.md): Resend Invitation by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |userId|string|true|The ID of the user|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Search Generic Entity entities by filter](https://docs.biot-med.com/reference/searchgenericentitiesv3-1.md): Search Generic Entity entities by filter > ❗ **The V3 Generic Entity API is available from BioT platform version 2.3.40 and requires the GENERIC_ENTITIES_API_V3 flag to be enabled. Contact Customer Success to request activation.** Returns list of Generic Entity, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_ownerOrganization.id*,*_name*,*_lastModifiedTime*,*_creationTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_ownerOrganization.id*,*_name*,*_lastModifiedTime*,*_creationTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Generic Entity by Template name](https://docs.biot-med.com/reference/creategenericentityv3-1.md): Create a new Generic Entity by Template name > ❗ **The V3 Generic Entity API is available from BioT platform version 2.3.40 and requires the GENERIC_ENTITIES_API_V3 flag to be enabled. Contact Customer Success to request activation.** (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|string|true||| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Generic Entity by ID](https://docs.biot-med.com/reference/getgenericentityv3-1.md): Get Generic Entity by ID > ❗ **The V3 Generic Entity API is available from BioT platform version 2.3.40 and requires the GENERIC_ENTITIES_API_V3 flag to be enabled. Contact Customer Success to request activation.** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| |id|string|true|Generic Entity ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Generic Entity](https://docs.biot-med.com/reference/deletegenericentityv3-1.md): Delete Generic Entity > ❗ **The V3 Generic Entity API is available from BioT platform version 2.3.40 and requires the GENERIC_ENTITIES_API_V3 flag to be enabled. Contact Customer Success to request activation.** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| |id|string|true|Generic Entity ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Generic Entity](https://docs.biot-med.com/reference/updategenericentityv3-1.md): Update Generic Entity > ❗ **The V3 Generic Entity API is available from BioT platform version 2.3.40 and requires the GENERIC_ENTITIES_API_V3 flag to be enabled. Contact Customer Success to request activation.** Performs partial update, if a field is specified in the request it will be updated (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|string|true||| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| |id|string|true|Generic Entity ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Search Generic Entity entities by filter](https://docs.biot-med.com/reference/searchgenericentities-1.md): Search Generic Entity entities by filter > ❗ **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.** Returns list of Generic Entity, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_ownerOrganization.id*,*_name*,*_templateId*,*_templateName*,*_lastModifiedTime*,*_creationTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_ownerOrganization.id*,*_name*,*_lastModifiedTime*,*_creationTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **GENERIC_ENTITY_SEARCH_GENERIC_ENTITY_V, PROTECTED_API** permission(s). - [Create a new Generic Entity by Template id](https://docs.biot-med.com/reference/creategenericentity-1.md): Create a new Generic Entity by Template id > **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40.** > **If your environment is on version 2.3.40 or later, you can optionally migrate to V3.** > **Contact Customer Success to enable V3 for your account.** (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|string|true||| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Generic Entity by Template name](https://docs.biot-med.com/reference/creategenericentitybytemplatename-1.md): Create a new Generic Entity by Template name > ❗ **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.** (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|string|true||| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Generic Entity by ID](https://docs.biot-med.com/reference/getgenericentity-1.md): Get Generic Entity by ID > ❗ **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Generic Entity ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Generic Entity](https://docs.biot-med.com/reference/deletegenericentity-1.md): Delete Generic Entity > ❗ **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Generic Entity ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Generic Entity](https://docs.biot-med.com/reference/updategenericentity-1.md): Update Generic Entity > **The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40.** > **If your environment is on version 2.3.40 or later, you can optionally migrate to V3.** > **Contact Customer Success to enable V3 for your account.** Performs partial update, if a field is specified in the request it will be updated (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_name|string|true||| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Generic Entity ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Search Device entities by filter](https://docs.biot-med.com/reference/searchdevices-1.md): Search Device entities by filter Returns list of Device, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_ownerOrganization.id*,*_description*,*_timezone*,*_patient.id*,*_status._fwVersion*,*_status._hwVersion*,*_status._bootTime*,*_status._connection._connected*,*_status._connection._ipAddress*,*_status._operational._status*,*_status._operational._message*,*_templateId*,*_templateName*,*_lastModifiedTime*,*_creationTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_ownerOrganization.id*,*_description*,*_timezone*,*_patient.id*,*_status._fwVersion*,*_status._hwVersion*,*_status._bootTime*,*_status._connection._connected*,*_status._connection._ipAddress*,*_status._operational._status*,*_status._operational._message*,*_lastModifiedTime*,*_creationTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Device by Template id](https://docs.biot-med.com/reference/registerdevice-1.md): Create a new Device by Template id (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_description|string|false|Device description|| |_id|string|true| Pattern:[a-zA-Z0-9:_-]+|| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| |_patient|object|false||| |_patient.id|string|true(*)||| |_registrationCode|object|false||| |_registrationCode.id|string|true(*)||| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| |_timezone|string|false|A java time zone supported by the java runtime environment|Europe/Oslo| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Device by Template name](https://docs.biot-med.com/reference/registerdevicewithtemplatename-1.md): Create a new Device by Template name (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_description|string|false|Device description|| |_id|string|true| Pattern:[a-zA-Z0-9:_-]+|| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| |_patient|object|false||| |_patient.id|string|true(*)||| |_registrationCode|object|false||| |_registrationCode.id|string|true(*)||| |_timezone|string|false|A java time zone supported by the java runtime environment|Europe/Oslo| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Device by ID](https://docs.biot-med.com/reference/getdevice-1.md): Get Device by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device ID that needs to be fetched|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Device](https://docs.biot-med.com/reference/deletedevice-1.md): Delete Device Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device ID that needs to be deleted|| This API requires **PROTECTED_API** permission(s). - [Update Device](https://docs.biot-med.com/reference/updatedevice-1.md): Update Device Performs partial update, if a field is specified in the request it will be updated (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_description|string|false|Device description|| |_ownerOrganization|object|false||| |_ownerOrganization.id|string|true(*)||| |_patient|object|false||| |_patient.id|string|true(*)||| |_registrationCode|object|false||| |_registrationCode.id|string|true(*)||| |_timezone|string|false|A java time zone supported by the java runtime environment|Europe/Oslo| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device ID that needs to be updated|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Device Connection Details by ID](https://docs.biot-med.com/reference/getconnectiondetails-1.md): Get Device Connection Details by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device id|device1| This API requires **PROTECTED_API** permission(s). - [Update device status by device id](https://docs.biot-med.com/reference/updatedevicestatus.md): Update device status by device id Performs partial update, if a field is specified in the request it will be updated Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |data|object|true|Status attributes to update (built-in and custom)|{_fwVersion=0.73, batteryLevel=0.63}| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device id|device1| This API requires **PROTECTED_API** permission(s). - [Create new Certificate for Device](https://docs.biot-med.com/reference/createcertificate-1.md): Create new Certificate for Device type - ***BOOTSTRAP*** or ***PRODUCTION*** - default ***PRODUCTION*** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device id|device1| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |type|string|false|Supported values are: BOOTSTRAP, PRODUCTION, default value: PRODUCTION. BOOTSTRAP - temporary certificate for factory tests only. PRODUCTION - certificate for production devices|| This API requires **PROTECTED_API** permission(s). - [Delete Certificate for Device](https://docs.biot-med.com/reference/deletecertificate-1.md): Delete Certificate for Device type - ***BOOTSTRAP*** or ***PRODUCTION*** - default ***PRODUCTION*** This API requires **PROTECTED_API** permission(s). - [Activate Certificate for Device](https://docs.biot-med.com/reference/activatecertificate-1.md): Activate Certificate for Device type - ***BOOTSTRAP*** or ***PRODUCTION*** - default ***PRODUCTION*** Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Device id|device1| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |type|string|false|null|| This API requires **PROTECTED_API** permission(s). - [Create a new Usage Session by Template id](https://docs.biot-med.com/reference/createsession-1.md): Create a new Usage Session by Template id If patient is null in the request, the patient id will be read from the device entity (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_endTime|string|false|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_name|string|false|The name of the session|| |_patient|object|false||| |_patient.id|string|true(*)||| |_startTime|string|true|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_state|string|true|The Sessions state Values:ACTIVE,DONE,PAUSED,ACTIVATING,PAUSING,RESUMING,STOPPING|ACTIVE| |_summary|object|false||| |_summary.<customAttribute1>|<customAttribute1Type>|false|Summary custom attribute 1 value|| |_summary.<customAttributeN>|<customAttributeNType>|false|Summary custom attribute N value|| |_summary._stopReason|string|false|The reason the session was stopped|Manual Stop| |_summary._stopReasonCode|string|false|The code of the stop reason Values:COMPLETION,GENERAL_DEVICE_ERROR,TIMEOUT|COMPLETION| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Usage Session by Template name](https://docs.biot-med.com/reference/createsessionbyusagetype-1.md): Create a new Usage Session by Template name If patient is null in the request, the patient id will be read from the device entity. (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_endTime|string|false|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_name|string|false|The name of the session|| |_patient|object|false||| |_patient.id|string|true(*)||| |_startTime|string|true|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_state|string|true|The Sessions state Values:ACTIVE,DONE,PAUSED,ACTIVATING,PAUSING,RESUMING,STOPPING|ACTIVE| |_summary|object|false||| |_summary.<customAttribute1>|<customAttribute1Type>|false|Summary custom attribute 1 value|| |_summary.<customAttributeN>|<customAttributeNType>|false|Summary custom attribute N value|| |_summary._stopReason|string|false|The reason the session was stopped|Manual Stop| |_summary._stopReasonCode|string|false|The code of the stop reason Values:COMPLETION,GENERAL_DEVICE_ERROR,TIMEOUT|COMPLETION| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |usageType|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Usage Session by ID](https://docs.biot-med.com/reference/getsession-1.md): Get Usage Session by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Usage Session ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Usage Session](https://docs.biot-med.com/reference/deletesession-1.md): Delete Usage Session Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Usage Session ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Usage Session](https://docs.biot-med.com/reference/updatesession-1.md): Update Usage Session Performs partial update, if a field is specified in the request it will be updated Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_endTime|string|false|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_name|string|false|The name of the session|| |_startTime|string|true|A UTC date-time in the ISO-8601 format|2007-12-20T10:15:30Z| |_state|string|true|The Sessions state Values:ACTIVE,DONE,PAUSED,ACTIVATING,PAUSING,RESUMING,STOPPING|ACTIVE| |_summary|object|false||| |_summary.<customAttribute1>|<customAttribute1Type>|false|Summary custom attribute 1 value|| |_summary.<customAttributeN>|<customAttributeNType>|false|Summary custom attribute N value|| |_summary._stopReason|string|false|The reason the session was stopped|Manual Stop| |_summary._stopReasonCode|string|false|The code of the stop reason Values:COMPLETION,GENERAL_DEVICE_ERROR,TIMEOUT|COMPLETION| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Usage Session ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Search Usage Session entities by filter](https://docs.biot-med.com/reference/searchsessions-1.md): Search Usage Session entities by filter Returns list of Usage Session, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_templateId*,*_templateName*,*_id*,*_patient.id*,*_device.id*,*_startTime*,*_endTime*,*_initiator*,*_state*,*_ownerOrganization.id*,*_requiredMeasurementIntervalMilliseconds*,*_summary._stopReason*,*_summary._stopReasonCode*,*_name*,*_creationTime*,*_lastModifiedTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_patient.id*,*_device.id*,*_startTime*,*_endTime*,*_initiator*,*_state*,*_ownerOrganization.id*,*_requiredMeasurementIntervalMilliseconds*,*_summary._stopReason*,*_summary._stopReasonCode*,*_name*,*_creationTime*,*_lastModifiedTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Search currently in progress devices' sessions entities by filter](https://docs.biot-med.com/reference/searchdevicesessions-1.md): Search currently in progress devices' sessions entities by filter Returns list of currently in progress devices' sessions, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_ownerOrganization.id*,*_id(device)*,*_patient.id* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Delete Usage Session](https://docs.biot-med.com/reference/deleteorphansessions-1.md): Delete Usage Session This api will delete up to 500 sessions that have a null value in the requested field. Supported Values: DEVICE, PATIENT Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deleteOrphanSessionsEnum|string|true|null|| This API requires **SESSION_DELETE_ORPHANS** permission(s). - [Stop an existing Usage Session](https://docs.biot-med.com/reference/stopsession-1.md): Stop an existing Usage Session Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|The device ID|device1| |id|string|true|Usage Session ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Resume a paused Usage Session](https://docs.biot-med.com/reference/resumesession-1.md): Resume a paused Usage Session Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Usage Session ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Pause an existing Usage Session](https://docs.biot-med.com/reference/pausesession-1.md): Pause an existing Usage Session Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Usage Session ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Create and start a Usage Session](https://docs.biot-med.com/reference/startsession-1.md): Create and start a Usage Session If patient is null in the request, the patient id will be read from the device entity (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_name|string|false|The name of the session|| |_patient|object|false||| |_patient.id|string|true(*)||| |_summary.<customAttribute1>|<customAttribute1Type>|false|Summary custom attribute 1 value|| |_summary.<customAttributeN>|<customAttributeNType>|false|Summary custom attribute N value|| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Start a new command by name](https://docs.biot-med.com/reference/startcommandbytemplatename-1.md): Start a new command by name Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |_configuration|object|false|An object that holds the entity configuration attributes|| |_name|string|false|The name of the command|| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |templateName|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Stop an existing Command](https://docs.biot-med.com/reference/stopcommand-1.md): Stop an existing Command Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Command ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Start a new command](https://docs.biot-med.com/reference/startcommand-1.md): Start a new command Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_configuration|object|false|An object that holds the entity configuration attributes|| |_configuration.<customAttribute1>|<customAttribute1Type>|false|Configuration custom attribute 1 value|| |_configuration.<customAttributeN>|<customAttributeNType>|false|Configuration custom attribute N value|| |_name|string|false|The name of the command|| |_status.<customAttribute1>|<customAttribute1Type>|false|Status custom attribute 1 value|| |_status.<customAttributeN>|<customAttributeNType>|false|Status custom attribute N value|| |_summary.<customAttribute1>|<customAttribute1Type>|false|Summary custom attribute 1 value|| |_summary.<customAttributeN>|<customAttributeNType>|false|Summary custom attribute N value|| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| This API requires **PROTECTED_API** permission(s). - [Get Command by ID](https://docs.biot-med.com/reference/getcommand-1.md): Get Command by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Command ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Command](https://docs.biot-med.com/reference/deletecommand-1.md): Delete Command Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Command ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Search Command entities by filter](https://docs.biot-med.com/reference/searchcommands-1.md): Search Command entities by filter Returns list of Command, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_templateId*,*_templateName*,*_id*,*_device.id*,*_startTime*,*_endTime*,*_state*,*_ownerOrganization.id*,*_supportStop*,*_timeoutInSeconds*,*_name*,*_creationTime*,*_lastModifiedTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_device.id*,*_startTime*,*_endTime*,*_state*,*_ownerOrganization.id*,*_supportStop*,*_timeoutInSeconds*,*_name*,*_creationTime*,*_lastModifiedTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Device Alert by Template id](https://docs.biot-med.com/reference/createalert_1.md): Create a new Device Alert by Template id Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_clearNotes|string|false|Clear notes|| |_name|string|false|The name of the alert|| |_severity|string|false|The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO Default:INFO|MAJOR| |_state|string|false|The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED Default:ACTIVE|ACTIVE| |_templateId|string|true|The id of a template that is configured in the settings service.|3fa85f64-5717-4562-b3fc-2c963f66afa6| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Create a new Device Alert by Template name](https://docs.biot-med.com/reference/createalertbytemplatename_1.md): Create a new Device Alert by Template name Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_clearNotes|string|false|Clear notes|| |_name|string|false|The name of the alert|| |_severity|string|false|The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO Default:INFO|MAJOR| |_state|string|false|The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED Default:ACTIVE|ACTIVE| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |templateName|string|true|null|| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get Device Alert by ID](https://docs.biot-med.com/reference/getalert_1.md): Get Device Alert by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Device Alert ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Delete Device Alert](https://docs.biot-med.com/reference/deletealert_1.md): Delete Device Alert Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Device Alert ID that needs to be deleted|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Update Device Alert](https://docs.biot-med.com/reference/updatealert_1.md): Update Device Alert Performs partial update, if a field is specified in the request it will be updated Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |<customAttribute1>|<customAttribute1Type>|false|Regular custom attribute 1 value|| |<customAttributeN>|<customAttributeNType>|false|Regular custom attribute N value|| |_clearNotes|string|false|Clear notes|| |_name|string|false|The name of the alert|| |_severity|string|false|The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO|MAJOR| |_state|string|false|The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED|ACTIVE| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |deviceId|string|true|null|| |id|string|true|Device Alert ID that needs to be updated|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Search open device's alerts entities by filter](https://docs.biot-med.com/reference/searchcurrentalerts_1.md): Search open device's alerts entities by filter Returns list of open device's alerts, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_ownerOrganization.id* ] ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ ] If sort was not specified, the result will be sorted by: creationTime DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| This API requires **PROTECTED_API** permission(s). - [Search Device Alert entities by filter](https://docs.biot-med.com/reference/searchalerts_1.md): Search Device Alert entities by filter Returns list of Device Alert, the response can be filtered, sorted and supports pagination **For more information and examples on creating search requests, click here.** ## Filter Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field By using the logical additionalProps $AND, $OR, $NOT, you can add complex nested logic filters. When sending these props, you must send only the nested filter field inside the filter value. This will allow you to group additional filters using logical AND/OR/NOT operators. When not sending a logic prop (including when not sending a nested logic prop), the props are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned. ***filter*** items possible values: [ *_id*,*_templateId*,*_templateName*,*_device.id*,*_ownerOrganization.id*,*_severity*,*_state*,*_setDateTime*,*_clearDateTime*,*_clearTrigger*,*_clearedBy.id*,*_clearNotes*,*_name*,*_creationTime*,*_lastModifiedTime* ] and all custom attributes of all templates ## Sort Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort The first field is the primary sort, the second is used when two values of the first field are the same, and so forth ***sort.order*** default value is DESC ***sort.prop*** possible values:[ *_id*,*_device.id*,*_ownerOrganization.id*,*_severity*,*_state*,*_setDateTime*,*_clearDateTime*,*_clearTrigger*,*_clearedBy.id*,*_clearNotes*,*_name*,*_creationTime*,*_lastModifiedTime* ] If sort was not specified, the result will be sorted by: *_creationTime* DESC ## Free text search When freeTextSearch is passed, the free text search will be performed on every field except those of type Date If used together with filters, freeTextSearch will be bundled to the filters with the logical AND operator, this means that only items that match all filters (and each filter's conditions) and the free text search will be returned ## Page ***limit*** max number of results that will be returned for each page. If not specify, the default will be 100 ***page*** page number starting from 0. If not specify, the default will be 0 ## Build URL Encode the JSON object and use the encoded string as the searchRequest parameter: https://<URL>?searchRequest= Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |searchRequest||false|Search request parameters: filter, sort and page|| |includeReferencers|boolean|false|Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.|| This API requires **PROTECTED_API** permission(s). - [Get self User by ID from access token](https://docs.biot-med.com/reference/getself.md): Get self User by ID from access token In addition to the common fields between all user types, the specific fields for the user type will be returned as well This API requires **PROTECTED_API** permission(s). - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-9.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Get mqtt temporary credentials for device gateway](https://docs.biot-med.com/reference/gettempcredentialsfordevice-1.md): Get mqtt temporary credentials for device gateway Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|Credentials ID|| This API requires **PROTECTED_API** permission(s). - [Get mqtt temporary credentials for receiving device measurements for all devices in an organization.](https://docs.biot-med.com/reference/gettempcredentialsfororganizationclient-1.md): Get mqtt temporary credentials for receiving device measurements for all devices in an organization. Also returns a single topic formatted '[ownerOrganizationId]/+/+'. [ownerOrganizationId] will be filled from the access token and should not be changed. The first [+] represents deviceId and can be changed to any deviceId in the organization, this topic will include only messages from that device. [+] can be used to listen to all devices. The second [+] represents notification type and can be changed, this topic will include only messages from that notification type. [+] can be used for all notification types. E.g. The topic for an organization with id [00000000-0000-0000-0000-000000000000] and device with id [device-id] listening to all notification types will be '00000000-0000-0000-0000-000000000000/device-id/+'. This API requires **PROTECTED_API** permission(s). - [Get endpoint](https://docs.biot-med.com/reference/getendpoint-1.md): Get endpoint This API requires **PROTECTED_API** permission(s). - [Upload ETags for parts of a multiple part file upload](https://docs.biot-med.com/reference/saveetagsformultiplepartfileupload.md): Upload ETags for parts of a multiple part file upload Each file upload to the links returned from this API will return an 'ETag' header. This header must be sent to this API, if it is not sent, the part will be ignored when the file is combined. Multiple ETags can be passed here, although ideally after each part is uploaded the returned ETag is sent to the service (to prevent data loss). If sending a tag for a part that was already sent, the previous tag for that part number will be overridden. This can also be done in completeMultiplePartUploadFile API. Part numbers must be only for existing parts in the system, and cannot repeat in the same request. May only be used on uncompleted multiple part uploads. At least one part must be sent in the list. (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |parts|array|true|List of file upload parts with their ETags|| |parts[index]|array|false|List of file upload parts with their ETags|| |parts[index].partNumber|integer|true(*)|The part number for which to save the eTag|5| |parts[index].etag|string|false||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|File ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Generate signed URLs for multiple part file upload](https://docs.biot-med.com/reference/generatesignedurlsformultiplepartfileupload.md): Generate signed URLs for multiple part file upload This API returns the same response as createMultiplePartUploadFileUrl API, but it does so for existing multiple part file uploads. It creates new signed urls and can be used in a situation where the signed urls have expired. It can also create signed urls for new parts not originally requested. It will return signedUrls only for parts in the requested range. May only be used on uncompleted multiple part uploads. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |fromPart|integer|true|The part number to generate from, inclusive|5| |toPart|integer|true|The part number to generate to, inclusive|10| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|File ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Create a new File](https://docs.biot-med.com/reference/createmultiplepartuploadfileurl.md): Create a new File This API returns a list of links to upload file parts. The number of parts requested must be between 1 and 10000. It can be changed later, so you don't have to know the file size in advance. If a link for a part is used more than once, the data that was previously uploaded to that link will be overwritten (and the ETag should be updated in the service). You don't have to use all of the links, but must use at least one. Each link has an expiry time, after which it cannot be used. To generate new links and request links for more parts use generateSignedUrlsForMultiplePartFileUpload. File uploads are done with the links returned in from this API as PUT requests with the data as a binary stream in the body. Each file upload to the links returned from this API will return an 'ETag' header. This header must be sent to the bioT API saveETagsForMultiplePartFileUpload, if it is not sent, the part will be ignored when the file is combined. The file must be split and uploaded to the links provided on the client's side. Parts may be uploaded in any order, but must be uploaded using the correct part number and link (E.g. file=abc with 3 parts - you can upload in any order p1=a, p3=c, p2=b). Each file part must be between 5MiB and 5GiB, the last part has no minimum size. 100MiB is recommended if possible. Max supported file size is 5TiB. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |name|string|true||| |mimeType|string|true||| |parts|integer|true|For how many parts to initially generate links, not all must be used and more can be generated later|100| This API requires **PROTECTED_API** permission(s). - [Complete multiple part file upload](https://docs.biot-med.com/reference/completemultiplepartuploadfile.md): Complete multiple part file upload If this API is called before the file is completely uploaded, then the file will be assembled incorrectly. Only parts that have an ETag sent using this API or saveETagsForMultiplePartFileUpload API will be combined to a file. At least one ETag must be sent using this API or saveETagsForMultiplePartFileUpload API. The body for this request is optional. May only be used on uncompleted multiple part uploads. Part numbers must be only for existing parts in the system, and cannot repeat in the same request. (*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information. Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |parts|array|true|List of file upload parts with their ETags|| |parts[index]|array|false|List of file upload parts with their ETags|| |parts[index].partNumber|integer|true(*)|The part number for which to save the eTag|5| |parts[index].etag|string|false||| Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|File ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Cancel multiple part file upload](https://docs.biot-med.com/reference/cancelmultiplepartuploadfile.md): Cancel multiple part file upload May only be used on uncompleted multiple part uploads. Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|File ID|3fa85f64-5717-4562-b3fc-2c963f66afa6| This API requires **PROTECTED_API** permission(s). - [Create a new File](https://docs.biot-med.com/reference/createuploadfileurl.md): Create a new File Request Body Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |name|string|true||| |mimeType|string|true||| This API requires **PROTECTED_API** permission(s). - [Get File by ID](https://docs.biot-med.com/reference/getdownloadfileurl.md): Get File by ID Path Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |id|string|true|File ID that needs to be fetched|3fa85f64-5717-4562-b3fc-2c963f66afa6| Query Parameters: | Parameter |Type | Mandatory| Description | Example | |-------------|-------|----------|----------------------|-----------| |contentDisposition|string|false|Parameter to the signed URL. INLINE - the file content should be displayed in the browser's tab. ATTACHMENT - the browser should download the file to the disk. Default: INLINE|| This API requires **PROTECTED_API** permission(s). - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-10.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**. - [Service Health check API](https://docs.biot-med.com/reference/healthcheck-11.md): Service Health check API The API returns 200 if the service is up, used by the Load Balancer This API is **public**.