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

        Optional flag used with the cancel action. When autoAck is true, a canceled request automatically transitions to the canceledAck state after cancellation completes. When autoAck is false, the request transitions to canceled, and you must call this endpoint again with action=ackcancel to acknowledge the cancellation.

      • OptionaldelGenApp?: boolean

        Optional flag that deletes the generated Analytics Application after an action of cancel (with autoAck=true), ackcancel, or ackfailure.

      • OptionalignoreSucceeded?: boolean

        Optional flag used with the cancel action. When true, the API does not return an error if the request reaches the succeeded state while the cancellation request is in progress.

    • Optionaloptions: ApiCallOptions

    Returns Promise<UpdateOdagRequestHttpResponse>

    UpdateOdagRequestHttpError