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
------------- | ------------- | -------------
[**checkDuplicateAsset** ](AssetApi.md#checkduplicateasset ) | **POST** /asset/check |
2022-10-25 16:51:03 +02:00
[**checkExistingAssets** ](AssetApi.md#checkexistingassets ) | **POST** /asset/exist |
2022-07-13 14:23:48 +02:00
[**deleteAsset** ](AssetApi.md#deleteasset ) | **DELETE** /asset |
2022-11-16 08:11:16 +02:00
[**downloadFile** ](AssetApi.md#downloadfile ) | **GET** /asset/download/{assetId} |
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 |
[**getAssetById** ](AssetApi.md#getassetbyid ) | **GET** /asset/assetById/{assetId} |
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 |
2022-07-13 14:23:48 +02:00
[**getAssetThumbnail** ](AssetApi.md#getassetthumbnail ) | **GET** /asset/thumbnail/{assetId} |
2022-08-27 07:53:37 +02:00
[**getCuratedLocations** ](AssetApi.md#getcuratedlocations ) | **GET** /asset/curated-locations |
[**getCuratedObjects** ](AssetApi.md#getcuratedobjects ) | **GET** /asset/curated-objects |
2022-07-13 14:23:48 +02:00
[**getUserAssetsByDeviceId** ](AssetApi.md#getuserassetsbydeviceid ) | **GET** /asset/{deviceId} |
[**searchAsset** ](AssetApi.md#searchasset ) | **POST** /asset/search |
2022-11-16 08:11:16 +02:00
[**serveFile** ](AssetApi.md#servefile ) | **GET** /asset/file/{assetId} |
2022-12-05 19:56:44 +02:00
[**updateAsset** ](AssetApi.md#updateasset ) | **PUT** /asset/{assetId} |
2022-07-13 14:23:48 +02:00
[**uploadFile** ](AssetApi.md#uploadfile ) | **POST** /asset/upload |
# **checkDuplicateAsset**
> CheckDuplicateAssetResponseDto checkDuplicateAsset(checkDuplicateAssetDto)
Check duplicated asset before uploading - for Web upload used
### Example
```dart
import 'package:openapi/api.dart';
// 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 |
try {
final result = api_instance.checkDuplicateAsset(checkDuplicateAssetDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->checkDuplicateAsset: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**checkDuplicateAssetDto** | [**CheckDuplicateAssetDto** ](CheckDuplicateAssetDto.md )| |
### Return type
[**CheckDuplicateAssetResponseDto** ](CheckDuplicateAssetResponseDto.md )
### Authorization
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
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';
// 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
[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
# **deleteAsset**
> List<DeleteAssetResponseDto> deleteAsset(deleteAssetDto)
### Example
```dart
import 'package:openapi/api.dart';
// 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
[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)
# **downloadFile**
2022-11-16 08:11:16 +02:00
> Object downloadFile(assetId, isThumb, isWeb)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
// 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-11-16 08:11:16 +02:00
final assetId = assetId_example; // String |
2022-07-13 14:23:48 +02:00
final isThumb = true; // bool |
final isWeb = true; // bool |
try {
2022-11-16 08:11:16 +02:00
final result = api_instance.downloadFile(assetId, isThumb, isWeb);
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
------------- | ------------- | ------------- | -------------
2022-11-16 08:11:16 +02:00
**assetId** | **String** | |
2022-07-13 14:23:48 +02:00
**isThumb** | **bool** | | [optional]
**isWeb** | **bool** | | [optional]
### Return type
[**Object** ](Object.md )
### Authorization
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2022-11-15 17:51:56 +02:00
# **downloadLibrary**
> Object downloadLibrary(skip)
### Example
```dart
import 'package:openapi/api.dart';
// 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 skip = 8.14; // num |
try {
final result = api_instance.downloadLibrary(skip);
print(result);
} catch (e) {
print('Exception when calling AssetApi->downloadLibrary: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**skip** | **num** | | [optional]
### Return type
[**Object** ](Object.md )
### Authorization
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2022-07-13 14:23:48 +02:00
# **getAllAssets**
2022-11-26 18:16:02 +02:00
> List<AssetResponseDto> getAllAssets(ifNoneMatch)
2022-07-13 14:23:48 +02:00
Get all AssetEntity belong to the user
### Example
```dart
import 'package:openapi/api.dart';
// 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-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 {
2022-11-26 18:16:02 +02:00
final result = api_instance.getAllAssets(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
------------- | ------------- | ------------- | -------------
**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
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getAssetById**
> AssetResponseDto getAssetById(assetId)
Get a single asset's information
### Example
```dart
import 'package:openapi/api.dart';
// 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 assetId = assetId_example; // String |
try {
final result = api_instance.getAssetById(assetId);
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAssetById: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetId** | **String** | |
### Return type
[**AssetResponseDto** ](AssetResponseDto.md )
### Authorization
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
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';
// 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
[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)
# **getAssetCountByTimeBucket**
> AssetCountByTimeBucketResponseDto getAssetCountByTimeBucket(getAssetCountByTimeBucketDto)
### Example
```dart
import 'package:openapi/api.dart';
// 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
[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-09-07 22:16:18 +02:00
# **getAssetCountByUserId**
> AssetCountByUserIdResponseDto getAssetCountByUserId()
### Example
```dart
import 'package:openapi/api.dart';
// 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
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2022-07-13 14:23:48 +02:00
# **getAssetSearchTerms**
> List<String> getAssetSearchTerms()
### Example
```dart
import 'package:openapi/api.dart';
// 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
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getAssetThumbnail**
2022-07-16 06:18:17 +02:00
> Object getAssetThumbnail(assetId, format)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
// 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 assetId = assetId_example; // String |
2022-07-16 06:18:17 +02:00
final format = ; // ThumbnailFormat |
2022-07-13 14:23:48 +02:00
try {
2022-07-16 06:18:17 +02:00
final result = api_instance.getAssetThumbnail(assetId, format);
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
------------- | ------------- | ------------- | -------------
**assetId** | **String** | |
2022-07-16 06:18:17 +02:00
**format** | [**ThumbnailFormat** ](.md )| | [optional]
2022-07-13 14:23:48 +02:00
### Return type
[**Object** ](Object.md )
### Authorization
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getCuratedLocations**
> List<CuratedLocationsResponseDto> getCuratedLocations()
### Example
```dart
import 'package:openapi/api.dart';
// 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
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **getCuratedObjects**
> List<CuratedObjectsResponseDto> getCuratedObjects()
### Example
```dart
import 'package:openapi/api.dart';
// 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
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **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';
// 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 deviceId = deviceId_example; // String |
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
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **searchAsset**
> List<AssetResponseDto> searchAsset(searchAssetDto)
### Example
```dart
import 'package:openapi/api.dart';
// 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 searchAssetDto = SearchAssetDto(); // SearchAssetDto |
try {
final result = api_instance.searchAsset(searchAssetDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->searchAsset: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**searchAssetDto** | [**SearchAssetDto** ](SearchAssetDto.md )| |
### Return type
[**List<AssetResponseDto>** ](AssetResponseDto.md )
### Authorization
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **serveFile**
2022-11-16 08:11:16 +02:00
> Object serveFile(assetId, isThumb, isWeb)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
// 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-11-16 08:11:16 +02:00
final assetId = assetId_example; // String |
2022-07-13 14:23:48 +02:00
final isThumb = true; // bool |
final isWeb = true; // bool |
try {
2022-11-16 08:11:16 +02:00
final result = api_instance.serveFile(assetId, isThumb, isWeb);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->serveFile: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2022-11-16 08:11:16 +02:00
**assetId** | **String** | |
2022-07-13 14:23:48 +02:00
**isThumb** | **bool** | | [optional]
**isWeb** | **bool** | | [optional]
### Return type
[**Object** ](Object.md )
### Authorization
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2022-12-05 19:56:44 +02:00
# **updateAsset**
> AssetResponseDto updateAsset(assetId, updateAssetDto)
2022-11-08 18:20:36 +02:00
Update an asset
### Example
```dart
import 'package:openapi/api.dart';
// 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 assetId = assetId_example; // String |
final updateAssetDto = UpdateAssetDto(); // UpdateAssetDto |
try {
2022-12-05 19:56:44 +02:00
final result = api_instance.updateAsset(assetId, updateAssetDto);
2022-11-08 18:20:36 +02:00
print(result);
} catch (e) {
2022-12-05 19:56:44 +02:00
print('Exception when calling AssetApi->updateAsset: $e\n');
2022-11-08 18:20:36 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetId** | **String** | |
**updateAssetDto** | [**UpdateAssetDto** ](UpdateAssetDto.md )| |
### Return type
[**AssetResponseDto** ](AssetResponseDto.md )
### Authorization
[bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2022-07-13 14:23:48 +02:00
# **uploadFile**
> AssetFileUploadResponseDto uploadFile(assetData)
### Example
```dart
import 'package:openapi/api.dart';
// 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 assetData = BINARY_DATA_HERE; // MultipartFile |
try {
final result = api_instance.uploadFile(assetData);
print(result);
} catch (e) {
print('Exception when calling AssetApi->uploadFile: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetData** | **MultipartFile** | |
### Return type
[**AssetFileUploadResponseDto** ](AssetFileUploadResponseDto.md )
### Authorization
[bearer ](../README.md#bearer )
### 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)