Interface DiProjectsAPI

interface DiProjectsAPI {
    clearCache: () => void;
    createDiProject: (
        body: CreateDiProjectReq,
        options?: ApiCallOptions,
    ) => Promise<CreateDiProjectHttpResponse>;
    exportDiProject: (
        projectId: string,
        body: ExportDiProjectReq,
        options?: ApiCallOptions,
    ) => Promise<ExportDiProjectHttpResponse>;
    getDiProject: (
        actionId: string,
        query: { detailed?: boolean },
        options?: ApiCallOptions,
    ) => Promise<GetDiProjectHttpResponse>;
    getDiProjectDiTask: (
        projectId: string,
        dataTaskId: string,
        options?: ApiCallOptions,
    ) => Promise<GetDiProjectDiTaskHttpResponse>;
    getDiProjectDiTaskRuntimeState: (
        projectId: string,
        dataTaskId: string,
        options?: ApiCallOptions,
    ) => Promise<GetDiProjectDiTaskRuntimeStateHttpResponse>;
    getDiProjectDiTasks: (
        projectId: string,
        options?: ApiCallOptions,
    ) => Promise<GetDiProjectDiTasksHttpResponse>;
    getDiProjectExportVariables: (
        projectId: string,
        query: { recalculate?: boolean },
        options?: ApiCallOptions,
    ) => Promise<GetDiProjectExportVariablesHttpResponse>;
    getDiProjects: (
        query: { spaceId?: string },
        options?: ApiCallOptions,
    ) => Promise<GetDiProjectsHttpResponse>;
    importDiProject: (
        projectId: string,
        body: { zip?: BodyInit },
        options?: ApiCallOptions,
    ) => Promise<ImportDiProjectHttpResponse>;
    prepareDiProject: (
        projectId: string,
        body: PrepareProjectReq,
        options?: ApiCallOptions,
    ) => Promise<PrepareDiProjectHttpResponse>;
    prepareDiProjectDiTask: (
        projectId: string,
        dataTaskId: string,
        body: PrepareTaskReq,
        options?: ApiCallOptions,
    ) => Promise<PrepareDiProjectDiTaskHttpResponse>;
    setDiProjectExportVariables: (
        projectId: string,
        body: UpdateDiExportProjectVariablesReq,
        options?: ApiCallOptions,
    ) => Promise<SetDiProjectExportVariablesHttpResponse>;
    startDiProjectDiTaskRuntime: (
        projectId: string,
        dataTaskId: string,
        options?: ApiCallOptions,
    ) => Promise<StartDiProjectDiTaskRuntimeHttpResponse>;
    stopDiProjectDiTaskRuntime: (
        projectId: string,
        dataTaskId: string,
        options?: ApiCallOptions,
    ) => Promise<StopDiProjectDiTaskRuntimeHttpResponse>;
    validateDiProject: (
        projectId: string,
        body: ValidateProjectReq,
        options?: ApiCallOptions,
    ) => Promise<ValidateDiProjectHttpResponse>;
    validateDiProjectDiTask: (
        projectId: string,
        dataTaskId: string,
        body: unknown,
        options?: ApiCallOptions,
    ) => Promise<ValidateDiProjectDiTaskHttpResponse>;
}
Index

Properties

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

Properties

clearCache: () => void

Clears the cache for di-projects api requests.

Type declaration

    • (): void

    • Clears the cache for di-projects api requests.

      Returns void

createDiProject: (
    body: CreateDiProjectReq,
    options?: ApiCallOptions,
) => Promise<CreateDiProjectHttpResponse>

Creates a new data integration project in the specified space.

Type declaration

Param: body

an object with the body content

CreateDiProjectHttpError

exportDiProject: (
    projectId: string,
    body: ExportDiProjectReq,
    options?: ApiCallOptions,
) => Promise<ExportDiProjectHttpResponse>

Exports the specified data integration project.

Type declaration

Data project ID

Param: body

an object with the body content

ExportDiProjectHttpError

getDiProject: (
    actionId: string,
    query: { detailed?: boolean },
    options?: ApiCallOptions,
) => Promise<GetDiProjectHttpResponse>

Retrieves the status of an asynchronous operation.

Type declaration

    • (
          actionId: string,
          query: { detailed?: boolean },
          options?: ApiCallOptions,
      ): Promise<GetDiProjectHttpResponse>

    • Retrieves the status of an asynchronous operation.

      Parameters

      • actionId: string

        Action ID

      • query: { detailed?: boolean }

        an object with query parameters

        • Optionaldetailed?: boolean

          Specifies whether to include detailed status information in the response. Set to true to return detailed information.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDiProjectHttpResponse>

      GetDiProjectHttpError

Action ID

an object with query parameters

GetDiProjectHttpError

getDiProjectDiTask: (
    projectId: string,
    dataTaskId: string,
    options?: ApiCallOptions,
) => Promise<GetDiProjectDiTaskHttpResponse>

Get a specific data task within a project.

