post https://example.com/device/v1/devices//usage-sessions/usage-type/
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).