Function updateOdagRequest

  • Performs actions on ODAG requests such as pausing, resuming, or canceling them. Cancel actions are effective only before the data loading phase. For multi-application generation requests, actions apply only to sub-requests that have not yet started loading. Automatic acknowledgment option simplifies state transitions.

    Parameters

    • requestId: string

      The ID of the request whose status is to be returned.

    • query: {
          action: RequestAction;
          autoAck?: boolean;
          delGenApp?: boolean;
          ignoreSucceeded?: boolean;
      }

      an object with query parameters

      • action: RequestAction

        The action to perform on the request. One of: (1) cancel a pending or in-flight request; (2) pause a request that has not started (still in the queued state); (3) resume a paused request; (4) acknowledge a prior cancellation; or (5) acknowledge a prior failure.

      • OptionalautoAck?: boolean
      • OptionaldelGenApp?: boolean
      • OptionalignoreSucceeded?: boolean
    • Optionaloptions: ApiCallOptions

    Returns Promise<UpdateOdagRequestHttpResponse>

    UpdateOdagRequestHttpError