Interface ReportsAPI

interface ReportsAPI {
    clearCache: () => void;
    createReport: (
        body: ReportRequest,
        options?: ApiCallOptions,
    ) => Promise<CreateReportHttpResponse>;
    getReportOutputs: (
        id: string,
        query: {
            filter?: string;
            limit?: number;
            page?: string;
            sort?: ("+outputId" | "-outputId" | "+sizeBytes" | "-sizeBytes")[];
        },
        options?: ApiCallOptions,
    ) => Promise<GetReportOutputsHttpResponse>;
    getReportStatus: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetReportStatusHttpResponse>;
}
Index

Properties

clearCache createReport getReportOutputs getReportStatus

Properties

clearCache: () => void

Clears the cache for reports api requests.

Type Declaration

    • (): void

    • Clears the cache for reports api requests.

      Returns void

createReport: (
    body: ReportRequest,
    options?: ApiCallOptions,
) => Promise<CreateReportHttpResponse>

Queue a new report request generation.

Type Declaration

Param: body

an object with the body content

CreateReportHttpError

getReportOutputs: (
    id: string,
    query: {
        filter?: string;
        limit?: number;
        page?: string;
        sort?: ("+outputId" | "-outputId" | "+sizeBytes" | "-sizeBytes")[];
    },
    options?: ApiCallOptions,
) => Promise<GetReportOutputsHttpResponse>

Get the list of the outputs produced so far for the given report request. The outputs are generated asynchronously and are complete only when the status of the report request is 'done' or 'failed' or 'aborted'.

Type Declaration

    • (
          id: string,
          query: {
              filter?: string;
              limit?: number;
              page?: string;
              sort?: ("+outputId" | "-outputId" | "+sizeBytes" | "-sizeBytes")[];
          },
          options?: ApiCallOptions,
      ): Promise<GetReportOutputsHttpResponse>

    • Get the list of the outputs produced so far for the given report request. The outputs are generated asynchronously and are complete only when the status of the report request is 'done' or 'failed' or 'aborted'.

      Parameters

      • id: string

        Identifier of the request.

      • query: {
            filter?: string;
            limit?: number;
            page?: string;
            sort?: ("+outputId" | "-outputId" | "+sizeBytes" | "-sizeBytes")[];
        }

        an object with query parameters

        • Optionalfilter?: string

          The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive. The following fields support the eq (equals) operator: outputId Example: outputId eq "123" or outputId eq "321"

        • Optionallimit?: number

          Limit the returned result set

        • Optionalpage?: string

          If present, the cursor that starts the page of data that is returned.

        • Optionalsort?: ("+outputId" | "-outputId" | "+sizeBytes" | "-sizeBytes")[]

          Sorting parameters

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetReportOutputsHttpResponse>

      GetReportOutputsHttpError

Identifier of the request.

an object with query parameters

GetReportOutputsHttpError

getReportStatus: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetReportStatusHttpResponse>

Get report request processing status.

Type Declaration

Identifier of the request.

GetReportStatusHttpError

Settings

Member Visibility

On This Page

Properties