Getting the Refresh Parameters of a Data Provider

Returns the parameters to be filled before running a data provider refresh.

Request

GET <webiURL>/documents/{documentId}/dataproviders/{dataproviderId}/parameters?lovInfo={true|false}

Where:

  • {documentId} is the document identifier retrieved from the list of documents
  • {dataproviderId} is the data provider identifier retrieved from the list of data providers
  • lovInfo is an optional, Boolean parameter. Default value is true. If set to false, the lists of values are not computed, nor displayed.
Response

Response type: application/xml or application/json

The response provides the parameters with their expected answers, previous values if applicable, otherwise default values. See Parameter XML Grammar to learn about the XML content structure and element details.