Files
few-line-engine/out/js/docs/LoggingApi.md

176 lines
4.8 KiB
Markdown

# LowCodeEngineApi.LoggingApi
All URIs are relative to *http://localhost:3000*
Method | HTTP request | Description
------------- | ------------- | -------------
[**loggerIdFindAllPost**](LoggingApi.md#loggerIdFindAllPost) | **POST** /logger/{id}/findAll | Find all logs
[**loggerIdFindPost**](LoggingApi.md#loggerIdFindPost) | **POST** /logger/{id}/find | Find logs for query
[**loggerIdTraceIdGet**](LoggingApi.md#loggerIdTraceIdGet) | **GET** /logger/{id}/{traceId} | Get log by trace ID
## loggerIdFindAllPost
> [Log] loggerIdFindAllPost(id, loggerIdFindAllPostRequest)
Find all logs
Find all logs for a project with filtering
### Example
```javascript
import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
let apiInstance = new LowCodeEngineApi.LoggingApi();
let id = "id_example"; // String | Project ID
let loggerIdFindAllPostRequest = new LowCodeEngineApi.LoggerIdFindAllPostRequest(); // LoggerIdFindAllPostRequest |
apiInstance.loggerIdFindAllPost(id, loggerIdFindAllPostRequest, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Project ID |
**loggerIdFindAllPostRequest** | [**LoggerIdFindAllPostRequest**](LoggerIdFindAllPostRequest.md)| |
### Return type
[**[Log]**](Log.md)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
## loggerIdFindPost
> [Log] loggerIdFindPost(id, loggerIdFindAllPostRequest)
Find logs for query
Find logs for a specific query with filtering
### Example
```javascript
import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: QueryGuard
let QueryGuard = defaultClient.authentications['QueryGuard'];
QueryGuard.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//QueryGuard.apiKeyPrefix = 'Token';
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
let apiInstance = new LowCodeEngineApi.LoggingApi();
let id = "id_example"; // String | Query ID
let loggerIdFindAllPostRequest = new LowCodeEngineApi.LoggerIdFindAllPostRequest(); // LoggerIdFindAllPostRequest |
apiInstance.loggerIdFindPost(id, loggerIdFindAllPostRequest, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Query ID |
**loggerIdFindAllPostRequest** | [**LoggerIdFindAllPostRequest**](LoggerIdFindAllPostRequest.md)| |
### Return type
[**[Log]**](Log.md)
### Authorization
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
## loggerIdTraceIdGet
> Log loggerIdTraceIdGet(id, traceId)
Get log by trace ID
Retrieve log entries by trace ID
### Example
```javascript
import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
let apiInstance = new LowCodeEngineApi.LoggingApi();
let id = "id_example"; // String | Log ID
let traceId = "traceId_example"; // String | Trace ID
apiInstance.loggerIdTraceIdGet(id, traceId, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Log ID |
**traceId** | **String**| Trace ID |
### Return type
[**Log**](Log.md)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json