{ "opencollection": "1.0.0", "info": { "name": "The Things Stack — Application Server AppAs UserBookmarkRegistry API", "version": "v3.36" }, "items": [ { "info": { "name": "UserBookmarkRegistry", "type": "folder" }, "items": [ { "info": { "name": "List the bookmarks for the given user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "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." }, { "name": "order", "value": "", "type": "query", "description": "Order the results by this field path.\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order." }, { "name": "deleted", "value": "", "type": "query", "description": "Only return recently deleted bookmarks." }, { "name": "entity_types", "value": "", "type": "query", "description": "Specifies that only bookmarks that reference the given entity type should be returned. If empty the filter is not\napplied." } ] }, "docs": "List the bookmarks for the given user." }, { "info": { "name": "Create a bookmark for the given user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." } ] }, "docs": "Create a bookmark for the given user." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/applications/:entity_ids.application_ids.application_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/applications/:entity_ids.device_ids.application_ids.application_id/devices/:entity_ids.device_ids.device_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.device_ids.application_ids.application_id", "value": "", "type": "path" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." }, { "info": { "name": "Delete a list of bookmarks of the given user.\nThis operation is atomic; either all bookmarks are deleted or none.\nBookmarks not found are skipped and no error is returned.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/batch", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete a list of bookmarks of the given user.\nThis operation is atomic; either all bookmarks are deleted or none.\nBookmarks not found are skipped and no error is returned." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/clients/:entity_ids.client_ids.client_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/gateways/:entity_ids.gateway_ids.gateway_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "path" }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/organizations/:entity_ids.organization_ids.organization_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "path", "description": "This ID shares namespace with user IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." }, { "info": { "name": "Delete the given user's bookmark.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_ids.user_id/bookmarks/users/:entity_ids.user_ids.user_id", "params": [ { "name": "user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "entity_ids.user_ids.user_id", "value": "", "type": "path", "description": "This ID shares namespace with organization IDs." }, { "name": "user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.client_ids.client_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.device_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.application_ids.application_id", "value": "", "type": "query" }, { "name": "entity_ids.device_ids.dev_eui", "value": "", "type": "query", "description": "The LoRaWAN DevEUI." }, { "name": "entity_ids.device_ids.join_eui", "value": "", "type": "query", "description": "The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices)." }, { "name": "entity_ids.device_ids.dev_addr", "value": "", "type": "query", "description": "The LoRaWAN DevAddr." }, { "name": "entity_ids.gateway_ids.gateway_id", "value": "", "type": "query" }, { "name": "entity_ids.gateway_ids.eui", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." }, { "name": "entity_ids.organization_ids.organization_id", "value": "", "type": "query", "description": "This ID shares namespace with user IDs." }, { "name": "entity_ids.user_ids.email", "value": "", "type": "query", "description": "Secondary identifier, which can only be used in specific requests." } ] }, "docs": "Delete the given user's bookmark." } ] } ], "bundled": true }