3.1.4.35 Refresh

  • Article

This operation is used to refresh connected data on a workbook.

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

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

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

  1. If dataConnectionName is present and is not empty, the protocol server refreshes the connected data as uniquely identified by the values of the dataConnectionName and externalSourceIndex elements.

  2. For the lifetime of the session (2) the protocol server allows external data refresh.

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

  • OdcNotSupported

  • GenericModelFailure

  • ModelStreamingFailure

  • NoStreamingServers

  • LegacyModelError