Interface DataAssetsAPI

interface DataAssetsAPI {
    clearCache: () => void;
    createDataAsset: (
        body: DataAsset,
        options?: ApiCallOptions,
    ) => Promise<CreateDataAssetHttpResponse>;
    deleteDataAssets: (
        body: BatchIdDto,
        options?: ApiCallOptions,
    ) => Promise<DeleteDataAssetsHttpResponse>;
    getDataAsset: (
        dataAssetId: string,
        query: { projections?: string[] },
        options?: ApiCallOptions,
    ) => Promise<GetDataAssetHttpResponse>;
    patchDataAsset: (
        dataAssetId: string,
        body: JsonPatch[],
        options?: ApiCallOptions,
    ) => Promise<PatchDataAssetHttpResponse>;
    updateDataAsset: (
        dataAssetId: string,
        body: DataAsset,
        options?: ApiCallOptions,
    ) => Promise<UpdateDataAssetHttpResponse>;
}
Index

Properties

clearCache createDataAsset deleteDataAssets getDataAsset patchDataAsset updateDataAsset

Properties

clearCache: () => void

Clears the cache for data-assets api requests.

Type declaration

    • (): void

    • Clears the cache for data-assets api requests.

      Returns void

createDataAsset: (
    body: DataAsset,
    options?: ApiCallOptions,
) => Promise<CreateDataAssetHttpResponse>

Save new data asset.

Type declaration

Param: body

an object with the body content

CreateDataAssetHttpError

deleteDataAssets: (
    body: BatchIdDto,
    options?: ApiCallOptions,
) => Promise<DeleteDataAssetsHttpResponse>

Batch delete data assets by IDs.

Type declaration

Param: body

an object with the body content

DeleteDataAssetsHttpError

getDataAsset: (
    dataAssetId: string,
    query: { projections?: string[] },
    options?: ApiCallOptions,
) => Promise<GetDataAssetHttpResponse>

Get data asset by ID.

Type declaration

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

    • Get data asset by ID.

      Parameters

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

        an object with query parameters

        • Optionalprojections?: string[]

          Comma-separated fields to return in the response.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataAssetHttpResponse>

      GetDataAssetHttpError

an object with query parameters

GetDataAssetHttpError

patchDataAsset: (
    dataAssetId: string,
    body: JsonPatch[],
    options?: ApiCallOptions,
) => Promise<PatchDataAssetHttpResponse>

Patch data asset.

Type declaration

Param: body

an object with the body content

PatchDataAssetHttpError

updateDataAsset: (
    dataAssetId: string,
    body: DataAsset,
    options?: ApiCallOptions,
) => Promise<UpdateDataAssetHttpResponse>

Update data asset.

Type declaration

Param: body

an object with the body content

UpdateDataAssetHttpError

Settings

Member Visibility

On This Page

Properties