113 lines
3.0 KiB
Markdown
113 lines
3.0 KiB
Markdown
# LowCodeEngineApi.FunctionsApi
|
|
|
|
All URIs are relative to *http://localhost:3000*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**functionsCreatePost**](FunctionsApi.md#functionsCreatePost) | **POST** /functions/create | Create function
|
|
[**functionsDeletePost**](FunctionsApi.md#functionsDeletePost) | **POST** /functions/delete | Delete function
|
|
|
|
|
|
|
|
## functionsCreatePost
|
|
|
|
> Function functionsCreatePost(functionsCreatePostRequest)
|
|
|
|
Create function
|
|
|
|
Create a new function 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.FunctionsApi();
|
|
let functionsCreatePostRequest = new LowCodeEngineApi.FunctionsCreatePostRequest(); // FunctionsCreatePostRequest |
|
|
apiInstance.functionsCreatePost(functionsCreatePostRequest, (error, data, response) => {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully. Returned data: ' + data);
|
|
}
|
|
});
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**functionsCreatePostRequest** | [**FunctionsCreatePostRequest**](FunctionsCreatePostRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**Function**](Function.md)
|
|
|
|
### Authorization
|
|
|
|
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
|
|
## functionsDeletePost
|
|
|
|
> functionsDeletePost(functionsDeletePostRequest)
|
|
|
|
Delete function
|
|
|
|
Delete a function from 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.FunctionsApi();
|
|
let functionsDeletePostRequest = new LowCodeEngineApi.FunctionsDeletePostRequest(); // FunctionsDeletePostRequest |
|
|
apiInstance.functionsDeletePost(functionsDeletePostRequest, (error, data, response) => {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully.');
|
|
}
|
|
});
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**functionsDeletePostRequest** | [**FunctionsDeletePostRequest**](FunctionsDeletePostRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: Not defined
|
|
|