# CommandsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**commandCreatePost**](#commandcreatepost) | **POST** /command/create | Create command|
|[**commandDeleteIdDelete**](#commanddeleteiddelete) | **DELETE** /command/delete/{id} | Delete command|
|[**commandRunIdPost**](#commandrunidpost) | **POST** /command/run/{id} | Run command|
|[**commandUpdateIdPost**](#commandupdateidpost) | **POST** /command/update/{id} | Update command|

# **commandCreatePost**
> Query commandCreatePost(commandCreatePostRequest)

Create a new command in the project

### Example

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

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

let commandCreatePostRequest: CommandCreatePostRequest; //

const { status, data } = await apiInstance.commandCreatePost(
    commandCreatePostRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **commandCreatePostRequest** | **CommandCreatePostRequest**|  | |


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

# **commandDeleteIdDelete**
> commandDeleteIdDelete()

Delete an existing command

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | Command 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** | Command deleted successfully |  -  |
|**401** | Unauthorized |  -  |
|**403** | Query access required |  -  |
|**404** | Command 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)

# **commandRunIdPost**
> object commandRunIdPost(body)

Execute a command with provided data

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **object**|  | |
| **id** | [**string**] | Command 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** | Command executed successfully |  -  |
|**302** | Redirect response |  -  |
|**401** | Unauthorized |  -  |
|**403** | Query access required |  -  |
|**404** | Command 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)

# **commandUpdateIdPost**
> Query commandUpdateIdPost(commandUpdateIdPostRequest)

Update an existing command

### Example

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

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

let id: string; //Command ID (default to undefined)
let commandUpdateIdPostRequest: CommandUpdateIdPostRequest; //

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **commandUpdateIdPostRequest** | **CommandUpdateIdPostRequest**|  | |
| **id** | [**string**] | Command 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** | Command updated successfully |  -  |
|**401** | Unauthorized |  -  |
|**403** | Query access required |  -  |
|**404** | Command 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)