few-line-engine/out/js/docs/CommandsApi.md

# LowCodeEngineApi.CommandsApi

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

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



## commandCreatePost

> Query commandCreatePost(commandCreatePostRequest)

Create command

Create a new command in the project

### 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.CommandsApi();
let commandCreatePostRequest = new LowCodeEngineApi.CommandCreatePostRequest(); // CommandCreatePostRequest | 
apiInstance.commandCreatePost(commandCreatePostRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **commandCreatePostRequest** | [**CommandCreatePostRequest**](CommandCreatePostRequest.md)|  | 

### Return type

[**Query**](Query.md)

### Authorization

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

### HTTP request headers

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


## commandDeleteIdDelete

> commandDeleteIdDelete(id)

Delete command

Delete an existing command

### 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.CommandsApi();
let id = "id_example"; // String | Command ID
apiInstance.commandDeleteIdDelete(id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Command ID | 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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


## commandRunIdPost

> Object commandRunIdPost(id, body, opts)

Run command

Execute a command with provided data

### 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.CommandsApi();
let id = "id_example"; // String | Command ID
let body = {key: null}; // Object | 
let opts = {
  'xTraceId': "xTraceId_example" // String | Trace ID for logging
};
apiInstance.commandRunIdPost(id, body, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Command ID | 
 **body** | **Object**|  | 
 **xTraceId** | **String**| Trace ID for logging | [optional] 

### Return type

**Object**

### Authorization

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

### HTTP request headers

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


## commandUpdateIdPost

> Query commandUpdateIdPost(id, commandUpdateIdPostRequest)

Update command

Update an existing command

### 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.CommandsApi();
let id = "id_example"; // String | Command ID
let commandUpdateIdPostRequest = new LowCodeEngineApi.CommandUpdateIdPostRequest(); // CommandUpdateIdPostRequest | 
apiInstance.commandUpdateIdPost(id, commandUpdateIdPostRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Command ID | 
 **commandUpdateIdPostRequest** | [**CommandUpdateIdPostRequest**](CommandUpdateIdPostRequest.md)|  | 

### Return type

[**Query**](Query.md)

### Authorization

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

### HTTP request headers

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