Smartsheet.Api.Internal.SheetResourcesImpl.GetSheet C# (CSharp) Method

GetSheet() public method

Get a sheet.

It mirrors To the following Smartsheet REST API method: GET /sheets/{sheetId}

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public GetSheet ( long sheetId, IEnumerable includes, IEnumerable excludes, IEnumerable rowIds, IEnumerable rowNumbers, IEnumerable columnIds, long pageSize, long page ) : Api.Models.Sheet
sheetId long the Id of the sheet
includes IEnumerable used To specify the optional objects To include.
excludes IEnumerable used To specify the optional objects To include.
rowIds IEnumerable used To specify the optional objects To include.
rowNumbers IEnumerable used To specify the optional objects To include.
columnIds IEnumerable used To specify the optional objects To include.
pageSize long used To specify the optional objects To include.
page long used To specify the optional objects To include.
return Api.Models.Sheet
        public virtual Sheet GetSheet(long sheetId, IEnumerable<SheetLevelInclusion> includes, IEnumerable<SheetLevelExclusion> excludes, IEnumerable<long> rowIds, IEnumerable<int> rowNumbers, IEnumerable<long> columnIds, long? pageSize, long? page)
        {
            IDictionary<string, string> parameters = new Dictionary<string, string>();
            if (includes != null)
            {
                parameters.Add("include", QueryUtil.GenerateCommaSeparatedList(includes));
            }
            if (excludes != null)
            {
                parameters.Add("exclude", QueryUtil.GenerateCommaSeparatedList(excludes));
            }
            if (rowIds != null)
            {
                parameters.Add("rowIds", QueryUtil.GenerateCommaSeparatedList(rowIds));
            }
            if (rowNumbers != null)
            {
                parameters.Add("rowNumbers", QueryUtil.GenerateCommaSeparatedList(rowNumbers));
            }
            if (columnIds != null)
            {
                parameters.Add("columnIds", QueryUtil.GenerateCommaSeparatedList(columnIds));
            }
            if (pageSize != null)
            {
                parameters.Add("pageSize", pageSize.ToString());
            }
            if (page != null)
            {
                parameters.Add("page", page.ToString());
            }

            return this.GetResource<Sheet>("sheets/" + sheetId + QueryUtil.GenerateUrl(null, parameters), typeof(Sheet));
        }

Usage Example

Example #1
0
        public virtual void TestGetSheet()
        {
            server.setResponseBody("../../../TestSDK/resources/getSheet.json");
            Sheet sheet = sheetResource.GetSheet(123123L, null);

            Assert.AreEqual(9, sheet.Columns.Count);
            Assert.AreEqual(0, sheet.Rows.Count);


            sheet = sheetResource.GetSheet(123123L, new List <ObjectInclusion>((ObjectInclusion[])Enum.
                                                                               GetValues(typeof(ObjectInclusion))));
            Assert.AreEqual(9, sheet.Columns.Count);
            Assert.AreEqual(0, sheet.Rows.Count);
        }
All Usage Examples Of Smartsheet.Api.Internal.SheetResourcesImpl::GetSheet