queryDrillPath(objectPath, parameterValues, options)

Use this method to retrieve a single bibus » drillPath object from the content store.

The bibus » drillPath object is returned in the bibus » asynchDetailDrillPathObject » drillPath property. An instance of this class is returned in the bibus » asynchReply » details property when the request is complete.

This method may return the following values in the bibus » asynchReply » status property:

You may be able to make secondary requests after using this method, depending on the server response. For more information about the asynchronous conversation status and secondary requests in asynchronous conversations, see Secondary requests.

This method performs a number of additional activities after it retrieves the specified object from the content store by calling the content » query(searchPath, properties, sortBy, options) method:

  • The drill-through specification may be upgraded to the current version, depending on the parameters provided.

  • The following drill-through specification values are set to reflect the object properties when the bibus » queryReportOptions » upgrade property is true:

If you want to retrieve multiple objects from the content store, or if you do not need to upgrade the drill-through specification or synchronize the property values, use the content » query(searchPath, properties, sortBy, options) method.

Use of this method requires:

  • read permission for the object and traverse permission for all ancestors of the object if the properties to be returned are not general properties

  • traverse permission for all ancestors of the object if the properties to be returned are general properties

  • setPolicy permission to read the bibus » baseClass » policies property

Java and Apache Axis

 
public  com.cognos.developer.schemas.bibus._3.AsynchReply 
queryDrillPath( 
com.cognos.developer.schemas.bibus._3.SearchPathSingleObject 
objectPath,  com.cognos.developer.schemas.bibus._3.ParameterValue[] 
parameterValues,  com.cognos.developer.schemas.bibus._3.Option[] 
options) 

C# .NET

 
public  asynchReply  queryDrillPath(searchPathSingleObject  objectPath, 
parameterValue[]  parameterValues,  option[]  options) 

References

Part of the following method sets:
Implemented by the following services:

The services that implement the queryDrillPath method, along with the associated SOAP actions, are listed in the following table.

Table 1. Services implementing the queryDrillPath method.

Service

SOAP Action
batchReportService

http://www.ibm.com/xmlns/prod/cognos/batchReportService/201404/
reportService

http://www.ibm.com/xmlns/prod/cognos/reportService/201404/

What's new

New in Version 8.4 — Supporting New Drill-through Targets

This method was added.

Input parameters

Use the following parameters when calling this method.

objectPath

Specifies the object associated with the request.

This argument

parameterValues

Specifies the parameter values for the request.

Parameter values can also be specified in other locations. For more information, see Specifying Options and Parameters.

This argument

options

Specifies the options for the request.

Options can also be specified in other locations. For more information, see Specifying Options and Parameters.

This argument

  • is an array of type bibus » option

    is encoded as type tns:optionArray

Return values

This method returns the following values.

result

Returns the state of the asynchronous conversation. Possible asynchronous conversation states are defined in the bibus » asynchReplyStatusEnum enumeration set.

Any data requested can be obtained by examining the bibus » asynchReply » details property.

This result