Subscribe

The UiPath Marketplace Guide

Get Record

The Get Record activity uses the the NetSuite get operation to retrieve a specific record (internalid).

After retrieving the record, the activity outputs the record details in a DataRow object (Results) and the status of the request (success/failure information) in a ResponseStatus object (NetSuiteStatus).

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the NetSuite Application Scope activity to your project.
  3. Add the Get Record activity inside the NetSuite Application Scope activity.
  4. Click the Configure button inside the Get Record activity (this opens the Object Wizard).
  5. Select the Object that you want to retrieve and enter, at a minimum, the internalid of the record.
  6. Create and enter a DataRow variable and a ResponseStatus variable for the Output properties.
    • Your input property values are sent to the get operation.
    • The operation returns the DataRow and ResponseStatus value to your output property variables.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Configure

To enter your Get Record property values, you must use the Object Wizard by clicking the Configure button.

To learn more, see the Wizards section in the About page.

📘

Casting a Record to a specific Record Type

The Record output parameter will return a generic NetSuite Record object. You can convert this to a specific NetSuite object by using an Assign Activity.

For example if you were retrieving a SupportCase object and your output variable from the NetSuite Get Record activity was named RecordOuput , you would use the following as the (To) parameter of the Assign Activity:

CType(RecordOutput,UiPath.OracleNetSuite.com.netsuite.webservices.SupportCase)

Common

DisplayName

The display name of the activity.

Attributes

Details

Type

String

Required

Yes

Default value

Get Record

Allowed values

Enter a String or String variable.

Notes

N/A


Object wizard

internalid

The id of the NetSuite record that you want to retrieve.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

To get the internalid value, see Enable Show Internal IDs in the Setup guide.


Input

AdditionalFields

A DataRow that includes the columns and values that you want to get.

Attributes

Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String variable.

Notes

The column names must match the names as they appear in the NetSuite database table for the record type.


Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes

Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Output

ResponseStatus

The status of the request (success/failure information).

Attributes

Details

Type

ResponseStatus

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a ResponseStatus variable.

UiPath.BAF.Models.ResponseStatus

Notes

The ResponseStatus object includes three properties that you can use in other activities.
Success - Boolean - Specifies whether the request was successful.
ErrorCode - String - The response error if the request is unsuccessful (Success=False).
Message - String - The error message.
The example image below shows some of the properties that you can return.

Updated 3 months ago


Get Record


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.