Type Alias DiProjectsAPI

type DiProjectsAPI = {
    clearCache: typeof clearCache;
    createDiProject: typeof createDiProject;
    exportDiProject: typeof exportDiProject;
    getDiProject: typeof getDiProject;
    getDiProjectDiTask: typeof getDiProjectDiTask;
    getDiProjectDiTaskRuntimeRunState: typeof getDiProjectDiTaskRuntimeRunState;
    getDiProjectDiTaskRuntimeRunStateDatasets: typeof getDiProjectDiTaskRuntimeRunStateDatasets;
    getDiProjectDiTaskRuntimeState: typeof getDiProjectDiTaskRuntimeState;
    getDiProjectDiTaskRuntimeStateDatasets: typeof getDiProjectDiTaskRuntimeStateDatasets;
    getDiProjectDiTasks: typeof getDiProjectDiTasks;
    getDiProjectExportVariables: typeof getDiProjectExportVariables;
    getDiProjects: typeof getDiProjects;
    importAsyncDiProject: typeof importAsyncDiProject;
    importDiProject: typeof importDiProject;
    prepareDiProject: typeof prepareDiProject;
    prepareDiProjectDiTask: typeof prepareDiProjectDiTask;
    recreateDatasetsDiProjectDiTask: typeof recreateDatasetsDiProjectDiTask;
    requestReloadDiProjectDiTask: typeof requestReloadDiProjectDiTask;
    searchDiProjectDiTaskRuntimeRuns: typeof searchDiProjectDiTaskRuntimeRuns;
    setDiProjectExportVariables: typeof setDiProjectExportVariables;
    startDiProjectDiTaskRuntime: typeof startDiProjectDiTaskRuntime;
    startDiProjectDiTaskRuntimeWithBody: typeof startDiProjectDiTaskRuntimeWithBody;
    stopDiProjectDiTaskRuntime: typeof stopDiProjectDiTaskRuntime;
    validateDiProject: typeof validateDiProject;
    validateDiProjectDiTask: typeof validateDiProjectDiTask;
    validateProjectDefinitions: typeof validateProjectDefinitions;
}
Index
clearCache createDiProject exportDiProject getDiProject getDiProjectDiTask getDiProjectDiTaskRuntimeRunState getDiProjectDiTaskRuntimeRunStateDatasets getDiProjectDiTaskRuntimeState getDiProjectDiTaskRuntimeStateDatasets getDiProjectDiTasks getDiProjectExportVariables getDiProjects importAsyncDiProject importDiProject prepareDiProject prepareDiProjectDiTask recreateDatasetsDiProjectDiTask requestReloadDiProjectDiTask searchDiProjectDiTaskRuntimeRuns setDiProjectExportVariables startDiProjectDiTaskRuntime startDiProjectDiTaskRuntimeWithBody stopDiProjectDiTaskRuntime validateDiProject validateDiProjectDiTask validateProjectDefinitions
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.

Identifier of the data project.

Param: body

an object with the body content

ExportDiProjectHttpError

getDiProject: typeof getDiProject

Retrieves the status of an asynchronous operation.

Identifier of the action.

an object with query parameters

GetDiProjectHttpError

getDiProjectDiTask: typeof getDiProjectDiTask

Get a specific data task within a project.

Identifier of the data project.

Identifier of the data task.

GetDiProjectDiTaskHttpError

getDiProjectDiTaskRuntimeRunState: typeof getDiProjectDiTaskRuntimeRunState

Returns the state of a specific historical run instance for a data task, including execution progress and any errors encountered.

Identifier of the data project.

Identifier of the data task.

Identifier of the run instance.

GetDiProjectDiTaskRuntimeRunStateHttpError

getDiProjectDiTaskRuntimeRunStateDatasets: typeof getDiProjectDiTaskRuntimeRunStateDatasets

Returns dataset-level state for a specific historical run instance of a data task. All datasets for the run are returned in a single response; this endpoint does not paginate.

Identifier of the data project.

Identifier of the data task.

Identifier of the run instance.

GetDiProjectDiTaskRuntimeRunStateDatasetsHttpError

getDiProjectDiTaskRuntimeState: typeof getDiProjectDiTaskRuntimeState

Get the current runtime state of a data task

Identifier of the data project.

Identifier of the data task.

GetDiProjectDiTaskRuntimeStateHttpError

getDiProjectDiTaskRuntimeStateDatasets: typeof getDiProjectDiTaskRuntimeStateDatasets

Returns dataset-level runtime state for a data task

Identifier of the data project.

Identifier of the data task.

GetDiProjectDiTaskRuntimeStateDatasetsHttpError

