Updating a Data Provider

Purges a data provider.

Request

PUT <webiURL>/documents/{documentId}/dataproviders/{dataProviderId}?purge={purge}&purgeOptions={purgeOptions}

Where:

  • {documentId} is the document identifier retrieved from the list of documents
  • {dataProviderId} is the identifier of the data provider available for a document
  • {purge} (optional) indicates whether to purge the data provider or not. Default is false.
  • {purgeOptions} (optional) is prompts to control the purge operation. If not set or empty, only the data provider will be purged.

Request body (optional):

<dataprovider>
    <name>...</name>
</dataprovider>
Response

Response type: application/xml or application/json

The response is a message stating the success or failure of the request.

Example

To purge a data provider, but no prompts

PUT <webiURL>/documents/7738/dataproviders/DP0?purge=true

<success>
    <message>The resource of type 'Data provider' with identifier 'DP0' has been successfully updated.</message>
    <id>DP0</id>
</success>

Example

To purge a data provider and prompts

PUT <webiURL>/documents/7738/dataproviders/DP0?purge=true&purgeOptions=prompts

<success>
    <message>The resource of type 'Data provider' with identifier 'DP0' has been successfully updated.</message>
    <id>DP0</id>
</success>

Example

To rename a data provider

PUT <webiURL>/documents/7738/dataproviders/DP0

Request body in an XML file:

<dataprovider>
    <name>My Renamed Data Provider</name>
</dataprovider>

Response:

<success>
    <message>The resource of type 'Data provider' with identifier 'DP0' has been successfully updated.</message>
    <id>DP0</id>
</success>