PiRemovalTaskStatus.status

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

Encapsulates the status of a personal information removal task returned by piremoval.getTaskStatus(options).

Possible status values include:

PENDING
PROCESSING
COMPLETE
FAILED

For more information, see task.TaskStatus.

Type

string (read-only)

Module

N/piremoval Module

Parent Object

piremoval.PiRemovalTaskStatus

Sibling Object Members

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

myPiRemovalTask.save();
var myId = myPiRemovalTask.id;

var myTaskStatus = piremoval.getTaskStatus({
    id: myId
});
var theStatus = myTaskStatus.status;
...
// Add additional code

Syntax

Related Topics