Share via

3.1.4.18 GetPivotFilterItemList

  • Article

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

 <wsdl:operation name="GetPivotFilterItemList">
   <wsdl:input wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetPivotFilterItemList" message="tns:ExcelServiceSoap_GetPivotFilterItemList_InputMessage"/>
   <wsdl:output wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetPivotFilterItemListResponse" message="tns:ExcelServiceSoap_GetPivotFilterItemList_OutputMessage"/>
   <wsdl:fault wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetPivotFilterItemListExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_GetPivotFilterItemList_ExcelServerMessageFault_FaultMessage"/>
 </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 manual filter.

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

  2. The protocol server returns the PivotTable members in itemList.

    • The PivotFilterItems element of itemList MUST contain the list of all the PivotTable members that are child PivotTable members of the PivotTable member that has an Id that is equal to the ParentId element of pivotOperationOptions if there are no more than 1000 such PivotTable members, and MUST contain the first 1000 such PivotTable members if there are more than 1000 such PivotTable members.

    • The ItemListMaxExceeded element of itemList MUST be set to "true" if the PivotTable member who has an Id that is equal to the ParentId element of pivotOperationOptions has more than 1000 child PivotTable members and MUST be set to "false" otherwise.

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<23> be one of the values specified in section 2.2.2.1.