User GuideAPI Reference
ProductUse CasesResource CenterFAQAbout UsBook a DemoSign Up - It's Free
API Reference

Create a new Usage Session by Template name

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:

ParameterTypeMandatoryDescriptionExample
<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
_configurationobjectfalseAn object that holds the entity configuration attributes
_configuration.<customAttribute1><customAttribute1Type>falseConfiguration custom attribute 1 value
_configuration.<customAttributeN><customAttributeNType>falseConfiguration custom attribute N value
_endTimestringfalseA UTC date-time in the ISO-8601 format2007-12-20T10:15:30Z
_namestringfalseThe name of the session
_patientobjectfalse
_patient.idstringtrue(*)A UUID formatted string3fa85f64-5717-4562-b3fc-2c963f66afa6
_startTimestringtrueA UTC date-time in the ISO-8601 format2007-12-20T10:15:30Z
_statestringtrueThe Sessions state Values:ACTIVE,DONE,PAUSED,ACTIVATING,PAUSING,RESUMING,STOPPINGACTIVE
_summaryobjectfalse
_summary.<customAttribute1><customAttribute1Type>falseSummary custom attribute 1 value
_summary.<customAttributeN><customAttributeNType>falseSummary custom attribute N value
_summary._stopReasonstringfalseThe reason the session was stoppedManual Stop
_summary._stopReasonCodestringfalseThe code of the stop reason Values:COMPLETION,GENERAL_DEVICE_ERROR,TIMEOUTCOMPLETION

Path Parameters:

ParameterTypeMandatoryDescriptionExample
deviceIdstringtruenull
usageTypestringtruenull

This API requires PROTECTED_API permission(s).

Language
Authorization
Bearer
JWT
Click Try It! to start a request and see the response here!