3.1.4.46 TogglePivotDrill

  • Article

This operation is used to expand or collapse a PivotTable or PivotChart member.

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

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

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

  1. The protocol client sends the PivotTable member to be expanded or collapsed in the pivotOperationOptions element (section 3.1.4.46.2.1).

  2. The protocol server expands the PivotTable member if it was collapsed. The protocol server collapses the PivotTable member if it was expanded.

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<63> 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