Search

 

Module: Editor

Version: 4.3.0 +

Category: DataStore

 

Description

With the VisionReference 'GetDataItem' it is possible to retrieve a dataitem by its unique identificationcode.

Parameters

DataItemID

The unique numeric identifier of a DataItem, found with the formula GetDataItems.

Response

Format

The returned XML data looks like this:

<response xmlns="http://www.actuit.nl/futurama/vision/service/response/1.0">
	<resultcode code="00000" success="true">
		<description>Success</description>
	</resultcode>
	<result xsi:type="GetDataItemResult" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
		<date>2012-03-29T10:41:04.4513314+02:00</date>
		<description>item 1</description>
		<xml>
			<test xmlns="http://www.actuit.nl/type1_2">
				<id>2355</id>
				<name>unknown</name>
			</test>
		</xml>
		<descendantcount>3</descendantcount>
	</result>
</response>

The information contained in this response consist of the following nodes:

  • Date: The timestamp on which this dataitem was stored.
  • Description: The description of the contents of this dataitem.
  • XML: The XML data that is contained in this dataitem.
  • DescendantCount: If this dataitem is a parent to other dataitem, this will indicate the number of "direct" children bound to this dataitem, which can be retrieved using the formula GetDataItems, by supplying the ID for this dataitem as ParentID in that formula.

Return codes

The following return codes can be encountered:

  • 00000 - GeneralSuccess: The operation completed successfully.
  • 01000 - GeneralFailError: The operation caused an error. See the error log of the Vision Management Site for more details.
  • 01999 - GeneralFailError: The operation caused an error. See the error log of the Vision Management Site for more details.
  • 51101 - DataStoreItemNotAvailable: Tje dataitem cannot be found or retrieved.
  • 51102 - DataStoreItemTypeTooNew: Type version of data item is newer than type version of DataSet.
  • 51104 - DataStoreItemInvalidXML: The dataitem contains invalid XML data.

Example soapUI message

In the preceding paragraph the parameters of the VisionReference are listed. The values of these parameters are used by Futurama to compose an XML-message. With soapUI it is possible to see the responses depending on the values of the parameters. Below you find an example of an XML-message. This example can be used in your soapUI project to test the connection with Vision and to see the response for a certain combination of parameters.

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.actuit.nl/futurama/vision/service/header/1.0" xmlns:ns1="http://www.actuit.nl/futurama/vision/service/request/1.0">
	<soapenv:header>
		<ns:document path="\\servername\path\datastore.xml" version=""/>
		<ns:futurama path="\\servername\path\futurama" version=""/>
	</soapenv:header>
	<soapenv:body>
		<ns1:request module="DataStore" version="1.0" method="GetDataItem">
			<ns1:parameter name="DataItemID" value="6" type="System.Int32"/>
		</ns1:request>
	</soapenv:body>
</soapenv:envelope>

Within the Header element you find an element 'Document' and an element 'Futurama'. For these elements you have to fill in the path of the Document and the Futurama respectively you also configured in the Apps and Futuramas tab of the Vision Management Site. Within the Request element you find the parameters for this VisionReference. By changing the values of these parameters you can execute different webservice calls.

Related Topics

- DeleteDataItem: for deleting a single DataItem

- DeleteDataItemHierarchy: for deleting a hierarchial tree with DataItems

- DeleteDataItems: for deleting all the DataItems for a person, or deleting all the DataItems in a certain DataSet

- StoreData: for storing Xml data in the Vision application

- GetDataItemHierarchy: for getting the full hierarchy of s DataItem and its children

- GetDataItems: for getting the DataItems from a person, or the DataItems from a certain DataSet

Feedback

If you have any questions about this subject or if you want to provide us feedback please send us an e-mail.

Updated: 2013-05-08