Interface DataStoresAPI

interface DataStoresAPI {
    clearCache: () => void;
    createDataStore: (
        body: DataStore,
        options?: ApiCallOptions,
    ) => Promise<CreateDataStoreHttpResponse>;
    deleteDataStoreDataAssetDataSets: (
        dataStoreIds: string,
        dataAssetIds: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteDataStoreDataAssetDataSetsHttpResponse>;
    deleteDataStoreDataAssets: (
        dataStoreIds: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteDataStoreDataAssetsHttpResponse>;
    deleteDataStores: (
        body: BatchIdDto,
        options?: ApiCallOptions,
    ) => Promise<DeleteDataStoresHttpResponse>;
    getDataStore: (
        dataStoreId: string,
        query: { projections?: string[] },
        options?: ApiCallOptions,
    ) => Promise<GetDataStoreHttpResponse>;
    getDataStoreDataAssetDataSets: (
        dataStoreIds: string,
        dataAssetIds: string,
        query: {
            limit?: number;
            page?: number;
            projections?: string[];
            sort?: string[];
        },
        options?: ApiCallOptions,
    ) => Promise<GetDataStoreDataAssetDataSetsHttpResponse>;
    getDataStoreDataAssets: (
        dataStoreIds: string,
        query: {
            limit?: number;
            page?: number;
            projections?: string[];
            sort?: string[];
        },
        options?: ApiCallOptions,
    ) => Promise<GetDataStoreDataAssetsHttpResponse>;
    getDataStores: (
        query: {
            limit?: number;
            page?: number;
            projections?: string[];
            sort?: string[];
        },
        options?: ApiCallOptions,
    ) => Promise<GetDataStoresHttpResponse>;
    patchDataStore: (
        dataStoreId: string,
        body: JsonPatch[],
        options?: ApiCallOptions,
    ) => Promise<PatchDataStoreHttpResponse>;
    updateDataStore: (
        dataStoreId: string,
        body: DataStore,
        options?: ApiCallOptions,
    ) => Promise<UpdateDataStoreHttpResponse>;
}
Index

Properties

clearCache createDataStore deleteDataStoreDataAssetDataSets deleteDataStoreDataAssets deleteDataStores getDataStore getDataStoreDataAssetDataSets getDataStoreDataAssets getDataStores patchDataStore updateDataStore

Properties

clearCache: () => void

Clears the cache for data-stores api requests.

Type declaration

    • (): void

    • Clears the cache for data-stores api requests.

      Returns void

createDataStore: (
    body: DataStore,
    options?: ApiCallOptions,
) => Promise<CreateDataStoreHttpResponse>

Save new data store.

Type declaration

Param: body

an object with the body content

CreateDataStoreHttpError

deleteDataStoreDataAssetDataSets: (
    dataStoreIds: string,
    dataAssetIds: string,
    options?: ApiCallOptions,
) => Promise<DeleteDataStoreDataAssetDataSetsHttpResponse>

Delete data sets by data-store IDs and data-asset IDs.

Type declaration

Comma-separated data store IDs or * to include all data stores.

Comma-separated data asset IDs or * to include all data assets.

DeleteDataStoreDataAssetDataSetsHttpError

deleteDataStoreDataAssets: (
    dataStoreIds: string,
    options?: ApiCallOptions,
) => Promise<DeleteDataStoreDataAssetsHttpResponse>

Delete data assets and child data-sets by data-store IDs.

Type declaration

Comma-separated data store IDs or * to include all data stores.

DeleteDataStoreDataAssetsHttpError

deleteDataStores: (
    body: BatchIdDto,
    options?: ApiCallOptions,
) => Promise<DeleteDataStoresHttpResponse>

Delete data stores if it does not contain any data-assets.

Type declaration

Param: body

an object with the body content

DeleteDataStoresHttpError

getDataStore: (
    dataStoreId: string,
    query: { projections?: string[] },
    options?: ApiCallOptions,
) => Promise<GetDataStoreHttpResponse>

Get data store by ID.

Type declaration

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

    • Get data store by ID.

      Parameters

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

        an object with query parameters

        • Optionalprojections?: string[]

          Comma-separated fields to return in the response.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataStoreHttpResponse>

      GetDataStoreHttpError

an object with query parameters

GetDataStoreHttpError

getDataStoreDataAssetDataSets: (
    dataStoreIds: string,
    dataAssetIds: string,
    query: {
        limit?: number;
        page?: number;
        projections?: string[];
        sort?: string[];
    },
    options?: ApiCallOptions,
) => Promise<GetDataStoreDataAssetDataSetsHttpResponse>

Get all data sets belonging to the data store(s) and data asset(s).

Type declaration

    • (
          dataStoreIds: string,
          dataAssetIds: string,
          query: {
              limit?: number;
              page?: number;
              projections?: string[];
              sort?: string[];
          },
          options?: ApiCallOptions,
      ): Promise<GetDataStoreDataAssetDataSetsHttpResponse>

    • Get all data sets belonging to the data store(s) and data asset(s).

      Parameters

      • dataStoreIds: string

        Comma-separated data store IDs or * to include all data stores.

      • dataAssetIds: string

        Comma-separated data asset IDs or * to include all data assets.

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

        an object with query parameters

        • Optionallimit?: number

          Page size limit.

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

          Comma-separated fields to return in the response.

        • Optionalsort?: string[]

          Comma-separated fields and field start with '-' character sorts the result set in descending order.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataStoreDataAssetDataSetsHttpResponse>

      GetDataStoreDataAssetDataSetsHttpError

Comma-separated data store IDs or * to include all data stores.

Comma-separated data asset IDs or * to include all data assets.

an object with query parameters

GetDataStoreDataAssetDataSetsHttpError

getDataStoreDataAssets: (
    dataStoreIds: string,
    query: {
        limit?: number;
        page?: number;
        projections?: string[];
        sort?: string[];
    },
    options?: ApiCallOptions,
) => Promise<GetDataStoreDataAssetsHttpResponse>

Get all data assets belonging to the data store(s).

Type declaration

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

    • Get all data assets belonging to the data store(s).

      Parameters

      • dataStoreIds: string

        Comma-separated data store IDs or * to include all data stores.

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

        an object with query parameters

        • Optionallimit?: number

          Page size limit.

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

          Comma-separated fields to return in the response.

        • Optionalsort?: string[]

          Comma-separated fields and field start with '-' character sorts the result set in descending order.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataStoreDataAssetsHttpResponse>

      GetDataStoreDataAssetsHttpError

Comma-separated data store IDs or * to include all data stores.

an object with query parameters

GetDataStoreDataAssetsHttpError

getDataStores: (
    query: {
        limit?: number;
        page?: number;
        projections?: string[];
        sort?: string[];
    },
    options?: ApiCallOptions,
) => Promise<GetDataStoresHttpResponse>

Get all data stores.

Type declaration

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

    • Get all data stores.

      Parameters

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

        an object with query parameters

        • Optionallimit?: number

          Page size limit.

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

          Comma-separated fields to return in the response.

        • Optionalsort?: string[]

          Comma-separated fields and field start with '-' character sorts the result set in descending order.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataStoresHttpResponse>

      GetDataStoresHttpError

an object with query parameters

GetDataStoresHttpError

patchDataStore: (
    dataStoreId: string,
    body: JsonPatch[],
    options?: ApiCallOptions,
) => Promise<PatchDataStoreHttpResponse>

Patch data store.

Type declaration

Param: body

an object with the body content

PatchDataStoreHttpError

updateDataStore: (
    dataStoreId: string,
    body: DataStore,
    options?: ApiCallOptions,
) => Promise<UpdateDataStoreHttpResponse>

Update data store.

Type declaration

Param: body

an object with the body content

UpdateDataStoreHttpError

Settings

Member Visibility

On This Page

Properties