immich/mobile/openapi/doc/JobApi.md

openapi.api.JobApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
getAllJobsStatus	GET /jobs
getJobStatus	GET /jobs/{jobId}
sendJobCommand	PUT /jobs/{jobId}

getAllJobsStatus

AllJobStatusResponseDto getAllJobsStatus()

Example

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

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getJobStatus

JobStatusResponseDto getJobStatus(jobId)

Example

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 | 

try {
    final result = api_instance.getJobStatus(jobId);
    print(result);
} catch (e) {
    print('Exception when calling JobApi->getJobStatus: $e\n');
}

Parameters

Name	Type	Description	Notes
jobId	JobId

Return type

JobStatusResponseDto

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sendJobCommand

num sendJobCommand(jobId, jobCommandDto)

Example

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
jobCommandDto	JobCommandDto

Return type

num

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]