3.1.4.9 ConnectAndGetPivotFilterItemList

  • Article

This operation is used to return the PivotTable members that are part of a PivotTable manual filter hierarchy.

 <wsdl:operation name="ConnectAndGetPivotFilterItemList">
   <wsdl:input wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ConnectAndGetPivotFilterItemList" message="tns:ExcelServiceSoap_ConnectAndGetPivotFilterItemList_InputMessage"/>
   <wsdl:output wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ConnectAndGetPivotFilterItemListResponse" message="tns:ExcelServiceSoap_ConnectAndGetPivotFilterItemList_OutputMessage"/>
   <wsdl:fault wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/ConnectAndGetPivotFilterItemListExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_ConnectAndGetPivotFilterItemList_ExcelServerMessageFault_FaultMessage"/>
 </wsdl:operation>

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

  1. The protocol client sends the information identifying the PivotTable manual filter in the pivotOperationOptions element.

  2. The protocol server returns the hierarchy of PivotTable members in itemList, as follows:

    • The PivotFilterItems element of itemList MUST contain the list of all the PivotTable members at the top hierarchy level of the PivotTable manual filter 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 there were more than 1000 PivotTable members at the top hierarchy level of the PivotTable manual filter 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<14> be one of the values specified in section 2.2.2.1.