3.1.4.47 ApplyPivot

  • Article

This operation is used to modify a PivotTable or a PivotChart.

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

 <wsdl:operation name="ApplyPivot" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ApplyPivot" message="tns:ExcelServiceSoap_ApplyPivot_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/ApplyPivotResponse" message="tns:ExcelServiceSoap_ApplyPivot_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/ApplyPivotExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_ApplyPivot_ExcelServerMessageFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

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

  1. The protocol client sends both information that identifies the PivotTable or PivotChart in the pivotOperationOptions element (section 3.1.4.47.2.1) and PivotTable field information (including how that PivotTable field is changing) in the pivotFieldApplyData element (section 3.1.4.47.2.1).

  2. The protocol server applies the PivotTable field information to the PivotTable or PivotChart, and modifies it accordingly.

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<64> be one of the values specified in section 2.2.2.1 or any of the following values (see section 2.2.5.13):

  • DclNotTrusted

  • ErrorAccessingSsoFromEcs

  • ErrorConnectingToDataSource

  • ErrorConnectingToDataSourceReadOrViewOnly

  • ExternalDataNotAllowedOnTL

  • ExternalDataRefreshFailed

  • ExternalDataRefreshFailed_Details

  • ExternalDataRefreshFailedReadOrViewOnly

  • ExternalDataRefreshFailedReal

  • IncorrectAuthUsed

  • InvalidUriorLocalConnectionPath

  • InvalidUserNameOrPassword

  • InvalidUserNameOrPasswordReadOrViewOnly

  • NoAccessToOdcReadOrViewOnly

  • OdcFileDoesNotExist

  • UnattendedAccountNotConfigured