openapi: 3.2.0 info: title: /IOTCONNECT™ Device Wireless Device API description: 'Device REST API contains information of Device modules. Headers Needed Headers for all the API. Authorization    Bearer + access_token (Generated From api/v1.1/auth/login API) Content-Type    application/json' version: '2.1' security: - Bearer: [] tags: - name: WirelessDevice description: Wireless Device Api List paths: /api/v2.1/WirelessDevice: post: tags: - WirelessDevice summary: Add new wireless device description: 'IoT device is a smart device that supports internet connectivity. Through connectivity, established using IoT communication protocols, these devices can interact with other devices. Not only that, it grants remote access to a user for managing the device as per their needs. These devices can be anything from consumer devices, wearables, home appliances, industrial monitoring systems to security systems. Add wireless device using this API endpoint for easy integration with IoTConnect. The approach requires a device template, defining the features and type of wireless devices.' responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the device is created successfully and returns created device guid. content: application/json: schema: $ref: '#/components/schemas/DeviceCreateResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nThe device template doesn't exist, entity doesn't exist, the device is already exists, invalid tag, \nno attributes found in device template, parent device doesn't exist, parent and child device tags are same \nand invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/WirelessDeviceCreateRequest' description: Json object with wireless device details. operationId: postApiV21WirelessDevice x-operation-id-source: derived /api/v2.1/WirelessDevice/{uniqueId}: post: tags: - WirelessDevice summary: Get hex files of wireless thing parameters: - name: uniqueId in: path description: Device Unique Id required: true schema: type: string responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the Get hex files of wireless thing. content: application/json: schema: $ref: '#/components/schemas/RetriveHexFileResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nThe device template doesn't exist, entity doesn't exist, the device is already exists, invalid tag, \nno attributes found in device template, parent device doesn't exist, parent and child device tags are same \nand invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/RetriveHexFileRequest' description: Json object with hex file retrieval details. operationId: postApiV21WirelessDeviceByUniqueId x-operation-id-source: derived /api/v2.1/WirelessDevice/queued-messages: post: tags: - WirelessDevice summary: Get all the queued messages of wireless device description: Getting all the queued messages of a wireless device. responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the received all the queued messages of wireless device successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceQueuedMessagesResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. the device doesn''t exist and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceQueuedMessagesRequest' operationId: postApiV21WirelessDeviceQueuedMessages x-operation-id-source: derived /api/v2.1/WirelessDevice/{uniqueId}/queued-messages: delete: tags: - WirelessDevice summary: Remove messages from the queue description: To Remove messages from the queue. parameters: - name: uniqueId in: path description: Device Unique Id required: true schema: type: string - name: messageId in: query description: Optional message Id to delete a specific message from the queue schema: type: string responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the device queued messages deleted successfully. content: application/json: schema: $ref: '#/components/schemas/DeleteDeviceQueuedMessagesResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. the device doesn''t exist,an error occurred during delete a queued messages and invalid logged user or company.' operationId: deleteApiV21WirelessDeviceByUniqueIdQueuedMessages x-operation-id-source: derived /api/v2.1/WirelessDevice/{uniqueId}/command-status: get: tags: - WirelessDevice summary: Get device command status description: To get a device command status. parameters: - name: uniqueId in: path description: Device Unique Id required: true schema: type: string - name: messageId in: query description: Message Id to filter command status schema: type: string - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' schema: type: integer format: int32 - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: type: integer format: int32 - name: searchText in: query description: To search for specific texts in the list. schema: type: string responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the device command status list loaded. content: application/json: schema: $ref: '#/components/schemas/WirelessCommandStatusResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. the device doesn''t exist,an error occurred during delete a queued messages and invalid logged user or company.' operationId: getApiV21WirelessDeviceByUniqueIdCommandStatus x-operation-id-source: derived /api/v2.1/WirelessDevice/advance-log: post: tags: - WirelessDevice summary: Get all the Logs of wireless device description: Getting all the Logs of a wireless device. responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the received all the logs of wireless device successfully. content: application/json: schema: $ref: '#/components/schemas/WirelessLogsResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. the device doesn''t exist and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/WirelessLogsRequest' description: Json object with wireless log filter criteria operationId: postApiV21WirelessDeviceAdvanceLog x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawan/master-data: get: tags: - WirelessDevice summary: Get lorawan master data parameters: - name: type in: query description: "To filter the lorawan master data with type. To do that, Specify type to filter.\n

Eg: type: 1 = LoRawanRFRegion,2 = LorawanMacVersion,3 = Regionalparametersversion,\n 4 = DeviceSpecification,5 = DeviceManufacturee

" schema: type: integer format: int32 responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the device command status list loaded. content: application/json: schema: $ref: '#/components/schemas/LorawanMasterDataResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: '' operationId: getApiV21WirelessDeviceLorawanMasterData x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawan/profile/{profileGuid}: get: tags: - WirelessDevice summary: Get details of lorawan device profile parameters: - name: profileGuid in: path description: Device Profile Guid required: true schema: type: string format: uuid - name: deviceGuid in: query description: Optional Device Guid to get profile for a specific device schema: type: string format: uuid - name: isPublic in: query description: Set to true to get public profile details schema: type: boolean responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the device profile information received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceProfileResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. the device doesn''t exist and invalid logged user or company.' operationId: getApiV21WirelessDeviceLorawanProfileByProfileGuid x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawan/updateDeviceProfile: put: tags: - WirelessDevice summary: Update a lorawan device profile description: This API endpoint allows you to update LoRaWAN device profile details. responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the lorawan device profile is updated successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceProfileUpdateResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. The device doesn''t exist, the device is shared device, the entity doesn''t exist, the child device entity can not update and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceProfileUpdateRequest' description: Json object with device profile update details operationId: putApiV21WirelessDeviceLorawanUpdateDeviceProfile x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawan/deviceProfilelookup: get: tags: - WirelessDevice summary: Get lorawan device profile lookup description: This API endpoint provides you the lookup of all available device profile. responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the lorawan devie profile lookup received. content: application/json: schema: $ref: '#/components/schemas/DeviceProfileLookupResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. operationId: getApiV21WirelessDeviceLorawanDeviceProfilelookup x-operation-id-source: derived /api/v2.1/WirelessDevice/wireless/advance-log: delete: tags: - WirelessDevice summary: Delete Network interface for lorawan logs description: Delete network Interface responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the delete network configuration of wireless device successfully. content: application/json: schema: $ref: '#/components/schemas/DeleteWirelessLogsInterface' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. the device doesn''t exist and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteWirelessLogRequest' description: Json object with network interface deletion details operationId: deleteApiV21WirelessDeviceWirelessAdvanceLog x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawanGateway: post: tags: - WirelessDevice summary: Create LorawanGateway description: This API endpoint allows you to create LorawanGateway. responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the LorawanGateway added successfully. content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayCreateResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device doesn't exist, user doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayCreateRequest' description: Json object operationId: postApiV21WirelessDeviceLorawanGateway x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawanGateway/{lorawanGatewayGuid}: put: tags: - WirelessDevice summary: Update LorawanGateway description: This API endpoint allows you to update LorawanGateway. parameters: - name: lorawanGatewayGuid in: path description: lorawanGateway Guid required: true schema: type: string format: uuid responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the LorawanGateway updated successfully. content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayUpdateResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device doesn't exist, user doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayUpdateRequest' description: Json object operationId: putApiV21WirelessDeviceLorawanGatewayByLorawanGatewayGuid x-operation-id-source: derived delete: tags: - WirelessDevice summary: Delete LorawanGateway description: To delete a LorawanGateway, use this API endpoint. To do that, you need to send a lorawanGatewayGuid in request url that you want to delete. parameters: - name: lorawanGatewayGuid in: path description: LorawanGateway Guid required: true schema: type: string format: uuid responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the LorawanGateway deleted successfully. content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayDeleteResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '409': description: Indicates that the request could not be carried out because of one of the below or other conflicts on the server. operationId: deleteApiV21WirelessDeviceLorawanGatewayByLorawanGatewayGuid x-operation-id-source: derived get: tags: - WirelessDevice summary: Get single LorawanGateway description: This API endpoint provides you the LorawanGateway lookup. parameters: - name: lorawanGatewayGuid in: path description: LorawanGateway Guid required: true schema: type: string format: uuid responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that LorawanGateway information received successfully. content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV21WirelessDeviceLorawanGatewayByLorawanGatewayGuid x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawanGateway/{lorawanGatewayGuid}/status: put: tags: - WirelessDevice summary: Update LorawanGateway status description: This API endpoint allows you to update LorawanGateway status. For that, you need to send lorawanGatewayGuid in request url and updated status in the request body. parameters: - name: lorawanGatewayGuid in: path description: LorawanGateway Guid required: true schema: type: string format: uuid responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the LorawanGateway status updated successfully. content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayUpdateStatusResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The gateway doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayUpdateStatusRequest' description: Json object operationId: putApiV21WirelessDeviceLorawanGatewayByLorawanGatewayGuidStatus x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawanGateway/list: get: tags: - WirelessDevice summary: Get LorawanGateway List description: 'This API endpoint gives you the list of available LorawanGateway devices in your company. You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string.' parameters: - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' schema: type: integer format: int32 - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: type: integer format: int32 - name: sortBy in: query description: Sort by name and order, Eg.gatewayname asc schema: type: string - name: GatewayName in: query description: To fetch Gateway name of lorawan gateway schema: type: string - name: EUI in: query description: To fetch EUI of lorawan gateway schema: type: string - name: FrequencyBand in: query description: To fetch Frequency Band of lorawan gateway schema: type: string - name: LUR in: query description: To fetch LUR of lorawan gateway schema: type: string - name: Device in: query description: To fetch Lorawan device count schema: type: string - name: Status in: query description: To fetch lorawan gateway status schema: type: string responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the LorawanGateway list received successfully. content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayListResponse' '204': description: Indicates that the request has been successfully processed and no records found. '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. invalid logged user or company.' operationId: getApiV21WirelessDeviceLorawanGatewayList x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawan/manufactureLookup: get: tags: - WirelessDevice summary: Get lorawan manufacturer lookup description: This API endpoint provides you the lookup of all available lorawan manufacturers. responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the lorawan manufacturer lookup received successfully. content: application/json: schema: $ref: '#/components/schemas/LorawanLookupResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV21WirelessDeviceLorawanManufactureLookup x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawanGateway/lookup: post: tags: - WirelessDevice responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayLookupResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/LorawanGatewayLookupRequest' summary: Create api wireless device lorawan gateway lookup x-summary-source: derived operationId: postApiV21WirelessDeviceLorawanGatewayLookup x-operation-id-source: derived /api/v2.1/WirelessDevice/lorawanGateway/{lorawanGatewayGuid}/device: get: tags: - WirelessDevice summary: Get device list by LorawanGateway description: 'This API endpoint gives you the list of available devices associated with a specific LoRaWAN gateway. You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string.' parameters: - name: lorawanGatewayGuid in: path description: LorawanGateway Guid required: true schema: type: string format: uuid - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' schema: type: integer format: int32 - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: type: integer format: int32 - name: sortBy in: query description: Sort by name and order, Eg. uniqueId asc, uniqueId desc etc. schema: type: string - name: UniqueId in: query description: The unique id of device schema: type: string - name: Name in: query description: The display name of device schema: type: string - name: TemplateName in: query description: The device template name schema: type: string - name: EntityName in: query description: The entity name schema: type: string - name: Status in: query description: The status of device, Eg. active or inactive schema: type: string - name: Property in: query description: The custom property name of device schema: type: string - name: Value in: query description: The custom property value of device schema: type: string - name: Acquired in: query description: The device acquire status, Eg. acquired, released or inprogress schema: type: string - name: TemplateGuid in: query schema: type: string - name: EntityGuid in: query schema: type: string - name: isEdge in: query description: 'IsEdge : Pass value as true to get only edge devices' schema: type: boolean - name: isGateway in: query description: 'IsGateway : Pass value as true to get only gateway devices' schema: type: boolean - name: isLowBandwidth in: query description: 'IsLowBandwidth : Pass value as true to get only low bandwidth devices' schema: type: boolean - name: greenGrass in: query description: 'GreenGrass : Pass value as true to get only greengrass devices' schema: type: boolean - name: wireless in: query description: 'Wireless : Pass value as true to get only wireless devices' schema: type: boolean responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the device list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceListResponse' '204': description: Indicates that the request has been successfully processed and no records found. content: application/json: schema: $ref: '#/components/schemas/NoContentResult' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV21WirelessDeviceLorawanGatewayByLorawanGatewayGuidDevice x-operation-id-source: derived /api/v2.1/WirelessDevice/{deviceGuid}/send: post: tags: - WirelessDevice summary: Execute a command on wireless device description: Run a command on wireless device using this API endpoint. For that, you need to send deviceGuid in request url along with commandGuid and parameterValue in the request body. This command will be executed on a real device. Using this, you will be able to send data to devices from your UI. parameters: - name: deviceGuid in: path description: Wireless Device Guid required: true schema: type: string format: uuid responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the command sent to device successfully. content: application/json: schema: $ref: '#/components/schemas/CommandSendToDeviceResponse' '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. Device doesn''t exist, not allowed to send the device command as the device is shared device with read permission only, command doesn''t exist and invalid logged user or company' requestBody: content: application/json: schema: $ref: '#/components/schemas/CommandSendToDeviceRequest' description: Json object operationId: postApiV21WirelessDeviceByDeviceGuidSend x-operation-id-source: derived /api/v2.1/WirelessDevice/send: post: tags: - WirelessDevice summary: Execute a command on wireless devices description: 'Run a command on wireless devices using this API endpoint. For that, you need to send either entityGuid or deviceGuid list along with commandGuid and parameterValue in the request body. If you wish to send entityGuid, send value “1” in the applyTo parameter and entity guid in entityGuid parameter. This will send commands to all the devices available in the given entity. You can also send these commands to child devices of a given entity. For that, you need to send value “true” in isRecursive parameter. If you wish to send deviceGuid list, send value “2” in the applyTo parameter and list of device guids in devices parameter. This will send commands to selected devices only.' responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the command sent to devices successfully. content: application/json: schema: $ref: '#/components/schemas/CommandSendResponse' '403': description: Indicates that the user is not authorized to access this section. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. Device doesn''t exist and invalid logged user or company' requestBody: content: application/json: schema: $ref: '#/components/schemas/CommandSendRequest' description: Json object operationId: postApiV21WirelessDeviceSend x-operation-id-source: derived /api/v2.1/WirelessDevice/{templateGuid}/bytesCommand: post: tags: - WirelessDevice summary: Add wireless template byte command description: To add a device template byte command, use this API endpoint. parameters: - name: templateGuid in: path description: Device Template Guid required: true schema: type: string format: uuid responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the device template is updated successfully. content: application/json: schema: $ref: '#/components/schemas/BytesCommandAddResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '409': description: '' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddBytesCommandRequest' description: Template update detail in json object operationId: postApiV21WirelessDeviceByTemplateGuidBytesCommand x-operation-id-source: derived /api/v2.1/WirelessDevice/{templateGuid}/bytesCommand/{bytesCommandGuid}: put: tags: - WirelessDevice summary: Update wireless template byte command description: To update a device template byte command, use this API endpoint. parameters: - name: templateGuid in: path description: Device Template Guid required: true schema: type: string format: uuid - name: bytesCommandGuid in: path description: Bytes Command Guid required: true schema: type: string format: uuid responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the bytes command is updated successfully. content: application/json: schema: $ref: '#/components/schemas/BytesCommandAddResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '409': description: '' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBytesCommandRequest' description: Template update detail in json object operationId: putApiV21WirelessDeviceByTemplateGuidBytesCommandByBytesCommandGuid x-operation-id-source: derived /api/v2.1/WirelessDevice/{templateGuid}/bytesCommandList: get: tags: - WirelessDevice summary: Get bytes command list description: Get the list of available device templates of your company using this API endpoint. parameters: - name: templateGuid in: path required: true schema: type: string format: uuid - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: type: integer format: int32 - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' schema: type: integer format: int32 - name: sortBy in: query description: 'Sort by name and order, Eg: name asc' schema: type: string responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the bytes command list received successfully. content: application/json: schema: $ref: '#/components/schemas/BytesCommandListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. invalid logged user or company.' operationId: getApiV21WirelessDeviceByTemplateGuidBytesCommandList x-operation-id-source: derived /api/v2.1/WirelessDevice/bytesCommand/{bytesCommandGuid}: get: tags: - WirelessDevice summary: Get details of bytes command description: Getting details of a bytes command parameters: - name: bytesCommandGuid in: path description: Bytes Command Guid required: true schema: type: string format: uuid responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the bytes command information received successfully. content: application/json: schema: $ref: '#/components/schemas/BytesCommandDetailResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: Indicates that the request could not be carried out because of one of the below or other conflicts on the server. operationId: getApiV21WirelessDeviceBytesCommandByBytesCommandGuid x-operation-id-source: derived delete: tags: - WirelessDevice summary: Delete device template bytes command description: To delete a device template bytes command, use this API endpoint. To do that, you need to pass bytes command guid that you want to delete. parameters: - name: bytesCommandGuid in: path description: Bytes Command Guid required: true schema: type: string format: uuid responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the device template bytes command is deleted successfully. content: application/json: schema: $ref: '#/components/schemas/BytesCommandDeleteResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. and invalid logged user or company.' operationId: deleteApiV21WirelessDeviceBytesCommandByBytesCommandGuid x-operation-id-source: derived /api/v2.1/WirelessDevice/{bytesCommandGuid}/{bytesDefinitionGuid}: put: tags: - WirelessDevice summary: Update bytes command byte definition sequence description: This API endpoint lets you update bytes command byte definition sequence. parameters: - name: bytesCommandGuid in: path description: byte Command Guid required: true schema: type: string format: uuid - name: bytesDefinitionGuid in: path description: byte Definition Guid required: true schema: type: string format: uuid responses: '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that bytes command bytes definition sequence updated successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '204': description: Indicates that bytes command bytes definition doesn't exist or bytes command bytes definition sequence already updated. content: application/json: schema: $ref: '#/components/schemas/NoContentResult' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/BytesDefinitionUpdateSequenceRequest' description: Json object operationId: putApiV21WirelessDeviceByBytesCommandGuidByBytesDefinitionGuid x-operation-id-source: derived components: schemas: WirelessSocketModel: type: object properties: webSocketURL: type: - string - 'null' additionalProperties: false Properties: type: object properties: customDecoderGuid: type: - string - 'null' format: uuid lorawanGatewayGuid: type: - string - 'null' format: uuid lorawanManufacturerGuid: type: - string - 'null' format: uuid networkCoverage: type: - string - 'null' networkType: type: - string - 'null' additionalProperties: false DeleteWirelessLogsInterface: type: object properties: data: type: - object - 'null' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false UpdateLorawanDeviceProfile: type: object properties: hasDeviceExist: type: boolean wirelessId: type: - string - 'null' wirelessProfileId: type: - string - 'null' additionalProperties: false RetriveHexFileModel: type: object properties: fileName: type: - string - 'null' fileUrl: type: - string - 'null' additionalProperties: false CreateDevice: type: object properties: newid: type: - string - 'null' readOnly: true entityGuid: type: - string - 'null' readOnly: true ParentUniqueId: type: - string - 'null' uniqueId: type: - string - 'null' ggDeviceScript: type: - string - 'null' activeDeviceCount: type: integer format: int32 inActiveDeviceCount: type: integer format: int32 ggDeviceType: type: integer format: int32 fileSupport: type: boolean additionalProperties: false DeviceProfileLookup: type: object properties: guid: type: string format: uuid name: type: - string - 'null' isPublic: type: boolean lorawanRFRegionGuid: type: - string - 'null' format: uuid additionalProperties: false BytesCommandAddResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/BytesCommandAdd' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false WirelessDeviceCreateRequest: required: - deviceTemplateGuid - displayName - entityGuid - uniqueId type: object properties: uniqueId: maxLength: 200 minLength: 1 type: string description: "The uniqueId of device.\nNotes: Device uniqueId length is conditional based on device template auth type and device type \n1. Self or CA signed parent device uniqueId length should be less than or equal to 31 characters. \n2. Self or CA signed child device uniqueId length should be less than or equal to 31 characters. \n3. For TPM or key, all device uniqueId length should be less than or equal to 128 characters." deviceTemplateGuid: minLength: 1 type: string description: The deviceTemplateGuid of device. wirelessDeviceType: type: integer format: int32 lorawanDevice: $ref: '#/components/schemas/LorawanDeviceCreateRequest' sidewalkDevice: $ref: '#/components/schemas/SidewalkDeviceCreateRequest' displayName: maxLength: 100 minLength: 1 type: string description: The display name of device. note: maxLength: 500 type: - string - 'null' description: The note of the device. entityGuid: minLength: 1 type: string description: The entityGuid of device. additionalProperties: false LorawanGatewayUpdateResponse: type: object properties: data: $ref: '#/components/schemas/LorawanGatewayUpdate' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false WirelessCommandStatusResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/WirelessDeviceCommandStatus' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false LorawanGatewayCreateRequest: required: - euiCode - frequencyBand - gatewayName type: object properties: euiCode: minLength: 1 type: string frequencyBand: minLength: 1 type: string description: type: - string - 'null' gatewayName: minLength: 1 type: string additionalProperties: false DeviceProfileDetails: type: object properties: guid: type: string format: uuid name: type: - string - 'null' lorawanRFRegionGuid: type: string format: uuid rfRegionGuid: type: string format: uuid readOnly: true macVersionGuid: type: string format: uuid rpvGuid: type: string format: uuid maxEIRP: type: integer format: int32 isSupportClassB: type: boolean isSupportClassC: type: boolean supportClassB: $ref: '#/components/schemas/SupportClassB' supportClassC: $ref: '#/components/schemas/SupportClassC' supportJoin: type: boolean isOptionalSettings: type: boolean optionalSettings: $ref: '#/components/schemas/OptionalSettings' isExistLorawanProfile: type: boolean wirelessProfileId: type: - string - 'null' deviceCount: type: integer format: int32 devices: type: - string - 'null' isPublic: type: boolean additionalProperties: false DeviceQueuedMessagesRequest: type: object properties: uniqueId: type: - string - 'null' nextToken: type: - string - 'null' additionalProperties: false BytesCommandList: type: object properties: guid: type: string format: uuid command: type: - string - 'null' name: type: - string - 'null' additionalProperties: false DeviceProfile: type: object properties: deviceProfileGuid: type: - string - 'null' format: uuid isPublic: type: boolean macVersionGuid: type: - string - 'null' format: uuid maxEIRP: type: integer format: int32 rfRegionGuid: type: - string - 'null' format: uuid rpvGuid: type: - string - 'null' format: uuid supportJoin: type: boolean isSupportClassB: type: boolean isSupportClassC: type: boolean isOptionalSettings: type: boolean optionalSettings: $ref: '#/components/schemas/OptionalSettings' supportClassB: $ref: '#/components/schemas/SupportClassB' supportClassC: $ref: '#/components/schemas/SupportClassC' additionalProperties: false LorawanGatewayUpdateRequest: required: - frequencyBand - gatewayName type: object properties: frequencyBand: minLength: 1 type: string description: type: - string - 'null' gatewayName: minLength: 1 type: string additionalProperties: false DeviceSpecification: type: object properties: appEui: type: - string - 'null' appKey: type: - string - 'null' appSKey: type: - string - 'null' devAddr: type: - string - 'null' devEui: type: - string - 'null' deviceSpecificationGuid: type: - string - 'null' format: uuid fNwkSIntKey: type: - string - 'null' nwkKey: type: - string - 'null' nwkSEncKey: type: - string - 'null' nwkSKey: type: - string - 'null' sNwkSIntKey: type: - string - 'null' additionalProperties: false LorawanGatewayLookupRequest: type: object properties: frequencyBand: type: - string - 'null' entityGuid: type: - string - 'null' format: uuid templateGuid: type: - string - 'null' format: uuid deviceGuids: type: - array - 'null' items: type: string format: uuid includeChildEntity: type: boolean hasCommand: type: boolean additionalProperties: false LorawanGatewayUpdateStatusRequest: required: - isActive type: object properties: isActive: type: boolean description: LorawanGateway Active Status, 'true' for making LorawanGateway active and 'false' for making LorawanGateway inactive additionalProperties: false SuccessResponse: type: object properties: message: type: - string - 'null' status: type: integer format: int32 data: type: - array - 'null' items: type: - object - 'null' additionalProperties: false AddBytesCommandRequest: type: object properties: commandName: type: - string - 'null' description: CommandName command: type: - string - 'null' description: command isHex: type: boolean description: isHex bytesCommandParameter: type: - array - 'null' items: $ref: '#/components/schemas/TemplateByteCommandParameter' description: templateByteCommandParameter additionalProperties: false WirelessLogsResponse: type: object properties: data: $ref: '#/components/schemas/WirelessSocketModel' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false DeleteDeviceQueuedMessagesResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false DeviceProfileLookupResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceProfileLookup' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false DeviceQueuedMessagesResponse: type: object properties: data: $ref: '#/components/schemas/DeviceQueuedMessageIdList' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false BytesCommandAdd: type: object properties: newId: type: - string - 'null' additionalProperties: false WirelessLogsRequest: type: object properties: deviceGuid: type: string format: uuid additionalProperties: false DeviceProperty: type: object properties: guid: type: - string - 'null' readOnly: true deviceGuid: type: - string - 'null' readOnly: true value: type: - string - 'null' name: type: - string - 'null' propertyGuid: type: - string - 'null' readOnly: true options: type: - string - 'null' fieldType: type: - string - 'null' additionalProperties: false LorawanGatewayListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LorawanGatewayList' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false DeviceProfileResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceProfileDetails' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false ErrorModel: type: object properties: param: type: - string - 'null' message: type: - string - 'null' additionalProperties: false BytesCommandDetail: type: object properties: guid: type: string format: uuid deviceTemplateGuid: type: string format: uuid companyGuid: type: string format: uuid name: type: - string - 'null' command: type: - string - 'null' convertToHex: type: boolean createdDate: type: string format: date-time bytesCmdDefs: type: - object - 'null' additionalProperties: false NoContentResult: type: object properties: statusCode: type: integer format: int32 additionalProperties: false SupportClassB: type: object properties: classBTimeout: type: integer format: int32 pingSlotDR: type: integer format: int32 pingSlotFreq: type: integer format: int32 pingSlotPeriod: type: integer format: int32 additionalProperties: false CommandSendToDeviceRequest: required: - commandGuid - gatewayGuid type: object properties: commandGuid: minLength: 1 type: string description: Command Guid parameterValue: type: - string - 'null' description: Command Value commandText: type: - string - 'null' description: Command Text gatewayGuid: minLength: 1 type: string description: Gateway Guid fPort: type: - integer - 'null' format: int32 transmissionInterval: type: - integer - 'null' format: int32 downlinkMode: type: - string - 'null' downlinkFrequency: type: - integer - 'null' format: int64 transmissionMode: type: - integer - 'null' format: int32 isBytesCommand: type: boolean additionalProperties: false LorawanLookup: type: object properties: guid: type: - string - 'null' readOnly: true manufacturer: type: - string - 'null' displayName: type: - string - 'null' decoderName: type: - string - 'null' manufacturerId: type: - string - 'null' isCustom: type: boolean additionalProperties: false DeviceCreateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/CreateDevice' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false BytesCommandDeleteResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false WirelessDeviceCommandStatus: type: object properties: messageId: type: - string - 'null' deviceId: type: - string - 'null' cmdText: type: - string - 'null' cmdName: type: - string - 'null' statusText: type: - string - 'null' status: type: - string - 'null' additionalProperties: false LorawanMasterData: type: object properties: guid: type: string format: uuid type: type: integer format: int32 name: type: - string - 'null' displayName: type: - string - 'null' additionalProperties: false LorawanGatewayLookup: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' gatewayName: type: - string - 'null' frequencyBand: type: - string - 'null' additionalProperties: false LorawanGatewayUpdate: type: object properties: newid: type: - string - 'null' additionalProperties: false LorawanGatewayCreate: type: object properties: newid: type: - string - 'null' additionalProperties: false OutputparamListResponse: type: object properties: fName: type: - string - 'null' dName: type: - string - 'null' value: type: - object - 'null' additionalProperties: false DeleteWirelessLogRequest: type: object properties: deviceGuid: type: string format: uuid additionalProperties: false BytesCommandListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/BytesCommandList' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false CommandSendRequest: required: - commandGuid - gatewayGuid type: object properties: commandGuid: minLength: 1 type: string description: Template command Guid parameterValue: type: - string - 'null' description: Command Value commandText: type: - string - 'null' description: Command Text applyTo: type: integer description: 'Send 1 or 2. 1: for entity, 2: for device guid list' format: int32 devices: type: - array - 'null' items: type: string description: "Device guid list. \n Required if applyTo is 2" entityGuid: maxLength: 750 type: - string - 'null' description: "Entity Guid. \n Required if applyTo is 1" isRecursive: type: - boolean - 'null' description: 'Send true to include child entity devices. Required if applyTo is 1' isScheduledCommand: type: - boolean - 'null' description: 'Allows to schedule a command. true: To schedule a command, false: Doesn''t schedule and send command instantly.' scheduleUnit: type: - string - 'null' description: "scheduleUnit is mandatory when isScheduledCommand is true. Valid unit values are given below.\n hour : To send a command after every N hours.\n minute : To send a command after every N minutes.\n time : To send a command at specific time of the day." scheduleUnitValue: type: - string - 'null' description: "scheduleUnitValue is mandatory when isScheduledCommand is true. This requires value as per the selected scheduleUnit.\n When scheduleUnit is hour, set hours between 1 to 24. eg: 5(after every 5 hours command will be sent)\n When scheduleUnit is minute, set minutes between 5 to 60. eg: 30(after every 30 minutes command will be sent)\n When scheduleUnit is time, set time in HH:mm format. eg: 13:30(every day at 01:30 PM command will be sent)" isCpidOptional: type: boolean gatewayGuid: minLength: 1 type: string description: Gateway Guid fPort: type: - integer - 'null' format: int32 transmissionInterval: type: - integer - 'null' format: int32 downlinkMode: type: - string - 'null' downlinkFrequency: type: - integer - 'null' format: int64 transmissionMode: type: - integer - 'null' format: int32 isBytesCommand: type: boolean commandAsString: type: boolean dType: type: - string - 'null' additionalProperties: false CommandSendResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false RetriveHexFileRequest: type: object properties: wirelessType: type: - string - 'null' additionalProperties: false DeviceQueuedMessageIdList: type: object properties: messageIds: type: - array - 'null' items: type: string nextToken: type: - string - 'null' additionalProperties: false LorawanLookupResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LorawanLookup' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false BytesCommandDetailResponse: type: object properties: data: $ref: '#/components/schemas/BytesCommandDetail' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false LorawanGatewayLookupResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LorawanGatewayLookup' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false ErrorsResponse: type: object properties: status: type: integer format: int32 message: type: - string - 'null' error: type: - array - 'null' items: $ref: '#/components/schemas/ErrorModel' additionalProperties: false LorawanGatewayDeleteResponse: type: object properties: data: type: - object - 'null' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false DeviceProfileUpdateRequest: type: object properties: deviceGuid: type: string format: uuid profileGuid: type: string format: uuid isPublic: type: boolean additionalProperties: false LorawanGatewayList: type: object properties: guid: type: - string - 'null' readOnly: true euiCode: type: - string - 'null' gatewayName: type: - string - 'null' frequencyBand: type: - string - 'null' isActive: type: boolean entityName: type: - string - 'null' entityGuid: type: - string - 'null' readOnly: true lorawanDeviceCount: type: integer format: int32 lastConnection: type: - string - 'null' format: date-time additionalProperties: false LorawanGatewayCreateResponse: type: object properties: data: $ref: '#/components/schemas/LorawanGatewayCreate' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false SidewalkDeviceCreateRequest: type: object properties: customDecoderGuid: type: - string - 'null' additionalProperties: false TemplateByteCommandParameter: type: object properties: parameter: type: - string - 'null' description: Parameter dtName: type: - string - 'null' description: Datatype Name rg: type: - string - 'null' description: Range seqNo: type: integer description: Seq No format: int32 additionalProperties: false BytesDefinitionUpdateSequenceRequest: required: - seqNo type: object properties: seqNo: type: integer format: int32 additionalProperties: false CommandSendToDeviceResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false DeviceProfileUpdateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/UpdateLorawanDeviceProfile' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false UpdateBytesCommandParamter: type: object properties: guid: type: - string - 'null' format: uuid parameter: type: - string - 'null' description: Parameter dtName: type: - string - 'null' description: Datatype Name rg: type: - string - 'null' description: Range seqNo: type: integer description: Seq No format: int32 additionalProperties: false DeviceListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceList' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false LorawanGatewayResponse: type: object properties: data: $ref: '#/components/schemas/LorawanGateway' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false RetriveHexFileResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/RetriveHexFileModel' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false DeviceList: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' isConnected: type: boolean lastactivityDate: type: - string - 'null' format: date-time isActive: type: boolean firmwareupgradeGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true authType: type: integer format: int32 authTypeName: type: - string - 'null' messageVersion: type: - string - 'null' isSolutionTemplate: type: boolean solutionName: type: - string - 'null' deviceInfo: type: - object - 'null' deviceTemplateName: type: - string - 'null' reportingTo: type: - string - 'null' entityName: type: - string - 'null' IsAcquired: type: boolean readOnly: true childDeviceCount: type: integer format: int32 isType2Support: type: boolean isAllottedDevice: type: integer format: int32 readOnly: true allottedDevicePermission: type: - integer - 'null' format: int32 count: type: integer format: int32 properties: type: - array - 'null' items: $ref: '#/components/schemas/DeviceProperty' deviceStatus: type: - string - 'null' recentAttrValue: type: - object - 'null' lastConnection: type: - string - 'null' format: date-time lastCommunication: type: - string - 'null' format: date-time solutionGuid: type: - string - 'null' readOnly: true groupName: type: - string - 'null' productName: type: - string - 'null' parentCompanyGuid: type: - string - 'null' format: uuid certLocation: type: integer format: int32 Wireless: type: boolean wirelessDeviceType: type: integer format: int32 publicDevice: type: boolean certAvailable: type: boolean ggDeviceType: type: integer format: int32 cloudTemplateGuid: type: - string - 'null' readOnly: true createdBy: type: - string - 'null' createdDate: type: string format: date-time attrEnable: type: boolean deviceCapability: type: - integer - 'null' format: int32 info: type: - array - 'null' items: $ref: '#/components/schemas/OutputparamListResponse' additionalProperties: false LorawanMasterDataResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LorawanMasterData' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false UpdateBytesCommandRequest: type: object properties: commandName: type: - string - 'null' description: CommandName command: type: - string - 'null' description: command isHex: type: boolean description: isHex bytesCommandParameter: type: - array - 'null' items: $ref: '#/components/schemas/UpdateBytesCommandParamter' description: templateByteCommandParameter additionalProperties: false SupportClassC: type: object properties: classCTimeout: type: integer format: int32 additionalProperties: false OptionalSettings: type: object properties: factoryPresetFreqs: type: - string - 'null' maxDutyCycle: type: integer format: int32 rXDataRate2: type: integer format: int32 rXDelay1: type: integer format: int32 rXDROffset1: type: integer format: int32 rXFreq2: type: integer format: int32 supports32bitFCnt: type: boolean additionalProperties: false LorawanDeviceCreateRequest: type: object properties: deviceProfile: $ref: '#/components/schemas/DeviceProfile' deviceSpecification: $ref: '#/components/schemas/DeviceSpecification' properties: $ref: '#/components/schemas/Properties' additionalProperties: false LorawanGateway: type: object properties: guid: type: - string - 'null' readOnly: true euiCode: type: - string - 'null' gatewayName: type: - string - 'null' frequencyBand: type: - string - 'null' description: type: - string - 'null' isActive: type: boolean entityName: type: - string - 'null' entityGuid: type: - string - 'null' readOnly: true cpId: type: - string - 'null' additionalProperties: false LorawanGatewayUpdateStatusResponse: type: object properties: data: type: - object - 'null' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please enter JWT with Bearer into field name: Authorization in: header