Share via

3.1.4.4 ApplyPivotTop10Filter

  • Article

This operation is used to apply a top N filter or a bottom N filter on a PivotTable field.

The following is the WSDL port type specification of the ApplyPivotTop10Filter WSDL operation.

 <wsdl:operation name="ApplyPivotTop10Filter" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ApplyPivotTop10Filter" message="tns:ExcelServiceSoap_ApplyPivotTop10Filter_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ApplyPivotTop10FilterResponse" message="tns:ExcelServiceSoap_ApplyPivotTop10Filter_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ApplyPivotTop10FilterExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_ApplyPivotTop10Filter_ExcelServerMessageFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

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

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

  2. The protocol server applies the top N filter or bottom N filter to the PivotTable field.

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

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<13> be one of the values specified in section 2.2.2.1 or any of the following values:

  • DclNotTrusted

  • ErrorAccessingSsoFromEcs

  • ErrorConnectingToDataSource

  • ErrorConnectingToDataSourceReadOrViewOnly

  • ExternalDataNotAllowedOnTL

  • ExternalDataRefreshFailed

  • ExternalDataRefreshFailed_Details

  • ExternalDataRefreshFailedReadOrViewOnly

  • ExternalDataRefreshFailedReal

  • IncorrectAuthUsed

  • InvalidUriorLocalConnectionPath

  • InvalidUserNameOrPassword

  • InvalidUserNameOrPasswordReadOrViewOnly

  • NoAccessToOdcReadOrViewOnly

  • OdcFileDoesNotExist

  • UnattendedAccountNotConfigured