Get Device by ID

get https://example.com/device/v2/devices/{id}

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

Responses

Parameter	Type	Description	Example
<customAttribute1>	<customAttribute1Type>	Regular custom attribute 1 value
<customAttributeN>	<customAttributeNType>	Regular custom attribute N value
_caption	string	The caption of the command instance	mydevice1
_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
_description	string	Device description
_id	string	The id of the device
_lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_ownerOrganization	object
_ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.name	string	The caption of the referenced entity
_ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
_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.parentEntityId	string	The id of the parent entity (appears only for child entities)
_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)
_registrationCode	object
_registrationCode.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_registrationCode.name	string	The caption of the referenced entity
_registrationCode.parentEntityId	string	The id of the parent entity (appears only for child entities)
_registrationCode.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_registrationCode.templateName	string	The name of the referenced entity template
_status	object
_status.<customAttribute1>	<customAttribute1Type>	Status custom attribute 1 value
_status.<customAttributeN>	<customAttributeNType>	Status custom attribute N value
_status._bootTime	string	A UTC date in the ISO-8601 format
_status._certificateStatus	string	Values:NOT_INSTALLED,BOOTSTRAP,PERMANENT
_status._connection	object
_status._connection._connected	boolean	If the device is connected to the MQTT the value is true, otherwise false	true
_status._connection._ipAddress	string	The IP Address of the connected device	2007-12-20
_status._connection._lastConnectedTime	string	The last time that the device was connected
_status._fwVersion	string
_status._hwVersion	string
_status._operational	object
_status._operational._message	string	Operational status message
_status._operational._status	string	Operational status of the device Values:OK,MINOR,MAJOR,CRITICAL
_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
_timezone	string	A java time zone supported by the java runtime environment	Europe/Oslo

Response body

object

_description

string

Device description

_timezone

string

A java time zone supported by the java runtime environment

_id

string

required

The id of the device

_ownerOrganization

object

required

uuid

required

A UUID formatted string

templateId

uuid

required

The id of a template that is configured in the settings service.

parentEntityId

string

The id of the parent entity (appears only for child entities)

templateName

string

required

The name of the referenced entity template

name

string

required

The caption of the referenced entity

_template

object

name

string

The name of the template

displayName

string

The display name of the template

parentTemplate

object

Base information about the template parent

string

The id of the 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)

_configuration

object

An object that holds the entity configuration attributes

Has additional fields

_status

object

_fwVersion

string

_hwVersion

string

_certificateStatus

string

NOT_INSTALLED BOOTSTRAP PERMANENT

_bootTime

date-time

A UTC date in the ISO-8601 format

_connection

object

_operational

object

_patient

object

uuid

required

A UUID formatted string

templateId

uuid

required

The id of a template that is configured in the settings service.

parentEntityId

string

The id of the parent entity (appears only for child entities)

templateName

string

required

The name of the referenced entity template

name

string

required

The caption of the referenced entity

_registrationCode

object

uuid

required

A UUID formatted string

templateId

uuid

required

The id of a template that is configured in the settings service.

parentEntityId

string

The id of the parent entity (appears only for child entities)

templateName

string

required

The name of the referenced entity template

name

string

required

The caption of the referenced entity

_creationTime

date-time

required

A UTC date-time in the ISO-8601 format

_lastModifiedTime

date-time

required

A UTC date-time in the ISO-8601 format

_caption

string

required

The caption of the command instance

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.com/device/v2/devices/id \
3
     --header 'accept: application/json'

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

application/json

400Bad Request

401Code : TOKEN_NOT_VALID, Details: []

403Code : ACCESS_DENIED, Details: []

404Code : DEVICE_NOT_FOUND, Details: [id]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []