Type Alias DiProjectsAPI

type DiProjectsAPI = {
    clearCache: typeof clearCache;
    createDiProject: typeof createDiProject;
    exportDiProject: typeof exportDiProject;
    getDiProject: typeof getDiProject;
    getDiProjectDiTask: typeof getDiProjectDiTask;
    getDiProjectDiTaskRuntimeState: typeof getDiProjectDiTaskRuntimeState;
    getDiProjectDiTaskRuntimeStateDatasets: typeof getDiProjectDiTaskRuntimeStateDatasets;
    getDiProjectDiTasks: typeof getDiProjectDiTasks;
    getDiProjectExportVariables: typeof getDiProjectExportVariables;
    getDiProjects: typeof getDiProjects;
    importDiProject: typeof importDiProject;
    prepareDiProject: typeof prepareDiProject;
    prepareDiProjectDiTask: typeof prepareDiProjectDiTask;
    setDiProjectExportVariables: typeof setDiProjectExportVariables;
    startDiProjectDiTaskRuntime: typeof startDiProjectDiTaskRuntime;
    stopDiProjectDiTaskRuntime: typeof stopDiProjectDiTaskRuntime;
    validateDiProject: typeof validateDiProject;
    validateDiProjectDiTask: typeof validateDiProjectDiTask;
}
Index

Properties

clearCache createDiProject exportDiProject getDiProject getDiProjectDiTask getDiProjectDiTaskRuntimeState getDiProjectDiTaskRuntimeStateDatasets getDiProjectDiTasks getDiProjectExportVariables getDiProjects importDiProject prepareDiProject prepareDiProjectDiTask setDiProjectExportVariables startDiProjectDiTaskRuntime stopDiProjectDiTaskRuntime validateDiProject validateDiProjectDiTask

Properties

clearCache: typeof clearCache

Clears the cache for di-projects api requests.

createDiProject: typeof createDiProject

Creates a new data integration project in the specified space.

Param: body

an object with the body content

CreateDiProjectHttpError

exportDiProject: typeof exportDiProject

Exports the specified data integration project.

Data project ID

Param: body

an object with the body content

ExportDiProjectHttpError

getDiProject: typeof getDiProject

Retrieves the status of an asynchronous operation.

Action ID

an object with query parameters

GetDiProjectHttpError

getDiProjectDiTask: typeof getDiProjectDiTask

Get a specific data task within a project.

getDiProjectDiTask(
  "65424a71c11367914c1e659b",
  "task-cYSY"
)

Data project id

Data task id

GetDiProjectDiTaskHttpError

getDiProjectDiTaskRuntimeState: typeof getDiProjectDiTaskRuntimeState

Get the current runtime state of a data task

getDiProjectDiTaskRuntimeState(
  "65424a71c11367914c1e659b",
  "task-cYSY"
)

GetDiProjectDiTaskRuntimeStateHttpError

getDiProjectDiTaskRuntimeStateDatasets: typeof getDiProjectDiTaskRuntimeStateDatasets

Returns dataset-level runtime state for a data task

ID of the project

ID of the data task

GetDiProjectDiTaskRuntimeStateDatasetsHttpError

getDiProjectDiTasks: typeof getDiProjectDiTasks

Lists data tasks within a given data integration project.

getDiProjectDiTasks(
  "65424a71c11367914c1e659b"
)

Data project id

GetDiProjectDiTasksHttpError

getDiProjectExportVariables: typeof getDiProjectExportVariables

Retrieves the export variables for a specific data integration project.

getDiProjectExportVariables(
  "65424a71c11367914c1e659b",
  {
    recalculate: true
  }
)

Data project ID

an object with query parameters

GetDiProjectExportVariablesHttpError

getDiProjects: typeof getDiProjects

List data integration projects.

an object with query parameters

GetDiProjectsHttpError

importDiProject: typeof importDiProject

Imports a data integration project from a .zip file.

Data project ID

Param: body

an object with the body content

ImportDiProjectHttpError

prepareDiProject: typeof prepareDiProject

Prepares the data integration project and its tasks for execution.

Data project ID

Param: body

an object with the body content

PrepareDiProjectHttpError

prepareDiProjectDiTask: typeof prepareDiProjectDiTask

Prepares the specified data task for execution.

Data project ID

Data task ID

Param: body

an object with the body content

PrepareDiProjectDiTaskHttpError

setDiProjectExportVariables: typeof setDiProjectExportVariables

Updates the export variables for a specific data integration project.

Data project ID

Param: body

an object with the body content

SetDiProjectExportVariablesHttpError

startDiProjectDiTaskRuntime: typeof startDiProjectDiTaskRuntime

Start a data task on a data integration project.

startDiProjectDiTaskRuntime(
  "65424a71c11367914c1e659b",
  "task-cYSY"
)

Data project id

Data task id

StartDiProjectDiTaskRuntimeHttpError

stopDiProjectDiTaskRuntime: typeof stopDiProjectDiTaskRuntime

Stop a data task on a data integration project.

stopDiProjectDiTaskRuntime(
  "65424a71c11367914c1e659b",
  "task-cYSY"
)

StopDiProjectDiTaskRuntimeHttpError

validateDiProject: typeof validateDiProject

Validates the data integration project and its tasks.

Data project ID

Param: body

an object with the body content

ValidateDiProjectHttpError

validateDiProjectDiTask: typeof validateDiProjectDiTask

Validates the specified data task.

validateDiProjectDiTask(
  "65424a71c11367914c1e659b",
  "task-cYSY",
  null
)

Data project ID

Data task ID

Param: body

an object with the body content

ValidateDiProjectDiTaskHttpError

Settings

Member Visibility

On This Page

Properties