kimai_client_lib 1.0.0

JSON API for the Kimai time-tracking software. Read our [API documentation](https://www.kimai.org/documentation/rest-api.html) and download the [Open API definition](doc.json) to import into your API client.
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443

# \TaskApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_delete_task**](TaskApi.md#delete_delete_task) | **DELETE** /api/tasks/{id} | Delete an existing task record
[**get_get_task**](TaskApi.md#get_get_task) | **GET** /api/tasks/{id} | Returns one task
[**get_get_tasks**](TaskApi.md#get_get_tasks) | **GET** /api/tasks | Returns a collection of tasks
[**get_tasks_timesheets**](TaskApi.md#get_tasks_timesheets) | **GET** /api/tasks/{id}/timesheets | Returns a collection of timesheets for one task
[**patch_assign_task**](TaskApi.md#patch_assign_task) | **PATCH** /api/tasks/{id}/assign | Assign a task to the current user
[**patch_close_task**](TaskApi.md#patch_close_task) | **PATCH** /api/tasks/{id}/close | Close a task for the current user
[**patch_kimaiplugin_taskmanagement_api_task_meta**](TaskApi.md#patch_kimaiplugin_taskmanagement_api_task_meta) | **PATCH** /api/tasks/{id}/meta | Sets the value of a meta-field for an existing task
[**patch_log_task**](TaskApi.md#patch_log_task) | **PATCH** /api/tasks/{id}/log | Logs work for a task record
[**patch_patch_task**](TaskApi.md#patch_patch_task) | **PATCH** /api/tasks/{id} | Update an existing task
[**patch_reopen_task**](TaskApi.md#patch_reopen_task) | **PATCH** /api/tasks/{id}/reopen | Reopens a task for the current user
[**patch_start_task**](TaskApi.md#patch_start_task) | **PATCH** /api/tasks/{id}/start | Start working on a task
[**patch_stop_task**](TaskApi.md#patch_stop_task) | **PATCH** /api/tasks/{id}/stop | Stops a task record for the current user
[**patch_unassign_task**](TaskApi.md#patch_unassign_task) | **PATCH** /api/tasks/{id}/unassign | Unassign a task from the current user
[**post_post_task**](TaskApi.md#post_post_task) | **POST** /api/tasks | Creates a new Task



## delete_delete_task

> delete_delete_task(id)
Delete an existing task record

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task record ID to delete | [required] |

### Return type

 (empty response body)

### Authorization

[bearer](../README.md#bearer)

### 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)


## get_get_task

> models::Task get_get_task(id)
Returns one task

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task ID to fetch | [required] |

### Return type

[**models::Task**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### 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_get_tasks

> Vec<models::Task> get_get_tasks(search_term, customers_left_square_bracket_right_square_bracket, projects_left_square_bracket_right_square_bracket, activities_left_square_bracket_right_square_bracket, tags, users_left_square_bracket_right_square_bracket, teams_left_square_bracket_right_square_bracket, status_left_square_bracket_right_square_bracket, page_size, page, size, order, order_by)
Returns a collection of tasks

Attention: This is a GET request, you can pass in every field of the form as query parameter. Array values need to be written like this: /api/tasks?projects[]=1&projects[]=2

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**search_term** | Option<**String**> | Free search term |  |
**customers_left_square_bracket_right_square_bracket** | Option<**String**> | Customer IDs |  |
**projects_left_square_bracket_right_square_bracket** | Option<**String**> | Project IDs |  |
**activities_left_square_bracket_right_square_bracket** | Option<**String**> | Activity IDs |  |
**tags** | Option<**String**> | Comma separated list of tag names |  |
**users_left_square_bracket_right_square_bracket** | Option<**String**> | User IDs |  |
**teams_left_square_bracket_right_square_bracket** | Option<**String**> | Team IDs |  |
**status_left_square_bracket_right_square_bracket** | Option<**String**> | One or more status. Allowed values: pending, progress, closed (default: pending and progress) |  |
**page_size** | Option<**String**> | DEPRECATED: The amount of entries for each page (default: 50) |  |
**page** | Option<**String**> | The page to display, renders a 404 if not found (default: 1) |  |
**size** | Option<**String**> | The amount of entries for each page (default: 50) |  |
**order** | Option<**String**> | The result order. Allowed values: ASC, DESC (default: DESC) |  |
**order_by** | Option<**String**> | The field by which results will be ordered. Allowed values: title, customer, project, activity, description, status, user, begin, end, team (default: end) |  |

### Return type

[**Vec<models::Task>**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### 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_tasks_timesheets

> Vec<models::TimesheetCollectionExpanded> get_tasks_timesheets(id)
Returns a collection of timesheets for one task

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** |  | [required] |

### Return type

[**Vec<models::TimesheetCollectionExpanded>**](TimesheetCollectionExpanded.md)

### Authorization

[bearer](../README.md#bearer)

### 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)


## patch_assign_task

> models::Task patch_assign_task(id)
Assign a task to the current user

Assign a currently unassigned task to the current user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task ID to update | [required] |

### Return type

[**models::Task**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### 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)


## patch_close_task

> models::Task patch_close_task(id)
Close a task for the current user

Closes an assigned task for the current user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task ID to close | [required] |

### Return type

[**models::Task**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### 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)


## patch_kimaiplugin_taskmanagement_api_task_meta

> models::Task patch_kimaiplugin_taskmanagement_api_task_meta(id, patch_kimaiplugin_expenses_api_expense_meta_request)
Sets the value of a meta-field for an existing task

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task record ID to set the meta-field value for | [required] |
**patch_kimaiplugin_expenses_api_expense_meta_request** | Option<[**PatchKimaipluginExpensesApiExpenseMetaRequest**](PatchKimaipluginExpensesApiExpenseMetaRequest.md)> |  |  |

### Return type

[**models::Task**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## patch_log_task

> models::TimesheetExpanded patch_log_task(id, task_log_work_form)
Logs work for a task record

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task ID to log times for | [required] |
**task_log_work_form** | [**TaskLogWorkForm**](TaskLogWorkForm.md) |  | [required] |

### Return type

[**models::TimesheetExpanded**](TimesheetExpanded.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## patch_patch_task

> models::Task patch_patch_task(id, task_edit_form)
Update an existing task

Update an existing task, you can pass all or just a subset of all attributes

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task ID to update | [required] |
**task_edit_form** | [**TaskEditForm**](TaskEditForm.md) |  | [required] |

### Return type

[**models::Task**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## patch_reopen_task

> models::Task patch_reopen_task(id)
Reopens a task for the current user

Reopens an assigned task for the current user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task ID to reopen | [required] |

### Return type

[**models::Task**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### 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)


## patch_start_task

> models::Task patch_start_task(id)
Start working on a task

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task ID to start | [required] |

### Return type

[**models::Task**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### 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)


## patch_stop_task

> models::Task patch_stop_task(id)
Stops a task record for the current user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task ID to stop | [required] |

### Return type

[**models::Task**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### 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)


## patch_unassign_task

> models::Task patch_unassign_task(id)
Unassign a task from the current user

Unassign a currently assigned task from the current user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Task ID to update | [required] |

### Return type

[**models::Task**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### 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)


## post_post_task

> models::Task post_post_task(task_edit_form)
Creates a new Task

Creates a new task and returns it afterwards

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**task_edit_form** | [**TaskEditForm**](TaskEditForm.md) |  | [required] |

### Return type

[**models::Task**](Task.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **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)