Getting the Query Specification

Usage

Returns the query specification attached to a given data provider.

The query specification describes the parameters and the result objects of the query.

Request

GET /documents/<documentID>/dataproviders/<dataProviderID>/specification

Response

Response type: text/xml

Response body: details of the query specification. See the example.

Example

GET /documents/7738/dataproviders/DP0/specification

<queryspec:QuerySpec ... xmlns:queryspec="http://com.sap.sl.queryspec" dataProviderId="DP0">
    <queryParameters> 		
        <duplicatedRowsProperty activated="true" value="true"/>    
        <maxRetrievalTimeInSecondsProperty value="300"/> 
        <maxRowsRetrievedProperty value="90000"/>		
        <removeEmptyRowsProperty activated="true" value="true"/>		
        <allowOtherUserToEditQueryProperty activated="true" value="true"/>		
        <resetContextOnRefreshProperty activated="true" value="true"/>		
        <stripQueryProperty/>	
   </queryParameters>	
   <queriesTree xsi:type="queryspec:QueryOperatorNode" queryOperator="Union">		
        <children xsi:type="queryspec:QueryDataNode">			
            <bOQuery name="Query" identifier="_1y8aENsVEeGswMB7H6m1Qw">				
                <resultObjects identifier="DS0.DObc" name="Year"/>				
                <resultObjects identifier="DS0.DOda" name="State"/>				
                <resultObjects identifier="DS0.DOa5" name="Lines"/>				
                <resultObjects identifier="DS0.DO93" name="Sales revenue"/>				
                <conditionPart/>			
            </bOQuery>		
        </children>	
    </queriesTree>	
    <propertyBag key="DUPLICATED_ROWS_UNDEFINED_VALUE" value="-1"/>	
    <propertyBag key="RESET_CONTEXT_ON_REFRESH_UNDEFINED_VALUE" value="-1"/>	
    <propertyBag key="ALLOW_THE_USER_TO_EDIT_QUERY_UNDEFINED_VALUE" value="-1"/>
</queryspec:QuerySpec>
Note In the case of .unv universes, the resultObjects identifier is a string made of the object identifier retrieved from the universe outline and prefixed by the dataSourcePrefix of the current data provider and retrieved from the data provider outline.