mirror of
https://github.com/immich-app/immich.git
synced 2024-12-22 01:47:08 +02:00
4cfac47674
* refactor(server): job repository * refactor: job repository * chore: generate open-api * fix: job panel * Remove incorrect subtitle Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
112 lines
2.8 KiB
Markdown
Generated
112 lines
2.8 KiB
Markdown
Generated
# openapi.api.JobApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:openapi/api.dart';
|
|
```
|
|
|
|
All URIs are relative to */api*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**getAllJobsStatus**](JobApi.md#getalljobsstatus) | **GET** /jobs |
|
|
[**sendJobCommand**](JobApi.md#sendjobcommand) | **PUT** /jobs/{jobId} |
|
|
|
|
|
|
# **getAllJobsStatus**
|
|
> AllJobStatusResponseDto getAllJobsStatus()
|
|
|
|
|
|
|
|
|
|
|
|
### 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 = JobApi();
|
|
|
|
try {
|
|
final result = api_instance.getAllJobsStatus();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling JobApi->getAllJobsStatus: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**AllJobStatusResponseDto**](AllJobStatusResponseDto.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)
|
|
|
|
# **sendJobCommand**
|
|
> num sendJobCommand(jobId, jobCommandDto)
|
|
|
|
|
|
|
|
|
|
|
|
### 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 = JobApi();
|
|
final jobId = ; // JobId |
|
|
final jobCommandDto = JobCommandDto(); // JobCommandDto |
|
|
|
|
try {
|
|
final result = api_instance.sendJobCommand(jobId, jobCommandDto);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling JobApi->sendJobCommand: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**jobId** | [**JobId**](.md)| |
|
|
**jobCommandDto** | [**JobCommandDto**](JobCommandDto.md)| |
|
|
|
|
### Return type
|
|
|
|
**num**
|
|
|
|
### 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)
|
|
|