getParameters(objectPath, parameterValues, options)

Use this method to return the list of parameters used by a runnable object, including optional parameters. This method also returns parameters from the model and stored procedures that are used by the object.

The parameters are stored in the bibus » asynchDetailParameters » parameters 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 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.

Signatures

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

References

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

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

Table 1. Services implementing the getParameters method.

Service

SOAP Action
batchReportService

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

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

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

batchReportService and reportService information

This information is specific to the batchReportService and reportService services.

If the request first generates a prompt page for connection information, the page is stored in an instance of the bibus » asynchDetailReportOutput class, which is returned in the bibus » asynchReply » details property.

Use of this method requires:

  • traverse permission for all ancestors of the object

  • execute permission for the object

  • read or execute permission for the metadata

The following Java code snippet demonstrates how to use the parameter » getParameters(objectPath, parameterValues, options) method with the report service.

To see this code in context, view the Java sample ReportParams/ReportParameters.java. For more information about the samples, see Code samples and language-specific coding practices.

 
response  =  connection.getReportService().getParameters( 
		reportPath,  new  ParameterValue[]  {},  new  Option[]  {}  ); 
... 
for  (int  i  =  0;  i  <  response.getDetails().length;  i++) 
{ 
	if  (response.getDetails()[i]  instanceof  AsynchDetailParameters) 
 
	{ 
		params  =  ((AsynchDetailParameters)response.getDetails()[i]).getParameters(); 
	} 
} 
 

The following C# code snippet demonstrates how to use the parameter » getParameters(objectPath, parameterValues, options) method with the report service.

To see this code in context, view the C# sample ReportParameters/ReportParameters.cs. For more information about the samples, see Code samples and language-specific coding practices.

 
asynchReply  gpReply  =  cBIRS.getParameters( 
		cmReportPath,  new  parameterValue[]  {},  new  runOption[]{}  ); 
... 
for  (int  i  =  0;  i  <  gpReply.details.Length;  i++) 
{ 
	if  (gpReply.details[i]  is  asynchDetailParameters) 
	{ 
		return  ((asynchDetailParameters)gpReply.details[i]).parameters; 
	} 
} 
 

powerPlayService information

This information is specific to the powerPlayService service.

Use of this method requires:

  • traverse permission for all ancestors of the object

  • execute permission for the object

  • read or execute permission for the metadata

New in Version 10.1.0 — New PowerPlay Service Methods

The documentation has been updated to show that this service now supports this method.

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