Function QualityApiFp

Returns {
    qualityCreateReport(rqId?, qualityReportCreateRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<QualityReport>)>;
    qualityListConflicts(xOrganization?, filter?, frame?, jobId?, org?, orgId?, page?, pageSize?, reportId?, severity?, sort?, taskId?, type?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedAnnotationConflictList>)>;
    qualityListReports(xOrganization?, filter?, jobId?, org?, orgId?, page?, pageSize?, parentId?, sort?, target?, taskId?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedQualityReportList>)>;
    qualityListSettings(xOrganization?, filter?, org?, orgId?, page?, pageSize?, sort?, taskId?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedQualitySettingsList>)>;
    qualityPartialUpdateSettings(id, patchedQualitySettingsRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<QualitySettings>)>;
    qualityRetrieveReport(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<QualityReport>)>;
    qualityRetrieveReportData(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<object>)>;
    qualityRetrieveSettings(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<QualitySettings>)>;
}

• qualityCreateReport:function

  • qualityCreateReport(rqId?, qualityReportCreateRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<QualityReport>)>

  • Parameters

    • Optional rqId: string

      The report creation request id. Can be specified to check the report creation status.

    • Optional qualityReportCreateRequest: QualityReportCreateRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<QualityReport>)>

    Summary

    Creates a quality report asynchronously and allows to check request status

    Throws

• qualityListConflicts:function

  • qualityListConflicts(xOrganization?, filter?, frame?, jobId?, org?, orgId?, page?, pageSize?, reportId?, severity?, sort?, taskId?, type?, options?): Promise<((axios?, basePath?) => AxiosPromise<PaginatedAnnotationConflictList>)>

  • Parameters

    • Optional xOrganization: string

      Organization unique slug

    • Optional filter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;id&#39;, &#39;frame&#39;, &#39;type&#39;, &#39;job_id&#39;, &#39;task_id&#39;, &#39;severity&#39;].

    • Optional frame: number

      A simple equality filter for the frame field

    • Optional jobId: number

      A simple equality filter for the job_id field

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • Optional page: number

      A page number within the paginated result set.

    • Optional pageSize: number

      Number of results to return per page.

    • Optional reportId: number

      A simple equality filter for report id

    • Optional severity: QualityListConflictsSeverityEnum

      A simple equality filter for the severity field

    • Optional sort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;id&#39;, &#39;frame&#39;, &#39;type&#39;, &#39;job_id&#39;, &#39;task_id&#39;, &#39;severity&#39;]

    • Optional taskId: number

      A simple equality filter for the task_id field

    • Optional type: QualityListConflictsTypeEnum

      A simple equality filter for the type field

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PaginatedAnnotationConflictList>)>

    Summary

    Method returns a paginated list of annotation conflicts

    Throws

• qualityListReports:function

  • qualityListReports(xOrganization?, filter?, jobId?, org?, orgId?, page?, pageSize?, parentId?, sort?, target?, taskId?, options?): Promise<((axios?, basePath?) => AxiosPromise<PaginatedQualityReportList>)>

  • Parameters

    • Optional xOrganization: string

      Organization unique slug

    • Optional filter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;id&#39;, &#39;job_id&#39;, &#39;created_date&#39;, &#39;gt_last_updated&#39;, &#39;target_last_updated&#39;, &#39;parent_id&#39;].

    • Optional jobId: number

      A simple equality filter for the job_id field

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • Optional page: number

      A page number within the paginated result set.

    • Optional pageSize: number

      Number of results to return per page.

    • Optional parentId: number

      A simple equality filter for the parent_id field

    • Optional sort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;id&#39;, &#39;job_id&#39;, &#39;created_date&#39;, &#39;gt_last_updated&#39;, &#39;target_last_updated&#39;, &#39;parent_id&#39;]

    • Optional target: string

      A simple equality filter for target

    • Optional taskId: number

      A simple equality filter for task id

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PaginatedQualityReportList>)>

    Summary

    Method returns a paginated list of quality reports

    Throws

• qualityListSettings:function

  • qualityListSettings(xOrganization?, filter?, org?, orgId?, page?, pageSize?, sort?, taskId?, options?): Promise<((axios?, basePath?) => AxiosPromise<PaginatedQualitySettingsList>)>

  • Parameters

    • Optional xOrganization: string

      Organization unique slug

    • Optional filter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;id&#39;, &#39;task_id&#39;].

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • Optional page: number

      A page number within the paginated result set.

    • Optional pageSize: number

      Number of results to return per page.

    • Optional sort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;id&#39;]

    • Optional taskId: number

      A simple equality filter for the task_id field

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PaginatedQualitySettingsList>)>

    Summary

    Method returns a paginated list of quality settings instances

    Throws

• qualityPartialUpdateSettings:function

  • qualityPartialUpdateSettings(id, patchedQualitySettingsRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<QualitySettings>)>

  • Parameters

    • id: number

      An id of a quality settings instance

    • Optional patchedQualitySettingsRequest: PatchedQualitySettingsRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<QualitySettings>)>

    Summary

    Methods does a partial update of chosen fields in the quality settings instance

    Throws

• qualityRetrieveReport:function

  • qualityRetrieveReport(id, options?): Promise<((axios?, basePath?) => AxiosPromise<QualityReport>)>

  • Parameters

    • id: number

      A unique integer value identifying this quality report.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<QualityReport>)>

    Summary

    Method returns details of a quality report

    Throws

• qualityRetrieveReportData:function

  • qualityRetrieveReportData(id, options?): Promise<((axios?, basePath?) => AxiosPromise<object>)>

  • Parameters

    • id: number

      A unique integer value identifying this quality report.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<object>)>

    Summary

    Retrieve full contents of the report in JSON format

    Throws

• qualityRetrieveSettings:function

  • qualityRetrieveSettings(id, options?): Promise<((axios?, basePath?) => AxiosPromise<QualitySettings>)>

  • Parameters

    • id: number

      An id of a quality settings instance

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<QualitySettings>)>

    Summary

    Method returns details of the quality settings instance

    Throws