Global

Type Definitions

APIKeysList

Type:

Object

Properties

Name	Type	Description
`id`	string	API Key Id
`name`	string	API Key Name
`rights`	Array.<string>	API Key Rights
`created_at`	timestamp	API Key Created At
`updated_at`	timestamp	API Key Updated At
`expires_at`	timestamp	API Key Expires At

Source: interfaces/doc-interface/docApp.interface.js, line 72

ApplicationList

Type:

Object

Properties

Name	Type	Description
`ids.application_id`	string	Application Id
`created_at`	timestamp	Application Created At
`updated_at`	timestamp	Application Updated At
`name`	string	The Name of the application
`description`	string	The Description of the application
`network_server_address`	string	Application Network Server Address
`application_server_address`	string	Application Application Server Address
`join_server_address`	string	Application Join Server Address

Source: interfaces/doc-interface/docApp.interface.js, line 35

CollabortorList

Type:

Object

Properties

Name	Type	Attributes	Description
`ids.organization_ids.organization_id`	string	<optional>	Organization Id
`ids.user_ids.user_id`	string	<optional>	User Id
`ids.user_ids.email`	string	<optional>	User Email
`rights`	Array.<string>		Collaborator Rights

Source: interfaces/doc-interface/docApp.interface.js, line 262

Config

Type:

Object

Properties

Name	Type	Attributes	Description
`API_KEY`	string		API Key
`IDENTITY_SERVER`	string		Identity Server
`NETWORK_SERVER`	string		Network Server
`APPLICATION_SERVER`	string		Application Server
`JOIN_SERVER`	string		Join Server
`TENANT_ID`	string	<optional>	TENANT_ID Tenant Id

Source: interfaces/doc-interface/docApp.interface.js, line 2

Input-CreateAPIKeyForApplication

Type:

Object

Properties

Name	Type	Attributes	Description
`name`	string		API Key Name
`rights`	Array.<string>		API Key Rights
`expires_at`	timestamp	<optional>	API Key Expires At

Source: interfaces/doc-interface/docApp.interface.js, line 219

Input-CreateAPIKeyForOrg

Type:

Object

Properties

Name	Type	Attributes	Description
`name`	string		API Key Name
`rights`	Array.<string>		API Key Rights
`expires_at`	timestamp	<optional>	API Key Expires At

Source: interfaces/doc-interface/docApp.interface.js, line 122

Input-CreateAPIKeyForUser

Type:

Object

Properties

Name	Type	Attributes	Description
`name`	string		API Key Name
`rights`	Array.<string>		API Key Rights
`expires_at`	timestamp	<optional>	API Key Expires At

Source: interfaces/doc-interface/docApp.interface.js, line 56

Input-CreateApplication

Type:

Object

Properties

Name	Type	Attributes	Description
`application_id`	string		Application Id
`name`	string	<optional>	Application Name
`description`	string	<optional>	Application Description

Source: interfaces/doc-interface/docApp.interface.js, line 11

Input-DownlinkQueue

Type:

Object

Properties

Name	Type	Description
`device_id`	string	The device ID of the end device.
`payload`	string \| byteArray	The payload of the downlink queue.
`payload_type`	string	The payload type of the downlink queue.
`port_no`	number	The port number of the downlink queue.
`request_type`	string	The request type of the downlink queue.
`confirmed_downlink`	boolean	The confirmed downlink of the downlink queue.

Source: interfaces/doc-interface/docEndDevice.interface.js, line 289

Input-GetAPIKeyInfo

Type:

Object

Properties

Name	Type	Description
`key_id`	string	API Key Id

Source: interfaces/doc-interface/docApp.interface.js, line 91

Input-GetAPIKeyList

Type:

Object

Properties

Name	Type	Attributes	Description
`order`	string	<optional>	Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. (e.g '-created_at')
`limit`	number	<optional>	Limit the number of results per page. (less than 1000)
`page`	number	<optional>	Page number for pagination. 0 is interpreted as 1.

Source: interfaces/doc-interface/docApp.interface.js, line 81

Input-GetApplicationList

Type:

Object

Properties

Name	Type	Attributes	Description
`order`	string	<optional>	Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. (e.g '-created_at')
`limit`	number	<optional>	Limit the number of results per page. (less than 1000)
`page`	number	<optional>	Page number for pagination. 0 is interpreted as 1.

