Smartsheet.com Data Syndication

 Data Syndication

Users within subscription environments may publish sheets for public consumption. Currently, the service provides a data syndication feed using the JSON (JavaScript Object Notation) file format.

The following describes how users publish and consume a data syndication file in JSON format from . It should be noted that a user can only publish a sheet they have created.

Publishing

To access the Publishing panel, select the Publish Sheet menu option from the Data menu or right-click on the sheet name in the sheet header. Select the Publish button to publish your sheet. Important information regarding JSON file consumption, including the link to the JSON source file, will be displayed.

To remove a sheet from publication, click Unpublish on the publishing form.

Consumption

In order to use the data syndication feature of , you will need to insert the following snippet of code into your HTML page. Please be aware that the order of the script tags in your page is important!

The file specified at the json_source_url which you will be supplied after publishing your smartsheet (see Publishing above) passes the JSON data representing your smartsheet, smartSheetData to the smartSheetData_load() listener method. At the point in time that the include file is retrieved by your browser, you can parse and display the data as desired. (For sample code used to consume the smartSheetData JSON object, see Code Samples below).

Changes to your smartsheet will trigger a refresh of the JSON data posted for consumption. These modifications include data changes, sheet structure changes (whether performed on the sheet itself or via an update request), and file attachment changes. In general, these changes will be refreshed within a fifteen seconds of any modification.

JSON file format

Following is a pseudo-JSON representation of the file. Data will only be supplied, with the exception of the available columns array, when it is not null. Additional description follows.

smartSheetData = {

"name":

sheetName,

"description":

description,

"columns":

[array of columns displayed in the sheet],

"files":

[array of files],

"rows":

[array of rows with data],

"availableColumns": [array of all available columns]

}

Column = {

"columnName":

columnName,

"displayName":

displayName

}

File =

{

"name":

"link":

}

file name, url

Row =

{

"rowIndex":

"parentRowIndex":

"hierarchyLevel":

"values":

"files":

}

rowIndex, parentRowIndex, hierarchyLevel, [array of data], [array of files]

Data =

{

"columnName":

"value":

}

columnName, dataValue

Additional detail:

Object

Members

smartSheetData name

description

columns

files

rows

Description

The name of your smartsheet.

The description of your smartsheet.

An ordered list of the columns displayed on your smartsheet. A list of all files attached to your smartsheet at the sheet-level (versus attaching a file directly to a row within your sheet).

A link to the most recent version of the file is all that is included. An ordered list of the rows in your smartsheet.

Object Column

File Row

Members

Description

availableColumns A list of all available columns displayed in the Column Chooser within your smartsheet environment.

Data values will be included for each cell in your smartsheet provided a value exists (i.e. the value is not null).

columnName

The distinct column name for each column. Each of the standard columns column names will begin with a prefix of `std:' (see the list of standard columns below).

Custom column names will be those distinct column names programmatically determined at the time of column creation within . You cannot control these column names but they should be recognizable based on the name chosen for the column.

displayName

Please be aware that any columns deleted from your environment will not be included in the data syndication file. Many standard columns can be deleted by any `full user ? admin' user typewithin an environment. The localized name of the column displayed on your smartsheet within your environment.

name link

The name of the file uploaded to . A public link to the file for download.

rowIndex

Zero-based index indicating the position of the row within the sheet.

parentRowIndex hierarchyLevel

To note: Blank rows are not included in the data. If a blank row is present in your sheet at rowIndex=5, for instance, you will see a row with rowIndex=4 followed by a row with rowIndex=6. A reference to the rowIndex of the parent row (parent task) to this row (task). Null indicates that there is no parent row. Calculated value, for your convenience, to represent the level at which this row should be displayed in a hierarchical tree structure.

Object Data

Members values files

columnName value

Description An array of column values for the row. A list of all files attached to a particular row in your smartsheet.

A link to the most recent version of the file is all that is included.

Indicates the column for the specified value. The value of the data.

List of standard columns

The following columns are provided out of the box with each environment. Standard columns can be deleted from an environment by `full user - admin' user types, at which time they will no longer be available in the data syndication feed. Likewise, custom columns can be created, which will become available for publishing/consumption.

columnName

std:actualCost std:actualMetric std:allocatedHeadcount std:approvalStatus std:approver std:assigned std:budget std:checkbox std:comments std:createDate std:creator std:description std:dueDate std:endDate std:estimatedEffort std:expectedCompletionDate std:nextSteps std:owner std:percentComplete std:priority std:rank std:risk std:RYG std:sourceSheet std:startDate std:status std:targetMetric std:taskName std:trend std:type std:updateBy std:updateDate

Default localized displayName Actual Cost Actual Metric Allocated Headcount Approval Status Approver Assigned To Budget Checkbox Comments Create Date Created by Description Due Date End Date Estimated Effort Expected Completion Date Next Steps Owner % Complete Priority Rank Risk RYG Source Sheet Start Date Status Target Metric Task Name (can't be deleted) Trend Type Update By (can't be deleted) Update Date (can't be deleted)

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download