# QueriesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**queryCreatePost**](#querycreatepost) | **POST** /query/create | Create query|
|[**queryDeleteIdDelete**](#querydeleteiddelete) | **DELETE** /query/delete/{id} | Delete query|
|[**queryRunIdPost**](#queryrunidpost) | **POST** /query/run/{id} | Run query|
|[**queryUpdateIdPost**](#queryupdateidpost) | **POST** /query/update/{id} | Update query|

# **queryCreatePost**
> Query queryCreatePost(queryCreatePostRequest)

Create a new query in the project

### Example

```typescript
import {
    QueriesApi,
    Configuration,
    QueryCreatePostRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new QueriesApi(configuration);

let queryCreatePostRequest: QueryCreatePostRequest; //

const { status, data } = await apiInstance.queryCreatePost(
    queryCreatePostRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **queryCreatePostRequest** | **QueryCreatePostRequest**|  | |


### Return type

**Query**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Query created successfully |  -  |
|**401** | Unauthorized |  -  |

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

# **queryDeleteIdDelete**
> queryDeleteIdDelete()

Delete an existing query

### Example

```typescript
import {
    QueriesApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new QueriesApi(configuration);

let id: string; //Query ID (default to undefined)

const { status, data } = await apiInstance.queryDeleteIdDelete(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | Query ID | defaults to undefined|


### Return type

void (empty response body)

### Authorization

[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Query deleted successfully |  -  |
|**401** | Unauthorized |  -  |
|**403** | Query access required |  -  |
|**404** | Query not found |  -  |

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

# **queryRunIdPost**
> object queryRunIdPost(body)

Execute a query with provided data

### Example

```typescript
import {
    QueriesApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new QueriesApi(configuration);

let id: string; //Query ID (default to undefined)
let body: object; //
let xTraceId: string; //Trace ID for logging (optional) (default to undefined)

const { status, data } = await apiInstance.queryRunIdPost(
    id,
    body,
    xTraceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **object**|  | |
| **id** | [**string**] | Query ID | defaults to undefined|
| **xTraceId** | [**string**] | Trace ID for logging | (optional) defaults to undefined|


### Return type

**object**

### Authorization

[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Query executed successfully |  -  |
|**302** | Redirect response |  -  |
|**401** | Unauthorized |  -  |
|**403** | Query access required |  -  |
|**404** | Query not found |  -  |
|**500** | Internal Server Error |  -  |

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

# **queryUpdateIdPost**
> Query queryUpdateIdPost(queryUpdateIdPostRequest)

Update an existing query

### Example

```typescript
import {
    QueriesApi,
    Configuration,
    QueryUpdateIdPostRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new QueriesApi(configuration);

let id: string; //Query ID (default to undefined)
let queryUpdateIdPostRequest: QueryUpdateIdPostRequest; //

const { status, data } = await apiInstance.queryUpdateIdPost(
    id,
    queryUpdateIdPostRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **queryUpdateIdPostRequest** | **QueryUpdateIdPostRequest**|  | |
| **id** | [**string**] | Query ID | defaults to undefined|


### Return type

**Query**

### Authorization

[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Query updated successfully |  -  |
|**401** | Unauthorized |  -  |
|**403** | Query access required |  -  |
|**404** | Query not found |  -  |

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