323 lines
8.9 KiB
Markdown
323 lines
8.9 KiB
Markdown
# LowCodeEngineApi.ProjectManagementApi
|
|
|
|
All URIs are relative to *http://localhost:3000*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**projectApiTokensGet**](ProjectManagementApi.md#projectApiTokensGet) | **GET** /project/api-tokens | Get all API tokens
|
|
[**projectCreatePut**](ProjectManagementApi.md#projectCreatePut) | **PUT** /project/create | Create project
|
|
[**projectCreateWithoutDbPut**](ProjectManagementApi.md#projectCreateWithoutDbPut) | **PUT** /project/create-without-db | Create project without database
|
|
[**projectSettingsCreatePut**](ProjectManagementApi.md#projectSettingsCreatePut) | **PUT** /project/settings/create | Create project setting
|
|
[**projectSettingsDeleteKeyDelete**](ProjectManagementApi.md#projectSettingsDeleteKeyDelete) | **DELETE** /project/settings/delete/{key} | Delete project setting
|
|
[**projectSettingsGet**](ProjectManagementApi.md#projectSettingsGet) | **GET** /project/settings | Get all project settings
|
|
|
|
|
|
|
|
## projectApiTokensGet
|
|
|
|
> [Token] projectApiTokensGet()
|
|
|
|
Get all API tokens
|
|
|
|
Retrieve all API tokens for the current project
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
import LowCodeEngineApi from 'low_code_engine_api';
|
|
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
|
// Configure API key authorization: AdminAuth
|
|
let AdminAuth = defaultClient.authentications['AdminAuth'];
|
|
AdminAuth.apiKey = 'YOUR API KEY';
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//AdminAuth.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.ProjectManagementApi();
|
|
apiInstance.projectApiTokensGet((error, data, response) => {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully. Returned data: ' + data);
|
|
}
|
|
});
|
|
```
|
|
|
|
### Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**[Token]**](Token.md)
|
|
|
|
### Authorization
|
|
|
|
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
|
|
## projectCreatePut
|
|
|
|
> Project projectCreatePut(projectCreatePutRequest)
|
|
|
|
Create project
|
|
|
|
Create a new project with database
|
|
|
|
### 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.ProjectManagementApi();
|
|
let projectCreatePutRequest = new LowCodeEngineApi.ProjectCreatePutRequest(); // ProjectCreatePutRequest |
|
|
apiInstance.projectCreatePut(projectCreatePutRequest, (error, data, response) => {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully. Returned data: ' + data);
|
|
}
|
|
});
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**projectCreatePutRequest** | [**ProjectCreatePutRequest**](ProjectCreatePutRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**Project**](Project.md)
|
|
|
|
### Authorization
|
|
|
|
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
|
|
## projectCreateWithoutDbPut
|
|
|
|
> Project projectCreateWithoutDbPut(projectCreatePutRequest)
|
|
|
|
Create project without database
|
|
|
|
Create a new project without creating a database
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
import LowCodeEngineApi from 'low_code_engine_api';
|
|
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
|
// Configure API key authorization: AdminAuth
|
|
let AdminAuth = defaultClient.authentications['AdminAuth'];
|
|
AdminAuth.apiKey = 'YOUR API KEY';
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//AdminAuth.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.ProjectManagementApi();
|
|
let projectCreatePutRequest = new LowCodeEngineApi.ProjectCreatePutRequest(); // ProjectCreatePutRequest |
|
|
apiInstance.projectCreateWithoutDbPut(projectCreatePutRequest, (error, data, response) => {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully. Returned data: ' + data);
|
|
}
|
|
});
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**projectCreatePutRequest** | [**ProjectCreatePutRequest**](ProjectCreatePutRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**Project**](Project.md)
|
|
|
|
### Authorization
|
|
|
|
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
|
|
## projectSettingsCreatePut
|
|
|
|
> ProjectSetting projectSettingsCreatePut(projectSettingsCreatePutRequest)
|
|
|
|
Create project setting
|
|
|
|
Create a new project setting
|
|
|
|
### 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.ProjectManagementApi();
|
|
let projectSettingsCreatePutRequest = new LowCodeEngineApi.ProjectSettingsCreatePutRequest(); // ProjectSettingsCreatePutRequest |
|
|
apiInstance.projectSettingsCreatePut(projectSettingsCreatePutRequest, (error, data, response) => {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully. Returned data: ' + data);
|
|
}
|
|
});
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**projectSettingsCreatePutRequest** | [**ProjectSettingsCreatePutRequest**](ProjectSettingsCreatePutRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**ProjectSetting**](ProjectSetting.md)
|
|
|
|
### Authorization
|
|
|
|
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
|
|
## projectSettingsDeleteKeyDelete
|
|
|
|
> projectSettingsDeleteKeyDelete(key)
|
|
|
|
Delete project setting
|
|
|
|
Delete a project setting by key
|
|
|
|
### 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.ProjectManagementApi();
|
|
let key = "key_example"; // String | Setting key to delete
|
|
apiInstance.projectSettingsDeleteKeyDelete(key, (error, data, response) => {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully.');
|
|
}
|
|
});
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**key** | **String**| Setting key to delete |
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: Not defined
|
|
|
|
|
|
## projectSettingsGet
|
|
|
|
> [ProjectSetting] projectSettingsGet()
|
|
|
|
Get all project settings
|
|
|
|
Retrieve all settings for the current 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.ProjectManagementApi();
|
|
apiInstance.projectSettingsGet((error, data, response) => {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully. Returned data: ' + data);
|
|
}
|
|
});
|
|
```
|
|
|
|
### Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**[ProjectSetting]**](ProjectSetting.md)
|
|
|
|
### Authorization
|
|
|
|
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|