274 lines
7.0 KiB
Markdown
274 lines
7.0 KiB
Markdown
# managerapi.api.RessourceApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://192.168.31.96*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**ressourceCreate**](RessourceApi.md#ressourcecreate) | **POST** /api/Ressource |
|
|
[**ressourceDelete**](RessourceApi.md#ressourcedelete) | **DELETE** /api/Ressource/{id} |
|
|
[**ressourceGet**](RessourceApi.md#ressourceget) | **GET** /api/Ressource |
|
|
[**ressourceGetDetail**](RessourceApi.md#ressourcegetdetail) | **GET** /api/Ressource/{id}/detail |
|
|
[**ressourceShow**](RessourceApi.md#ressourceshow) | **GET** /api/Ressource/{id} |
|
|
[**ressourceUpdate**](RessourceApi.md#ressourceupdate) | **PUT** /api/Ressource |
|
|
|
|
|
|
# **ressourceCreate**
|
|
> RessourceDetailDTO ressourceCreate(ressourceDetailDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = RessourceApi();
|
|
final ressourceDetailDTO = RessourceDetailDTO(); // RessourceDetailDTO |
|
|
|
|
try {
|
|
final result = api_instance.ressourceCreate(ressourceDetailDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling RessourceApi->ressourceCreate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**ressourceDetailDTO** | [**RessourceDetailDTO**](RessourceDetailDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**RessourceDetailDTO**](RessourceDetailDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[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)
|
|
|
|
# **ressourceDelete**
|
|
> String ressourceDelete(id)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = RessourceApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.ressourceDelete(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling RessourceApi->ressourceDelete: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
|
|
### Return type
|
|
|
|
**String**
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[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)
|
|
|
|
# **ressourceGet**
|
|
> List<RessourceDTO> ressourceGet()
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = RessourceApi();
|
|
|
|
try {
|
|
final result = api_instance.ressourceGet();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling RessourceApi->ressourceGet: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**List<RessourceDTO>**](RessourceDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[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)
|
|
|
|
# **ressourceGetDetail**
|
|
> RessourceDetailDTO ressourceGetDetail(id)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = RessourceApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.ressourceGetDetail(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling RessourceApi->ressourceGetDetail: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**RessourceDetailDTO**](RessourceDetailDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[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)
|
|
|
|
# **ressourceShow**
|
|
> MultipartFile ressourceShow(id)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = RessourceApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.ressourceShow(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling RessourceApi->ressourceShow: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**MultipartFile**](MultipartFile.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/octet-stream, application/json
|
|
|
|
[[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)
|
|
|
|
# **ressourceUpdate**
|
|
> RessourceDetailDTO ressourceUpdate(ressourceDetailDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = RessourceApi();
|
|
final ressourceDetailDTO = RessourceDetailDTO(); // RessourceDetailDTO |
|
|
|
|
try {
|
|
final result = api_instance.ressourceUpdate(ressourceDetailDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling RessourceApi->ressourceUpdate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**ressourceDetailDTO** | [**RessourceDetailDTO**](RessourceDetailDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**RessourceDetailDTO**](RessourceDetailDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[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)
|
|
|