Type Alias OdagRequestsAPI

Index

Properties

clearCache: typeof odagRequests.clearCache

Clears the cache for odag-requests api requests.

createOdagRequestReloadApp: typeof createOdagRequestReloadApp

Reloads data in a generated Analytics Application from the underlying data sources. Only the request owner or ODAG link creator can reload generated Analytics Applications.

The ID of the request.

an object with the body content

CreateOdagRequestReloadAppHttpError

createOdagRequestRenameApp: typeof createOdagRequestRenameApp

Renames a generated Analytics Application. Only the request owner or ODAG link creator can rename generated Analytics Applications.

The ID of the request.

an object with the body content

CreateOdagRequestRenameAppHttpError

deleteOdagRequestApp: typeof deleteOdagRequestApp

Deletes the generated Analytics Application associated with a completed request. Only the request owner or ODAG link creator can delete generated Analytics Applications.

The ID of the request.

DeleteOdagRequestAppHttpError

getOdagRequest: typeof getOdagRequest

Retrieves the current status and details of an ODAG request, including its state (queued, loading, succeeded, failed), generated Analytics Application ID, and error information. For multi-application generation requests, includes nested status for each sub-request.

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

GetOdagRequestHttpError

getOdagRequestSelections: typeof getOdagRequestSelections

Retrieves the selection state (selected and optional field values) that was active when the Analytics Application generation request was submitted.

The ID of the request.

GetOdagRequestSelectionsHttpError

updateOdagRequest: typeof 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.

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

an object with query parameters

UpdateOdagRequestHttpError