SAP AI SDK for JavaScript - v2.8.0
    Preparing search index...

    Variable ExecutionApiConst

    ExecutionApi: {
        _defaultBasePath: undefined;
        executionBatchModify: (
            body: AiExecutionBulkModificationRequest,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<AiExecutionBulkModificationResponse>;
        executionCount: (
            queryParameters: {
                configurationId?: string;
                executableIds?: string[];
                executionScheduleId?: string;
                scenarioId?: string;
                status?:
                    | "PENDING"
                    | "RUNNING"
                    | "COMPLETED"
                    | "DEAD"
                    | "STOPPING"
                    | "STOPPED"
                    | "UNKNOWN";
            },
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<number>;
        executionCreate: (
            body: AiEnactmentCreationRequest,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<AiExecutionCreationResponse>;
        executionDelete: (
            executionId: string,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<AiExecutionDeletionResponse>;
        executionGet: (
            executionId: string,
            queryParameters: { $select?: "status" },
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<AiExecutionResponseWithDetails>;
        executionModify: (
            executionId: string,
            body: AiExecutionModificationRequest,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<AiExecutionModificationResponse>;
        executionQuery: (
            queryParameters: {
                $select?: "status";
                $skip?: number;
                $top?: number;
                configurationId?: string;
                executableIds?: string[];
                executionScheduleId?: string;
                scenarioId?: string;
                status?:
                    | "PENDING"
                    | "RUNNING"
                    | "COMPLETED"
                    | "DEAD"
                    | "STOPPING"
                    | "STOPPED"
                    | "UNKNOWN";
            },
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<AiExecutionList>;
        kubesubmitV4ExecutionsGetLogs: (
            executionId: string,
            queryParameters?: {
                $order?: "asc" | "desc";
                $top?: number;
                end?: string;
                start?: string;
            },
            headerParameters?: { Authorization?: string },
        ) => OpenApiRequestBuilder<RTALogCommonResponse>;
    }

    Representation of the 'ExecutionApi'. This API is part of the 'AI_CORE_API' service.

    Type Declaration

    • _defaultBasePath: undefined
    • executionBatchModify: (
          body: AiExecutionBulkModificationRequest,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<AiExecutionBulkModificationResponse>

      Patch multiple executions' status to stopped or deleted.

    • executionCount: (
          queryParameters: {
              configurationId?: string;
              executableIds?: string[];
              executionScheduleId?: string;
              scenarioId?: string;
              status?:
                  | "PENDING"
                  | "RUNNING"
                  | "COMPLETED"
                  | "DEAD"
                  | "STOPPING"
                  | "STOPPED"
                  | "UNKNOWN";
          },
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<number>

      Retrieve the number of available executions. The number can be filtered by scenarioId, configurationId, executableIdsList or by execution status.

    • executionCreate: (
          body: AiEnactmentCreationRequest,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<AiExecutionCreationResponse>

      Create an execution using the configuration specified by configurationId.

    • executionDelete: (
          executionId: string,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<AiExecutionDeletionResponse>

      Mark the execution with executionId as deleted.

    • executionGet: (
          executionId: string,
          queryParameters: { $select?: "status" },
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<AiExecutionResponseWithDetails>

      Retrieve details for execution with executionId.

    • executionModify: (
          executionId: string,
          body: AiExecutionModificationRequest,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<AiExecutionModificationResponse>

      Update target status of the execution to stop an execution.

    • executionQuery: (
          queryParameters: {
              $select?: "status";
              $skip?: number;
              $top?: number;
              configurationId?: string;
              executableIds?: string[];
              executionScheduleId?: string;
              scenarioId?: string;
              status?:
                  | "PENDING"
                  | "RUNNING"
                  | "COMPLETED"
                  | "DEAD"
                  | "STOPPING"
                  | "STOPPED"
                  | "UNKNOWN";
          },
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<AiExecutionList>

      Retrieve a list of executions that match the specified filter criteria. Filter criteria include a list of executableIds, a scenarioId, a configurationId, or a execution status. With top/skip parameters it is possible to paginate the result list. With select parameter it is possible to select only status.

    • kubesubmitV4ExecutionsGetLogs: (
          executionId: string,
          queryParameters?: {
              $order?: "asc" | "desc";
              $top?: number;
              end?: string;
              start?: string;
          },
          headerParameters?: { Authorization?: string },
      ) => OpenApiRequestBuilder<RTALogCommonResponse>

      Retrieve logs of an execution for getting insight into the execution results or failures.

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