Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Arelle
Logo
Arelle
  • Install
  • Command Line Operation
  • Webserver Security
  • FAQ
  • Versioning
  • ESEF (European Single Electronic Format)
  • User Guides
    • Fact Deduplication
  • Plugins
    • Plugin Installation
    • Using Plugins with GUI
    • Using Plugins with CLI
    • Popular Plugins
      • Arelle iXBRL Viewer
      • EDGAR
      • Inline XBRL Document Set
      • Save Loadable OIM
      • SEC Inline Transforms
      • Validation Plugins
      • XULE
    • Plugin Development
      • Getting Started
      • Publishing a Plugin
      • Create a Validation Plugin
      • Plugin Hooks
  • Python API
  • Contributor Guides
    • Contributing
    • Building Documentation
    • Updating the EFM Conformance Suite
  • License
  • API Reference
    • arelle
      • arelle.oim
        • arelle.oim.tc
          • arelle.oim.tc.metadata
            • arelle.oim.tc.metadata.validate
            • arelle.oim.tc.metadata.model
            • arelle.oim.tc.metadata.parser
            • arelle.oim.tc.metadata.keys_validation
            • arelle.oim.tc.metadata.restrictions
            • arelle.oim.tc.metadata.value_constraint_validation
            • arelle.oim.tc.metadata.common
            • arelle.oim.tc.metadata.types
          • arelle.oim.tc.report
            • arelle.oim.tc.report.validate
            • arelle.oim.tc.report.cell
            • arelle.oim.tc.report.key_values
            • arelle.oim.tc.report.keys
            • arelle.oim.tc.report.common
          • arelle.oim.tc.xs_dates
          • arelle.oim.tc.periods
          • arelle.oim.tc.value_validator
          • arelle.oim.tc.common
          • arelle.oim.tc.const
        • arelle.oim.xml
          • arelle.oim.xml.Save
        • arelle.oim.csv
          • arelle.oim.csv.metadata
            • arelle.oim.csv.metadata.model
            • arelle.oim.csv.metadata.parser
            • arelle.oim.csv.metadata.common
          • arelle.oim.csv.context
        • arelle.oim.Validate
        • arelle.oim.const
        • arelle.oim.Load
      • arelle.logging
        • arelle.logging.handlers
          • arelle.logging.handlers.LogToBufferHandler
          • arelle.logging.handlers.LogToXmlHandler
          • arelle.logging.handlers.LogToPrintHandler
          • arelle.logging.handlers.LogHandlerWithXml
          • arelle.logging.handlers.StructuredMessageLogHandler
        • arelle.logging.formatters
          • arelle.logging.formatters.LogFormatter
      • arelle.packages
        • arelle.packages.report
          • arelle.packages.report.ReportPackage
          • arelle.packages.report.DetectReportPackage
          • arelle.packages.report.ReportPackageValidator
          • arelle.packages.report.ReportPackageConst
        • arelle.packages.PackageUtils
        • arelle.packages.package_registry
        • arelle.packages.PackageType
        • arelle.packages.package_meta
        • arelle.packages.PackageConst
        • arelle.packages.PackageValidation
      • arelle.webserver
        • arelle.webserver.bottle
      • arelle.plugin_system
        • arelle.plugin_system.entry_point_ref
        • arelle.plugin_system.plugin_meta
        • arelle.plugin_system.plugin_provider
      • arelle.rendering
        • arelle.rendering.RenderingResolution
        • arelle.rendering.RenderingEvaluator
        • arelle.rendering.RenderingLayout
      • arelle.api
        • arelle.api.Session
      • arelle.conformance
        • arelle.conformance.CSVTestcaseLoader
        • arelle.conformance.Constants
      • arelle.utils
        • arelle.utils.validate
          • arelle.utils.validate.Common
          • arelle.utils.validate.Document
          • arelle.utils.validate.RoleTypes
          • arelle.utils.validate.Validation
          • arelle.utils.validate.ESEFImage
          • arelle.utils.validate.ValidationPlugin
          • arelle.utils.validate.Decorator
          • arelle.utils.validate.Characters
          • arelle.utils.validate.ValidationUtil
          • arelle.utils.validate.ContextIssues
          • arelle.utils.validate.DetectScriptsInXhtml
          • arelle.utils.validate.Concepts
          • arelle.utils.validate.DuplicateFacts
          • arelle.utils.validate.Facts
        • arelle.utils.deprecation
        • arelle.utils.PluginHooks
        • arelle.utils.Equivalence
        • arelle.utils.PluginData
        • arelle.utils.Units
        • arelle.utils.Contexts
        • arelle.utils.EntryPointDetection
      • arelle.formula
        • arelle.formula.XPathContext
        • arelle.formula.XPathParser
        • arelle.formula.FactAspectsCache
        • arelle.formula.FormulaEvaluator
        • arelle.formula.FormulaConsisAsser
        • arelle.formula.ValidateFormula
      • arelle.FunctionCustom
      • arelle.DialogArcroleGroup
      • arelle.DialogOpenArchive
      • arelle.PrototypeDtsObject
      • arelle.ViewFileRelationshipSet
      • arelle.ViewWinTkTable
      • arelle.ViewFileRssFeed
      • arelle.ModelManager
      • arelle.FunctionIxt
      • arelle.UrlUtil
      • arelle.ModelRenderingObject
      • arelle.DialogFind
      • arelle.DialogLanguage
      • arelle.XmlValidateConst
      • arelle.ViewWinXml
      • arelle.ViewFileTests
      • arelle.DialogFormulaParameters
      • arelle.PrototypeInstanceObject
      • arelle.DialogUserPassword
      • arelle.ViewFileRoleTypes
      • arelle.UiUtil
      • arelle.XmlValidateSchema
      • arelle.BetaFeatures
      • arelle.ModelInstanceObject
      • arelle.DialogNewFactItem
      • arelle.ViewWinFactList
      • arelle.ModelDocument
      • arelle.CntlrWinMain
      • arelle.HtmlUtil
      • arelle.ValidateInfoset
      • arelle.ViewWinTupleGrid
      • arelle.ViewFileRenderedStructure
      • arelle.CntlrWinTooltip
      • arelle.ViewWinRssFeed
      • arelle.HashUtil
      • arelle.XbrlUtil
      • arelle.WatchRss
      • arelle.ModelValue
      • arelle.ErrorManager
      • arelle.ValidateXbrlCalcs
      • arelle.Cntlr
      • arelle.SocketUtils
      • arelle.ValidateFilingText
      • arelle.ViewUtil
      • arelle.ViewWinRoleTypes
      • arelle.PluginUtils
      • arelle.CompareInstance
      • arelle.ModelXbrl
      • arelle.UITkTable
      • arelle.FileSource
      • arelle.Updater
      • arelle.TkTableWrapper
      • arelle.ModelRelationshipSet
      • arelle.FunctionXs
      • arelle.ValidateFileSource
      • arelle.RuntimeOptions
      • arelle.Version
      • arelle.DialogPackageManager
      • arelle.ViewFileRenderedGrid
      • arelle.ViewWinFormulae
      • arelle.ViewWinGrid
      • arelle.typing
      • arelle.DialogRssWatch
      • arelle.ValidateDuplicateFacts
      • arelle.XhtmlValidate
      • arelle.ViewWinProperties
      • arelle.ViewWinVersReport
      • arelle.ModelVersObject
      • arelle.XbrlConst
      • arelle.ModelVersReport
      • arelle.XmlValidateParticles
      • arelle.DisclosureSystem
      • arelle.Validate
      • arelle.SystemInfo
      • arelle.DialogAbout
      • arelle.ViewFileFactTable
      • arelle.ValidateDuplicateFactsConst
      • arelle.ViewWinRelationshipSet
      • arelle.CntlrCmdLine
      • arelle.ModelRssObject
      • arelle.FunctionXfi
      • arelle.ViewFileFactList
      • arelle.PythonUtil
      • arelle.DialogPluginManager
      • arelle.ValidateVersReport
      • arelle.WebCache
      • arelle.ModelObjectFactory
      • arelle.TableStructure
      • arelle.LinkbaseType
      • arelle.ViewWinDiffs
      • arelle.LinkRelationships
      • arelle.ModelTestcaseObject
      • arelle.ModelDocumentType
      • arelle.ViewUtilFormulae
      • arelle.ViewFileDTS
      • arelle.ViewFile
      • arelle.FunctionFn
      • arelle.ModelDtsObject
      • arelle.XmlUtil
      • arelle.ValidateXbrlDimensions
      • arelle.ViewWinConcepts
      • arelle.ViewWinTree
      • arelle.ViewWinRenderedGrid
      • arelle.ViewFileConcepts
      • arelle.ValidateXbrl
      • arelle.LocalViewer
      • arelle.ValidateUtr
      • arelle.ViewWinDTS
      • arelle.ViewFileRenderedLayout
      • arelle.ViewWinPane
      • arelle.LeiUtil
      • arelle.ViewWinFactTable
      • arelle.ValidateXbrlDTS
      • arelle.FunctionUtil
      • arelle.PluginManager
      • arelle.ModelFormulaObject
      • arelle.ViewWinList
      • arelle.Aspect
      • arelle.DialogURL
      • arelle.ModelRssItem
      • arelle.Locale
      • arelle.ModelObject
      • arelle.ViewWinTests
      • arelle.XhtmlInlineUtil
      • arelle.CntlrWebMain
      • arelle.ViewFileFormulae
      • arelle.PackageManager
      • arelle.XmlValidate
  • Index
Back to top
View this page

arelle.oim.xml.Save¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Functions¶

saveOimReportToXmlInstance

API¶

arelle.oim.xml.Save.saveOimReportToXmlInstance(modelDocument: arelle.ModelDocument.ModelDocument, filePath: str, responseZipStream: BinaryIO | None = None) → None¶
Next
arelle.oim.csv
Previous
arelle.oim.xml
Copyright © 2011-present Workiva, Inc.
Made with Sphinx and @pradyunsg's Furo
On this page
  • arelle.oim.xml.Save
    • Module Contents
      • Functions
      • API
        • saveOimReportToXmlInstance()