record.detach(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description

Detaches a record from another record.

Note:

For the promise version of this method, see record.detach.promise(options). Note that promises are only supported in client scripts.

Returns

void

Supported Script Types

Client and server scripts

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

Governance

10 units

Module

N/record Module

Since

2015.2

Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

Since

options.record

record.Record

required

The record to be detached.

2015.2

options.record.type

string

required

The type of record to be detached.

Set this value using the record.Type enum.

2015.2

options.record.id

number | string

required

The ID of the record to be detached.

2015.2

options.from

record.Record

required

The destination record that options.record should be detached from.

2015.2

options.from.type

string

required

The type of the destination.

Set this value using the record.Type enum.

2015.2

options.from.id

number | string

required

The ID of the destination.

2015.2

options.attributes

Object

optional

Name-value pairs containing default values of fields in the new record.

By default, this value is null.

2015.2

Errors

Error Code

Thrown If

SSS_MISSING_REQD_ARGUMENT

A required argument is missing or undefined.

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/record Module Script Samples.

          // Add additional code
...
record.detach({
    record: {
        type: 'file',
        id:'200'
    },
    from: {
        type: 'customer',
        id:'90'
    }
})
...    
// Add additional code 

        

Related Topics

N/record Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices