65 lines
2.3 KiB
Markdown
65 lines
2.3 KiB
Markdown
# holzleitner_api.api.AttachmentsApi
|
||
|
||
## Load the API package
|
||
```dart
|
||
import 'package:holzleitner_api/api.dart';
|
||
```
|
||
|
||
All URIs are relative to *http://localhost*
|
||
|
||
Method | HTTP request | Description
|
||
------------- | ------------- | -------------
|
||
[**getAttachment**](AttachmentsApi.md#getattachment) | **GET** /attachments/{id} | Liefert ein gerendertes Vorschaubild des Attachments (Bytes), geladen aus DOCUframe. Auflösung/Format über Query-Parameter steuerbar (`?w=&h=&q=&ext=&page=`).
|
||
|
||
|
||
# **getAttachment**
|
||
> getAttachment(id, w, h, q, ext, page)
|
||
|
||
Liefert ein gerendertes Vorschaubild des Attachments (Bytes), geladen aus DOCUframe. Auflösung/Format über Query-Parameter steuerbar (`?w=&h=&q=&ext=&page=`).
|
||
|
||
### Example
|
||
```dart
|
||
import 'package:holzleitner_api/api.dart';
|
||
|
||
final api = HolzleitnerApi().getAttachmentsApi();
|
||
final String id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Attachment-Id (unsere UUID)
|
||
final int w = 56; // int | Breite in Pixeln (Default 1024)
|
||
final int h = 56; // int | Höhe in Pixeln (Default 1024)
|
||
final int q = 56; // int | Qualität 0–100 (Default 85)
|
||
final String ext = ext_example; // String | png|jpeg|jpg|webp|tiff (Default jpeg)
|
||
final String page = page_example; // String | Seitennummer (Default 1)
|
||
|
||
try {
|
||
api.getAttachment(id, w, h, q, ext, page);
|
||
} catch on DioException (e) {
|
||
print('Exception when calling AttachmentsApi->getAttachment: $e\n');
|
||
}
|
||
```
|
||
|
||
### Parameters
|
||
|
||
Name | Type | Description | Notes
|
||
------------- | ------------- | ------------- | -------------
|
||
**id** | **String**| Attachment-Id (unsere UUID) |
|
||
**w** | **int**| Breite in Pixeln (Default 1024) | [optional]
|
||
**h** | **int**| Höhe in Pixeln (Default 1024) | [optional]
|
||
**q** | **int**| Qualität 0–100 (Default 85) | [optional]
|
||
**ext** | **String**| png|jpeg|jpg|webp|tiff (Default jpeg) | [optional]
|
||
**page** | **String**| Seitennummer (Default 1) | [optional]
|
||
|
||
### Return type
|
||
|
||
void (empty response body)
|
||
|
||
### Authorization
|
||
|
||
[bearer_auth](../README.md#bearer_auth)
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: Not defined
|
||
- **Accept**: image/jpeg
|
||
|
||
[[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)
|
||
|