3.1.4.24 Refresh

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

 <wsdl:operation name="Refresh">
     <wsdl:input message="RefreshSoapIn" />
     <wsdl:output message="RefreshSoapOut" />
 </wsdl:operation>

The protocol client sends a RefreshSoapIn request message, and the protocol server responds with a RefreshSoapOut response message, as follows:

  1. If dataConnectionName is not present or is empty, the protocol server MUST return an ExcelServerMessage as specified in section 2.2.9.2. The id element of the ExcelServerMessage MUST be InternalError.

  2. If dataConnectionName is present and is not empty, the protocol server MUST refresh the specified connected data.

In the event of an application error on the protocol server during this operation, the protocol server MUST return an ExcelServerMessage as specified in section 2.2.9.2. The id element of the ExcelServerMessage MUST be one of the values specified in section 2.2.9.4, and SHOULD<39> be one of the values described in the following table.

Id

Description

InvalidOrTimedOutSession

See section 2.2.9.5.

RetryError

See section 2.2.9.5.

OperationCanceled

See section 2.2.9.5.

MultipleRequestsOnSession

See section 2.2.9.5.

MaxRequestDurationExceeded

See section 2.2.9.5.

InternalError

See section 2.2.9.5.

ExternalDataRefreshFailed

Connected data refresh failed.