Skip to main content

Smartsheet - Upload File from Shipyard to Smartsheet

Overview​

Easily import data from a single CSV or Excel file into a single SmartSheet Sheet. If the the Sheet already exists, the data being uploaded will either be appended or will overwrite the existing data based on the Insert Method.

Insert Method​
  • If Append or Replace is selected, then a Sheet ID is also required so the existing sheet can be modified
  • If Create is selected, then a Sheet Name is recommended, otherwise the newly created Sheet will be named after the file

Only one file can be uploaded at a time.

Note: This Vessel cannot be used to upload a local file from your computer.

Recommended Setup:

  1. A Vessel built with this Blueprint should typically run after a Vessel that either downloads a file to Shipyard or generates a file with code.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
Access TokenSMARTSHEET_ACCESS_TOKENPasswordβœ…--The access token for the Smartsheet API
Sheet IDSMARTSHEET_SHEET_IDAlphanumericβž–--The ID of the sheet to write to. This is only necessary if you are modifying an existing sheet
Sheet NameSMARTSHEET_SHEET_NAMEAlphanumericβž–--The name of the sheet to be created. Only necessary if creating a new sheet
Source Folder NameSMARTSHEET_SOURCE_FOLDER_NAMEAlphanumericβž–--The optional location of the file to be uploaded
Source File NameSMARTSHEET_SOURCE_FILE_NAMEAlphanumericβœ…--The name of the file to upload
File TypeSMARTSHEET_FILE_TYPESelectβœ…csvCSV: csv

XLSX: xlsx

The file type to upload (either XLSX or CSV)
Insert MethodSMARTSHEET_INSERT_METHODSelectβœ…replaceAppend: append

Replace: replace

Create: create

This determines whether the data being uploaded will append to an existing sheet, overwrite an existing sheet, or create a new one.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: Smartsheet - Upload File from Shipyard to Smartsheet
inputs:
SMARTSHEET_ACCESS_TOKEN: null ## REQUIRED
SMARTSHEET_SHEET_ID: null
SMARTSHEET_SHEET_NAME: null
SMARTSHEET_SOURCE_FOLDER_NAME: null
SMARTSHEET_SOURCE_FILE_NAME: null ## REQUIRED
SMARTSHEET_FILE_TYPE: csv ## REQUIRED
SMARTSHEET_INSERT_METHOD: replace ## REQUIRED
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '200'
- '201'
- '202'
- '203'
- '204'
- '205'
- '206'
- '220'
- '249'