API Documentation¶

Start by importing Archiver Python Frontend.

The ArchiverConfig class¶

Interface to REST API commands supported by the Archiver Appliance MGMT service

Methods for getting the information about Archiver’s PVs:

`ArchiverConfig.get_all_pvs`	Return all the PVs (Note: this call can return millions of PVs)
`ArchiverConfig.get_pv_status`	Return the PV status
`ArchiverConfig.get_pv_type_info`	Return the type info for the specified PV
`ArchiverConfig.get_pv_details`	Return the detailed statistics for the specified PV
`ArchiverConfig.get_recently_added_pvs`	Return a list of PVs sorted by descending PVTypeInfo creation timestamp
`ArchiverConfig.get_paused_pvs_report`	Return a list of PVs that are currently paused
`ArchiverConfig.get_never_connected_pvs`	Return a list of PVs that never connected

Methods for archiving PVs:

`ArchiverConfig.archive_pvs`	Archive one or more PVs
`ArchiverConfig.get_archiving_status`	Return the PV archiving status
`ArchiverConfig.change_archival_parameters`	Change the archival parameters for the specified PV

Methods for aborting, pausing or deleting PVs:

`ArchiverConfig.abort_archiving_pv`	Abort any pending requests for archiving the specified PV
`ArchiverConfig.pause_archiving_pvs`	Pause archiving the specified PVs
`ArchiverConfig.resume_archiving_pvs`	Resume archiving the specified PVs
`ArchiverConfig.delete_pv`	Stop archiving the specified PV (Note: the PV needs to be paused first)

Interface to the Channel Finder dbl files using the PV System{Device}Signal naming convention

Methods:

`PVFinder.get_pvs`	Return PV names for the selected beamline, system, device, and signals
`PVFinder.get_systems`	Return PV system names
`PVFinder.get_devices`	Return PV device names
`PVFinder.get_signals`	Return PV signal names