3.1.1.1 Model Entity Set

  • Article

The Model entity set represents the spreadsheet as a whole.

The protocol server will return a value as follows:

  • If a URL parameter with a key of "$format" and value of "workbook" is passed, or the ACCEPT HTTP header, as specified in [RFC2616], fits one of the following content types: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.ms-excel.sheet.binary.macroEnabled.12" or "application/vnd.ms-excel.sheet.macroEnabled.12",  then the protocol server will return a workbook file.

  • If a URL parameter with a key of "$format" and value of "json" is passed, accessing Model Entity Set will result in JSON text returned. This JSON text represents the list of other Entity Sets supported by the spreadsheet. The following table lists the JSON members.

    Member Name

    Member Value

    Ranges

    A JSONReference object representing ranges in the worksheet and referencing the corresponding Ranges Entity Set.

    Charts

    A JSONReference object representing charts in the worksheet and referencing the corresponding Charts Entity Set.

    Tables

    A JSONReference object representing tables in the worksheet and referencing the corresponding Tables Entity Set.

    pivotTables

    A JSONReference object representing PivotTables in the worksheet and referencing the corresponding PivotTables Entity Set.

  • Otherwise, accessing The Model Entity Set as an entity set as specified in [MS-ODATA] will result in the list of other entity sets supported by the spreadsheet. The protocol server returns an EntitySet containing 4 entity sets, as follows:

    • An entity set with the category element present, as specified in [MS-ODATA] section 2.2.6.2.1, with the term attribute set to "ExcelServices.Ranges" which represents the ranges in the workbook.

    • An entity set with the category element present, as specified in [MS-ODATA] section 2.2.6.2.1, with the term attribute set to "ExcelServices.Charts" which represents the charts in the workbook.

    • An entity set with the category element present, as specified in [MS-ODATA] section 2.2.6.2.1, with the term attribute set to "ExcelServices.Tables" which represents the tables in the workbook.

    • An entity set with the category element present, as specified in [MS-ODATA] section 2.2.6.2.1, with the term attribute set to "ExcelServices.PivotTables" which represents the PivotTables in the workbook.