2022-07-13 05:23:48 -07: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 14:21:22 -07:00
[**addAssetsToSharedLink** ](AssetApi.md#addassetstosharedlink ) | **PATCH** /asset/shared-link/add |
2022-07-13 05:23:48 -07:00
[**checkDuplicateAsset** ](AssetApi.md#checkduplicateasset ) | **POST** /asset/check |
2022-10-25 07:51:03 -07:00
[**checkExistingAssets** ](AssetApi.md#checkexistingassets ) | **POST** /asset/exist |
2023-01-14 22:49:47 -07:00
[**createAssetsSharedLink** ](AssetApi.md#createassetssharedlink ) | **POST** /asset/shared-link |
2022-07-13 05:23:48 -07:00
[**deleteAsset** ](AssetApi.md#deleteasset ) | **DELETE** /asset |
2022-11-15 23:11:16 -07:00
[**downloadFile** ](AssetApi.md#downloadfile ) | **GET** /asset/download/{assetId} |
2023-01-09 13:16:08 -07:00
[**downloadFiles** ](AssetApi.md#downloadfiles ) | **POST** /asset/download-files |
2022-11-15 08:51:56 -07:00
[**downloadLibrary** ](AssetApi.md#downloadlibrary ) | **GET** /asset/download-library |
2022-07-13 05:23:48 -07:00
[**getAllAssets** ](AssetApi.md#getallassets ) | **GET** /asset |
2023-04-12 08:37:52 -07:00
[**getArchivedAssetCountByUserId** ](AssetApi.md#getarchivedassetcountbyuserid ) | **GET** /asset/stat/archive |
2022-07-13 05:23:48 -07:00
[**getAssetById** ](AssetApi.md#getassetbyid ) | **GET** /asset/assetById/{assetId} |
2022-09-04 06:34:39 -07:00
[**getAssetByTimeBucket** ](AssetApi.md#getassetbytimebucket ) | **POST** /asset/time-bucket |
[**getAssetCountByTimeBucket** ](AssetApi.md#getassetcountbytimebucket ) | **POST** /asset/count-by-time-bucket |
2022-09-07 13:16:18 -07:00
[**getAssetCountByUserId** ](AssetApi.md#getassetcountbyuserid ) | **GET** /asset/count-by-user-id |
2022-08-26 22:53:37 -07:00
[**getAssetSearchTerms** ](AssetApi.md#getassetsearchterms ) | **GET** /asset/search-terms |
2022-07-13 05:23:48 -07:00
[**getAssetThumbnail** ](AssetApi.md#getassetthumbnail ) | **GET** /asset/thumbnail/{assetId} |
2022-08-26 22:53:37 -07:00
[**getCuratedLocations** ](AssetApi.md#getcuratedlocations ) | **GET** /asset/curated-locations |
[**getCuratedObjects** ](AssetApi.md#getcuratedobjects ) | **GET** /asset/curated-objects |
2023-05-05 18:33:30 -07:00
[**getMapMarkers** ](AssetApi.md#getmapmarkers ) | **GET** /asset/map-marker |
2022-07-13 05:23:48 -07:00
[**getUserAssetsByDeviceId** ](AssetApi.md#getuserassetsbydeviceid ) | **GET** /asset/{deviceId} |
2023-02-15 14:21:22 -07:00
[**removeAssetsFromSharedLink** ](AssetApi.md#removeassetsfromsharedlink ) | **PATCH** /asset/shared-link/remove |
2022-07-13 05:23:48 -07:00
[**searchAsset** ](AssetApi.md#searchasset ) | **POST** /asset/search |
2022-11-15 23:11:16 -07:00
[**serveFile** ](AssetApi.md#servefile ) | **GET** /asset/file/{assetId} |
2022-12-05 10:56:44 -07:00
[**updateAsset** ](AssetApi.md#updateasset ) | **PUT** /asset/{assetId} |
2022-07-13 05:23:48 -07:00
[**uploadFile** ](AssetApi.md#uploadfile ) | **POST** /asset/upload |
2023-02-15 14:21:22 -07:00
# **addAssetsToSharedLink**
2023-02-24 09:01:10 -07:00
> SharedLinkResponseDto addAssetsToSharedLink(addAssetsDto, key)
2023-02-15 14:21:22 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 14:21:22 -07: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 09:01:10 -07:00
final key = key_example; // String |
2023-02-15 14:21:22 -07:00
try {
2023-02-24 09:01:10 -07:00
final result = api_instance.addAssetsToSharedLink(addAssetsDto, key);
2023-02-15 14:21:22 -07: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 09:01:10 -07:00
**key** | **String** | | [optional]
2023-02-15 14:21:22 -07:00
### Return type
[**SharedLinkResponseDto** ](SharedLinkResponseDto.md )
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-02-15 14:21:22 -07: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 05:23:48 -07:00
# **checkDuplicateAsset**
2023-02-24 09:01:10 -07:00
> CheckDuplicateAssetResponseDto checkDuplicateAsset(checkDuplicateAssetDto, key)
2022-07-13 05:23:48 -07:00
Check duplicated asset before uploading - for Web upload used
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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 09:01:10 -07:00
final key = key_example; // String |
2022-07-13 05:23:48 -07:00
try {
2023-02-24 09:01:10 -07:00
final result = api_instance.checkDuplicateAsset(checkDuplicateAssetDto, key);
2022-07-13 05:23:48 -07: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 09:01:10 -07:00
**key** | **String** | | [optional]
2022-07-13 05:23:48 -07:00
### Return type
[**CheckDuplicateAssetResponseDto** ](CheckDuplicateAssetResponseDto.md )
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07: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 07:51:03 -07: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-08 19:26:09 -07: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 09:41:29 -07: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 07:51:03 -07: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 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-10-25 07:51:03 -07: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-14 22:49:47 -07:00
# **createAssetsSharedLink**
> SharedLinkResponseDto createAssetsSharedLink(createAssetsShareLinkDto)
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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-14 22:49:47 -07: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 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-01-14 22:49:47 -07: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 05:23:48 -07:00
# **deleteAsset**
> List<DeleteAssetResponseDto> deleteAsset(deleteAssetDto)
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07: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-02-24 09:01:10 -07:00
> MultipartFile downloadFile(assetId, key)
2022-07-13 05:23:48 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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-04 15:24:08 -07:00
final assetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-24 09:01:10 -07:00
final key = key_example; // String |
2022-07-13 05:23:48 -07:00
try {
2023-02-24 09:01:10 -07:00
final result = api_instance.downloadFile(assetId, key);
2022-07-13 05:23:48 -07:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->downloadFile: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2022-11-15 23:11:16 -07:00
**assetId** | **String** | |
2023-02-24 09:01:10 -07:00
**key** | **String** | | [optional]
2022-07-13 05:23:48 -07:00
### Return type
2023-02-24 09:01:10 -07:00
[**MultipartFile** ](MultipartFile.md )
2022-07-13 05:23:48 -07:00
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07:00
### HTTP request headers
- **Content-Type**: Not defined
2023-02-24 09:01:10 -07:00
- **Accept**: application/octet-stream
2022-07-13 05:23:48 -07: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 13:16:08 -07:00
# **downloadFiles**
2023-02-24 09:01:10 -07:00
> MultipartFile downloadFiles(downloadFilesDto, key)
2023-01-09 13:16:08 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 13:16:08 -07: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 09:01:10 -07:00
final key = key_example; // String |
2023-01-09 13:16:08 -07:00
try {
2023-02-24 09:01:10 -07:00
final result = api_instance.downloadFiles(downloadFilesDto, key);
2023-01-09 13:16:08 -07: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 09:01:10 -07:00
**key** | **String** | | [optional]
2023-01-09 13:16:08 -07:00
### Return type
2023-02-24 09:01:10 -07:00
[**MultipartFile** ](MultipartFile.md )
2023-01-09 13:16:08 -07:00
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-01-09 13:16:08 -07:00
### HTTP request headers
- **Content-Type**: application/json
2023-02-24 09:01:10 -07:00
- **Accept**: application/octet-stream
2023-01-09 13:16:08 -07: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 08:51:56 -07:00
# **downloadLibrary**
2023-04-06 10:50:55 -07:00
> MultipartFile downloadLibrary(name, skip, key)
2022-11-15 08:51:56 -07:00
2023-01-23 20:46:37 -07:00
Current this is not used in any UI element
2023-01-14 22:49:47 -07:00
2022-11-15 08:51:56 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 08:51:56 -07: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 10:50:55 -07:00
final name = name_example; // String |
2022-11-15 08:51:56 -07:00
final skip = 8.14; // num |
2023-02-24 09:01:10 -07:00
final key = key_example; // String |
2022-11-15 08:51:56 -07:00
try {
2023-04-06 10:50:55 -07:00
final result = api_instance.downloadLibrary(name, skip, key);
2022-11-15 08:51:56 -07:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->downloadLibrary: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-04-06 10:50:55 -07:00
**name** | **String** | | [optional]
2022-11-15 08:51:56 -07:00
**skip** | **num** | | [optional]
2023-02-24 09:01:10 -07:00
**key** | **String** | | [optional]
2022-11-15 08:51:56 -07:00
### Return type
2023-02-24 09:01:10 -07:00
[**MultipartFile** ](MultipartFile.md )
2022-11-15 08:51:56 -07:00
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-11-15 08:51:56 -07:00
### HTTP request headers
- **Content-Type**: Not defined
2023-02-24 09:01:10 -07:00
- **Accept**: application/octet-stream
2022-11-15 08:51:56 -07: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 05:23:48 -07:00
# **getAllAssets**
2023-04-12 08:37:52 -07:00
> List<AssetResponseDto> getAllAssets(isFavorite, isArchived, skip, ifNoneMatch)
2022-07-13 05:23:48 -07:00
Get all AssetEntity belong to the user
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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-01-23 21:16:20 -07:00
final isFavorite = true; // bool |
2023-04-12 08:37:52 -07:00
final isArchived = true; // bool |
2023-01-23 21:16:20 -07:00
final skip = 8.14; // num |
2022-11-26 09:16:02 -07:00
final ifNoneMatch = ifNoneMatch_example; // String | ETag of data already cached on the client
2022-07-13 05:23:48 -07:00
try {
2023-04-12 08:37:52 -07:00
final result = api_instance.getAllAssets(isFavorite, isArchived, skip, ifNoneMatch);
2022-07-13 05:23:48 -07:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAllAssets: $e\n');
}
```
### Parameters
2022-11-26 09:16:02 -07:00
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-01-23 21:16:20 -07:00
**isFavorite** | **bool** | | [optional]
2023-04-12 08:37:52 -07:00
**isArchived** | **bool** | | [optional]
2023-01-23 21:16:20 -07:00
**skip** | **num** | | [optional]
2022-11-26 09:16:02 -07:00
**ifNoneMatch** | **String** | ETag of data already cached on the client | [optional]
2022-07-13 05:23:48 -07:00
### Return type
[**List<AssetResponseDto>** ](AssetResponseDto.md )
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07: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 08:37:52 -07: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 09:41:29 -07: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 08:37:52 -07: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 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-04-12 08:37:52 -07: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 05:23:48 -07:00
# **getAssetById**
2023-02-24 09:01:10 -07:00
> AssetResponseDto getAssetById(assetId, key)
2022-07-13 05:23:48 -07:00
Get a single asset's information
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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-04 15:24:08 -07:00
final assetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-24 09:01:10 -07:00
final key = key_example; // String |
2022-07-13 05:23:48 -07:00
try {
2023-02-24 09:01:10 -07:00
final result = api_instance.getAssetById(assetId, key);
2022-07-13 05:23:48 -07:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAssetById: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetId** | **String** | |
2023-02-24 09:01:10 -07:00
**key** | **String** | | [optional]
2022-07-13 05:23:48 -07:00
### Return type
[**AssetResponseDto** ](AssetResponseDto.md )
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07: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 06:34:39 -07:00
# **getAssetByTimeBucket**
> List<AssetResponseDto> getAssetByTimeBucket(getAssetByTimeBucketDto)
2022-08-26 22:53:37 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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-26 22:53:37 -07: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 06:34:39 -07:00
final getAssetByTimeBucketDto = GetAssetByTimeBucketDto(); // GetAssetByTimeBucketDto |
2022-08-26 22:53:37 -07:00
try {
2022-09-04 06:34:39 -07:00
final result = api_instance.getAssetByTimeBucket(getAssetByTimeBucketDto);
2022-08-26 22:53:37 -07:00
print(result);
} catch (e) {
2022-09-04 06:34:39 -07:00
print('Exception when calling AssetApi->getAssetByTimeBucket: $e\n');
2022-08-26 22:53:37 -07:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2022-09-04 06:34:39 -07:00
**getAssetByTimeBucketDto** | [**GetAssetByTimeBucketDto** ](GetAssetByTimeBucketDto.md )| |
2022-08-26 22:53:37 -07:00
### Return type
2022-09-04 06:34:39 -07:00
[**List<AssetResponseDto>** ](AssetResponseDto.md )
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-09-04 06:34:39 -07: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-08 19:26:09 -07: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 09:41:29 -07: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 06:34:39 -07: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-26 22:53:37 -07:00
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-08-26 22:53:37 -07: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 13:16:18 -07:00
# **getAssetCountByUserId**
> AssetCountByUserIdResponseDto getAssetCountByUserId()
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 13:16:18 -07: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 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-09-07 13:16:18 -07: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 05:23:48 -07:00
# **getAssetSearchTerms**
> List<String> getAssetSearchTerms()
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07: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-02-24 09:01:10 -07:00
> MultipartFile getAssetThumbnail(assetId, format, key)
2022-07-13 05:23:48 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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-04 15:24:08 -07:00
final assetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2022-07-15 21:18:17 -07:00
final format = ; // ThumbnailFormat |
2023-02-24 09:01:10 -07:00
final key = key_example; // String |
2022-07-13 05:23:48 -07:00
try {
2023-02-24 09:01:10 -07:00
final result = api_instance.getAssetThumbnail(assetId, format, key);
2022-07-13 05:23:48 -07:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAssetThumbnail: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetId** | **String** | |
2022-07-15 21:18:17 -07:00
**format** | [**ThumbnailFormat** ](.md )| | [optional]
2023-02-24 09:01:10 -07:00
**key** | **String** | | [optional]
2022-07-13 05:23:48 -07:00
### Return type
2023-02-24 09:01:10 -07:00
[**MultipartFile** ](MultipartFile.md )
2022-07-13 05:23:48 -07:00
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07:00
### HTTP request headers
- **Content-Type**: Not defined
2023-02-24 09:01:10 -07:00
- **Accept**: application/octet-stream
2022-07-13 05:23:48 -07: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-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07: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-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07: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-05 18:33:30 -07:00
# **getMapMarkers**
2023-05-20 23:26:06 -07:00
> List<MapMarkerResponseDto> getMapMarkers(isFavorite)
2023-05-05 18:33:30 -07: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 12:59:33 -07: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-05 18:33:30 -07: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 |
try {
2023-05-20 23:26:06 -07:00
final result = api_instance.getMapMarkers(isFavorite);
2023-05-05 18:33:30 -07:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getMapMarkers: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**isFavorite** | **bool** | | [optional]
### Return type
[**List<MapMarkerResponseDto>** ](MapMarkerResponseDto.md )
### Authorization
2023-05-08 12:59:33 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-05-05 18:33:30 -07: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 05:23:48 -07: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-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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-04 15:24:08 -07:00
final deviceId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2022-07-13 05:23:48 -07: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 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07: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 14:21:22 -07:00
# **removeAssetsFromSharedLink**
2023-02-24 09:01:10 -07:00
> SharedLinkResponseDto removeAssetsFromSharedLink(removeAssetsDto, key)
2022-07-13 05:23:48 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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 14:21:22 -07:00
final removeAssetsDto = RemoveAssetsDto(); // RemoveAssetsDto |
2023-02-24 09:01:10 -07:00
final key = key_example; // String |
2022-07-13 05:23:48 -07:00
try {
2023-02-24 09:01:10 -07:00
final result = api_instance.removeAssetsFromSharedLink(removeAssetsDto, key);
2022-07-13 05:23:48 -07:00
print(result);
} catch (e) {
2023-02-15 14:21:22 -07:00
print('Exception when calling AssetApi->removeAssetsFromSharedLink: $e\n');
2022-07-13 05:23:48 -07:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-02-15 14:21:22 -07:00
**removeAssetsDto** | [**RemoveAssetsDto** ](RemoveAssetsDto.md )| |
2023-02-24 09:01:10 -07:00
**key** | **String** | | [optional]
2022-07-13 05:23:48 -07:00
### Return type
2023-02-15 14:21:22 -07:00
[**SharedLinkResponseDto** ](SharedLinkResponseDto.md )
2022-07-13 05:23:48 -07:00
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07: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 14:21:22 -07:00
# **searchAsset**
> List<AssetResponseDto> searchAsset(searchAssetDto)
2022-07-13 05:23:48 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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 14:21:22 -07:00
final searchAssetDto = SearchAssetDto(); // SearchAssetDto |
2022-07-13 05:23:48 -07:00
try {
2023-02-15 14:21:22 -07:00
final result = api_instance.searchAsset(searchAssetDto);
2022-07-13 05:23:48 -07:00
print(result);
} catch (e) {
2023-02-15 14:21:22 -07:00
print('Exception when calling AssetApi->searchAsset: $e\n');
2022-07-13 05:23:48 -07:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-02-15 14:21:22 -07:00
**searchAssetDto** | [**SearchAssetDto** ](SearchAssetDto.md )| |
2022-07-13 05:23:48 -07:00
### Return type
2023-02-15 14:21:22 -07:00
[**List<AssetResponseDto>** ](AssetResponseDto.md )
2022-07-13 05:23:48 -07:00
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07:00
### HTTP request headers
2023-02-15 14:21:22 -07:00
- **Content-Type**: application/json
2022-07-13 05:23:48 -07: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 14:21:22 -07:00
# **serveFile**
2023-02-24 09:01:10 -07:00
> MultipartFile serveFile(assetId, isThumb, isWeb, key)
2023-02-15 14:21:22 -07:00
2022-11-08 09:20:36 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 09:20:36 -07: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-04 15:24:08 -07:00
final assetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-15 14:21:22 -07:00
final isThumb = true; // bool |
final isWeb = true; // bool |
2023-02-24 09:01:10 -07:00
final key = key_example; // String |
2022-11-08 09:20:36 -07:00
try {
2023-02-24 09:01:10 -07:00
final result = api_instance.serveFile(assetId, isThumb, isWeb, key);
2022-11-08 09:20:36 -07:00
print(result);
} catch (e) {
2023-02-15 14:21:22 -07:00
print('Exception when calling AssetApi->serveFile: $e\n');
2022-11-08 09:20:36 -07:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetId** | **String** | |
2023-02-15 14:21:22 -07:00
**isThumb** | **bool** | | [optional]
**isWeb** | **bool** | | [optional]
2023-02-24 09:01:10 -07:00
**key** | **String** | | [optional]
2022-11-08 09:20:36 -07:00
### Return type
2023-02-24 09:01:10 -07:00
[**MultipartFile** ](MultipartFile.md )
2022-11-08 09:20:36 -07:00
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-11-08 09:20:36 -07:00
### HTTP request headers
2023-02-15 14:21:22 -07:00
- **Content-Type**: Not defined
2023-02-24 09:01:10 -07:00
- **Accept**: application/octet-stream
2022-11-08 09:20:36 -07: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 14:21:22 -07:00
# **updateAsset**
> AssetResponseDto updateAsset(assetId, updateAssetDto)
2023-01-14 22:49:47 -07:00
2023-02-15 14:21:22 -07:00
Update an asset
2023-01-14 22:49:47 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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-14 22:49:47 -07: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-04 15:24:08 -07:00
final assetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-15 14:21:22 -07:00
final updateAssetDto = UpdateAssetDto(); // UpdateAssetDto |
2023-01-14 22:49:47 -07:00
try {
2023-02-15 14:21:22 -07:00
final result = api_instance.updateAsset(assetId, updateAssetDto);
2023-01-14 22:49:47 -07:00
print(result);
} catch (e) {
2023-02-15 14:21:22 -07:00
print('Exception when calling AssetApi->updateAsset: $e\n');
2023-01-14 22:49:47 -07:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-02-15 14:21:22 -07:00
**assetId** | **String** | |
**updateAssetDto** | [**UpdateAssetDto** ](UpdateAssetDto.md )| |
2023-01-14 22:49:47 -07:00
### Return type
2023-02-15 14:21:22 -07:00
[**AssetResponseDto** ](AssetResponseDto.md )
2023-01-14 22:49:47 -07:00
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-01-14 22:49:47 -07: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 05:23:48 -07:00
# **uploadFile**
2023-04-12 08:37:52 -07:00
> AssetFileUploadResponseDto uploadFile(assetType, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, fileExtension, key, livePhotoData, isArchived, isVisible, duration)
2022-07-13 05:23:48 -07:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-08 19:26:09 -07: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 09:41:29 -07: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 05:23:48 -07: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-11 22:54:07 -07:00
final assetType = ; // AssetTypeEnum |
2022-07-13 05:23:48 -07:00
final assetData = BINARY_DATA_HERE; // MultipartFile |
2023-02-11 22:54:07 -07:00
final deviceAssetId = deviceAssetId_example; // String |
final deviceId = deviceId_example; // String |
2023-02-19 09:44:53 -07:00
final fileCreatedAt = fileCreatedAt_example; // String |
final fileModifiedAt = fileModifiedAt_example; // String |
2023-02-11 22:54:07 -07:00
final isFavorite = true; // bool |
final fileExtension = fileExtension_example; // String |
2023-02-24 09:01:10 -07:00
final key = key_example; // String |
2023-02-11 22:54:07 -07:00
final livePhotoData = BINARY_DATA_HERE; // MultipartFile |
2023-04-12 08:37:52 -07:00
final isArchived = true; // bool |
2023-02-11 22:54:07 -07:00
final isVisible = true; // bool |
final duration = duration_example; // String |
2022-07-13 05:23:48 -07:00
try {
2023-04-12 08:37:52 -07:00
final result = api_instance.uploadFile(assetType, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, fileExtension, key, livePhotoData, isArchived, isVisible, duration);
2022-07-13 05:23:48 -07:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->uploadFile: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-02-11 22:54:07 -07:00
**assetType** | [**AssetTypeEnum** ](AssetTypeEnum.md )| |
2022-07-13 05:23:48 -07:00
**assetData** | **MultipartFile** | |
2023-02-11 22:54:07 -07:00
**deviceAssetId** | **String** | |
**deviceId** | **String** | |
2023-02-19 09:44:53 -07:00
**fileCreatedAt** | **String** | |
**fileModifiedAt** | **String** | |
2023-02-11 22:54:07 -07:00
**isFavorite** | **bool** | |
**fileExtension** | **String** | |
2023-02-24 09:01:10 -07:00
**key** | **String** | | [optional]
2023-02-11 22:54:07 -07:00
**livePhotoData** | **MultipartFile** | | [optional]
2023-04-12 08:37:52 -07:00
**isArchived** | **bool** | | [optional]
2023-02-11 22:54:07 -07:00
**isVisible** | **bool** | | [optional]
**duration** | **String** | | [optional]
2022-07-13 05:23:48 -07:00
### Return type
[**AssetFileUploadResponseDto** ](AssetFileUploadResponseDto.md )
### Authorization
2023-05-04 09:41:29 -07:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 05:23:48 -07: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)