3.1.1.7 PivotTables Entity Set

  • Article

PivotTables in the spreadsheet are represented as an EntitySet, which contains Entities of a single EntityType as specified in section 3.1.1.8. The PivotTables entity set represents the list of PivotTables exposed by the spreadsheet. The protocol server will return a value as follows:

  • If a URL parameter with a key "$format’ and value of "atom" is passed, or is accessed in the context of Model Entity Set then the protocol server returns an entity with the category element present (as specified in [MS-ODATA] section 2.2.6.2.1) and the term attribute set to "ExcelServices.PivotTable" for every published item in the workbook that represents a PivotTable.

  • If a URL parameter with a key of "$format" and value of "json" is passed, or is accessed in the context of Session Entity Set then the protocol server returns JSON text containing JSONCollection as defined in section 2.2.4.5. The JSONCollection represents a list of entities for every published item in the workbook that represents a PivotTable. Each entry in the JSONCollection has members listed in the following table.

    Member Name

    Member Value

    Name

    A JSON string value representing the name of a PivotTable.