Type Alias DataSetsAPI

type DataSetsAPI = {
    clearCache: typeof clearCache;
    createDataSet: typeof createDataSet;
    deleteDataSets: typeof deleteDataSets;
    getDataSet: typeof getDataSet;
    getDataSetProfiles: typeof getDataSetProfiles;
    patchDataSet: typeof patchDataSet;
    updateDataSet: typeof updateDataSet;
}
Index

Properties

clearCache: typeof clearCache

Clears the cache for data-sets api requests.

createDataSet: typeof createDataSet

Save new data set

an object with the body content

CreateDataSetHttpError

deleteDataSets: typeof deleteDataSets

Batch delete data sets.

an object with the body content

DeleteDataSetsHttpError

getDataSet: typeof getDataSet

Get data set by ID.

an object with query parameters

GetDataSetHttpError

getDataSetProfiles: typeof getDataSetProfiles

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.

an object with query parameters

GetDataSetProfilesHttpError

patchDataSet: typeof patchDataSet

Partially updates an existing DataSet by ID using JSON Patch operations (RFC 6902), including ownership attributes.

A user can update any DataSet within a space if they fulfill one of the following conditions:

  • Has Can edit permission in a data space.
  • Is a Professional user with the Editor or Operator role in a shared space.
  • Is a Professional user with the Facilitator or Operator role in a managed space.

an object with the body content

PatchDataSetHttpError

updateDataSet: typeof updateDataSet

Fully replaces an existing DataSet by ID, including ownership attributes.

A user can update any DataSet within a space if they fulfill one of the following conditions:

  • Has Can edit permission in a data space.
  • Is a Professional user with the Editor or Operator role in a shared space.
  • Is a Professional user with the Facilitator or Operator role in a managed space.

an object with the body content

UpdateDataSetHttpError