getDiProjectDiTasks: typeof getDiProjectDiTasks

Lists data tasks within a given data integration project.

Identifier of the data project.

GetDiProjectDiTasksHttpError

getDiProjectExportVariables: typeof getDiProjectExportVariables

Retrieves the export variables for a specific data integration project.

Identifier of the data project.

an object with query parameters

GetDiProjectExportVariablesHttpError

getDiProjects: typeof getDiProjects

List data integration projects.

an object with query parameters

GetDiProjectsHttpError

importAsyncDiProject: typeof importAsyncDiProject

Imports a data integration project from a .zip file and returns an action identifier for tracking the background import operation. Accepts both JSON-based (legacy) and YAML-based project formats, making it the recommended endpoint for deploying YAML-defined pipeline definitions programmatically. Poll the import status using GET /di-projects/actions/{actionId}.

Identifier of the data project.

Param: body

an object with the body content

ImportAsyncDiProjectHttpError

importDiProject: typeof importDiProject

Imports a data integration project synchronously from a legacy JSON-based .zip file. This endpoint only accepts zips that contain JSON project files (the legacy format). The import is processed synchronously and completes before the response is returned. Submitting a YAML-based zip to this endpoint returns 400. To import a YAML-based zip, use POST /di-projects/{projectId}/actions/import-async instead.

Identifier of the data project.

Param: body

an object with the body content

ImportDiProjectHttpError

prepareDiProject: typeof prepareDiProject

Prepares the data integration project and its tasks for execution.

Identifier of the data project.

Param: body

an object with the body content

PrepareDiProjectHttpError

prepareDiProjectDiTask: typeof prepareDiProjectDiTask

Prepares the specified data task for execution.

Identifier of the data project.

Identifier of the data task.

Param: body

an object with the body content

PrepareDiProjectDiTaskHttpError

recreateDatasetsDiProjectDiTask: typeof recreateDatasetsDiProjectDiTask

Recreates datasets in the specified data task.

Identifier of the data project.

Identifier of the data task.

Param: body

an object with the body content

RecreateDatasetsDiProjectDiTaskHttpError

requestReloadDiProjectDiTask: typeof requestReloadDiProjectDiTask

Registers a request to reload the datasets associated with the specified data task. The reload does not occur immediately; it will take effect on the next scheduled or manual run of the task.

Identifier of the data project.

Identifier of the data task.

Param: body

an object with the body content

RequestReloadDiProjectDiTaskHttpError

searchDiProjectDiTaskRuntimeRuns: typeof searchDiProjectDiTaskRuntimeRuns

Returns a paginated list of historical run instances for the specified data task, filtered by the provided criteria.

Identifier of the data project.

Identifier of the data task.

Param: body

an object with the body content

SearchDiProjectDiTaskRuntimeRunsHttpError

setDiProjectExportVariables: typeof setDiProjectExportVariables

Updates the export variables for a specific data integration project.

Identifier of the data project.

Param: body

an object with the body content

SetDiProjectExportVariablesHttpError

startDiProjectDiTaskRuntime: typeof startDiProjectDiTaskRuntime

Start a data task on a data integration project.

Identifier of the data project.

Identifier of the data task.

StartDiProjectDiTaskRuntimeHttpError

startDiProjectDiTaskRuntimeWithBody: typeof startDiProjectDiTaskRuntimeWithBody

Start a data task on a data integration project.

Identifier of the data project.

Identifier of the data task.

Param: body

an object with the body content

StartDiProjectDiTaskRuntimeWithBodyHttpError

stopDiProjectDiTaskRuntime: typeof stopDiProjectDiTaskRuntime

Stop a data task on a data integration project.

Identifier of the data project.

Identifier of the data task.

StopDiProjectDiTaskRuntimeHttpError

validateDiProject: typeof validateDiProject

Validates the data integration project and its tasks.

Identifier of the data project.

Param: body

an object with the body content

ValidateDiProjectHttpError

validateDiProjectDiTask: typeof validateDiProjectDiTask

Validates the specified data task.

Identifier of the data project.

Identifier of the data task.

Param: body

an object with the body content

ValidateDiProjectDiTaskHttpError

validateProjectDefinitions: typeof validateProjectDefinitions

Validates the project definition files in a .zip and returns a structured report of warnings and errors. The validation runs synchronously and completes before the response is returned. Use this operation before importing with POST /di-projects/{projectId}/actions/import-async to confirm that YAML-based pipeline definitions are correct.

Param: body

an object with the body content

ValidateProjectDefinitionsHttpError

Settings
Member Visibility

On This Page
Properties