hab-rs-api-client 0.3.0

Bindings for openHAB REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

# \TagsApi

All URIs are relative to */rest*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_semantic_tag**](TagsApi.md#create_semantic_tag) | **POST** /tags | Creates a new semantic tag and adds it to the registry.
[**get_semantic_tag_and_sub_tags**](TagsApi.md#get_semantic_tag_and_sub_tags) | **GET** /tags/{tagId} | Gets a semantic tag and its sub tags.
[**get_semantic_tags**](TagsApi.md#get_semantic_tags) | **GET** /tags | Get all available semantic tags.
[**remove_semantic_tag**](TagsApi.md#remove_semantic_tag) | **DELETE** /tags/{tagId} | Removes a semantic tag and its sub tags from the registry.
[**update_semantic_tag**](TagsApi.md#update_semantic_tag) | **PUT** /tags/{tagId} | Updates a semantic tag.



## create_semantic_tag

> serde_json::Value create_semantic_tag(body, accept_language)
Creates a new semantic tag and adds it to the registry.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **serde_json::Value** | tag data | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_semantic_tag_and_sub_tags

> Vec<serde_json::Value> get_semantic_tag_and_sub_tags(tag_id, accept_language)
Gets a semantic tag and its sub tags.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tag_id** | **String** | tag id | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**Vec<serde_json::Value>**](serde_json::Value.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_semantic_tags

> Vec<serde_json::Value> get_semantic_tags(accept_language)
Get all available semantic tags.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**accept_language** | Option<**String**> | language |  |

### Return type

[**Vec<serde_json::Value>**](serde_json::Value.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## remove_semantic_tag

> remove_semantic_tag(tag_id, accept_language)
Removes a semantic tag and its sub tags from the registry.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tag_id** | **String** | tag id | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

 (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_semantic_tag

> serde_json::Value update_semantic_tag(tag_id, body, accept_language)
Updates a semantic tag.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tag_id** | **String** | tag id | [required] |
**body** | **serde_json::Value** | tag data | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[basicAuth](../README.md#basicAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)