piremoval.PiRemovalTaskStatus

Note:

The content in this help topic pertains to SuiteScript 2.0.

Object 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.

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/piremoval Module

Methods and Properties

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 myFirstStatus = piremoval.getTaskStatus({
    id: myId
});

myPiRemovalTask.run();

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

Syntax

Related Topics