---
schema_version: "1"
id: c8b28fec51a62367fd81b18310591647d60f726ed61e53efa7ccf7a65351838a
title: NetSuite OpenAir Connector Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/netsuite-openair-connector/latest/netsuite-openair-connector-reference.md
canonical_url: https://docs.mulesoft.com/netsuite-openair-connector/latest/netsuite-openair-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 06275c599e60431c76a2c5667a853f4c597fad09aec50d2ca8d2b8f0910f4e35
description: MuleSoft Documentation Site
release: "2.0"
latest: true
---
---
product: NetSuite OpenAir Connector
version: 2.0
is-latest-version: true
---

# NetSuite OpenAir Connector Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

NetSuite OpenAir Connector v2.0

Release Notes:
[NetSuite OpenAir Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/netsuite-openair-connector-release-notes-mule-4)

## Default Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#config_login-authentication">Login Authentication</a></p></div></div></td><td><p>The connection types that can be provided to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances as it sees fit.</p></td><td></td><td></td></tr></tbody></table>

## Connection Types

## Login Authentication

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Company</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Api Namespace</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>Open Enpoint. Default value: <code>https://sandbox.openair.com/soap</code></p></td><td><p><code>https://sandbox.openair.com/soap</code></p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Connection Timeout. Default value: 300 seconds</p></td><td><p>300</p></td><td></td></tr><tr><td><p>Read Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Read Timeout: Default value: 270 seconds</p></td><td><p>270</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy</p></td><td></td><td></td></tr></tbody></table>

## Associated Operations

- [Add](#add)

- [Create Account](#createAccount)

- [Create User](#createUser)

- [Delete](#delete)

- [Get Crystal Info](#getCrystalInfo)

- [Make URL](#makeUrl)

- [Modify](#modify)

- [Read](#read)

- [Run Report](#runReport)

- [Server Time](#serverTime)

- [Server Time With Timezone](#serverTimeWithTimezone)

- [Submit](#submit)

- [Upsert](#upsert)

- [Who am I](#whoAmI)

## Operations

## Add

`<openair:add>`

Adds data to NetSuite OpenAir instance.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>oaObject</p></td><td><div><div><p>String</p></div></div></td><td><p>oaObject to add.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the add request.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:READ\_ERROR

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:UNKNOWN

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:XML\_PARSING

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

## Create Account

`<openair:create-account>`

Creates an account in the NetSuite OpenAir instance

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the create account request</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Create User

`<openair:create-user>`

Creates a user in the NetSuite OpenAir instance.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the create user request</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Delete

`<openair:delete>`

Deletes an oaObject from the NetSuite OpenAir instance.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>oaObject</p></td><td><div><div><p>String</p></div></div></td><td><p>oaObject to Delete</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the delete request</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Get Crystal Info

`<openair:get-crystal-info>`

Get Crystal Information from NetSuite OpenAir instance.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Make URL

`<openair:make-url>`

The makeURL creates a valid URL to a specified OpenAir page. It requires a valid user login to
succeed.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the makeURL request</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Modify

`<openair:modify>`

Modifies an OpenAir object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>oaObject</p></td><td><div><div><p>String</p></div></div></td><td><p>OpenAir Object to modify.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the modify request.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Read

`<openair:read>`

Reads data from a NetSuite OpenAir instance.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>oaObject</p></td><td><div><div><p>String</p></div></div></td><td><p>oaObject to read.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the read request.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Run Report

`<openair:run-report>`

Runs a defined Report.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the RunReport request.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:READ\_ERROR

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:UNKNOWN

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:XML\_PARSING

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

## Server Time

`<openair:server-time>`

Returns the current server time.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:READ\_ERROR

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:UNKNOWN

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:XML\_PARSING

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

## Server Time With Timezone

`<openair:server-time-with-timezone>`

Returns the current server time.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the server time request.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Submit

`<openair:submit>`

Submits an OpenAir object for approval.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>oaObject</p></td><td><div><div><p>String</p></div></div></td><td><p>oaObject for submission</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the Submit request.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Upsert

`<openair:upsert>`

Upserts the oaObject to the NetSuite OpenAir instance. The upsert operation adds or modifies an
OpenAir object based on the lookup attributes.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>oaObject</p></td><td><div><div><p>String</p></div></div></td><td><p>oaObject to upsert.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Request</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Request containing the upsert request.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Who am I

`<openair:who-am-i>`

Gets information about the current user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable in which to store the output of the operation.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr></tbody></table>

### For Configurations

- [Default Configuration](#config)

### Throws

- OPENAIR:ADD\_MODIFY\_ERROR

- OPENAIR:CONNECTIVITY

- OPENAIR:CREATE\_ACCOUNT\_ERROR

- OPENAIR:CREATE\_USER\_ERROR

- OPENAIR:DELETE\_ERROR

- OPENAIR:EXECUTION

- OPENAIR:MAKE\_URL\_ERROR

- OPENAIR:OPERATION\_FAILED

- OPENAIR:READ\_ERROR

- OPENAIR:RETRY\_EXHAUSTED

- OPENAIR:SUBMIT\_ERROR

- OPENAIR:UNKNOWN

- OPENAIR:WSDL\_PARSING\_PROBLEM

- OPENAIR:XML\_PARSING

## Types

## Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>The reconnection strategy to use</p></td><td></td><td></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If false, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

## Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute.</p></td><td></td><td></td></tr></tbody></table>

## Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>How much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which all these attributes are expressed</p></td><td></td><td></td></tr></tbody></table>

## Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)