All URIs are relative to /
Method | HTTP request | Description |
---|---|---|
getAppApiConfigurationColorconfig | GET /api/config/colors | Returns the configured color codes and names |
getAppApiConfigurationTimesheetconfig | GET /api/config/timesheet | Returns the timesheet configuration |
getAppApiStatusPing | GET /api/ping | A testing route for the API |
getAppApiStatusPlugin | GET /api/plugins | Returns information about installed Plugins |
getAppApiStatusVersion | GET /api/version | Returns information about the Kimai release |
map[string,string] getAppApiConfigurationColorconfig()
Returns the configured color codes and names
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP bearer authorization: bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()
->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Swagger\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getAppApiConfigurationColorconfig();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getAppApiConfigurationColorconfig: ', $e->getMessage(), PHP_EOL;
}
?>
This endpoint does not need any parameter.
map[string,string]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\TimesheetConfig getAppApiConfigurationTimesheetconfig()
Returns the timesheet configuration
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP bearer authorization: bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()
->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Swagger\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getAppApiConfigurationTimesheetconfig();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getAppApiConfigurationTimesheetconfig: ', $e->getMessage(), PHP_EOL;
}
?>
This endpoint does not need any parameter.
\Swagger\Client\Model\TimesheetConfig
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAppApiStatusPing()
A testing route for the API
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP bearer authorization: bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()
->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Swagger\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$apiInstance->getAppApiStatusPing();
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getAppApiStatusPing: ', $e->getMessage(), PHP_EOL;
}
?>
This endpoint does not need any parameter.
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Plugin[] getAppApiStatusPlugin()
Returns information about installed Plugins
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP bearer authorization: bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()
->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Swagger\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getAppApiStatusPlugin();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getAppApiStatusPlugin: ', $e->getMessage(), PHP_EOL;
}
?>
This endpoint does not need any parameter.
\Swagger\Client\Model\Plugin[]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Version getAppApiStatusVersion()
Returns information about the Kimai release
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP bearer authorization: bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()
->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Swagger\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getAppApiStatusVersion();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getAppApiStatusVersion: ', $e->getMessage(), PHP_EOL;
}
?>
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]