Source: interfaces/doc-interface/docApp.interface.js, line 46

Input-GetCollaboratorInfo

Type:

Object

Properties

Name	Type	Description
`user_id`	string	User Id

Source: interfaces/doc-interface/docApp.interface.js, line 135

Input-GetCollaboratorInfoOfOrg

Type:

Object

Properties

Name	Type	Description
`organization_id`	string	Organization Id

Source: interfaces/doc-interface/docApp.interface.js, line 242

Input-GetCollaboratorInfoOfUser

Type:

Object

Properties

Name	Type	Description
`user_id`	string	User Id

Source: interfaces/doc-interface/docApp.interface.js, line 232

Input-GetCollabortorList

Type:

Object

Properties

Name	Type	Attributes	Description
`order`	string	<optional>	Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. (e.g '-id')
`limit`	number	<optional>	Limit the number of results per page. (less than 1000)
`page`	number	<optional>	Page number for pagination. 0 is interpreted as 1.

Source: interfaces/doc-interface/docApp.interface.js, line 269

Input-GetEndDeviceList

Type:

Object

Properties

Name	Type	Attributes	Description
`order`	string	<optional>	Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. (e.g '-created_at')
`limit`	number	<optional>	Limit the number of results per page. (less than 1000)
`page`	number	<optional>	Page number for pagination. 0 is interpreted as 1.

Source: interfaces/doc-interface/docEndDevice.interface.js, line 275

Input-GetGatewayList

Type:

Object

Properties

Name	Type	Attributes	Description
`order`	string	<optional>	Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order. (e.g '-created_at')
`limit`	number	<optional>	Limit the number of results per page. (less than 1000)
`page`	number	<optional>	Page number for pagination. 0 is interpreted as 1.

Source: interfaces/doc-interface/docApp.interface.js, line 283

Input-SetCollaborator

Type:

Object

Properties

Name	Type	Attributes	Description
`user_id`	string		User Id
`email`	string	<optional>	User Email Address
`rights`	Array.<string>		Collaborator Rights

Source: interfaces/doc-interface/docApp.interface.js, line 145

Input-SetCollaboratorOfOrg

Type:

Object

Properties

Name	Type	Description
`organization_id`	string	Organization Id
`rights`	Array.<string>	Collaborator Rights

Source: interfaces/doc-interface/docApp.interface.js, line 257

Input-SetCollaboratorOfUser

Type:

Object

Properties

Name	Type	Attributes	Description
`user_id`	string		User Id
`email`	string	<optional>	User Email Address
`rights`	Array.<string>		Collaborator Rights

Source: interfaces/doc-interface/docApp.interface.js, line 251

Input-SubscribeDownLinkEvent

Type:

Object

Properties

Name	Type	Description
`device_id`	string	The device ID of the end device.
`down_type`	string	The down type of the downlink queue.
`host`	string	The host of the downlink queue.
`port`	number	The port of the downlink queue.
`username`	string	The username of the downlink queue.
`callback_downlink_event`	callBackFunction	The callback downlink event of the downlink queue.

Source: interfaces/doc-interface/docEndDevice.interface.js, line 298

Input-SubscribeUpLinkEvent

Type:

Object

Properties

Name	Type	Description
`device_id`	string	The device ID of the end device.
`host`	string	The host of the uplink queue.
`port`	number	The port of the uplink queue.
`username`	string	The username of the uplink queue.
`callback_uplink_event`	callBackFunction	The callback uplink event of the uplink queue.

Source: interfaces/doc-interface/docEndDevice.interface.js, line 312

Input-UpdateAPIKeyOfApplication

Type:

Object

Properties

Name	Type	Attributes	Description
`api_key_id`	string		API Key Id
`api_key_name`	string	<optional>	API Key Name
`api_key_rights`	Array.<string>	<optional>	API Key Rights
`expires_at`	timestamp	<optional>	API Key Expires At

Source: interfaces/doc-interface/docApp.interface.js, line 225

Input-UpdateAPIKeyOfOrg

Type:

Object

Properties

Name	Type	Attributes	Description
`api_key_id`	string		API Key Id
`api_key_name`	string	<optional>	API Key Name
`api_key_rights`	Array.<string>	<optional>	API Key Rights
`expires_at`	timestamp	<optional>	API Key Expires At

Source: interfaces/doc-interface/docApp.interface.js, line 128