Type declaration

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

Data project id

Data task id

GetDiProjectDiTaskHttpError

getDiProjectDiTaskRuntimeState: (
    projectId: string,
    dataTaskId: string,
    options?: ApiCallOptions,
) => Promise<GetDiProjectDiTaskRuntimeStateHttpResponse>

Get data task runtime state within a data integration project.

Type declaration

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

GetDiProjectDiTaskRuntimeStateHttpError

getDiProjectDiTasks: (
    projectId: string,
    options?: ApiCallOptions,
) => Promise<GetDiProjectDiTasksHttpResponse>

Lists data tasks within a given data integration project.

Type declaration

getDiProjectDiTasks(
  "65424a71c11367914c1e659b"
)

Data project id

GetDiProjectDiTasksHttpError

getDiProjectExportVariables: (
    projectId: string,
    query: { recalculate?: boolean },
    options?: ApiCallOptions,
) => Promise<GetDiProjectExportVariablesHttpResponse>

Retrieves the export variables for a specific data integration project.

Type declaration

    • (
          projectId: string,
          query: { recalculate?: boolean },
          options?: ApiCallOptions,
      ): Promise<GetDiProjectExportVariablesHttpResponse>

    • Retrieves the export variables for a specific data integration project.

      Parameters

      • projectId: string

        Data project ID

      • query: { recalculate?: boolean }

        an object with query parameters

        • Optionalrecalculate?: boolean

          Recalculate the bindings if true, otherwise saved bindings are returned.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDiProjectExportVariablesHttpResponse>

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

      GetDiProjectExportVariablesHttpError

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

Data project ID

an object with query parameters

GetDiProjectExportVariablesHttpError

getDiProjects: (
    query: { spaceId?: string },
    options?: ApiCallOptions,
) => Promise<GetDiProjectsHttpResponse>

List data integration projects.

Type declaration

an object with query parameters

GetDiProjectsHttpError

importDiProject: (
    projectId: string,
    body: { zip?: BodyInit },
    options?: ApiCallOptions,
) => Promise<ImportDiProjectHttpResponse>

Imports a data integration project from a .zip file.

Type declaration

Data project ID

Param: body

an object with the body content

ImportDiProjectHttpError

prepareDiProject: (
    projectId: string,
    body: PrepareProjectReq,
    options?: ApiCallOptions,
) => Promise<PrepareDiProjectHttpResponse>

Prepares the data integration project and its tasks for execution.

Type declaration

Data project ID

Param: body

an object with the body content

PrepareDiProjectHttpError

prepareDiProjectDiTask: (
    projectId: string,
    dataTaskId: string,
    body: PrepareTaskReq,
    options?: ApiCallOptions,
) => Promise<PrepareDiProjectDiTaskHttpResponse>

Prepares the specified data task for execution.

Type declaration

Data project ID

Data task ID

Param: body

an object with the body content

PrepareDiProjectDiTaskHttpError

setDiProjectExportVariables: (
    projectId: string,
    body: UpdateDiExportProjectVariablesReq,
    options?: ApiCallOptions,
) => Promise<SetDiProjectExportVariablesHttpResponse>

Updates the export variables for a specific data integration project.

Type declaration

Data project ID

Param: body

an object with the body content

SetDiProjectExportVariablesHttpError

startDiProjectDiTaskRuntime: (
    projectId: string,
    dataTaskId: string,
    options?: ApiCallOptions,
) => Promise<StartDiProjectDiTaskRuntimeHttpResponse>

Start a data task on a data integration project.

Type declaration

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

Data project id

Data task id

StartDiProjectDiTaskRuntimeHttpError

stopDiProjectDiTaskRuntime: (
    projectId: string,
    dataTaskId: string,
    options?: ApiCallOptions,
) => Promise<StopDiProjectDiTaskRuntimeHttpResponse>

Stop a data task on a data integration project.

Type declaration

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

StopDiProjectDiTaskRuntimeHttpError

validateDiProject: (
    projectId: string,
    body: ValidateProjectReq,
    options?: ApiCallOptions,
) => Promise<ValidateDiProjectHttpResponse>

Validates the data integration project and its tasks.

Type declaration

Data project ID

Param: body

an object with the body content

ValidateDiProjectHttpError

validateDiProjectDiTask: (
    projectId: string,
    dataTaskId: string,
    body: unknown,
    options?: ApiCallOptions,
) => Promise<ValidateDiProjectDiTaskHttpResponse>

Validates the specified data task.

Type declaration

    • (
          projectId: string,
          dataTaskId: string,
          body: unknown,
          options?: ApiCallOptions,
      ): Promise<ValidateDiProjectDiTaskHttpResponse>

    • Validates the specified data task.

      Parameters

      • projectId: string

        Data project ID

      • dataTaskId: string

        Data task ID

      • body: unknown

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<ValidateDiProjectDiTaskHttpResponse>

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

      ValidateDiProjectDiTaskHttpError

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