Description
This function deletes one history from the database. When a history is deleted its ID and the time its was deleted are recorded in the database.
When a history is deleted, any History Digest API it forms part of is automatically updated (ie the relevant row is also deleted).
Parameters
| Name | Type | Description |
|---|---|---|
| datasource | String, optional | The name of the datasource where this history is logged. This parameter overrides the same parameter in the worker configuration which in turn overrides the default datasource |
| id | String, optional | The unique internally generated key that identifies this history. Do not specify id and label parameters together |
| labela | String/int/real/bool, required if id is not set | The first part of the unique compound key that identifies this history. |
| labelb | String/int/real/bool/null, optional | The second (optional) part of the unique compound key that identifies this history |
| labelc | String/int/real/bool/null, optional | The third (optional) part of the unique compound key that identifies this history |
| labeld | String/int/real/bool/null, optional | The fourth (optional) part of the unique compound key that identifies this history |
| labele | String/int/real/bool/null, optional | The fifth (optional) part of the unique compound key that identifies this history |
Returns
If the deleteHistory() operation was successful then the "result" structure will contain the boolean value true.
Example
function(params, credentials) {
let resp = this.callWorkerMethod("history", "deleteHistory", {
"labela": "LoopingWorkflow",
"labelb": "0708-4214-3536-4580"
});
return resp;
}
Last modified on August 01, 2023
Share this page
