367 lines
8.6 KiB
Markdown
367 lines
8.6 KiB
Markdown
# JobService
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
|Method | HTTP request | Description|
|
|
|------------- | ------------- | -------------|
|
|
|[**getAllJobs**](#getalljobs) | **GET** /api/jobs | Get status of all Jobs|
|
|
|[**getCardPrintImportJobPage**](#getcardprintimportjobpage) | **GET** /api/jobs/cardPrintImports | Get a page of all CardSetImportJobs|
|
|
|[**getCardPrintImportJobStatusById**](#getcardprintimportjobstatusbyid) | **GET** /api/jobs/cardPrintImport/{id} | Get status of CardPrintImportJob|
|
|
|[**getCardSetImportJobPage**](#getcardsetimportjobpage) | **GET** /api/jobs/cardSetImports | Get a page of all CardSetImportJobs|
|
|
|[**getCardSetImportJobStatusById**](#getcardsetimportjobstatusbyid) | **GET** /api/jobs/cardSetImport/{id} | Get status of CardSetImportJob|
|
|
|[**getRegionalSetImportJobPage**](#getregionalsetimportjobpage) | **GET** /api/jobs/regionalSetImports | Get a page of all CardSetImportJobs|
|
|
|[**getRegionalSetImportJobStatusById**](#getregionalsetimportjobstatusbyid) | **GET** /api/jobs/regionalSetImport/{id} | Get status of RegionalSetImportJob|
|
|
|
|
# **getAllJobs**
|
|
> Array<JobDto> getAllJobs()
|
|
|
|
|
|
### Example
|
|
|
|
```typescript
|
|
import {
|
|
JobService,
|
|
Configuration
|
|
} from './api';
|
|
|
|
const configuration = new Configuration();
|
|
const apiInstance = new JobService(configuration);
|
|
|
|
const { status, data } = await apiInstance.getAllJobs();
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not have any parameters.
|
|
|
|
|
|
### Return type
|
|
|
|
**Array<JobDto>**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
|
|
### HTTP response details
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
|**200** | OK | - |
|
|
|
|
[[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)
|
|
|
|
# **getCardPrintImportJobPage**
|
|
> PageJobDto getCardPrintImportJobPage()
|
|
|
|
|
|
### Example
|
|
|
|
```typescript
|
|
import {
|
|
JobService,
|
|
Configuration
|
|
} from './api';
|
|
|
|
const configuration = new Configuration();
|
|
const apiInstance = new JobService(configuration);
|
|
|
|
let page: number; // (optional) (default to undefined)
|
|
let pageSize: number; // (optional) (default to undefined)
|
|
|
|
const { status, data } = await apiInstance.getCardPrintImportJobPage(
|
|
page,
|
|
pageSize
|
|
);
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes|
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **page** | [**number**] | | (optional) defaults to undefined|
|
|
| **pageSize** | [**number**] | | (optional) defaults to undefined|
|
|
|
|
|
|
### Return type
|
|
|
|
**PageJobDto**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
|
|
### HTTP response details
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
|**200** | OK | - |
|
|
|
|
[[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)
|
|
|
|
# **getCardPrintImportJobStatusById**
|
|
> JobDto getCardPrintImportJobStatusById()
|
|
|
|
|
|
### Example
|
|
|
|
```typescript
|
|
import {
|
|
JobService,
|
|
Configuration
|
|
} from './api';
|
|
|
|
const configuration = new Configuration();
|
|
const apiInstance = new JobService(configuration);
|
|
|
|
let id: number; // (default to undefined)
|
|
|
|
const { status, data } = await apiInstance.getCardPrintImportJobStatusById(
|
|
id
|
|
);
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes|
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **id** | [**number**] | | defaults to undefined|
|
|
|
|
|
|
### Return type
|
|
|
|
**JobDto**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
|
|
### HTTP response details
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
|**200** | OK | - |
|
|
|
|
[[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)
|
|
|
|
# **getCardSetImportJobPage**
|
|
> PageJobDto getCardSetImportJobPage()
|
|
|
|
|
|
### Example
|
|
|
|
```typescript
|
|
import {
|
|
JobService,
|
|
Configuration
|
|
} from './api';
|
|
|
|
const configuration = new Configuration();
|
|
const apiInstance = new JobService(configuration);
|
|
|
|
let page: number; // (optional) (default to undefined)
|
|
let pageSize: number; // (optional) (default to undefined)
|
|
|
|
const { status, data } = await apiInstance.getCardSetImportJobPage(
|
|
page,
|
|
pageSize
|
|
);
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes|
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **page** | [**number**] | | (optional) defaults to undefined|
|
|
| **pageSize** | [**number**] | | (optional) defaults to undefined|
|
|
|
|
|
|
### Return type
|
|
|
|
**PageJobDto**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
|
|
### HTTP response details
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
|**200** | OK | - |
|
|
|
|
[[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)
|
|
|
|
# **getCardSetImportJobStatusById**
|
|
> JobDto getCardSetImportJobStatusById()
|
|
|
|
|
|
### Example
|
|
|
|
```typescript
|
|
import {
|
|
JobService,
|
|
Configuration
|
|
} from './api';
|
|
|
|
const configuration = new Configuration();
|
|
const apiInstance = new JobService(configuration);
|
|
|
|
let id: number; // (default to undefined)
|
|
|
|
const { status, data } = await apiInstance.getCardSetImportJobStatusById(
|
|
id
|
|
);
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes|
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **id** | [**number**] | | defaults to undefined|
|
|
|
|
|
|
### Return type
|
|
|
|
**JobDto**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
|
|
### HTTP response details
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
|**200** | OK | - |
|
|
|
|
[[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)
|
|
|
|
# **getRegionalSetImportJobPage**
|
|
> PageJobDto getRegionalSetImportJobPage()
|
|
|
|
|
|
### Example
|
|
|
|
```typescript
|
|
import {
|
|
JobService,
|
|
Configuration
|
|
} from './api';
|
|
|
|
const configuration = new Configuration();
|
|
const apiInstance = new JobService(configuration);
|
|
|
|
let page: number; // (optional) (default to undefined)
|
|
let pageSize: number; // (optional) (default to undefined)
|
|
|
|
const { status, data } = await apiInstance.getRegionalSetImportJobPage(
|
|
page,
|
|
pageSize
|
|
);
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes|
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **page** | [**number**] | | (optional) defaults to undefined|
|
|
| **pageSize** | [**number**] | | (optional) defaults to undefined|
|
|
|
|
|
|
### Return type
|
|
|
|
**PageJobDto**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
|
|
### HTTP response details
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
|**200** | OK | - |
|
|
|
|
[[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)
|
|
|
|
# **getRegionalSetImportJobStatusById**
|
|
> JobDto getRegionalSetImportJobStatusById()
|
|
|
|
|
|
### Example
|
|
|
|
```typescript
|
|
import {
|
|
JobService,
|
|
Configuration
|
|
} from './api';
|
|
|
|
const configuration = new Configuration();
|
|
const apiInstance = new JobService(configuration);
|
|
|
|
let id: number; // (default to undefined)
|
|
|
|
const { status, data } = await apiInstance.getRegionalSetImportJobStatusById(
|
|
id
|
|
);
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes|
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **id** | [**number**] | | defaults to undefined|
|
|
|
|
|
|
### Return type
|
|
|
|
**JobDto**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
|
|
### HTTP response details
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
|**200** | OK | - |
|
|
|
|
[[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)
|
|
|