piremoval.createTask(options)
Method Description |
Creates a new personal information removal task.
Note:
Remove Personal Information Create permission is required to create a PI removal task. |
Returns |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Object Members |
|
Since |
2019.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
number[] |
optional |
Represents IDs of fields whose personal information is removed. |
|
boolean |
optional |
Indicates whether the PI removal task removes system note information only, not field values or workflow history. If true, the task removes information from system notes only. If false, the task removes information from system notes, workflow history, and field values. The default value is false. |
|
string |
optional |
Represents the text used in system notes to replace the original values. |
|
number[] |
optional |
Represents IDs of records whose personal information is removed. |
|
string |
optional |
Describes the record type that is updated by the PI removal task. |
|
number[] |
optional |
Represents the workflow IDs whose history is processed by the PI removal task. |
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;
myPiRemovalTask.run();
...
// Add additional code