Share via

3.1.4.63 GetPivotValueFieldSettings

  • Article

This operation is used to get a list of the PivotTable or PivotChart aggregation types and the selected aggregation type. This operation is supported only for native-mode PivotTables and PivotCharts.

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

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

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

  1. The protocol client sends information that identifies the PivotTable or PivotChart in the pivotOperationOptions element.

  2. The protocol server uses this information to get a list of PivotTable or PivotChart aggregation types and the selected type that is associated with the PivotTable or PivotChart query.

This operation is not 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<79> be one of the values specified in section 2.2.2.1.