getObjectContext(objectPath, parameterValues, options)

Use this method to obtain context information for an bibus » output object.

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

You may 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.

Use of this method requires:

  • traverse permission for all ancestors of the object

  • execute permission for the object

Signatures

Java and Apache Axis
 
public  com.cognos.developer.schemas.bibus._3.AsynchReply 
getObjectContext( 
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  getObjectContext(searchPathSingleObject 
objectPath,  parameterValue[]  parameterValues,  option[]  options) 

References

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

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

Table 1. Services implementing the getObjectContext 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.3 — Improved Context Metadata for Selection

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