SheetResources Interface

This interface provides methods to access sheet resources.

Thread Safety: Implementation of this interface must be thread safe.

Namespace: Smartsheet.Api
Assemblies: smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0

Syntax

C++

Copy

public interface SheetResources

Public Interface SheetResources

public interface class SheetResources

type SheetResources =  interface end

The SheetResources type exposes the following members.

Properties

	Name	Description
	AttachmentResources	Returns the SheetAttachmentResources object that provides access to attachment resources associated with sheet resources.
	AutomationRuleResources	Returns the AutomationRuleResources object that provides access to automation rules resources associated with sheet resources.
	ColumnResources	Returns the SheetColumnResources object that provides access to column resources associated with sheet resources.
	CommentResources	Returns the SheetCommentResources object that provides access to comment resources associated with sheet resources.
	CrossSheetReferenceResources	Returns the CrossSheetReferenceResources object that provides access to cross-sheet reference resources associated with sheet resources.
	DiscussionResources	Returns the SheetDiscussionResources object that provides access to discussion resources associated with sheet resources.
	FilterResources	Returns the FilterResources object that provides access to filter resources associated with sheet resources.
	RowResources	Returns the SheetRowResources object that provides access to row resources associated with sheet resources.
	ShareResources	Returns the ShareResources object that provides access to share resources associated with sheet resources.
	SummaryResources	Returns the SheetSummaryResources object that provides access to sheet summary resources associated with sheet resources.
	UpdateRequestResources	Returns the SheetUpdateRequestResources object that provides access to update request resources associated with sheet resources.

Top

Methods

	Name	Description
	CopySheet(Int64, ContainerDestination, IEnumerableSheetCopyInclusion)	Creates a copy of the specified sheet. Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/copy
	CopySheet(Int64, ContainerDestination, IEnumerableSheetCopyInclusion, IEnumerableSheetCopyExclusion)	Creates a copy of the specified sheet. Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/copy
	CreateSheet	Creates a sheet in default "Sheets" collection. Mirrors to the following Smartsheet REST API method: POST /Sheets
	CreateSheetFromTemplate	Creates a sheet (from existing sheet or template) in default "Sheets" collection. Mirrors to the following Smartsheet REST API method: POST /Sheets
	DeleteSheet	Deletes a sheet. Mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}
	GetPublishStatus	Gets the status of the publish settings of the sheet, including the URLs of any enabled publishings. Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/publish
	GetSheet(Int64, IEnumerableSheetLevelInclusion, IEnumerableSheetLevelExclusion, IEnumerableInt64, IEnumerableInt32, IEnumerableInt64, NullableInt64, NullableInt64)	Gets a sheet. Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}
	GetSheet(Int64, IEnumerableSheetLevelInclusion, IEnumerableSheetLevelExclusion, IEnumerableInt64, IEnumerableInt32, IEnumerableInt64, NullableInt64, NullableInt64, NullableInt64)	Gets a sheet. Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}
	GetSheet(Int64, IEnumerableSheetLevelInclusion, IEnumerableSheetLevelExclusion, IEnumerableInt64, IEnumerableInt32, IEnumerableInt64, NullableInt64, NullableInt64, NullableInt64, NullableInt32)	Gets a sheet. Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}
	GetSheetAsCSV	Gets a sheet as a CSV file. Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId} with "text/csv" Accept HTTP header
	GetSheetAsExcel	Gets a sheet as an Excel file. Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId} with "application/vnd.ms-excel" Accept HTTP header
	GetSheetAsPDF	Gets a sheet as a PDF file. Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId} with "application/pdf" Accept HTTP header
	GetSheetVersion	Gets the sheet version without loading the entire sheet. Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/version
	ImportCsvSheet	Imports a sheet (from CSV). Mirrors to the following Smartsheet REST API method: POST /sheets/import
	ImportXlsSheet	Imports a sheet (from XLSX). Mirrors to the following Smartsheet REST API method: POST /sheets/import
	ListOrganizationSheets	Obsolete. Lists all sheets in the organization. Mirrors to the following Smartsheet REST API method: GET /users/sheets
	ListSheets	Gets the list of all sheets that the user has access to, in alphabetical order, by name. Mirrors to the following Smartsheet REST API method: GET /Sheets
	MoveSheet	Moves the specified sheet to a new location. Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/move
	SendSheet	Sends a sheet as a PDF attachment via email to the designated recipients. Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/emails
	SendUpdateRequest	Obsolete. Creates an update request for the specified rows within the sheet. An email notification (containing a link to the update request) will be asynchronously sent to the specified recipients. Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/updaterequests
	SortSheet(Int64, SortSpecifier)	Sorts a sheet according to the sort criteria. Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/sort
	SortSheet(Int64, SortSpecifier, NullableInt32)	Sorts a sheet according to the sort criteria. Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/sort
	UpdatePublishStatus	Sets the publish status of a sheet and returns the new status, including the URLs of any enabled publishings. Mirrors to the following Smartsheet REST API method: PUT /sheets/{sheetId}/publish
	UpdateSheet	Updates a sheet. To modify sheet contents, see Add Rows, Update Rows, and Update Column. This operation can be used to update an individual users sheet settings. If the request body contains only the userSettings attribute, this operation may be performed even if the user only has read-only access to the sheet (i.e., the user has viewer permissions, or the sheet is read-only). Mirrors to the following Smartsheet REST API method: PUT /sheets/{sheetId}

Top

Reference

Smartsheet.Api Namespace