3.1.4.19 GetPivotMenu

  • Article

This operation is used to return information about a PivotTable area.

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

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

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

  1. The protocol client sends the information identifying the PivotTable area in the pivotOperationOptions element.

  2. The protocol server returns the PivotTable area information in the pivotMenu element.

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<28> be one of the values specified in section 2.2.2.1