2022-07-13 14:23:48 +02:00
# openapi.api.AssetApi
## Load the API package
```dart
import 'package:openapi/api.dart';
```
All URIs are relative to */api*
Method | HTTP request | Description
------------- | ------------- | -------------
2023-02-15 23:21:22 +02:00
[**addAssetsToSharedLink** ](AssetApi.md#addassetstosharedlink ) | **PATCH** /asset/shared-link/add |
2023-05-24 23:08:21 +02:00
[**bulkUploadCheck** ](AssetApi.md#bulkuploadcheck ) | **POST** /asset/bulk-upload-check |
2022-07-13 14:23:48 +02:00
[**checkDuplicateAsset** ](AssetApi.md#checkduplicateasset ) | **POST** /asset/check |
2022-10-25 16:51:03 +02:00
[**checkExistingAssets** ](AssetApi.md#checkexistingassets ) | **POST** /asset/exist |
2023-01-15 07:49:47 +02:00
[**createAssetsSharedLink** ](AssetApi.md#createassetssharedlink ) | **POST** /asset/shared-link |
2022-07-13 14:23:48 +02:00
[**deleteAsset** ](AssetApi.md#deleteasset ) | **DELETE** /asset |
2023-06-02 04:19:25 +02:00
[**downloadFile** ](AssetApi.md#downloadfile ) | **GET** /asset/download/{id} |
2023-01-09 22:16:08 +02:00
[**downloadFiles** ](AssetApi.md#downloadfiles ) | **POST** /asset/download-files |
2022-11-15 17:51:56 +02:00
[**downloadLibrary** ](AssetApi.md#downloadlibrary ) | **GET** /asset/download-library |
2022-07-13 14:23:48 +02:00
[**getAllAssets** ](AssetApi.md#getallassets ) | **GET** /asset |
2023-04-12 17:37:52 +02:00
[**getArchivedAssetCountByUserId** ](AssetApi.md#getarchivedassetcountbyuserid ) | **GET** /asset/stat/archive |
2023-06-02 04:19:25 +02:00
[**getAssetById** ](AssetApi.md#getassetbyid ) | **GET** /asset/assetById/{id} |
2022-09-04 15:34:39 +02:00
[**getAssetByTimeBucket** ](AssetApi.md#getassetbytimebucket ) | **POST** /asset/time-bucket |
[**getAssetCountByTimeBucket** ](AssetApi.md#getassetcountbytimebucket ) | **POST** /asset/count-by-time-bucket |
2022-09-07 22:16:18 +02:00
[**getAssetCountByUserId** ](AssetApi.md#getassetcountbyuserid ) | **GET** /asset/count-by-user-id |
2022-08-27 07:53:37 +02:00
[**getAssetSearchTerms** ](AssetApi.md#getassetsearchterms ) | **GET** /asset/search-terms |
2023-06-02 04:19:25 +02:00
[**getAssetThumbnail** ](AssetApi.md#getassetthumbnail ) | **GET** /asset/thumbnail/{id} |
2022-08-27 07:53:37 +02:00
[**getCuratedLocations** ](AssetApi.md#getcuratedlocations ) | **GET** /asset/curated-locations |
[**getCuratedObjects** ](AssetApi.md#getcuratedobjects ) | **GET** /asset/curated-objects |
2023-05-06 03:33:30 +02:00
[**getMapMarkers** ](AssetApi.md#getmapmarkers ) | **GET** /asset/map-marker |
2022-07-13 14:23:48 +02:00
[**getUserAssetsByDeviceId** ](AssetApi.md#getuserassetsbydeviceid ) | **GET** /asset/{deviceId} |
2023-02-15 23:21:22 +02:00
[**removeAssetsFromSharedLink** ](AssetApi.md#removeassetsfromsharedlink ) | **PATCH** /asset/shared-link/remove |
2022-07-13 14:23:48 +02:00
[**searchAsset** ](AssetApi.md#searchasset ) | **POST** /asset/search |
2023-06-02 04:19:25 +02:00
[**serveFile** ](AssetApi.md#servefile ) | **GET** /asset/file/{id} |
[**updateAsset** ](AssetApi.md#updateasset ) | **PUT** /asset/{id} |
2022-07-13 14:23:48 +02:00
[**uploadFile** ](AssetApi.md#uploadfile ) | **POST** /asset/upload |
2023-02-15 23:21:22 +02:00
# **addAssetsToSharedLink**
2023-02-24 18:01:10 +02:00
> SharedLinkResponseDto addAssetsToSharedLink(addAssetsDto, key)
2023-02-15 23:21:22 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2023-02-15 23:21:22 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final addAssetsDto = AddAssetsDto(); // AddAssetsDto |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2023-02-15 23:21:22 +02:00
try {
2023-02-24 18:01:10 +02:00
final result = api_instance.addAssetsToSharedLink(addAssetsDto, key);
2023-02-15 23:21:22 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->addAssetsToSharedLink: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**addAssetsDto** | [**AddAssetsDto** ](AddAssetsDto.md )| |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2023-02-15 23:21:22 +02:00
### Return type
[**SharedLinkResponseDto** ](SharedLinkResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-02-15 23:21:22 +02:00
### 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)
2023-05-24 23:08:21 +02:00
# **bulkUploadCheck**
> AssetBulkUploadCheckResponseDto bulkUploadCheck(assetBulkUploadCheckDto)
Checks if assets exist by checksums
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final assetBulkUploadCheckDto = AssetBulkUploadCheckDto(); // AssetBulkUploadCheckDto |
try {
final result = api_instance.bulkUploadCheck(assetBulkUploadCheckDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->bulkUploadCheck: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetBulkUploadCheckDto** | [**AssetBulkUploadCheckDto** ](AssetBulkUploadCheckDto.md )| |
### Return type
[**AssetBulkUploadCheckResponseDto** ](AssetBulkUploadCheckResponseDto.md )
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [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)
2022-07-13 14:23:48 +02:00
# **checkDuplicateAsset**
2023-02-24 18:01:10 +02:00
> CheckDuplicateAssetResponseDto checkDuplicateAsset(checkDuplicateAssetDto, key)
2022-07-13 14:23:48 +02:00
Check duplicated asset before uploading - for Web upload used
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final checkDuplicateAssetDto = CheckDuplicateAssetDto(); // CheckDuplicateAssetDto |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-07-13 14:23:48 +02:00
try {
2023-02-24 18:01:10 +02:00
final result = api_instance.checkDuplicateAsset(checkDuplicateAssetDto, key);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->checkDuplicateAsset: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**checkDuplicateAssetDto** | [**CheckDuplicateAssetDto** ](CheckDuplicateAssetDto.md )| |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
[**CheckDuplicateAssetResponseDto** ](CheckDuplicateAssetResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### 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)
2022-10-25 16:51:03 +02:00
# **checkExistingAssets**
> CheckExistingAssetsResponseDto checkExistingAssets(checkExistingAssetsDto)
Checks if multiple assets exist on the server and returns all existing - used by background backup
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-10-25 16:51:03 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final checkExistingAssetsDto = CheckExistingAssetsDto(); // CheckExistingAssetsDto |
try {
final result = api_instance.checkExistingAssets(checkExistingAssetsDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->checkExistingAssets: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**checkExistingAssetsDto** | [**CheckExistingAssetsDto** ](CheckExistingAssetsDto.md )| |
### Return type
[**CheckExistingAssetsResponseDto** ](CheckExistingAssetsResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-10-25 16:51:03 +02:00
### 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)
2023-01-15 07:49:47 +02:00
# **createAssetsSharedLink**
> SharedLinkResponseDto createAssetsSharedLink(createAssetsShareLinkDto)
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2023-01-15 07:49:47 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final createAssetsShareLinkDto = CreateAssetsShareLinkDto(); // CreateAssetsShareLinkDto |
try {
final result = api_instance.createAssetsSharedLink(createAssetsShareLinkDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->createAssetsSharedLink: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**createAssetsShareLinkDto** | [**CreateAssetsShareLinkDto** ](CreateAssetsShareLinkDto.md )| |
### Return type
[**SharedLinkResponseDto** ](SharedLinkResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-01-15 07:49:47 +02:00
### 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)
2022-07-13 14:23:48 +02:00
# **deleteAsset**
> List<DeleteAssetResponseDto> deleteAsset(deleteAssetDto)
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final deleteAssetDto = DeleteAssetDto(); // DeleteAssetDto |
try {
final result = api_instance.deleteAsset(deleteAssetDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->deleteAsset: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**deleteAssetDto** | [**DeleteAssetDto** ](DeleteAssetDto.md )| |
### Return type
[**List<DeleteAssetResponseDto>** ](DeleteAssetResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### 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)
# **downloadFile**
2023-06-02 04:19:25 +02:00
> MultipartFile downloadFile(id, key)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-02 04:19:25 +02:00
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-07-13 14:23:48 +02:00
try {
2023-06-02 04:19:25 +02:00
final result = api_instance.downloadFile(id, key);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->downloadFile: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-02 04:19:25 +02:00
**id** | **String** | |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
2023-02-24 18:01:10 +02:00
[**MultipartFile** ](MultipartFile.md )
2022-07-13 14:23:48 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: Not defined
2023-02-24 18:01:10 +02:00
- **Accept**: application/octet-stream
2022-07-13 14:23:48 +02:00
[[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)
2023-01-09 22:16:08 +02:00
# **downloadFiles**
2023-02-24 18:01:10 +02:00
> MultipartFile downloadFiles(downloadFilesDto, key)
2023-01-09 22:16:08 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2023-01-09 22:16:08 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final downloadFilesDto = DownloadFilesDto(); // DownloadFilesDto |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2023-01-09 22:16:08 +02:00
try {
2023-02-24 18:01:10 +02:00
final result = api_instance.downloadFiles(downloadFilesDto, key);
2023-01-09 22:16:08 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->downloadFiles: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**downloadFilesDto** | [**DownloadFilesDto** ](DownloadFilesDto.md )| |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2023-01-09 22:16:08 +02:00
### Return type
2023-02-24 18:01:10 +02:00
[**MultipartFile** ](MultipartFile.md )
2023-01-09 22:16:08 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-01-09 22:16:08 +02:00
### HTTP request headers
- **Content-Type**: application/json
2023-02-24 18:01:10 +02:00
- **Accept**: application/octet-stream
2023-01-09 22:16:08 +02:00
[[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)
2022-11-15 17:51:56 +02:00
# **downloadLibrary**
2023-04-06 19:50:55 +02:00
> MultipartFile downloadLibrary(name, skip, key)
2022-11-15 17:51:56 +02:00
2023-01-24 05:46:37 +02:00
Current this is not used in any UI element
2023-01-15 07:49:47 +02:00
2022-11-15 17:51:56 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-11-15 17:51:56 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-04-06 19:50:55 +02:00
final name = name_example; // String |
2022-11-15 17:51:56 +02:00
final skip = 8.14; // num |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-11-15 17:51:56 +02:00
try {
2023-04-06 19:50:55 +02:00
final result = api_instance.downloadLibrary(name, skip, key);
2022-11-15 17:51:56 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->downloadLibrary: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-04-06 19:50:55 +02:00
**name** | **String** | | [optional]
2022-11-15 17:51:56 +02:00
**skip** | **num** | | [optional]
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-11-15 17:51:56 +02:00
### Return type
2023-02-24 18:01:10 +02:00
[**MultipartFile** ](MultipartFile.md )
2022-11-15 17:51:56 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-11-15 17:51:56 +02:00
### HTTP request headers
- **Content-Type**: Not defined
2023-02-24 18:01:10 +02:00
- **Accept**: application/octet-stream
2022-11-15 17:51:56 +02:00
[[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)
2022-07-13 14:23:48 +02:00
# **getAllAssets**
2023-05-25 05:52:43 +02:00
> List<AssetResponseDto> getAllAssets(userId, isFavorite, isArchived, skip, ifNoneMatch)
2022-07-13 14:23:48 +02:00
Get all AssetEntity belong to the user
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-05-25 05:52:43 +02:00
final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-01-24 06:16:20 +02:00
final isFavorite = true; // bool |
2023-04-12 17:37:52 +02:00
final isArchived = true; // bool |
2023-01-24 06:16:20 +02:00
final skip = 8.14; // num |
2022-11-26 18:16:02 +02:00
final ifNoneMatch = ifNoneMatch_example; // String | ETag of data already cached on the client
2022-07-13 14:23:48 +02:00
try {
2023-05-25 05:52:43 +02:00
final result = api_instance.getAllAssets(userId, isFavorite, isArchived, skip, ifNoneMatch);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAllAssets: $e\n');
}
```
### Parameters
2022-11-26 18:16:02 +02:00
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-05-25 05:52:43 +02:00
**userId** | **String** | | [optional]
2023-01-24 06:16:20 +02:00
**isFavorite** | **bool** | | [optional]
2023-04-12 17:37:52 +02:00
**isArchived** | **bool** | | [optional]
2023-01-24 06:16:20 +02:00
**skip** | **num** | | [optional]
2022-11-26 18:16:02 +02:00
**ifNoneMatch** | **String** | ETag of data already cached on the client | [optional]
2022-07-13 14:23:48 +02:00
### Return type
[**List<AssetResponseDto>** ](AssetResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### 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)
2023-04-12 17:37:52 +02:00
# **getArchivedAssetCountByUserId**
> AssetCountByUserIdResponseDto getArchivedAssetCountByUserId()
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2023-04-12 17:37:52 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
try {
final result = api_instance.getArchivedAssetCountByUserId();
print(result);
} catch (e) {
print('Exception when calling AssetApi->getArchivedAssetCountByUserId: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**AssetCountByUserIdResponseDto** ](AssetCountByUserIdResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-04-12 17:37:52 +02:00
### 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)
2022-07-13 14:23:48 +02:00
# **getAssetById**
2023-06-02 04:19:25 +02:00
> AssetResponseDto getAssetById(id, key)
2022-07-13 14:23:48 +02:00
Get a single asset's information
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-02 04:19:25 +02:00
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-07-13 14:23:48 +02:00
try {
2023-06-02 04:19:25 +02:00
final result = api_instance.getAssetById(id, key);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAssetById: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-02 04:19:25 +02:00
**id** | **String** | |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
[**AssetResponseDto** ](AssetResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### 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)
2022-09-04 15:34:39 +02:00
# **getAssetByTimeBucket**
> List<AssetResponseDto> getAssetByTimeBucket(getAssetByTimeBucketDto)
2022-08-27 07:53:37 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-08-27 07:53:37 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2022-09-04 15:34:39 +02:00
final getAssetByTimeBucketDto = GetAssetByTimeBucketDto(); // GetAssetByTimeBucketDto |
2022-08-27 07:53:37 +02:00
try {
2022-09-04 15:34:39 +02:00
final result = api_instance.getAssetByTimeBucket(getAssetByTimeBucketDto);
2022-08-27 07:53:37 +02:00
print(result);
} catch (e) {
2022-09-04 15:34:39 +02:00
print('Exception when calling AssetApi->getAssetByTimeBucket: $e\n');
2022-08-27 07:53:37 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2022-09-04 15:34:39 +02:00
**getAssetByTimeBucketDto** | [**GetAssetByTimeBucketDto** ](GetAssetByTimeBucketDto.md )| |
2022-08-27 07:53:37 +02:00
### Return type
2022-09-04 15:34:39 +02:00
[**List<AssetResponseDto>** ](AssetResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-09-04 15:34:39 +02:00
### 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)
# **getAssetCountByTimeBucket**
> AssetCountByTimeBucketResponseDto getAssetCountByTimeBucket(getAssetCountByTimeBucketDto)
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-09-04 15:34:39 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final getAssetCountByTimeBucketDto = GetAssetCountByTimeBucketDto(); // GetAssetCountByTimeBucketDto |
try {
final result = api_instance.getAssetCountByTimeBucket(getAssetCountByTimeBucketDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAssetCountByTimeBucket: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**getAssetCountByTimeBucketDto** | [**GetAssetCountByTimeBucketDto** ](GetAssetCountByTimeBucketDto.md )| |
### Return type
[**AssetCountByTimeBucketResponseDto** ](AssetCountByTimeBucketResponseDto.md )
2022-08-27 07:53:37 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-08-27 07:53:37 +02:00
### 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)
2022-09-07 22:16:18 +02:00
# **getAssetCountByUserId**
> AssetCountByUserIdResponseDto getAssetCountByUserId()
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-09-07 22:16:18 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
try {
final result = api_instance.getAssetCountByUserId();
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAssetCountByUserId: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**AssetCountByUserIdResponseDto** ](AssetCountByUserIdResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-09-07 22:16:18 +02:00
### 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)
2022-07-13 14:23:48 +02:00
# **getAssetSearchTerms**
> List<String> getAssetSearchTerms()
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
try {
final result = api_instance.getAssetSearchTerms();
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAssetSearchTerms: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
**List< String > **
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### 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)
# **getAssetThumbnail**
2023-06-02 04:19:25 +02:00
> MultipartFile getAssetThumbnail(id, format, key)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-02 04:19:25 +02:00
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2022-07-16 06:18:17 +02:00
final format = ; // ThumbnailFormat |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-07-13 14:23:48 +02:00
try {
2023-06-02 04:19:25 +02:00
final result = api_instance.getAssetThumbnail(id, format, key);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAssetThumbnail: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-02 04:19:25 +02:00
**id** | **String** | |
2022-07-16 06:18:17 +02:00
**format** | [**ThumbnailFormat** ](.md )| | [optional]
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
2023-02-24 18:01:10 +02:00
[**MultipartFile** ](MultipartFile.md )
2022-07-13 14:23:48 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: Not defined
2023-02-24 18:01:10 +02:00
- **Accept**: application/octet-stream
2022-07-13 14:23:48 +02:00
[[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)
# **getCuratedLocations**
> List<CuratedLocationsResponseDto> getCuratedLocations()
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
try {
final result = api_instance.getCuratedLocations();
print(result);
} catch (e) {
print('Exception when calling AssetApi->getCuratedLocations: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**List<CuratedLocationsResponseDto>** ](CuratedLocationsResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### 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)
# **getCuratedObjects**
> List<CuratedObjectsResponseDto> getCuratedObjects()
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
try {
final result = api_instance.getCuratedObjects();
print(result);
} catch (e) {
print('Exception when calling AssetApi->getCuratedObjects: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**List<CuratedObjectsResponseDto>** ](CuratedObjectsResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### 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)
2023-05-06 03:33:30 +02:00
# **getMapMarkers**
2023-05-25 18:47:52 +02:00
> List<MapMarkerResponseDto> getMapMarkers(isFavorite, fileCreatedAfter, fileCreatedBefore)
2023-05-06 03:33:30 +02:00
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-08 21:59:33 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2023-05-06 03:33:30 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final isFavorite = true; // bool |
2023-05-25 18:47:52 +02:00
final fileCreatedAfter = 2013-10-20T19:20:30+01:00; // DateTime |
final fileCreatedBefore = 2013-10-20T19:20:30+01:00; // DateTime |
2023-05-06 03:33:30 +02:00
try {
2023-05-25 18:47:52 +02:00
final result = api_instance.getMapMarkers(isFavorite, fileCreatedAfter, fileCreatedBefore);
2023-05-06 03:33:30 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getMapMarkers: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**isFavorite** | **bool** | | [optional]
2023-05-25 18:47:52 +02:00
**fileCreatedAfter** | **DateTime** | | [optional]
**fileCreatedBefore** | **DateTime** | | [optional]
2023-05-06 03:33:30 +02:00
### Return type
[**List<MapMarkerResponseDto>** ](MapMarkerResponseDto.md )
### Authorization
2023-05-08 21:59:33 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-05-06 03:33:30 +02:00
### 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)
2022-07-13 14:23:48 +02:00
# **getUserAssetsByDeviceId**
> List<String> getUserAssetsByDeviceId(deviceId)
Get all asset of a device that are in the database, ID only.
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-04-05 00:24:08 +02:00
final deviceId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2022-07-13 14:23:48 +02:00
try {
final result = api_instance.getUserAssetsByDeviceId(deviceId);
print(result);
} catch (e) {
print('Exception when calling AssetApi->getUserAssetsByDeviceId: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**deviceId** | **String** | |
### Return type
**List< String > **
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### 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)
2023-02-15 23:21:22 +02:00
# **removeAssetsFromSharedLink**
2023-02-24 18:01:10 +02:00
> SharedLinkResponseDto removeAssetsFromSharedLink(removeAssetsDto, key)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-02-15 23:21:22 +02:00
final removeAssetsDto = RemoveAssetsDto(); // RemoveAssetsDto |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-07-13 14:23:48 +02:00
try {
2023-02-24 18:01:10 +02:00
final result = api_instance.removeAssetsFromSharedLink(removeAssetsDto, key);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
2023-02-15 23:21:22 +02:00
print('Exception when calling AssetApi->removeAssetsFromSharedLink: $e\n');
2022-07-13 14:23:48 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-02-15 23:21:22 +02:00
**removeAssetsDto** | [**RemoveAssetsDto** ](RemoveAssetsDto.md )| |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
2023-02-15 23:21:22 +02:00
[**SharedLinkResponseDto** ](SharedLinkResponseDto.md )
2022-07-13 14:23:48 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### 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)
2023-02-15 23:21:22 +02:00
# **searchAsset**
> List<AssetResponseDto> searchAsset(searchAssetDto)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-02-15 23:21:22 +02:00
final searchAssetDto = SearchAssetDto(); // SearchAssetDto |
2022-07-13 14:23:48 +02:00
try {
2023-02-15 23:21:22 +02:00
final result = api_instance.searchAsset(searchAssetDto);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
2023-02-15 23:21:22 +02:00
print('Exception when calling AssetApi->searchAsset: $e\n');
2022-07-13 14:23:48 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-02-15 23:21:22 +02:00
**searchAssetDto** | [**SearchAssetDto** ](SearchAssetDto.md )| |
2022-07-13 14:23:48 +02:00
### Return type
2023-02-15 23:21:22 +02:00
[**List<AssetResponseDto>** ](AssetResponseDto.md )
2022-07-13 14:23:48 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
2023-02-15 23:21:22 +02:00
- **Content-Type**: application/json
2022-07-13 14:23:48 +02:00
- **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)
2023-02-15 23:21:22 +02:00
# **serveFile**
2023-06-02 04:19:25 +02:00
> MultipartFile serveFile(id, isThumb, isWeb, key)
2023-02-15 23:21:22 +02:00
2022-11-08 18:20:36 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-11-08 18:20:36 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-02 04:19:25 +02:00
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-15 23:21:22 +02:00
final isThumb = true; // bool |
final isWeb = true; // bool |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-11-08 18:20:36 +02:00
try {
2023-06-02 04:19:25 +02:00
final result = api_instance.serveFile(id, isThumb, isWeb, key);
2022-11-08 18:20:36 +02:00
print(result);
} catch (e) {
2023-02-15 23:21:22 +02:00
print('Exception when calling AssetApi->serveFile: $e\n');
2022-11-08 18:20:36 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-02 04:19:25 +02:00
**id** | **String** | |
2023-02-15 23:21:22 +02:00
**isThumb** | **bool** | | [optional]
**isWeb** | **bool** | | [optional]
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-11-08 18:20:36 +02:00
### Return type
2023-02-24 18:01:10 +02:00
[**MultipartFile** ](MultipartFile.md )
2022-11-08 18:20:36 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-11-08 18:20:36 +02:00
### HTTP request headers
2023-02-15 23:21:22 +02:00
- **Content-Type**: Not defined
2023-02-24 18:01:10 +02:00
- **Accept**: application/octet-stream
2022-11-08 18:20:36 +02:00
[[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)
2023-02-15 23:21:22 +02:00
# **updateAsset**
2023-06-02 04:19:25 +02:00
> AssetResponseDto updateAsset(id, updateAssetDto)
2023-01-15 07:49:47 +02:00
2023-02-15 23:21:22 +02:00
Update an asset
2023-01-15 07:49:47 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2023-01-15 07:49:47 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-02 04:19:25 +02:00
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-15 23:21:22 +02:00
final updateAssetDto = UpdateAssetDto(); // UpdateAssetDto |
2023-01-15 07:49:47 +02:00
try {
2023-06-02 04:19:25 +02:00
final result = api_instance.updateAsset(id, updateAssetDto);
2023-01-15 07:49:47 +02:00
print(result);
} catch (e) {
2023-02-15 23:21:22 +02:00
print('Exception when calling AssetApi->updateAsset: $e\n');
2023-01-15 07:49:47 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-02 04:19:25 +02:00
**id** | **String** | |
2023-02-15 23:21:22 +02:00
**updateAssetDto** | [**UpdateAssetDto** ](UpdateAssetDto.md )| |
2023-01-15 07:49:47 +02:00
### Return type
2023-02-15 23:21:22 +02:00
[**AssetResponseDto** ](AssetResponseDto.md )
2023-01-15 07:49:47 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-01-15 07:49:47 +02:00
### 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)
2022-07-13 14:23:48 +02:00
# **uploadFile**
feat(server): xmp sidecar metadata (#2466)
* initial commit for XMP sidecar support
* Added support for 'missing' metadata files to include those without sidecar files, now detects sidecar files in the filesystem for media already ingested but the sidecar was created afterwards
* didn't mean to commit default log level during testing
* new sidecar logic for video metadata as well
* Added xml mimetype for sidecars only
* don't need capture group for this regex
* wrong default value reverted
* simplified the move here - keep it in the same try catch since the outcome is to move the media back anyway
* simplified setter logic
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
* simplified logic per suggestions
* sidecar is now its own queue with a discover and sync, updated UI for the new job queueing
* queue a sidecar job for every asset based on discovery or sync, though the logic is almost identical aside from linking the sidecar
* now queue sidecar jobs for each assset, though logic is mostly the same between discovery and sync
* simplified logic of filename extraction and asset instantiation
* not sure how that got deleted..
* updated code per suggestions and comments in the PR
* stat was not being used, removed the variable set
* better type checking, using in-scope variables for exif getter instead of passing in every time
* removed commented out test
* ran and resolved all lints, formats, checks, and tests
* resolved suggested change in PR
* made getExifProperty more dynamic with multiple possible args for fallbacks, fixed typo, used generic in function for better type checking
* better error handling and moving files back to positions on move or save failure
* regenerated api
* format fixes
* Added XMP documentation
* documentation typo
* Merged in main
* missed merge conflict
* more changes due to a merge
* Resolving conflicts
* added icon for sidecar jobs
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-05-25 03:59:30 +02:00
> AssetFileUploadResponseDto uploadFile(assetType, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, fileExtension, key, livePhotoData, sidecarData, isArchived, isVisible, duration)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-02-12 07:54:07 +02:00
final assetType = ; // AssetTypeEnum |
2022-07-13 14:23:48 +02:00
final assetData = BINARY_DATA_HERE; // MultipartFile |
2023-02-12 07:54:07 +02:00
final deviceAssetId = deviceAssetId_example; // String |
final deviceId = deviceId_example; // String |
2023-05-29 16:05:14 +02:00
final fileCreatedAt = 2013-10-20T19:20:30+01:00; // DateTime |
final fileModifiedAt = 2013-10-20T19:20:30+01:00; // DateTime |
2023-02-12 07:54:07 +02:00
final isFavorite = true; // bool |
final fileExtension = fileExtension_example; // String |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2023-02-12 07:54:07 +02:00
final livePhotoData = BINARY_DATA_HERE; // MultipartFile |
feat(server): xmp sidecar metadata (#2466)
* initial commit for XMP sidecar support
* Added support for 'missing' metadata files to include those without sidecar files, now detects sidecar files in the filesystem for media already ingested but the sidecar was created afterwards
* didn't mean to commit default log level during testing
* new sidecar logic for video metadata as well
* Added xml mimetype for sidecars only
* don't need capture group for this regex
* wrong default value reverted
* simplified the move here - keep it in the same try catch since the outcome is to move the media back anyway
* simplified setter logic
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
* simplified logic per suggestions
* sidecar is now its own queue with a discover and sync, updated UI for the new job queueing
* queue a sidecar job for every asset based on discovery or sync, though the logic is almost identical aside from linking the sidecar
* now queue sidecar jobs for each assset, though logic is mostly the same between discovery and sync
* simplified logic of filename extraction and asset instantiation
* not sure how that got deleted..
* updated code per suggestions and comments in the PR
* stat was not being used, removed the variable set
* better type checking, using in-scope variables for exif getter instead of passing in every time
* removed commented out test
* ran and resolved all lints, formats, checks, and tests
* resolved suggested change in PR
* made getExifProperty more dynamic with multiple possible args for fallbacks, fixed typo, used generic in function for better type checking
* better error handling and moving files back to positions on move or save failure
* regenerated api
* format fixes
* Added XMP documentation
* documentation typo
* Merged in main
* missed merge conflict
* more changes due to a merge
* Resolving conflicts
* added icon for sidecar jobs
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-05-25 03:59:30 +02:00
final sidecarData = BINARY_DATA_HERE; // MultipartFile |
2023-04-12 17:37:52 +02:00
final isArchived = true; // bool |
2023-02-12 07:54:07 +02:00
final isVisible = true; // bool |
final duration = duration_example; // String |
2022-07-13 14:23:48 +02:00
try {
feat(server): xmp sidecar metadata (#2466)
* initial commit for XMP sidecar support
* Added support for 'missing' metadata files to include those without sidecar files, now detects sidecar files in the filesystem for media already ingested but the sidecar was created afterwards
* didn't mean to commit default log level during testing
* new sidecar logic for video metadata as well
* Added xml mimetype for sidecars only
* don't need capture group for this regex
* wrong default value reverted
* simplified the move here - keep it in the same try catch since the outcome is to move the media back anyway
* simplified setter logic
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
* simplified logic per suggestions
* sidecar is now its own queue with a discover and sync, updated UI for the new job queueing
* queue a sidecar job for every asset based on discovery or sync, though the logic is almost identical aside from linking the sidecar
* now queue sidecar jobs for each assset, though logic is mostly the same between discovery and sync
* simplified logic of filename extraction and asset instantiation
* not sure how that got deleted..
* updated code per suggestions and comments in the PR
* stat was not being used, removed the variable set
* better type checking, using in-scope variables for exif getter instead of passing in every time
* removed commented out test
* ran and resolved all lints, formats, checks, and tests
* resolved suggested change in PR
* made getExifProperty more dynamic with multiple possible args for fallbacks, fixed typo, used generic in function for better type checking
* better error handling and moving files back to positions on move or save failure
* regenerated api
* format fixes
* Added XMP documentation
* documentation typo
* Merged in main
* missed merge conflict
* more changes due to a merge
* Resolving conflicts
* added icon for sidecar jobs
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-05-25 03:59:30 +02:00
final result = api_instance.uploadFile(assetType, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, fileExtension, key, livePhotoData, sidecarData, isArchived, isVisible, duration);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->uploadFile: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-02-12 07:54:07 +02:00
**assetType** | [**AssetTypeEnum** ](AssetTypeEnum.md )| |
2022-07-13 14:23:48 +02:00
**assetData** | **MultipartFile** | |
2023-02-12 07:54:07 +02:00
**deviceAssetId** | **String** | |
**deviceId** | **String** | |
2023-05-29 16:05:14 +02:00
**fileCreatedAt** | **DateTime** | |
**fileModifiedAt** | **DateTime** | |
2023-02-12 07:54:07 +02:00
**isFavorite** | **bool** | |
**fileExtension** | **String** | |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2023-02-12 07:54:07 +02:00
**livePhotoData** | **MultipartFile** | | [optional]
feat(server): xmp sidecar metadata (#2466)
* initial commit for XMP sidecar support
* Added support for 'missing' metadata files to include those without sidecar files, now detects sidecar files in the filesystem for media already ingested but the sidecar was created afterwards
* didn't mean to commit default log level during testing
* new sidecar logic for video metadata as well
* Added xml mimetype for sidecars only
* don't need capture group for this regex
* wrong default value reverted
* simplified the move here - keep it in the same try catch since the outcome is to move the media back anyway
* simplified setter logic
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
* simplified logic per suggestions
* sidecar is now its own queue with a discover and sync, updated UI for the new job queueing
* queue a sidecar job for every asset based on discovery or sync, though the logic is almost identical aside from linking the sidecar
* now queue sidecar jobs for each assset, though logic is mostly the same between discovery and sync
* simplified logic of filename extraction and asset instantiation
* not sure how that got deleted..
* updated code per suggestions and comments in the PR
* stat was not being used, removed the variable set
* better type checking, using in-scope variables for exif getter instead of passing in every time
* removed commented out test
* ran and resolved all lints, formats, checks, and tests
* resolved suggested change in PR
* made getExifProperty more dynamic with multiple possible args for fallbacks, fixed typo, used generic in function for better type checking
* better error handling and moving files back to positions on move or save failure
* regenerated api
* format fixes
* Added XMP documentation
* documentation typo
* Merged in main
* missed merge conflict
* more changes due to a merge
* Resolving conflicts
* added icon for sidecar jobs
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-05-25 03:59:30 +02:00
**sidecarData** | **MultipartFile** | | [optional]
2023-04-12 17:37:52 +02:00
**isArchived** | **bool** | | [optional]
2023-02-12 07:54:07 +02:00
**isVisible** | **bool** | | [optional]
**duration** | **String** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
[**AssetFileUploadResponseDto** ](AssetFileUploadResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: multipart/form-data
- **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)