3.1.4.2 ApplyPivotFilter

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 message="ApplyPivotFilterSoapIn" />
     <wsdl:output message="ApplyPivotFilterSoapOut" />
 </wsdl:operation>

The protocol client sends an ApplyPivotFilterSoapIn request message and the protocol server responds with an ApplyPivotFilterSoapOut 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 pivotFilterOptions 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, 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<9> 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.