3.1.4.4 ApplyPivotTop10Filter

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

 <wsdl:operation name="ApplyPivotTop10Filter">
     <wsdl:input message="ApplyPivotTop10FilterSoapIn" />
     <wsdl:output message="ApplyPivotTop10FilterSoapOut" />
 </wsdl:operation>

The protocol client sends an ApplyPivotTop10FilterSoapIn request message, and the protocol server responds with an ApplyPivotTop10FilterSoapOut 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 pivotFilterOptions element.

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

In the event of an application error on the protocol server during this operation, the protocol server MUST return an ExcelServerMessage as specified in section 2.2.9.2. The id element of the ExcelServerMessage MUST be one of the values specified in section 2.2.9.4, and SHOULD<11> be one of the values described in the following table.

Id

Description

InvalidOrTimedOutSession

See section 2.2.9.5.

RetryError

See section 2.2.9.5.

OperationCanceled

See section 2.2.9.5.

InternalError

See section 2.2.9.5.

MultipleRequestsOnSession

See section 2.2.9.5.

MaxRequestDurationExceeded

See section 2.2.9.5.