Update Usage Session

patch

https://device/v1/devices/{deviceId}/usage-sessions/{id}

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).

Path Params

deviceId

string

required

uuid

required

Usage Session ID that needs to be updated

Query Params

includeReferencers

boolean

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.

Body Params

_startTime

date-time

required

A UTC date-time in the ISO-8601 format

_endTime

date-time

A UTC date-time in the ISO-8601 format

_state

string

enum

required

The Sessions state

Allowed:

_configuration

object

An object that holds the entity configuration attributes

_summary

object

_name

string

length between 1 and 64

The name of the session

Responses

Parameter	Type	Description	Example
<customAttribute1>	<customAttribute1Type>	Regular custom attribute 1 value
<customAttributeN>	<customAttributeNType>	Regular custom attribute N value
_caption	string
_configuration	object	An object that holds the entity configuration attributes
_configuration.<customAttribute1>	<customAttribute1Type>	Configuration custom attribute 1 value
_configuration.<customAttributeN>	<customAttributeNType>	Configuration custom attribute N value
_creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_device	object
_device.id	string
_device.name	string	The caption of the referenced entity
_device.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_device.parentEntityId	string	The id of the parent entity (appears only for child entities)
_device.template	object
_device.template.displayName	string	The display name of the template
_device.template.id	string	The id of the template
_device.template.name	string	The name of the template
_device.template.parentTemplate	object
_device.template.parentTemplate.displayName	string
_device.template.parentTemplate.id	string
_device.template.parentTemplate.name	string
_device.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_device.templateName	string	The name of the referenced entity template
_endTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_id	string	Session ID	3fa85f64-5717-4562-b3fc-2c963f66afa6
_initiator	string	What API initiated the session Values:REMOTE_CONTROL,EXTERNAL	EXTERNAL
_lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_name	string	The name of the session
_ownerOrganization	object
_ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.name	string	The caption of the referenced entity
_ownerOrganization.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
_ownerOrganization.template	object
_ownerOrganization.template.displayName	string	The display name of the template
_ownerOrganization.template.id	string	The id of the template
_ownerOrganization.template.name	string	The name of the template
_ownerOrganization.template.parentTemplate	object
_ownerOrganization.template.parentTemplate.displayName	string
_ownerOrganization.template.parentTemplate.id	string
_ownerOrganization.template.parentTemplate.name	string
_ownerOrganization.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.templateName	string	The name of the referenced entity template
_patient	object
_patient.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_patient.name	string	The caption of the referenced entity
_patient.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_patient.parentEntityId	string	The id of the parent entity (appears only for child entities)
_patient.template	object
_patient.template.displayName	string	The display name of the template
_patient.template.id	string	The id of the template
_patient.template.name	string	The name of the template
_patient.template.parentTemplate	object
_patient.template.parentTemplate.displayName	string
_patient.template.parentTemplate.id	string
_patient.template.parentTemplate.name	string
_patient.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_patient.templateName	string	The name of the referenced entity template
_referencers	object	An object that contains all the referencers of this entity. Each referencer is the RSAN and it's an object that contains the count of the referrers, and information of the referrer (in case count = 1)
_requiredMeasurementIntervalMilliseconds	integer	The interval between measurements in milliseconds	1000
_sessionContext	string	The context that is linked to the current session and should be sent in a measurement message
_startTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_state	string	The Sessions state Values:ACTIVE,DONE,PAUSED,ACTIVATING,PAUSING,RESUMING,STOPPING	ACTIVE
_summary	object
_summary.<customAttribute1>	<customAttribute1Type>	Summary custom attribute 1 value
_summary.<customAttributeN>	<customAttributeNType>	Summary custom attribute N value
_summary._stopReason	string	The reason the session was stopped	Manual Stop
_summary._stopReasonCode	string	The code of the stop reason Values:COMPLETION,GENERAL_DEVICE_ERROR,TIMEOUT	COMPLETION
_template	object
_template.displayName	string	The display name of the template
_template.id	string	The id of the template
_template.name	string	The name of the template
_template.parentTemplate	object
_template.parentTemplate.displayName	string
_template.parentTemplate.id	string
_template.parentTemplate.name	string

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Code : TOKEN_NOT_VALID, Details: []

404Code : SESSION_NOT_FOUND, Details: [id] Code : REFERENCE_CONFIGURATION_ENTITY_NOT_FOUND, Details: [attributeName, entityId]

409Code : SESSION_WRONG_DEVICE_ID, Details: [id, deviceId] Code : SESSION_STATE_CHANGE_INVALID, Details: [currentState, targetState]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []