{ "opencollection": "1.0.0", "info": { "name": "The Things Stack — Application Server AppAs EndDeviceRegistry API", "version": "v3.36" }, "items": [ { "info": { "name": "EndDeviceRegistry", "type": "folder" }, "items": [ { "info": { "name": "List end devices in the given application.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/devices", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the end device fields that should be returned.\nSee the API reference for which fields can be returned by the different services." }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. 0 is interpreted as 1." } ] }, "docs": "List end devices in the given application.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Count end devices in the given application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:application_ids.application_id/devices/count", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "Count end devices in the given application." }, { "info": { "name": "List end devices in the given application.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/applications/:application_ids.application_id/devices/filter", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "List end devices in the given application.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller." }, { "info": { "name": "Delete the end device with the given IDs.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/applications/:application_ids.application_id/devices/:device_id", "params": [ { "name": "application_ids.application_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" }, { "name": "dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." } ] }, "docs": "Before deleting an end device it first needs to be deleted from the\nNsEndDeviceRegistry, the AsEndDeviceRegistry and the JsEndDeviceRegistry.\nIn addition, if the device claimed on a Join Server, it also needs to be\nunclaimed via the DeviceClaimingServer so it can be claimed in the future.\nThis is NOT done automatically." }, { "info": { "name": "Create a new end device within an application.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/applications/:end_device.ids.application_ids.application_id/devices", "params": [ { "name": "end_device.ids.application_ids.application_id", "value": "", "type": "path" } ] }, "docs": "After registering an end device, it also needs to be registered in\nthe NsEndDeviceRegistry that is exposed by the Network Server,\nthe AsEndDeviceRegistry that is exposed by the Application Server,\nand the JsEndDeviceRegistry that is exposed by the Join Server." }, { "info": { "name": "Update the end device, changing the fields specified by the field mask to the provided values.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/applications/:end_device.ids.application_ids.application_id/devices/:end_device.ids.device_id", "params": [ { "name": "end_device.ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device.ids.device_id", "value": "", "type": "path" } ] }, "docs": "Update the end device, changing the fields specified by the field mask to the provided values." }, { "info": { "name": "Get the end device with the given identifiers, selecting the fields specified\nin the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/applications/:end_device_ids.application_ids.application_id/devices/:end_device_ids.device_id", "params": [ { "name": "end_device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "end_device_ids.device_id", "value": "", "type": "path" }, { "name": "end_device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "end_device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "end_device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "field_mask", "value": "", "type": "query", "description": "The names of the end device fields that should be returned.\nSee the API reference for which fields can be returned by the different services." } ] }, "docs": "Get the end device with the given identifiers, selecting the fields specified\nin the field mask.\nMore or less fields may be returned, depending on the rights of the caller." } ] } ], "bundled": true }