Input-UpdateAPIKeyOfUser

Type:

Object

Properties

Name	Type	Attributes	Description
`api_key_id`	string		API Key Id
`api_key_name`	string	<optional>	API Key Name
`api_key_rights`	Array.<string>	<optional>	API Key Rights
`expires_at`	timestamp	<optional>	API Key Expires At

Source: interfaces/doc-interface/docApp.interface.js, line 105

Input-UpdateApplication

Type:

Object

Properties

Name	Type	Attributes	Description
`name`	string	<optional>	Application Name
`description`	string	<optional>	Application Description
`attributes`	Object	<optional>	Application Attributes

Source: interfaces/doc-interface/docApp.interface.js, line 173

Output-CreateAPIKey

Type:

Object

Properties

Name	Type	Description
`id`	string	API Key Id
`key`	string	API Key
`name`	string	API Key Name
`rights`	Array.<string>	API Key Rights
`created_at`	timestamp	API Key Created At
`updated_at`	timestamp	API Key Updated At
`expires_at`	timestamp	API Key Expires At

Source: interfaces/doc-interface/docApp.interface.js, line 62

Output-CreateApplication

Type:

Object

Properties

Name	Type	Description
`ids.application_id`	string	Application Id
`created_at`	timestamp	Application Created At
`updated_at`	timestamp	Application Updated At
`deleted_at`	timestamp	Application Deleted At
`name`	string	Application Name
`description`	string	Application Description
`attributes`	string	Application Attributes
`contact_info`	Array.<string>	Application Contact Info
`administrative_contact.user_ids.user_id`	string	Application Administrative Contact
`technical_contact.user_ids.user_id`	string	Application Technical Contact
`network_server_address`	string	Application Network Server Address
`application_server_address`	string	Application Application Server Address
`join_server_address`	string	Application Join Server Address
`dev_eui_counter`	number	Application Dev EUI Counter
`end_device_limit`	null	Application End Device Limit

Source: interfaces/doc-interface/docApp.interface.js, line 17

Output-EmptyPayload

Type:

Object

Properties

Name	Type	Description
`Object`	Object	Empty Object

Source: interfaces/doc-interface/docApp.interface.js, line 151

Output-EmptyPayload

Type:

Object

Properties

Name	Type	Description
`Object`	Object	Empty Object

Source: interfaces/doc-interface/docEndDevice.interface.js, line 281

Output-GetAPIKeyInfo

Type:

Object

Properties

Name	Type	Description
`id`	string	API Key Id
`key`	string	API Key
`name`	string	API Key Name
`rights`	Array.<string>	API Key Rights
`created_at`	timestamp	API Key Created At
`updated_at`	timestamp	API Key Updated At
`expires_at`	timestamp	API Key Expires At

Source: interfaces/doc-interface/docApp.interface.js, line 95

Output-GetAPIKeyList

Type:

Object

Properties

Name	Type	Description
`api_keys`	Array.<APIKeysList>	API Key List

Source: interfaces/doc-interface/docApp.interface.js, line 87

Output-GetApplication

Type:

Object

Properties

Name	Type	Description
`ids.application_id`	string	Application Id
`created_at`	timestamp	Application Created At
`updated_at`	timestamp	Application Updated At
`deleted_at`	timestamp	Application Deleted At
`name`	string	Application Name
`description`	string	Application Description
`attributes`	string	Application Attributes
`contact_info`	Array.<string>	Application Contact Info
`administrative_contact.user_ids.user_id`	string	Application Administrative Contact
`technical_contact.user_ids.user_id`	string	Application Technical Contact
`network_server_address`	string	Application Network Server Address
`application_server_address`	string	Application Application Server Address
`join_server_address`	string	Application Join Server Address
`dev_eui_counter`	number	Application Dev EUI Counter
`end_device_limit`	null	Application End Device Limit

Source: interfaces/doc-interface/docApp.interface.js, line 155

Output-GetApplicationList

Type:

Object

Properties

Name	Type	Description
`applications`	Array.<ApplicationList>	Application List

Source: interfaces/doc-interface/docApp.interface.js, line 52

Output-GetApplicationRight

Type:

Object

Properties

Name	Type	Description
`rights`	Array.<string>	Application Rights

Source: interfaces/doc-interface/docApp.interface.js, line 215

Output-GetCollaboratorInfo

