Extracting parameter definitions
Using the Actuate Information Delivery API, you can extract parameter definitions from a parameter values file. For example, you can determine whether a parameter is ad hoc, whether it is hidden, and what data type it is. To retrieve the parameter definitions from a file, use ExtractParameterDefinitionsFromFile and identify the file by name and file-type extension. Then submit the file as an attachment to the request or embed it in the request.
<SOAP-ENV:Body>
<ExtractParameterDefinitionsFromFile>
<Content>
<ContentId>ROD_param.rop</ContentId>
<ContentType>binary</ContentType>
<ContentLength>62000</ContentLength>
</Content>
</ExtractParameterDefinitionsFromFile>
</SOAP-ENV:Body>
The preceding request returns a definition for each parameter in the attachment.
<SOAP-ENV:Body>
<ExtractParameterDefinitionsFromFileResponse>
<ParameterDefinitions>
<ParameterDefinition>
<Name>DCP_DEBUG_LEVEL</Name>
<DataType>Integer</DataType>
<DefaultValue>100</DefaultValue>
<IsRequired>false</IsRequired>
<IsPassword>false</IsPassword>
<IsHidden>false</IsHidden>
<IsAdHoc>false</IsAdHoc>
</ParameterDefinition>
<ParameterDefinition>
<Name>DCP_ESPRESSO_LIB</Name>
<DataType>String</DataType>
<IsRequired>false</IsRequired>
<IsPassword>false</IsPassword>
<IsHidden>false</IsHidden>
<IsAdHoc>false</IsAdHoc>
</ParameterDefinition>
…
</ParameterDefinitions>
</ExtractParameterDefinitionsFromFileResponse>
</SOAP-ENV:Body>