3.1.4.61 ApplyPivotValueFieldSettings

  • Article

This operation is used to modify a PivotTable or PivotChart by changing the aggregation type. This operation is supported only for native-mode PivotTables and PivotCharts. The result is a query.

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

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

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

  1. The protocol client sends information that identifies the PivotTable or PivotChart in the pivotOperationOptions element, and it sends the PivotTable or PivotChart aggregation type in the pivotValueFieldSettingsApplyData element.

  2. The protocol server applies the aggregation type to the PivotTable or PivotChart.

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