OpenInfoObject
Opens an information object, returning handles to the object in its response.
Request schema
<xsd:complexType name="OpenInfoObject">
<xsd:sequence>
<xsd:choice>
<xsd:element name="ObjectName" type="xsd:string" />
<xsd:element name="ObjectId" type="xsd:string" />
</xsd:choice>
<xsd:element name="Query" type="typens:Query"
minOccurs="0"/>
<xsd:element name="DownloadEmbedded" type="xsd:boolean"
minOccurs="0" />
<xsd:element name="ReturnDataInBlocks" type="xsd:boolean"
minOccurs="0" />
<xsd:element name="FetchSize" type="xsd:long"
minOccurs="0"/>
<xsd:element name="Format" type="typens:InfoObjectDataFormat"
minOccurs="0" />
<xsd:element name="DownloadDoubleAsBinary" type="xsd:boolean"
minOccurs="0" />
</xsd:sequence>
</xsd:complexType>
Request elements
ObjectName
The name of the information object.
ObjectId
The ID of the information object.
Query
The query name.
ReturnDataInBlocks
A flag indicating whether to return data in blocks as specified for the database. If ReturnDataInBlocks is false, FetchSize is set to 0.
FetchSize
The maximum number of records to retrieve and return in a result set. The default value is 500.
Format
The format of the information object.
DownloadDoubleAsBinary
A flag indicating whether to download double values in binary format.
Response schema
<xsd:complexType name="OpenInfoObjectResponse">
<xsd:sequence>
<xsd:element name="DataFetchHandle" type="xsd:string" />
<xsd:element name="ConnectionHandle" type="xsd:string"
minOccurs="0" />
</xsd:sequence>
</xsd:complexType>
Response elements
DataFetchHandle
The handle to the information object.
ConnectionHandle
The ID of the object. Supports viewing an item already in the iHub System.