---
schema_version: "1"
id: e84f80317a8082ff39914961efafc3707317f16009dca0f39be392717bf2cba1
title: Smartsheet Connector 1.2 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/smartsheet-connector/latest/smartsheet-connector-reference.md
canonical_url: https://docs.mulesoft.com/smartsheet-connector/latest/smartsheet-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: c43f74551c86ef26cb2ea5d0a89da2f191ab15fca1f18fab1175c94312c005cf
description: MuleSoft Documentation Site
release: "1.2"
latest: true
---
---
product: Smartsheet Connector
version: 1.2
is-latest-version: true
---

# Smartsheet Connector 1.2 Reference

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

Anypoint Connector for Smartsheet (Smartsheet Connector) enables you to interface with the
Smartsheet platform without having to interact with the Smartsheet API directly.

## Configurations

---

### Config

#### 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_Oauth20">Oauth2 0 Connection Provider</a></p></div></div></td><td><p>The connection types to provide to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td><p>60</p></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</p></td><td><p>AUTO</p></td><td></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 Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Oauth2 0 Connection Provider

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

###### 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>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for establishing connections to the remote service</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout 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 Connection Timeout</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If false, each connection will be closed after the first request is completed.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of outbound connections to keep open at the same time</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>A timeout for how long a connection can remain idle before it is closed</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout 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 connection Idle Timeout</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Reusable configuration element for outbound connections through a proxy</p></td><td></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether or not to stream received responses, which means that processing continues as soon as all headers are parsed, and the body is streamed as it is received.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The space, in bytes, for the buffer where the HTTP response will be stored.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Protocol</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HTTP</p></li><li><p>HTTPS</p></li></ul></div></div></td><td><p>Protocol to use for communication. Valid values are HTTP and HTTPS.</p></td><td><p>HTTP</p></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td></td><td></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><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerKey as registered with the service provider</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth consumerSecret as registered with the service provider</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s authorization endpoint URL</p></td><td><p><code>https://app.smartsheet.com/b/authorize</code></p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s accessToken endpoint URL</p></td><td><p><code>https://api.smartsheet.com/2.0/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth scopes to be requested during the dance. If not provided, this value defaults to those in the annotation.</p></td><td><p>ADMIN_SHEETS</p></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The resourceOwnerId that each component should use if it isn’t referenced otherwise.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute right before starting the OAuth dance</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute right after an accessToken has been received</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to an &lt;http:listener-config /&gt; to use to create the listener that will catch the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the access token callback endpoint</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>The path of the local HTTP endpoint that triggers the OAuth dance</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>If the callback endpoint is behind a proxy or should be accessed through an indirect URL, use this parameter to tell the OAuth provider the URL it should use to access the callback</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store that should be used to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store.</p></td><td></td><td></td></tr></tbody></table>

## Supported Operations

