PiRemovalTask.recordIds

Property Description

ID of records whose PI is removed.

If no record IDs are entered, no information changes are performed. If the record IDs are null or invalid, the following exception occurs:

  • Wrong parameter type: options.recordIds is expected as array.

Type

number[] (read-only)

Module

N/piremoval Module

Parent Object

piremoval.PiRemovalTask

Sibling Object Members

PiRemovalTask Object Members

Since

2019.2

Syntax

Important:

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'],
    historyReplacement: 'removed_value'
});

myPiRemovalTask.save();
var theRecordIds = myPiRemovalTask.recordIds;
...
// Add additional code 

          

Related Topics

General Notices