Variable PipelinesApiConst

Type Declaration

• _defaultBasePath: string

• createPipeline: (
      body: CreatePipeline,
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<PipelineId>

  Create a pipeline

• deletePipelineById: (
      pipelineId: string,
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<any>

  Delete a pipeline by pipeline id

• getAllDocumentsForPipeline: (
      pipelineId: string,
      queryParameters: { $count?: boolean; $skip?: number; $top?: number },
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<DocumentsStatusResponse>

  Retrieve all documents associated with a specific pipeline. Optionally, filter the results using query parameters.

• getAllExecutionsForPipeline: (
      pipelineId: string,
      queryParameters: {
          $count?: boolean;
          $skip?: number;
          $top?: number;
          lastExecution?: boolean;
      },
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<GetPipelineExecutions>

  Retrieve all executions for a specific pipeline. Optionally, filter to get only the last execution.

• getAllPipelines: (
      queryParameters: { $count?: boolean; $skip?: number; $top?: number },
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<GetPipelines>

  Get all pipelines

• getDocumentByIdForPipeline: (
      pipelineId: string,
      documentId: string,
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<PipelineDocumentResponse>

  Retrieve details of a specific document associated with a pipeline.

• getDocumentByIdForPipelineExecution: (
      pipelineId: string,
      executionId: string,
      documentId: string,
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<PipelineDocumentResponse>

  Retrieve details of a specific document associated with a pipeline execution.

• getDocumentsForPipelineExecution: (
      pipelineId: string,
      executionId: string,
      queryParameters: { $count?: boolean; $skip?: number; $top?: number },
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<DocumentsStatusResponse>

  Retrieve all documents associated with a specific pipeline execution. Optionally, filter the results using query parameters.

• getExecutionDetailsByIdForPipelineExecution: (
      pipelineId: string,
      executionId: string,
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<GetPipelineExecutionById>

  Retrieve details of a specific pipeline execution by its execution ID.

• getPipelineById: (
      pipelineId: string,
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<GetPipeline>

  Get details of a pipeline by pipeline id

• getPipelineStatus: (
      pipelineId: string,
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<GetPipelineStatus>

  Get pipeline status by pipeline id

• manualTriggerPipeline: (
      body: ManualPipelineTrigger,
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<any>

  Manually trigger a pipeline

• patchPipelineById: (
      pipelineId: string,
      body: PatchPipeline,
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<any>

  Patch a pipeline by pipeline id

• searchPipelinesByMetadata: (
      body: SearchPipeline,
      queryParameters: { $count?: boolean; $skip?: number; $top?: number },
      headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<SearchPipelinesResponse>

  Search for pipelines based on metadata

  Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.