piremoval.deleteTask(options)
|
Method Description |
Deletes a personal information removal task. |
|
Returns |
void |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
|
Governance |
20 units |
|
Module |
|
|
Sibling Object Members |
|
|
Since |
2019.2 |
Parameters
The options parameter is a JavaScript object.
|
Parameter |
Type |
Required / Optional |
Description |
|---|---|---|---|
|
|
number |
required |
Unique identifier of the personal information removal task. |
Errors
|
Error Code |
Error Message |
Thrown If |
|---|---|---|
|
|
Cannot delete PIRemoval job that was not saved |
Job is not saved. |
Syntax
The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/piremoval Module Script Sample.
// Add additional code
...
var myPiRemovalTask = piremoval.createTask({
recordType: 'customer',
recordIds: [95, 107],
fieldIds: ['email', 'phone'],
workflowIds: [3, 7],
historyOnly: true,
historyReplacement: 'removed_value'
});
myPiRemovalTask.save();
var myTaskId = myPiRemovalTask.id;
piremoval.deleteTask({
id: myTaskId
});
...
// Add additional code