3.1.4.18 GetPivotFilterItemList

  • Article

This operation is used to return child PivotTable members that are part of a PivotTable manual filter hierarchy, or child PivotChart members that are part of a PivotChart manual filter hierarchy. This operation is used after calling either the ConnectAndGetPivotFilterItemList operation (section 3.1.4.9) or this operation for an ancestor in the hierarchy.

The following is the WSDL port type specification of the GetPivotFilterItemList WSDL operation.

 <wsdl:operation name="GetPivotFilterItemList" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetPivotFilterItemList" message="tns:ExcelServiceSoap_GetPivotFilterItemList_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetPivotFilterItemListResponse" message="tns:ExcelServiceSoap_GetPivotFilterItemList_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetPivotFilterItemListExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_GetPivotFilterItemList_ExcelServerMessageFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The protocol client sends an ExcelServiceSoap_GetPivotFilterItemList_InputMessage request message, and the protocol server responds with an ExcelServiceSoap_GetPivotFilterItemList_OutputMessage response message, as follows:

  1. The protocol client sends the following information in the pivotOperationOptions element:

    • The PivotTable or PivotChart manual filter.

    • The PivotTable or PivotChart member that is the common ancestor of all the PivotTable or PivotChart members in the hierarchy to be returned.

  2. The protocol server returns the PivotTable members or PivotChart members in the itemList element as follows:

    • The PivotFilterItems element of itemList MUST contain a list of the PivotTable or PivotChart members that are child PivotTable members or child PivotChart members of a particular PivotTable or PivotChart—specifically, of the member that has an Id element equal to the ParentId element of pivotOperationOptions. If no more than 1000 such child members exist, the list MUST contain all those child members. If more than 1000 such child members exist, the list MUST contain the first 1000 such child members.

    • If the PivotTable or PivotChart member that has an Id element equal to the ParentId element of pivotOperationOptions has more than 1000 child PivotTable members or child PivotChart members, the ItemListMaxExceeded element of itemList MUST be set to true. Otherwise, the ItemListMaxExceeded element of itemList MUST be set to false.

In the event of an application error on the protocol server during this operation, a SOAP fault is returned, as specified in section 2.2.2. The Id element of the ExcelServerMessage SHOULD<27> be one of the values specified in section 2.2.2.1.