{"id":24221570,"url":"https://github.com/michdo93/openhab-rest-api-client-libraries","last_synced_at":"2026-03-07T11:03:20.122Z","repository":{"id":181159061,"uuid":"666327814","full_name":"Michdo93/openHAB-REST-API-Client-Libraries","owner":"Michdo93","description":"Client libraries to access the REST API of openHAB.","archived":false,"fork":false,"pushed_at":"2023-08-08T13:47:25.000Z","size":187,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-04T00:45:34.964Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Michdo93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-14T08:39:10.000Z","updated_at":"2023-07-14T08:39:10.000Z","dependencies_parsed_at":"2025-01-14T06:19:28.417Z","dependency_job_id":"98c437f3-cf23-4cd3-be14-3582b1988b0d","html_url":"https://github.com/Michdo93/openHAB-REST-API-Client-Libraries","commit_stats":null,"previous_names":["michdo93/openhab-rest-api-client-libraries"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Michdo93/openHAB-REST-API-Client-Libraries","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Michdo93%2FopenHAB-REST-API-Client-Libraries","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Michdo93%2FopenHAB-REST-API-Client-Libraries/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Michdo93%2FopenHAB-REST-API-Client-Libraries/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Michdo93%2FopenHAB-REST-API-Client-Libraries/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Michdo93","download_url":"https://codeload.github.com/Michdo93/openHAB-REST-API-Client-Libraries/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Michdo93%2FopenHAB-REST-API-Client-Libraries/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30212103,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T09:02:10.694Z","status":"ssl_error","status_checked_at":"2026-03-07T09:02:08.429Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-14T06:19:22.658Z","updated_at":"2026-03-07T11:03:20.088Z","avatar_url":"https://github.com/Michdo93.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# openHAB-REST-API-Client-Libraries\nClient libraries to access the REST API of openHAB.\n\n| REST endpoints | [Android-Java](https://github.com/Michdo93/android-java-openHAB-Client-Library) | [Android-Kotlin](https://github.com/Michdo93/android-kotlin-openHAB-Client-Library) | [C++](https://github.com/Michdo93/cpp-openHAB-Client-Library) | [C#](https://github.com/Michdo93/csharp-openHAB-Client-Library) | [Java](https://github.com/Michdo93/java-openHAB-Client-Library) | [JavaScript](https://github.com/Michdo93/JavaScript-openHAB-Client-Library) | [jQuery](https://github.com/Michdo93/jQuery-openHAB-Client-Library) | [NodeJS](https://github.com/Michdo93/NodeJS-openHAB-Client-Library) | [Python](https://github.com/Michdo93/Python-openHAB-Client-Library) |\n| -------------- | ------------ | -------------- | --- | -- | ---- | ---------- | ------ | ------ | ------ |\n| addons | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| audio | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| auth | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| bindings | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| channel-types | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| config-descriptions | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| discovery | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| events | :x: | :x: | :x: | :heavy_check_mark:| :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: |\n| habpanel | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| iconsets | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| inbox | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| items | :heavy_check_mark: | :x: | :x: | :heavy_check_mark:| :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: |\n| links | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| logging | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| module-types | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| persistence | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| profile-types | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| rules | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| services | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| sitemaps | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| systeminfo | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| templates | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| things | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| thing-types | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| transformations| :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| ui | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| uuid | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n| voice | :x: | :x: | :x: | :x:| :x: | :x: | :x: | :x: | :x: |\n\n## Endpoint description\n\n| Element | Details |\n|----------------|-------------------------------------------------------------------------------|\n| Endpoint | / |\n| HTTP Method | GET |\n| Tags | \"root\" |\n| Summary | \"Gets information about the runtime, the API version and links to resources.\" |\n| operationId | \"getRoot\" |\n| Responses | 200: \"OK\" |\n| Content | application/json |\n| Schema | $ref: \"#/components/schemas/RootBean\" |\n\n\n### addons\n\n| Endpoint | Method | Tags | Summary | Operation ID | Parameters | Responses |\n| ---------- | ------ | ------ | ------------------------------------------- | ------------ | ----------------------------------------------------------- | ----------------------------------- |\n| /addons | GET | addons | Get all add-ons. | getAddons | Accept-Language (header)\u003cbr\u003etype: string\u003cbr\u003eserviceId (query)\u003cbr\u003etype: string | 200 - OK\u003cbr\u003e404 - Service not found |\n| /addons/{addonId} | GET | addons | Get add-on with given ID | getAddonById | Accept-Language (header)\u003cbr\u003etype: string\u003cbr\u003eaddonId (path)\u003cbr\u003etype: string\u003cbr\u003eserviceId (query)\u003cbr\u003etype: string | 200 - OK\u003cbr\u003e404 - Not found |\n| /addons/services | GET | addons | Get all add-on types | getAddonTypes | Accept-Language (header)\u003cbr\u003etype: string | 200 - OK |\n| /addons/types | GET | addons | Get add-on services | getAddonServices | Accept-Language (header)\u003cbr\u003etype: string\u003cbr\u003eserviceId (query)\u003cbr\u003etype: string | 200 - OK\u003cbr\u003e404 - Service not found |\n| /addons/{addonId}/install | POST | addons | Installs the add-on with the given ID. | installAddonById | addonId (path)\u003cbr\u003etype: string\u003cbr\u003erequired: true\u003cbr\u003eserviceId (query)\u003cbr\u003etype: string | 200 - OK\u003cbr\u003e404 - Not found |\n| /addons/url/{url}/install | POST | addons | Installs the add-on from the given URL. | installAddonFromURL | url (path)\u003cbr\u003etype: string\u003cbr\u003erequired: true | 200 - OK\u003cbr\u003e400 - The given URL is malformed or not valid. |\n| /addons/{addonId}/uninstall | POST | addons | Uninstalls the add-on with the given ID. | uninstallAddon | addonId (path)\u003cbr\u003etype: string\u003cbr\u003erequired: true | 200 - OK\u003cbr\u003e404 - Not found |\n\n### audio\n\n| Endpoint | Method | Tags | Summary | Operation ID | Responses |\n| ------------------ | ------ | ----- | ----------------------------------------------------- | ------------------- | ----------------------------------------------------------------------------------------------- |\n| /audio/defaultsink | GET | audio | Get the default sink if defined or the first available sink. | getAudioDefaultSink | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: $ref: \"#/components/schemas/AudioSinkDTO\"\u003cbr\u003e404 - Sink not found |\n| /audio/defaultsource | GET | audio | Get the default source if defined or the first available source. | getAudioDefaultSource | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: $ref: \"#/components/schemas/AudioSourceDTO\"\u003cbr\u003e404 - Source not found |\n| /audio/sinks | GET | audio | Get the list of all sinks. | getAudioSinks | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: type: array\u003cbr\u003eitems: $ref: \"#/components/schemas/AudioSinkDTO\" |\n| /audio/sources | GET | audio | Get the list of all sources.| getAudioSources | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: type: array\u003cbr\u003eitems: $ref: \"#/components/schemas/AudioSourceDTO\" |\n\n\n### auth\n\n| Endpoint | Method | Tags | Summary | Operation ID | Request Body | Responses |\n| ------------ | ------ | ----- | ------------------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------- |\n| /auth/logout | POST | auth | Delete the session associated with a refresh token. | deleteSession | content: application/x-www-form-urlencoded\u003cbr\u003eschema: type: object\u003cbr\u003eproperties: refresh_token: type: string id: type: string | 200 - OK\u003cbr\u003e401 - User is not authenticated\u003cbr\u003e404 - User or refresh token not found |\n| /auth/apitokens | GET | auth | List the API tokens associated to the authenticated user. | getApiTokens | 200 - OK\u003cbr\u003e401 - User is not authenticated\u003cbr\u003e404 - User not found |\n| /auth/sessions | GET | auth | List the sessions associated to the authenticated user. | getSessionsForCurrentUser | 200 - OK\u003cbr\u003e401 - User is not authenticated\u003cbr\u003e404 - User not found |\n| /auth/token | POST | auth | Get access and refresh tokens. | getOAuthToken | useCookie (query)\u003cbr\u003etype: boolean | grant_type (form data)\u003cbr\u003etype: string\u003cbr\u003ecode (form data)\u003cbr\u003etype: string\u003cbr\u003eredirect_uri (form data)\u003cbr\u003etype: string\u003cbr\u003eclient_id (form data)\u003cbr\u003etype: string\u003cbr\u003erefresh_token (form data)\u003cbr\u003etype: string\u003cbr\u003ecode_verifier (form data)\u003cbr\u003etype: string | 200 - OK\u003cbr\u003e400 - Invalid request parameters |\n| /auth/apitokens/{name} | DELETE | auth | Revoke a specified API token associated to the authenticated user. | removeApiToken | name (path)\u003cbr\u003etype: string | 200 - OK\u003cbr\u003e401 - User is not authenticated\u003cbr\u003e404 - User or API token not found |\n\n### bindings\n\n| Endpoint | Method | Tags | Summary | Operation ID | Parameters | Responses |\n| ----------------------- | ------ | -------- | ----------------- | ------------ | ----------------------------------------- | ------------------------- |\n| /bindings | GET | bindings | Get all bindings. | getBindings | Accept-Language (header)\u003cbr\u003etype: string | 200 - OK\u003cbr\u003esecurity: oauth2 |\n| /bindings/{bindingId}/config | GET | bindings | Get binding configuration for given binding ID. | getBindingConfiguration | bindingId (path)\u003cbr\u003etype: string | 200 - OK\u003cbr\u003e404 - Binding does not exist\u003cbr\u003e500 - Configuration can not be read due to internal error\u003cbr\u003esecurity: oauth2 |\n| /bindings/{bindingId}/config | PUT | bindings | Updates a binding configuration for given binding ID and returns the old configuration. | updateBindingConfiguration | bindingId (path)\u003cbr\u003etype: string\u003cbr\u003erequestBody (content)\u003cbr\u003etype: object\u003cbr\u003eadditionalProperties (type)\u003cbr\u003etype: object | 200 - OK\u003cbr\u003e204 - No old configuration\u003cbr\u003e404 - Binding does not exist\u003cbr\u003e500 - Configuration can not be updated due to internal error\u003cbr\u003esecurity: oauth2 |\n\n### channel-types\n\n| Endpoint | Method | Tags | Summary | Operation ID | Parameters | Responses |\n| -------------------------------------- | ------ | --------------- | ------------------------------------------ | ----------------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------- |\n| /channel-types | GET | channel-types | Gets all available channel types. | getChannelTypes | Accept-Language (header)\u003cbr\u003etype: string\u003cbr\u003eprefixes (query)\u003cbr\u003etype: string\u003cbr\u003edescription: filter UIDs by prefix (multiple comma-separated prefixes allowed, for example: 'system,mqtt') | 200 - OK\u003cbr\u003esecurity: oauth2 |\n| /channel-types/{channelTypeUID} | GET | channel-types | Gets channel type by UID. | getChannelTypeByUID | channelTypeUID (path)\u003cbr\u003etype: string\u003cbr\u003edescription: channelTypeUID\u003cbr\u003erequired: true\u003cbr\u003eAccept-Language (header)\u003cbr\u003etype: string | 200 - Channel type with provided channelTypeUID does not exist.\u003cbr\u003e404 - No content\u003cbr\u003esecurity: oauth2 |\n| /channel-types/{channelTypeUID}/linkableItemTypes | GET | channel-types | Gets the item types the given trigger channel type UID can be linked to. | getLinkableItemTypesByChannelTypeUID | channelTypeUID (path)\u003cbr\u003etype: string\u003cbr\u003edescription: channelTypeUID\u003cbr\u003erequired: true\u003cbr\u003eAccept-Language (header)\u003cbr\u003etype: string | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: uniqueItems: true\u003cbr\u003etype: array\u003cbr\u003eitems: type: string\u003cbr\u003e204 - No content: channel type has no linkable items or is no trigger channel.\u003cbr\u003e404 - Given channel type UID not found. | security: oauth2 |\n\n### config-descriptions\n\n| Endpoint | Method | Tags | Summary | Operation ID | Parameters | Responses |\n| ------------------------ | ------ | --------------------- | -------------------------------------- | --------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |\n| /config-descriptions | GET | config-descriptions | Gets all available config descriptions. | getConfigDescriptions | Accept-Language (header)\u003cbr\u003etype: string\u003cbr\u003escheme (query)\u003cbr\u003etype: string\u003cbr\u003edescription: scheme filter | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: type: array\u003cbr\u003eitems: $ref: \"#/components/schemas/ConfigDescriptionDTO\" | security: oauth2 |\n| /config-descriptions/{uri} | GET | config-descriptions | Gets a config description by URI. | getConfigDescriptionByURI | Accept-Language (header)\u003cbr\u003etype: string\u003cbr\u003euri (path)\u003cbr\u003etype: string\u003cbr\u003edescription: uri | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: $ref: \"#/components/schemas/ConfigDescriptionDTO\"\u003cbr\u003e400 - Invalid URI syntax\u003cbr\u003e404 - Not found | security: oauth2 |\n\n### discovery\n\n| Endpoint | Method | Tags | Summary | Operation ID | Responses |\n| ---------------------------------- | ------ | -------------- | ------------------------------------------ | --------------------------------- | --------------------------------------------------------------------------------------- |\n| /discovery | GET | discovery | Gets all bindings that support discovery. | getBindingsWithDiscoverySupport | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: uniqueItems: true\u003cbr\u003etype: array\u003cbr\u003eitems: type: string | security: oauth2 |\n| /discovery/bindings/{bindingId}/scan | POST | discovery | Starts asynchronous discovery process for a binding and returns the timeout in seconds of the discovery operation. | scan | 200 - OK\u003cbr\u003econtent: text/plain\u003cbr\u003eschema: type: integer\u003cbr\u003eformat: int32\u003cbr\u003esecurity: oauth2 |\n\n### events\n\n| Endpoint | HTTP Method | Tags | Summary | operationId | Parameters | Responses |\n|--------------------------|-------------|-------------|-------------------------------------------------------------|----------------------------------|---------------------------|-------------------------|\n| /events | GET | \"events\" | Get all events. | \"getEvents\" | | 200: \"OK\" |\n| | | | | | 400: \"Topic is empty or contains invalid characters\" |\n| /events/states | GET | \"events\" | Initiates a new item state tracker connection | \"initNewStateTacker\" | | 200: \"OK\" |\n| /events/states/{connectionId} | POST | \"events\" | Changes the list of items a SSE connection will receive state updates to. | \"updateItemListForStateUpdates\" | name: \"connectionId\" | 200: \"OK\" |\n| | | | | | in: \"path\" | 404: \"Unknown connectionId\" |\n\n\n### habpanel\n\n| Endpoint | Method | Tags | Summary | Operation ID | Parameters | Responses |\n| --------------------------------------- | ------ | --------- | ------------------------------ | -------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |\n| /habpanel/gallery/{galleryName}/widgets | GET | habpanel | Gets the list of widget gallery items. | getGalleryWidgetList | 0: name: \"galleryName\"\u003cbr\u003e in: \"path\"\u003cbr\u003e description: \"gallery name e.g. 'community'\"\u003cbr\u003e required: true\u003cbr\u003e schema: type: \"string\" | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: type: \"array\"\u003cbr\u003eitems: $ref: \"#/components/schemas/GalleryWidgetsListItem\"\u003cbr\u003e404 - Unknown gallery |\n| /habpanel/gallery/{galleryName}/widgets/{id} | GET | habpanel | Gets the details about a widget gallery item. | getGalleryWidgetsItem | 0: name: \"galleryName\"\u003cbr\u003e in: \"path\"\u003cbr\u003e description: \"gallery name e.g. 'community'\"\u003cbr\u003e required: true\u003cbr\u003e schema: type: \"string\"\u003cbr\u003e 1: name: \"id\"\u003cbr\u003e in: \"path\"\u003cbr\u003e description: \"id within the gallery\"\u003cbr\u003e required: true\u003cbr\u003e schema: type: \"string\" | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: $ref: \"#/components/schemas/GalleryItem\"\u003cbr\u003e404 - Unknown gallery or gallery item not found |\n\n\n### iconsets\n\n| Endpoint | Method | Tags | Summary | Operation ID | Parameters | Responses |\n| ----------- | ------ | --------- | ----------------- | ------------ | --------------------------------------------------------------- | ------------------------------------------------------------ |\n| /iconsets | GET | iconsets | Gets all icon sets | getIconSets | 0: name: \"Accept-Language\"\u003cbr\u003e in: \"header\"\u003cbr\u003e description: \"language\"\u003cbr\u003e schema: type: \"string\" | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: type: \"array\"\u003cbr\u003eitems: $ref: \"#/components/schemas/IconSet\" |\n\n\n### inbox\n\n| Endpoint | Method | Tags | Summary | Operation ID | Parameters | Request Body | Responses | Security |\n| ----------------------- | ------ | ------ | ----------------------------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------- |\n| /inbox/{thingUID}/approve | POST | inbox | Approves the discovery result by adding the thing to the registry. | approveInboxItemById | Accept-Language: header\u003cbr\u003ethingUID: path (required)\u003cbr\u003enewThingId: query (description: new thing ID) | content: text/plain\u003cbr\u003eschema: type: string | 200 - OK\u003cbr\u003e400 - Invalid new thing ID\u003cbr\u003e404 - Thing unable to be approved\u003cbr\u003e409 - No binding found that supports this thing | oauth2: admin |\n| /inbox/{thingUID} | DELETE | inbox | Removes the discovery result from the inbox. | removeItemFromInbox | thingUID: path (required) | 200 - OK\u003cbr\u003e404 - Discovery result not found in the inbox | oauth2: admin |\n| /inbox | GET | inbox | Get all discovered things. | getDiscoveredInboxItems | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: array items: $ref: \"#/components/schemas/DiscoveryResultDTO\" | oauth2: admin |\n| /inbox/{thingUID}/ignore | POST | inbox | Flags a discovery result as ignored. | flagInboxItemAsIgnored | 200 - OK | oauth2: admin |\n| /inbox/{thingUID}/unignore | POST | inbox | Removes ignore flag from a discovery result. | removeIgnoreFlagOnInboxItem | 200 - OK | oauth2: admin |\n\n### items\n\n| Endpoint | HTTP Method | Tags | Summary | operationId | Parameters | Request Body | Responses | Security |\n|-----------------------------------|-------------|----------|--------------------------------------------|------------------------|------------------------------------------|----------------|-------------------------------------------------------------------|-------------------|\n| /items/{itemName}/members/{memberItemName} | PUT | \"items\" | \"Adds a new member to a group item.\" | \"addMemberToGroupItem\" | name: \"itemName\" | | 200: \"OK\" | oauth2: \"admin\" |\n| | | | | | in: \"path\" | | 404: \"Item or member item not found or item is not of type group item.\" | |\n| | | | | | description: \"item name\" | | 405: \"Member item is not editable.\" | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"memberItemName\" | | | |\n| | | | | | in: \"path\" | | | |\n| | | | | | description: \"member item name\" | | | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| /items/{itemname}/metadata/{namespace} | PUT | \"items\" | \"Adds metadata to an item.\" | \"addMetadataToItem\" | name: \"itemname\" | | 200: \"OK\" | oauth2: \"admin\" |\n| | | | | | in: \"path\" | | 201: \"Created\" | |\n| | | | | | description: \"item name\" | | 400: \"Metadata value empty.\" | |\n| | | | | | required: true | | 404: \"Item not found.\" | |\n| | | | | | schema: type: \"string\" | | 405: \"Metadata not editable.\" | |\n| | | | | | | | | |\n| | | | | | name: \"namespace\" | | | |\n| | | | | | in: \"path\" | | | |\n| | | | | | description: \"namespace\" | | | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| /items/{itemname}/tags/{tag} | PUT | \"items\" | \"Adds a tag to an item.\" | \"addTagToItem\" | name: \"itemname\" | | 200: \"OK\" | oauth2: \"admin\" |\n| | | | | | in: \"path\" | | | |\n| | | | | | description: \"item name\" | | | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | 404: \"Item not found.\" | |\n| | | | | | | | 405: \"Item not editable.\" | |\n| /items/{itemname}/tags/{tag} | DELETE | \"items\" | \"Removes a tag from an item.\" | \"removeTagFromItem\" | name: \"itemname\" | | 200: \"OK\" | oauth2: \"admin\" |\n| | | | | | in: \"path\" | | | |\n| | | | | | description: \"item name\" | | | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | 404: \"Item not found.\" | |\n| | | | | | | | 405: \"Item not editable.\" | |\n| /items/{itemname} | GET | \"items\" | \"Gets a single item.\" | \"getItemByName\" | name: \"Accept-Language\" | | 200: \"OK\" | |\n| | | | | | description: \"language\" | | 404: \"Item not found\" | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"metadata\" | | | |\n| | | | | | description: \"metadata selector - a comma separated list or a regular expression (suppressed if no value given)\" | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"recursive\" | | | |\n| | | | | | description: \"get member items if the item is a group item\" | | | |\n| | | | | | schema: type: \"boolean\" | default: true | | |\n| | | | | | | | | |\n| | | | | | name: \"itemname\" | | | |\n| | | | | | description: \"item name\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | 200: \"OK\" | |\n| | | | | | content: application/json | schema: {...} | | |\n| | | | | | | | | |\n| | | | | | 404: \"Item not found.\" | | | |\n| | | | | | | | | |\n| | | | | | 405: \"Item not editable.\" | | | |\n| | | | | | | | | |\n| | | | | | oauth2: | | | |\n| | | | | | 0: \"admin\" | | | |\n| | | | | | | | | |\n| /items | GET | \"items\" | \"Get all available items.\" | \"getItems\" | name: \"Accept-Language\" | | 200: \"OK\" | |\n| | | | | | description: \"language\" | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"type\" | | | |\n| | | | | | description: \"item type filter\" | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"tags\" | | | |\n| | | | | | description: \"item tag filter\" | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"metadata\" | | | |\n| | | | | | description: \"metadata selector - a comma separated list or a regular expression (suppressed if no value given)\" | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"recursive\" | | | |\n| | | | | | description: \"get member items recursively\" | | | |\n| | | | | | schema: type: \"boolean\" | default: false | | |\n| | | | | | | | | |\n| | | | | | name: \"fields\" | | | |\n| | | | | | description: \"limit output to the given fields (comma separated)\" | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | 200: \"OK\" | content: application/json | schema: {...} | |\n| | | | | | | | | |\n| /items | PUT | \"items\" | \"Adds a list of items to the registry or updates the existing items.\" | | name: \"Accept-Language\" | | 200: \"OK\" | oauth2: \"admin\" |\n| | | | | | description: \"language\" | | 400: \"Payload is invalid.\" | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"itemname\" | | | |\n| | | | | | description: \"item name\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | 200: \"OK\" | content: */* | schema: {...} | |\n| | | | | | | | | |\n| | | | | | 405: \"Item not editable.\" | | | |\n| | | | | | | | | |\n| | | | | | oauth2: | | | |\n| | | | | | 0: \"admin\" | | | |\n| | | | | | | | | |\n| /items/{itemname}/state | GET | \"items\" | \"Gets the state of an item.\" | \"getItemState_1\" | name: \"itemname\" | | 200: \"OK\" | |\n| | | | | | in: \"path\" | | content: text/plain | |\n| | | | | | description: \"item name\" | | schema: {...} | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | | | | |\n| | | | | | | | 404: \"Item not found\" | |\n| /items/{itemname}/state | PUT | \"items\" | \"Updates the state of an item.\" | \"updateItemState\" | name: \"Accept-Language\" | | 202: \"Accepted\" | |\n| | | | | | in: \"header\" | | 400: \"Item state null\" | |\n| | | | | | description: \"language\" | | 404: \"Item not found\" | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"itemname\" | | | |\n| | | | | | description: \"item name\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | | | 404: \"Item not found\" | |\n| /items/{itemName}/semantic/{semanticClass} | GET | \"items\" | \"Gets the item which defines the requested semantics of an item.\" | \"getSemanticItem\" | name: \"Accept-Language\" | | 200: \"OK\" | |\n| | | | | | in: \"header\" | | 404: \"Item not found\" | |\n| | | | | | description: \"language\" | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"itemName\" | | | |\n| | | | | | description: \"item name\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"semanticClass\" | | | |\n| | | | | | description: \"semantic class\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| /items/metadata/purge | POST | \"items\" | \"Remove unused/orphaned metadata.\" | \"purgeDatabase\" | | | 200: \"OK\" | oauth2: |\n| | | | | | | | | 0: \"admin\" |\n\n### links\n\n| Endpoint | HTTP Method | Tags | Summary | operationId | Parameters | Request Body | Responses | Security |\n|-----------------------------------|-------------|----------|------------------------------------------------|--------------------|------------------------------------------|----------------|-------------------------------|---------------|\n| /links | GET | \"links\" | \"Gets all available links.\" | \"getItemLinks\" | name: \"channelUID\" | | 200: \"OK\" | oauth2: |\n| | | | | | in: \"query\" | | | 0: \"admin\" |\n| | | | | | description: \"filter by channel UID\" | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"itemName\" | | | |\n| | | | | | description: \"filter by item name\" | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | | | 200: \"OK\" | |\n| | | | | | content: application/json | schema: {...} | | |\n| | | | | | | | | |\n| | | | | | oauth2: | | | |\n| | | | | | 0: \"admin\" | | | |\n| /links/{itemName}/{channelUID} | GET | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| | | |\n| /links/{itemName}/{channelUID} | GET | \"links\" | \"Retrieves an individual link.\" | \"getItemLink\" | name: \"itemName\" | | 200: \"OK\" | oauth2: 0: \"admin\" |\n| | | | | | in: \"path\" | | 404: \"Content does not match the path\" | |\n| | | | | | description: \"item name\" | | | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"channelUID\" | | | |\n| | | | | | description: \"channel UID\" | | | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | | | | |\n| | | | | | | | | |\n| | | | | | | | | |\n| /links/{itemName}/{channelUID} | PUT | \"links\" | \"Links an item to a channel.\" | \"linkItemToChannel\" | name: \"itemName\" | | 200: \"OK\" | oauth2: 0: \"admin\" |\n| | | | | | in: \"path\" | | 400: \"Content does not match the path\" | |\n| | | | | | description: \"item name\" | | 405: \"Link is not editable\" | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"channelUID\" | | | |\n| | | | | | description: \"channel UID\" | | | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| /links/{itemName}/{channelUID} | DELETE | \"links\" | \"Unlinks an item from a channel.\" | \"unlinkItemFromChannel\" | name: \"itemName\" | | 200: \"OK\" | oauth2: 0: \"admin\" |\n| | | | | | in: \"path\" | | 404: \"Link not found.\" | |\n| | | | | | description: \"itemName\" | | 405: \"Link not editable.\" | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | name: \"channelUID\" | | | |\n| | | | | | description: \"channelUID\" | | | |\n| | | | | | required: true | | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | | | | |\n| | | | | | | | | |\n| /links/purge | POST | \"links\" | \"Remove unused/orphaned links.\" | \"purgeDatabase_1\" | | | 200: \"OK\" | oauth2: 0: \"admin\" |\n| /links/{object} | DELETE | \"links\" | \"Delete all links that refer to an item or thing.\" | \"removeAllLinksForObject\" | | | 200: \"OK\" | oauth2: 0: \"admin\" |\n\n### logging\n\n| Endpoint | Method | Tags | Summary | Operation ID | Parameters | Responses |\n| --------------------- | ------ | -------- | ---------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------ |\n| /logging/{loggerName} | GET | logging | Get a single logger. | getLogger | - name: loggerName\u003cbr\u003e in: path\u003cbr\u003e description: logger name\u003cbr\u003e required: true\u003cbr\u003e schema: {type: \"string\"} | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: $ref: \"#/components/schemas/LoggerInfo\"\u003cbr\u003esecurity: 0: oauth2: 0: \"admin\" |\n| /logging/{loggerName} | PUT | logging | Modify or add logger | putLogger | - name: loggerName\u003cbr\u003e in: path\u003cbr\u003e description: logger name\u003cbr\u003e required: true\u003cbr\u003e schema: {type: \"string\"} | 200 - OK\u003cbr\u003e400 - Payload is invalid.\u003cbr\u003esecurity: 0: oauth2: 0: \"admin\" |\n| /logging/{loggerName} | DELETE | logging | Remove a single logger. | removeLogger | - name: loggerName\u003cbr\u003e in: path\u003cbr\u003e description: logger name\u003cbr\u003e required: true\u003cbr\u003e schema: {type: \"string\"} | 200 - OK\u003cbr\u003esecurity: 0: oauth2: 0: \"admin\" |\n| /logging | GET | logging | Get all loggers | getLogger_1 | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: $ref: \"#/components/schemas/LoggerBean\"\u003cbr\u003esecurity: 0: oauth2: 0: \"admin\" |\n\n\n### module-types\n\n| Endpoint | Method | Tags | Summary | Operation ID | Parameters | Responses |\n| --------------------- | ------ | ------------- | ---------------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |\n| /module-types | GET | module-types | Get all available module types. | getModuleTypes | 0: name: \"Accept-Language\"\u003cbr\u003e in: \"header\"\u003cbr\u003e description: \"language\"\u003cbr\u003e schema: type: \"string\"\u003cbr\u003e 1: name: \"tags\"\u003cbr\u003e in: \"query\"\u003cbr\u003e description: \"tags for filtering\"\u003cbr\u003e schema: type: \"string\"\u003cbr\u003e 2: name: \"type\"\u003cbr\u003e in: \"query\"\u003cbr\u003e description: \"filtering by action, condition or trigger\"\u003cbr\u003e schema: type: \"string\" | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: type: \"array\"\u003cbr\u003eitems: $ref: \"#/components/schemas/ModuleTypeDTO\" |\n| /module-types/{moduleTypeUID} | GET | module-types | Gets a module type corresponding to the given UID. | getModuleTypeById | 0: name: \"Accept-Language\"\u003cbr\u003e in: \"header\"\u003cbr\u003e description: \"language\"\u003cbr\u003e schema: type: \"string\"\u003cbr\u003e 1: name: \"moduleTypeUID\"\u003cbr\u003e in: \"path\"\u003cbr\u003e description: \"moduleTypeUID\"\u003cbr\u003e required: true\u003cbr\u003e schema: type: \"string\" | 200 - OK\u003cbr\u003econtent: application/json\u003cbr\u003eschema: {…}\u003cbr\u003e404 - Module Type corresponding to the given UID does not found. |\n\n\n### persistence\n\n| Endpoint | HTTP Method | Tags | Summary | operationId | Parameters | Request Body | Responses | Security |\n|---------------------------------------|-------------|---------------|---------------------------------------------------------|----------------------------------------|--------------------------------------------------|-------------------------------|--------------------------------------|-----------------------|\n| /persistence/items/{itemname} | GET | \"persistence\" | \"Gets item persistence data from the persistence service.\" | \"getItemDataFromPersistenceService\" | name: \"serviceId\" | | 200: \"OK\" | |\n| | | | | | in: \"query\" | | | |\n| | | | | | description: \"Id of the persistence service. If not provided the default service will be used\" | required: false | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | name: \"itemname\" | | | |\n| | | | | | description: \"The item name\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | name: \"starttime\" | in: \"query\" | | |\n| | | | | | description: \"Start time of the data to return. Will default to 1 day before endtime. [yyyy-MM-dd'T'HH:mm:ss.SSSZ]\" | required: false | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | name: \"endtime\" | in: \"query\" | | |\n| | | | | | description: \"End time of the data to return. Will default to current time. [yyyy-MM-dd'T'HH:mm:ss.SSSZ]\" | required: false | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | name: \"page\" | in: \"query\" | | |\n| | | | | | description: \"Page number of data to return. This parameter will enable paging.\" | required: false | | |\n| | | | | | schema: type: \"integer\" | format: \"int32\" | | |\n| | | | | | name: \"pagelength\" | in: \"query\" | | |\n| | | | | | description: \"The length of each page.\" | required: false | | |\n| | | | | | schema: type: \"integer\" | format: \"int32\" | | |\n| | | | | | name: \"boundary\" | in: \"query\" | | |\n| | | | | | description: \"Gets one value before and after the requested period.\" | required: false | | |\n| | | | | | schema: type: \"boolean\" | | | |\n| | | | | | | | | |\n| | | | | | | | 200: \"OK\" | |\n| | | | | | content: application/json | schema: {...} | | |\n| /persistence/items/{itemname} | PUT | \"persistence\" | \"Stores item persistence data into the persistence service.\" | \"storeItemDataInPersistenceService\" | name: \"serviceId\" | | 200: \"OK\" | oauth2: 0: \"admin\" |\n| | | | | | in: \"query\" | | | |\n| | | | | | description: \"Id of the persistence service. If not provided the default service will be used\" | required: false | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | name: \"itemname\" | | | |\n| | | | | | description: \"The item name.\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | name: \"time\" | in: \"query\" | | |\n| | | | | | description: \"Time of the data to be stored. Will default to current time. [yyyy-MM-dd'T'HH:mm:ss.SSSZ]\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | name: \"state\" | in: \"query\" | | |\n| | | | | | description: \"The state to store.\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | | | 200: \"OK\" | |\n| /persistence/items/{itemname} | DELETE | \"persistence\" | \"Deletes item persistence data from a specific persistence service in a given time range.\" | \"deleteItemFromPersistenceService\" | name: \"serviceId\" | | 200: \"OK\" | oauth2: 0: \"admin\" |\n| | | | | | in: \"query\" | | | |\n| | | | | | description: \"Id of the persistence service.\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | name: \"itemname\" | | | |\n| | | | | | description: \"The item name.\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | name: \"starttime\" | in: \"query\" | | |\n| | | | | | description: \"Start of the time range to be deleted. [yyyy-MM-dd'T'HH:mm:ss.SSSZ]\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | name: \"endtime\" | in: \"query\" | | |\n| | | | | | description: \"End of the time range to be deleted. [yyyy-MM-dd'T'HH:mm:ss.SSSZ]\" | required: true | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | | | 200: \"OK\" | |\n| | | | | | content: application/json | schema: {...} | | |\n| | | | | | | | 400: \"Invalid filter parameters\" | |\n| | | | | | | | 404: \"Unknown persistence service\" | |\n| /persistence | GET | \"persistence\" | \"Gets a list of persistence services.\" | \"getPersistenceServices\" | name: \"Accept-Language\" | | 200: \"OK\" | |\n| | | | | | in: \"header\" | | | |\n| | | | | | description: \"language\" | required: false | | |\n| | | | | | schema: type: \"string\" | | | |\n| | | | | | | | | |\n| | | | | | | | 200: \"OK\" | |\n| | | | | | content: application/json | schema: {...} | | |\n| | | | | | | | | ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichdo93%2Fopenhab-rest-api-client-libraries","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichdo93%2Fopenhab-rest-api-client-libraries","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichdo93%2Fopenhab-rest-api-client-libraries/lists"}