JobAnalysisApi

JobAnalysisApi - object-oriented interface

Export

JobAnalysisApi

Extends

  • BaseAPI

Constructors

Constructor

new JobAnalysisApi(configuration?, basePath?, axios?): JobAnalysisApi

Parameters

configuration?

basePath?

string = BASE_PATH

axios?

AxiosInstance = globalAxios

Returns

JobAnalysisApi

Inherited from

BaseAPI.constructor

Properties

axios

protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios


basePath

protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath


configuration

protected configuration: Configuration | undefined

Inherited from

BaseAPI.configuration

Methods

apiV1JobsJobIdAnalyzeAnalysisIdGet()

apiV1JobsJobIdAnalyzeAnalysisIdGet(jobId, analysisId, options?): Promise<AxiosResponse<JobAnalysisResponseDTO, any, { }>>

Parameters

jobId

string

analysisId

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<JobAnalysisResponseDTO, any, { }>>

Throws

Memberof

JobAnalysisApi


apiV1JobsJobIdAnalyzeDelete()

apiV1JobsJobIdAnalyzeDelete(jobId, options?): Promise<AxiosResponse<void, any, { }>>

Parameters

jobId

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<void, any, { }>>

Throws

Memberof

JobAnalysisApi


apiV1JobsJobIdAnalyzeGet()

apiV1JobsJobIdAnalyzeGet(jobId, options?): Promise<AxiosResponse<JobAnalysisListResponseDTO, any, { }>>

Parameters

jobId

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<JobAnalysisListResponseDTO, any, { }>>

Throws

Memberof

JobAnalysisApi


apiV1JobsJobIdAnalyzePost()

apiV1JobsJobIdAnalyzePost(jobId, force?, sync?, syncTimeoutSeconds?, jobAnalysisRequestDTO?, options?): Promise<AxiosResponse<JobAnalysisResponseDTO, any, { }>>

Parameters

jobId

string

force?

boolean

sync?

boolean

syncTimeoutSeconds?

number

jobAnalysisRequestDTO?

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<JobAnalysisResponseDTO, any, { }>>

Throws

Memberof

JobAnalysisApi

Found a mistake? Let us know.

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.