|
| 1 | +# ActiveTimeApi |
| 2 | + |
| 3 | +All URIs are relative to *https://localhost/api/v5* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**getServerReport**](ActiveTimeApi.md#getServerReport) | **GET** /active-time | Server report |
| 8 | +[**getUserReport**](ActiveTimeApi.md#getUserReport) | **GET** /active-time/user/{uuid} | User report |
| 9 | + |
| 10 | + |
| 11 | +<a name="getServerReport"></a> |
| 12 | +# **getServerReport** |
| 13 | +> ServerReport getServerReport(details, accept, pretty) |
| 14 | +
|
| 15 | +Server report |
| 16 | + |
| 17 | +Generates a report for the whole server from week ago until now **Required permissions:** - **active-time.report.server** |
| 18 | + |
| 19 | +### Example |
| 20 | +```java |
| 21 | +// Import classes: |
| 22 | +//import io.swagger.client.ApiClient; |
| 23 | +//import io.swagger.client.ApiException; |
| 24 | +//import io.swagger.client.Configuration; |
| 25 | +//import io.swagger.client.auth.*; |
| 26 | +//import io.swagger.client.api.ActiveTimeApi; |
| 27 | + |
| 28 | +ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 29 | + |
| 30 | +// Configure API key authorization: ApiKeyHeader |
| 31 | +ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader"); |
| 32 | +ApiKeyHeader.setApiKey("YOUR API KEY"); |
| 33 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 34 | +//ApiKeyHeader.setApiKeyPrefix("Token"); |
| 35 | + |
| 36 | +// Configure API key authorization: ApiKeyQuery |
| 37 | +ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery"); |
| 38 | +ApiKeyQuery.setApiKey("YOUR API KEY"); |
| 39 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 40 | +//ApiKeyQuery.setApiKeyPrefix("Token"); |
| 41 | + |
| 42 | +ActiveTimeApi apiInstance = new ActiveTimeApi(); |
| 43 | +Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise |
| 44 | +String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests) |
| 45 | +Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) |
| 46 | +try { |
| 47 | + ServerReport result = apiInstance.getServerReport(details, accept, pretty); |
| 48 | + System.out.println(result); |
| 49 | +} catch (ApiException e) { |
| 50 | + System.err.println("Exception when calling ActiveTimeApi#getServerReport"); |
| 51 | + e.printStackTrace(); |
| 52 | +} |
| 53 | +``` |
| 54 | + |
| 55 | +### Parameters |
| 56 | + |
| 57 | +Name | Type | Description | Notes |
| 58 | +------------- | ------------- | ------------- | ------------- |
| 59 | + **details** | **Boolean**| Add to include additional details, omit or false otherwise | [optional] |
| 60 | + **accept** | **String**| Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
| 61 | + **pretty** | **Boolean**| Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
| 62 | + |
| 63 | +### Return type |
| 64 | + |
| 65 | +[**ServerReport**](ServerReport.md) |
| 66 | + |
| 67 | +### Authorization |
| 68 | + |
| 69 | +[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery) |
| 70 | + |
| 71 | +### HTTP request headers |
| 72 | + |
| 73 | + - **Content-Type**: application/json, application/xml |
| 74 | + - **Accept**: application/json, application/xml |
| 75 | + |
| 76 | +<a name="getUserReport"></a> |
| 77 | +# **getUserReport** |
| 78 | +> UserReport getUserReport(uuid, details, accept, pretty) |
| 79 | +
|
| 80 | +User report |
| 81 | + |
| 82 | +Generates a report for a specific user from a week ago until now **Required permissions:** - **active-time.report.user** |
| 83 | + |
| 84 | +### Example |
| 85 | +```java |
| 86 | +// Import classes: |
| 87 | +//import io.swagger.client.ApiClient; |
| 88 | +//import io.swagger.client.ApiException; |
| 89 | +//import io.swagger.client.Configuration; |
| 90 | +//import io.swagger.client.auth.*; |
| 91 | +//import io.swagger.client.api.ActiveTimeApi; |
| 92 | + |
| 93 | +ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 94 | + |
| 95 | +// Configure API key authorization: ApiKeyHeader |
| 96 | +ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader"); |
| 97 | +ApiKeyHeader.setApiKey("YOUR API KEY"); |
| 98 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 99 | +//ApiKeyHeader.setApiKeyPrefix("Token"); |
| 100 | + |
| 101 | +// Configure API key authorization: ApiKeyQuery |
| 102 | +ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery"); |
| 103 | +ApiKeyQuery.setApiKey("YOUR API KEY"); |
| 104 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 105 | +//ApiKeyQuery.setApiKeyPrefix("Token"); |
| 106 | + |
| 107 | +ActiveTimeApi apiInstance = new ActiveTimeApi(); |
| 108 | +String uuid = "uuid_example"; // String | |
| 109 | +Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise |
| 110 | +String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests) |
| 111 | +Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) |
| 112 | +try { |
| 113 | + UserReport result = apiInstance.getUserReport(uuid, details, accept, pretty); |
| 114 | + System.out.println(result); |
| 115 | +} catch (ApiException e) { |
| 116 | + System.err.println("Exception when calling ActiveTimeApi#getUserReport"); |
| 117 | + e.printStackTrace(); |
| 118 | +} |
| 119 | +``` |
| 120 | + |
| 121 | +### Parameters |
| 122 | + |
| 123 | +Name | Type | Description | Notes |
| 124 | +------------- | ------------- | ------------- | ------------- |
| 125 | + **uuid** | **String**| | |
| 126 | + **details** | **Boolean**| Add to include additional details, omit or false otherwise | [optional] |
| 127 | + **accept** | **String**| Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
| 128 | + **pretty** | **Boolean**| Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
| 129 | + |
| 130 | +### Return type |
| 131 | + |
| 132 | +[**UserReport**](UserReport.md) |
| 133 | + |
| 134 | +### Authorization |
| 135 | + |
| 136 | +[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery) |
| 137 | + |
| 138 | +### HTTP request headers |
| 139 | + |
| 140 | + - **Content-Type**: application/json, application/xml |
| 141 | + - **Accept**: application/json, application/xml |
| 142 | + |
0 commit comments