Clear Data (External Source Models)
  • 1 Minute to read
  • Dark
    Light
  • PDF

Clear Data (External Source Models)

  • Dark
    Light
  • PDF

Article summary

The Clear Data API clears existing data from an External Source Model based on the scope of the definition. When clearing data from an external source model, you can opt to clear specific data versus the entire model. To clear specific data, use filters. To clear all model data, use the API without filters. For example, you might opt to clear data for a specific period, a department, or a company.

 This API works with both the legacy External Source Model functionality and the newest implementation of ESM.

Note:
This API cannot be used to clear data from the HACPM_Financial model, even though it is of type Source.

The request is idempotent. Clear Data API will return success even if all data has been cleared in earlier call.

POST /modeling/sourcemodel/data/clear HTTP/1.1
Content-Type: application/xml
Accept: application/xml
X-ACCESS-TOKEN:
 
<clear-data-payload>
<model-name>$SourceModelName</model-name>
</clear-data-payload>
 
The syntax below provides example syntax to clear data for two fields (each of which have 3 values) from an external source model.
<clear-data-payload>
<model-name>$SourceModelName</model-name>
<filters>
<filter>
<field></field>
<field-value></field-value>
<field-value></field-value>
<field-value></field-value>
</filter>
<filter>
<field></field>
<field-value></field-value>
<field-value></field-value>
<field-value></field-value>
</filter>
</filters>
</clear-data-payload>

Was this article helpful?