Engine

Covers Engine 2.0.0

Channels and Persistence

Read, write, search, and persist channel data and channel definitions.

OperationDescription
argus/history/startQueries event and log history in a detached job.
rapid/audit-channel-impactAudits channel ownership and project references before a channel, task,
rapid/channel-export-startStarts a client-owned background CSV export of raw channel samples.
rapid/dataframes/channelsLists recorded channels overlapping one saved view. Counts are loaded only for the requested page.
rapid/dataframes/createCreates a historical dataframe from a recording selection.
rapid/dataframes/create-sampleCreates sample recordings, events, logs and historical dataframes.
rapid/dataframes/export-startStarts a cancellable ZIP export of a dataframe’s selected records.
rapid/dataframes/getReturns a test dataframe.
rapid/dataframes/listLists managed test dataframes. Pages are ordered by start time, then ID. Overview mode covers the full requested range without returning full frame records.
rapid/dataframes/removeRemoves a stored dataframe definition.
rapid/dataframes/startStarts a saved dataframe view at the engine clock.
rapid/dataframes/statistics-startCounts a saved dataframe and estimates logical recording payload size without reading channel sample values or formatting an export.
rapid/dataframes/stopCloses a saved dataframe view at the engine clock.
rapid/dataframes/updateUpdates a stored historical dataframe selection.
rapid/delete-channelDeletes channel.
rapid/delete-channelsDeletes multiple local channels in one protected RAPID configuration transaction.
rapid/get-channel-field-configReturns channel field config.
rapid/get-channel-keysReturns channel keys.
rapid/get-channels-dataReturns channels data.
rapid/get-fixed-configurationReturns RAPID fixed-channel configuration and protection state.
rapid/get-persistence-diagnosticsReturns persistence diagnostics.
rapid/history/channelsQueries channel history summaries in a detached job.
rapid/history/configure-retentionSaves automatic retention policy with nonnegative limits.
rapid/history/delete-previewBuilds a history cleanup preview without deleting recordings.
rapid/history/delete-startApplies a reviewed history cleanup preview.
rapid/history/jobsLists stored cleanup operations and maintenance status.
rapid/history/resumeResumes reclamation for a stored cleanup operation.
rapid/history/retentionReads automatic retention policy.
rapid/history/storesLists recording stores and their history in a detached job.
rapid/list-channel-reference-candidatesLists literal channel names used by project resources and live task
rapid/query-channel-last-recordedQueries channel last recorded.
rapid/query-channel-rangeQueries channel range.
rapid/query-channel-range-startStarts a cancellable, low-priority historical graph query job.
rapid/search-channel-keysSearches channel keys.
rapid/set-fixed-configuration-sealedOpens or protects RAPID’s fixed-channel configuration after active task transactions finish.
rapid/upsert-channel-fieldCreates or updates a typed channel field.