- [Create Sheet](#CreateSheets)

- [Copy Sheet](#CreateSheetsCopyBySheetId)

- [Add Comment](#CreateSheetsDiscussionsCommentsBySheetIdDiscussionId)

- [Add File to Row](#CreateSheetsRowsAttachmentsBySheetIdRowId)

- [Add Rows](#CreateSheetsRowsBySheetId)

- [Copy Rows to Another Sheet](#CreateSheetsRowsCopyBySheetId)

- [Delete Sheet](#DeleteSheetsBySheetId)

- [Delete Rows](#DeleteSheetsRowsBySheetId)

- [List Sheets](#GetSheets)

- [Search Sheet](#GetSearchSheetsBySheetId)

- [Get Sheet](#GetSheetsBySheetId)

- [Get Row](#GetSheetsRowsBySheetIdRowId)

- [Unauthorize](#Unauthorize)

- [Update Sheet](#UpdateSheetsBySheetId)

- [Update Rows](#UpdateSheetsRowsBySheetId)

## Associated Sources

- [On New Or Updated Row In Sheet Trigger](#OnNewOrUpdatedRowInSheetTrigger)

## Operations

## Create Sheet

`<smartsheet:create-sheets>`

Creates a new sheet in the user’s Sheets folder. This operation makes an HTTP POST request to the
`/sheets` endpoint.

### 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>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>The content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines whether to send the request using streaming. If the value is set to <code>AUTO</code>, the best strategy is automatically determined based on the content of the request.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Copy Sheet

`<smartsheet:create-sheets-copy-by-sheet-id>`

Creates a copy of the specified sheet. This operation makes an HTTP POST request to the
`/sheets/{sheetId}/copy` endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>include</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of elements to copy</p></td><td></td><td></td></tr><tr><td><p>exclude</p></td><td><div><div><p>String</p></div></div></td><td><p>Excludes the sheet’s hyperlinks from the response</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>The content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Add Comment

`<smartsheet:create-sheets-discussions-comments-by-sheet-id-discussion-id>`

Adds a comment to a discussion. This operation makes an HTTP POST request to the
`/sheets/{sheetId}/discussions/{discussionId}/comments` endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Discussion Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Discussion ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>The content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Add File to Row

`<smartsheet:create-sheets-rows-attachments-by-sheet-id-row-id>`

Attaches a file to the specified row. This operation makes an HTTP POST request to the
`/sheets/{sheetId}/rows/{rowId}/attachments` endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Row Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Row ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Content Disposition</p></td><td><div><div><p>String</p></div></div></td><td><p>Content disposition</p></td><td></td><td></td></tr><tr><td><p>Content Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Content type</p></td><td></td><td></td></tr><tr><td><p>Content Length</p></td><td><div><div><p>Number</p></div></div></td><td><p>Content length</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Binary</p></div></div></td><td><p>The content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Add Rows

`<smartsheet:create-sheets-rows-by-sheet-id>`

Inserts one or more rows into the specified sheet. This operation makes an HTTP POST request to the
`/sheets/{sheetId}/rows` endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Allow Partial Success</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When <code>true</code>, this field enables partial success for the Add Row operation</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Override Validation</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When <code>true</code>, this field allows a cell value to be outside of the validation limits. Set this value to <code>false</code> to bypass value type checking.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>The content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Copy Rows to Another Sheet

`<smartsheet:create-sheets-rows-copy-by-sheet-id>`

Copies rows from the specified sheet to the bottom of another sheet. This operation makes an HTTP
POST request to the `/sheets/{sheetId}/rows/copy` endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>include</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of row elements to copy. The connector copies these rows in addition to the cell data.</p></td><td></td><td></td></tr><tr><td><p>Ignore Rows Not Found</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When <code>true</code>, specifying row IDs that don’t exist within the source sheet does not cause an error response. If omitted or set to <code>false</code>, specifying row IDs that don’t exist within the source sheet causes an error response, and no rows are copied.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>The content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Delete Sheet

`<smartsheet:delete-sheets-by-sheet-id>`

Deletes the specified sheet. This operation makes an HTTP DELETE request to the `/sheets/{sheetId}`
endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Delete Rows

`<smartsheet:delete-sheets-rows-by-sheet-id>`

Deletes one or more rows from the specified sheet. This operation makes an HTTP DELETE request to
the `/sheets/{sheetId}/rows` endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ids</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of row IDs</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Ignore Rows Not Found</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If <code>false</code> and any of the specified row IDs are not found, no rows are deleted.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Search Sheet

`<smartsheet:get-search-sheets-by-sheet-id>`

Searches a sheet for the specified text. This operation makes an HTTP GET request to the
`/search/sheets/{sheetId}` endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>query</p></td><td><div><div><p>String</p></div></div></td><td><p>Text for which to search. Use double quotes for an exact search.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Get Sheet

`<smartsheet:get-sheets-by-sheet-id>`

Returns the specified sheet, optionally populated with discussion and attachment objects. This
operation makes an HTTP GET request to the `/sheets/{sheetId}` endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>include</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of elements to include in the response</p></td><td></td><td></td></tr><tr><td><p>exclude</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of elements to exclude from the response</p></td><td></td><td></td></tr><tr><td><p>Column Ids</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of column IDs</p></td><td></td><td></td></tr><tr><td><p>Filter Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Overrides the values in the include field with the values specified here</p></td><td></td><td></td></tr><tr><td><p>level</p></td><td><div><div><p>Number</p></div></div></td><td><p>Indicates whether data with a new column type, such as MULTI_CONTACT_LIST or MULTI-PICK-LIST, is returned in a backwards-compatible text format or as a complex object. Valid values are:</p><p>* 0 - returns the data in a backwards-compatible text format * 1 - returns multi-contact data as a complex object * 2 - Returns multi-picklist data as a complex object</p></td><td></td><td></td></tr><tr><td><p>If Version After (DEPRECATED)</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>(DEPRECATED) This parameter will be removed in future releases. Use the <strong>If Version After</strong> field with an integer value instead.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>If Version After</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies the version of the sheet to return.</p></td><td></td><td></td></tr><tr><td><p>page</p></td><td><div><div><p>Number</p></div></div></td><td><p>Specifies which page number (1-based) to return. If not specified, the default value is <code>1</code>. If a page number greater than the number of total pages is specified, the last page is returned.</p></td><td></td><td></td></tr><tr><td><p>Page Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of rows per page to include with the sheet. If neither the page size nor page is specified, the connector returns all rows in the sheet. If only the page is specified, the connector defaults to a page size of <code>100</code>.</p></td><td></td><td></td></tr><tr><td><p>Row Ids</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of row IDs by which to filter the rows included in the result</p></td><td></td><td></td></tr><tr><td><p>Row Numbers</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of row numbers by which to filter the rows included in the result. Non-existent row numbers are ignored.</p></td><td></td><td></td></tr><tr><td><p>Rows Modified Since</p></td><td><div><div><p>String</p></div></div></td><td><p>Return only rows that have been modified since the specified date and time. Use ISO-8601 format for the date.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Get Row

`<smartsheet:get-sheets-rows-by-sheet-id-row-id>`

Returns the specified rows. This operation makes an HTTP GET request to the
`/sheets/{sheetId}/rows/{rowId}` endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Row Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Row ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>include</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of elements to include in the response</p></td><td></td><td></td></tr><tr><td><p>exclude</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of elements exclude from the response</p></td><td></td><td></td></tr><tr><td><p>level</p></td><td><div><div><p>Number</p></div></div></td><td><p>Indicates whether data with a new column type, such as MULTI_CONTACT_LIST or MULTI-PICK-LIST, is returned in a backwards-compatible text format or as a complex object. Valid values are:</p><p>* 0 - returns the data in a backwards-compatible text format * 1 - returns multi-contact data as a complex object * 2 - Returns multi-picklist data as a complex object</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## List Sheets

`<smartsheet:get-sheets>`

Gets a list of all of the sheets the user has access to. The list contains an abbreviated Sheet
object for each sheet. This operation makes an HTTP GET request to the /sheets endpoint.

### 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>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>include</p></td><td><div><div><p>String</p></div></div></td><td><p>A comma-separated list of optional elements to include in the response.</p></td><td></td><td></td></tr><tr><td><p>Modified Since</p></td><td><div><div><p>String</p></div></div></td><td><p>When specified with a date and time value, the response includes only objects that are modified on or after the date and time specified.</p></td><td></td><td></td></tr><tr><td><p>Numeric Dates</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Receive and send dates or times in numeric format, in milliseconds since the UNIX epoch.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>page</p></td><td><div><div><p>Number</p></div></div></td><td><p>Page number.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Page Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Page size.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p>RepeatableInMemoryIterable</p></li><li><p>RepeatableFileStoreIterable</p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the response times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>How the connector streams request content to the remote service:</p><p>* <code>AUTO</code> (default)</p><p>Connector automatically uses the best streaming strategy based on the request content.</p><p>* <code>ALWAYS</code></p><p>Connector always streams the request content.</p><p>* <code>NEVER</code></p><p>Connector does not stream the request content.</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>Name of the variable that stores the operation’s output.</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>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</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="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>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><strong>Type</strong></p></td><td><div><div><p>Array of Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Unauthorize

`<smartsheet:unauthorize>`

Deletes the access token information associated with a specified resource owner ID so that it’s not
possible to execute an operation for that user without performing the authorization dance again.

### 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>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the resource owner whose access should be invalidated</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</p></td><td></td><td><p>x</p></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

## Update Sheet

`<smartsheet:update-sheets-by-sheet-id>`

Updates an individual user’s sheet settings. If the request body contains only the userSettings
attribute, this operation can be performed even if the user has only read-only access to the sheet
(for example, if the user has viewer permissions or the sheet is read-only). This operation makes an
HTTP PUT request to the /sheets/{sheetId} endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>The content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Update Rows

`<smartsheet:update-sheets-rows-by-sheet-id>`

Updates the cell values in the specified rows. This operation makes an HTTP PUT request to the
`/sheets/{sheetId}/rows` endpoint.

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Sheet ID</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Allow Partial Success</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When <code>true</code>, this field enables the Update Rows operation results to be partially successful</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Override Validation</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When <code>true</code>, this field allows a cell value to be outside the validation limits. Set this value to <code>false</code>, to bypass value type checking.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>The content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for the request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout 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 Response Timeout</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><p>Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.</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>Name of the variable that stores the operation’s output</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>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- SMARTSHEET:BAD\_REQUEST

- SMARTSHEET:CLIENT\_ERROR

- SMARTSHEET:CONNECTIVITY

- SMARTSHEET:INTERNAL\_SERVER\_ERROR

- SMARTSHEET:NOT\_ACCEPTABLE

- SMARTSHEET:NOT\_FOUND

- SMARTSHEET:RETRY\_EXHAUSTED

- SMARTSHEET:SERVER\_ERROR

- SMARTSHEET:SERVICE\_UNAVAILABLE

- SMARTSHEET:TIMEOUT

- SMARTSHEET:TOO\_MANY\_REQUESTS

- SMARTSHEET:UNAUTHORIZED

- SMARTSHEET:UNSUPPORTED\_MEDIA\_TYPE

## Sources

## On New Or Updated Row In Sheet Trigger

`<smartsheet:on-new-or-updated-row-in-sheet-trigger>`

### 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>Sheet Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The unique identifier for a sheet.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Rows Modified Since</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter to return only rows that have been modified since the date/time provided.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines whether to execute this source on only the primary node when running in a cluster</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling</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="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message</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="#ReconnectForever">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>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

## Types

### Default Header

<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>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Default Query Param

<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>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Proxy

<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>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### TLS

Defines a configuration for TLS, which can be used from both the client and server sides to secure
communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured
using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must
configure the keystore in the `tls:context` child element of the `listener-config`.

<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>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom Ocsp Responder</a></p></li><li><p><a href="#CrlFile">Crl File</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

<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>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

<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>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>When the keystore contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

<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>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Only verify the last element of the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Try CRL instead of OCSP first.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Do not use the secondary checking method (the one not selected before).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom Ocsp Responder

<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>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response (must be in the truststore), if present.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Crl File

<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>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></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 in milliseconds to reconnect</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>How many reconnection attempts to make.</p></div></div></td><td><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></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><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><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></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></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><div><div><p>A time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Http Response Attributes

<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>Status Code</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Headers</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reason Phrase</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></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><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of memory that will be allocated 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></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by 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></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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 than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></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><div><div><p>The unit in which all these attributes are expressed</p></div></div></td><td><div></div></td><td><div></div></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><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></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><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery 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><strong>Max Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a process-failed-message</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The secure hashing algorithm to use. If not set, the default is SHA-256.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Identifier</strong></p></td><td><div><div><p><a href="#RedeliveryPolicyMessageIdentifier">Redelivery Policy Message Identifier</a></p></div></div></td><td><div><div><p>Defines which strategy is used to identify the messages.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>ObjectStore</p></div></div></td><td><div><div><p>The object store where the redelivery counter for each message is stored.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy Message Identifier

<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>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use a secure hash algorithm to identify a redelivered message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Defines one or more expressions to use to determine when a message has been redelivered. This property can be set only if useSecureHash is false.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

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