dex-ui-vue/src/api/openapi/docs/JobService.md

JobService

All URIs are relative to http://localhost

Method	HTTP request	Description
getAllJobs	GET /api/jobs	Get status of all Jobs
getCardPrintImportJobPage	GET /api/jobs/cardPrintImports	Get a page of all CardSetImportJobs
getCardPrintImportJobStatusById	GET /api/jobs/cardPrintImport/{id}	Get status of CardPrintImportJob
getCardSetImportJobPage	GET /api/jobs/cardSetImports	Get a page of all CardSetImportJobs
getCardSetImportJobStatusById	GET /api/jobs/cardSetImport/{id}	Get status of CardSetImportJob
getRegionalSetImportJobPage	GET /api/jobs/regionalSetImports	Get a page of all CardSetImportJobs
getRegionalSetImportJobStatusById	GET /api/jobs/regionalSetImport/{id}	Get status of RegionalSetImportJob

getAllJobs

Array getAllJobs()

Example

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

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] [Back to Model list] [Back to README]

getCardPrintImportJobPage

PageJobDto getCardPrintImportJobPage()

Example

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] [Back to Model list] [Back to README]

getCardPrintImportJobStatusById

JobDto getCardPrintImportJobStatusById()

Example

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] [Back to Model list] [Back to README]

getCardSetImportJobPage

PageJobDto getCardSetImportJobPage()

Example

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] [Back to Model list] [Back to README]

getCardSetImportJobStatusById

JobDto getCardSetImportJobStatusById()

Example

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] [Back to Model list] [Back to README]

getRegionalSetImportJobPage

PageJobDto getRegionalSetImportJobPage()

Example

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] [Back to Model list] [Back to README]

getRegionalSetImportJobStatusById

JobDto getRegionalSetImportJobStatusById()

Example

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] [Back to Model list] [Back to README]