Interface DataSetsAPI

interface DataSetsAPI {
    clearCache: () => void;
    createDataSet: (
        body: DataSet,
        options?: ApiCallOptions,
    ) => Promise<CreateDataSetHttpResponse>;
    deleteDataSets: (
        body: BatchIdDto,
        options?: ApiCallOptions,
    ) => Promise<DeleteDataSetsHttpResponse>;
    getDataSet: (
        dataSetId: string,
        query: { projections?: string[] },
        options?: ApiCallOptions,
    ) => Promise<GetDataSetHttpResponse>;
    getDataSetProfiles: (
        dataSetId: string,
        query: {
            dataConnectionIds?: string[];
            limit?: number;
            page?: number;
            projections?: string[];
            sort?: string[];
        },
        options?: ApiCallOptions,
    ) => Promise<GetDataSetProfilesHttpResponse>;
    patchDataSet: (
        dataSetId: string,
        body: JsonPatch[],
        options?: ApiCallOptions,
    ) => Promise<PatchDataSetHttpResponse>;
    updateDataSet: (
        dataSetId: string,
        body: DataSet,
        options?: ApiCallOptions,
    ) => Promise<UpdateDataSetHttpResponse>;
}
Index

Properties

clearCache createDataSet deleteDataSets getDataSet getDataSetProfiles patchDataSet updateDataSet

Properties

clearCache: () => void

Clears the cache for data-sets api requests.

Type declaration

    • (): void

    • Clears the cache for data-sets api requests.

      Returns void

createDataSet: (
    body: DataSet,
    options?: ApiCallOptions,
) => Promise<CreateDataSetHttpResponse>

Save new data set

Type declaration

Param: body

an object with the body content

CreateDataSetHttpError

deleteDataSets: (
    body: BatchIdDto,
    options?: ApiCallOptions,
) => Promise<DeleteDataSetsHttpResponse>

Batch delete data sets.

Type declaration

Param: body

an object with the body content

DeleteDataSetsHttpError

getDataSet: (
    dataSetId: string,
    query: { projections?: string[] },
    options?: ApiCallOptions,
) => Promise<GetDataSetHttpResponse>

Get data set by ID.

Type declaration

    • (
          dataSetId: string,
          query: { projections?: string[] },
          options?: ApiCallOptions,
      ): Promise<GetDataSetHttpResponse>

    • Get data set by ID.

      Parameters

      • dataSetId: string
      • query: { projections?: string[] }

        an object with query parameters

        • Optionalprojections?: string[]

          Comma-separated fields to return in the response.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataSetHttpResponse>

      GetDataSetHttpError

an object with query parameters

GetDataSetHttpError

getDataSetProfiles: (
    dataSetId: string,
    query: {
        dataConnectionIds?: string[];
        limit?: number;
        page?: number;
        projections?: string[];
        sort?: string[];
    },
    options?: ApiCallOptions,
) => Promise<GetDataSetProfilesHttpResponse>

Get profile for the given dataset and connection Id pair, if the profile already exists in the system. Profile returned can be either latest or Stale one based on when it was computed.

Type declaration

    • (
          dataSetId: string,
          query: {
              dataConnectionIds?: string[];
              limit?: number;
              page?: number;
              projections?: string[];
              sort?: string[];
          },
          options?: ApiCallOptions,
      ): Promise<GetDataSetProfilesHttpResponse>

    • Get profile for the given dataset and connection Id pair, if the profile already exists in the system. Profile returned can be either latest or Stale one based on when it was computed.

      Parameters

      • dataSetId: string
      • query: {
            dataConnectionIds?: string[];
            limit?: number;
            page?: number;
            projections?: string[];
            sort?: string[];
        }

        an object with query parameters

        • OptionaldataConnectionIds?: string[]

          Comma-separated data connection IDs.

        • Optionallimit?: number

          Page size limit.

        • Optionalpage?: number
        • Optionalprojections?: string[]

          Comma-separated fields to return in the response.

        • Optionalsort?: string[]
      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataSetProfilesHttpResponse>

      GetDataSetProfilesHttpError

an object with query parameters

GetDataSetProfilesHttpError

patchDataSet: (
    dataSetId: string,
    body: JsonPatch[],
    options?: ApiCallOptions,
) => Promise<PatchDataSetHttpResponse>

Patch data set.

Type declaration

Param: body

an object with the body content

PatchDataSetHttpError

updateDataSet: (
    dataSetId: string,
    body: DataSet,
    options?: ApiCallOptions,
) => Promise<UpdateDataSetHttpResponse>

Update data set.

Type declaration

Param: body

an object with the body content

UpdateDataSetHttpError

Settings

Member Visibility

On This Page

Properties