Share via

3.1.4.2 ApplyPivotFilter

  • Article

This operation is used to apply a PivotTable custom filter or a PivotTable manual filter on a PivotTable field.

 <wsdl:operation name="ApplyPivotFilter">
   <wsdl:input wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ApplyPivotFilter" message="tns:ExcelServiceSoap_ApplyPivotFilter_InputMessage"/>
   <wsdl:output wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ApplyPivotFilterResponse" message="tns:ExcelServiceSoap_ApplyPivotFilter_OutputMessage"/>
   <wsdl:fault wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ApplyPivotFilterExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_ApplyPivotFilter_ExcelServerMessageFault_FaultMessage"/>
 </wsdl:operation>

The protocol client sends an ExcelServiceSoap_ApplyPivotFilter_InputMessage request message, and the protocol server responds with an ExcelServiceSoap_ApplyPivotFilter_OutputMessage response message, as follows:

  1. The protocol client sends the PivotTable custom filter or PivotTable manual filter to be applied, and the information identifying the PivotTable field in the pivotOperationOptions element.

  2. The protocol server applies the PivotTable custom filter or PivotTable manual filter to the PivotTable field.

In the event of an application error on the protocol server during this operation, a SOAP fault is returned, as specified in section 2.2.2. The Id element of the ExcelServerMessage SHOULD<7> be one of the values specified in section 2.2.2.1 or any of the following values.

  • "DclNotTrusted"

  • "ErrorAccessingSsoFromEcs"

  • "ErrorAccessingSsofromWfe"

  • "ErrorConnectingToDataSource"

  • "ErrorConnectingToDataSourceReadOrViewOnly"

  • "ExternalDataNotAllowedOnTL"

  • "ExternalDataRefreshFailed"

  • "ExternalDataRefreshFailed_Details"

  • "ExternalDataRefreshFailedReadOrViewOnly"

  • "ExternalDataRefreshFailedReal"

  • "IncorrectAuthUsed"

  • "InvalidUriorLocalConnectionPath"

  • "InvalidUserNameOrPassword"

  • "InvalidUserNameOrPasswordReadOrViewOnly"

  • "NoAccessToOdcReadOrViewOnly"

  • "OdcFileDoesNotExist"

  • "UnattendedAccountNotConfigured"

This operation is a state changing operation on the protocol server.