Type:

Object

Properties

Name	Type	Attributes	Description
`ids.user_ids.user_id`	string	<optional>	User Id
`ids.user_ids.email`	string	<optional>	User Email
`rights`	Array.<string>		Collaborator Rights

Source: interfaces/doc-interface/docApp.interface.js, line 139

Output-GetCollaboratorInfoOfOrg

Type:

Object

Properties

Name	Type	Attributes	Description
`ids.organization_ids.organization_id`	string	<optional>	Organization Id
`rights`	Array.<string>		Collaborator Rights

Source: interfaces/doc-interface/docApp.interface.js, line 246

Output-GetCollaboratorInfoOfUser

Type:

Object

Properties

Name	Type	Attributes	Description
`ids.user_ids.user_id`	string	<optional>	User Id
`ids.user_ids.email`	string	<optional>	User Email
`rights`	Array.<string>		Collaborator Rights

Source: interfaces/doc-interface/docApp.interface.js, line 236

Output-GetCollabortorList

Type:

Object

Properties

Name	Type	Description
`collaborators`	Array.<CollabortorList>	Collaborator List

Source: interfaces/doc-interface/docApp.interface.js, line 275

Output-GetGatewayRight

Type:

Object

Properties

Name	Type	Description
`rights`	Array.<string>	Gateway Rights

Source: interfaces/doc-interface/docApp.interface.js, line 279

Output-IssueDevEUI

Type:

Object

Properties

Name	Type	Description
`dev_eui`	string	The dev eui of the end device.

Source: interfaces/doc-interface/docEndDevice.interface.js, line 285

Output-SearchApplication

Type:

Object

Properties

Name	Type	Description
`ids.application_id`	string	Application Id
`created_at`	timestamp	Application Created At
`updated_at`	timestamp	Application Updated At
`deleted_at`	timestamp	Application Deleted At
`name`	string	Application Name
`description`	string	Application Description
`attributes`	string	Application Attributes
`contact_info`	Array.<string>	Application Contact Info
`administrative_contact.user_ids.user_id`	string	Application Administrative Contact
`technical_contact.user_ids.user_id`	string	Application Technical Contact
`network_server_address`	string	Application Network Server Address
`application_server_address`	string	Application Application Server Address
`join_server_address`	string	Application Join Server Address
`dev_eui_counter`	number	Application Dev EUI Counter
`end_device_limit`	null	Application End Device Limit

Source: interfaces/doc-interface/docApp.interface.js, line 197

Output-SubscribeDownLinkEvent

Type:

Object

Properties

Name	Type	Description
`client`	mqttClient	The mqtt client of the downlink event.
`topic`	string	The topic of the downlink event.

Source: interfaces/doc-interface/docEndDevice.interface.js, line 307

Output-SubscribeUpLinkEvent

Type:

Object

Properties

Name	Type	Description
`client`	mqttClient	The mqtt client of the uplink event.
`topic`	string	The topic of the uplink event.

Source: interfaces/doc-interface/docEndDevice.interface.js, line 320

Output-UpdateAPIKey

Type:

Object

Properties

Name	Type	Description
`id`	string	API Key Id
`key`	string	API Key
`name`	string	API Key Name
`rights`	Array.<string>	API Key Rights
`created_at`	timestamp	API Key Created At
`updated_at`	timestamp	API Key Updated At
`expires_at`	timestamp	API Key Expires At

Source: interfaces/doc-interface/docApp.interface.js, line 112

Output-UpdateApplication

Type:

Object

Properties

Name	Type	Description
`ids.application_id`	string	Application Id
`created_at`	timestamp	Application Created At
`updated_at`	timestamp	Application Updated At
`deleted_at`	timestamp	Application Deleted At
`name`	string	Application Name
`description`	string	Application Description
`attributes`	string	Application Attributes
`contact_info`	Array.<string>	Application Contact Info
`administrative_contact.user_ids.user_id`	string	Application Administrative Contact
`technical_contact.user_ids.user_id`	string	Application Technical Contact
`network_server_address`	string	Application Network Server Address
`application_server_address`	string	Application Application Server Address
`join_server_address`	string	Application Join Server Address
`dev_eui_counter`	number	Application Dev EUI Counter
`end_device_limit`	null	Application End Device Limit

Source: interfaces/doc-interface/docApp.interface.js, line 179