CData Python Connector for SAP BusinessObjects BI

Build 25.0.9454

PurgeReport

Purges a document or its data providers.

Execute


    EXEC PurgeReport DocumentId=5486, purge=true, purgeOptions='prompts', dataProviderIDs='12,1'

Input

Name Type Required Description
DocumentID String True The identifier of the document to purge.
Purge Bool False An optional boolean that specifies whether the application should purge the document.

The default value is false.

PurgeOptions String False An optional string parameter that manages the purge. For now, prompt is the only value allowed. If you don't set this parameter or leave it empty, the application only purges the data provider.
DataProviderIDs String False An optional string that specifies the data providers whose parameters should be retrieved. If you have multiple data providers, make sure to separate them using a comma.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details String Details of execution failure. NULL if success=true.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454