Search

 

Module: Editor

Version: 4.3.0 +

Category: DataStore

 

Description

With the VisionReference 'GetDataItems' it is possible to retrieve a list of information about dataitems for a given dataset.

Parameters

Person:

The identifier of the person whom the dataitem is bound to (this parameter is not required. Don't assign this parameter a value if no filtering is required/possible).

Dataset:

The name of the dataset to which the dataitems belong.

ParentID:

The identifier of the dataitem's parent, if any. (use the value '0' to find all items)

Response

Format

The following response is given after a successfull call of this formula:

<response xmlns="http://www.actuit.nl/futurama/vision/service/response/1.0">
    <resultcode code="00000" success="true">
        <description>Success</description>
    </resultcode>
    <result xsi:type="GetDataItemsResult" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <dataitems>
            <dataiteminfo>
                <id>1</id>
                <date>2012-02-10T13:02:53.107</date>
                <description>item 1</description>
            </dataiteminfo>
            <dataiteminfo>
                <id>10</id>
                <date>2012-02-13T11:53:53.867</date>
                <description>item 10</description>
            </dataiteminfo>
            <dataiteminfo>
                <id>11</id>
                <date>2012-02-14T15:36:03.693</date>
                <description>item 11</description>
            </dataiteminfo>
        </dataitems>
    </result>
</response>

This response contains the following information for every found dataitem:

  • ID: The unique identifier for this DataItem, this can be used to retrieve the full dataitem using the formula GetDataItem
  • Date: The timestamp on which this dataitem was stored.
  • Description: A small description of the contents of this dataitem.

Return codes

The possible return codes are:

  • 00000 - Success: The operation was completed successfully.
  • 01000 - Fail: The operation failed in some way. See the error log of the Vision Management Site for more details.
  • 01999 - Fail: The operation failed in some way. See the error log of the Vision Management Site for more details.
  • 51003 - DataStorePersonDoesNotExist: The selected person does not exist.
  • 51005 - DataStoreDataSetNotFound: Could not find the dataset

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="GetDataItems">
			<ns1:parameter name="PersonID" value="" type="System.String"/>
			<ns1:parameter name="DataSetName" value="DataSet 1" type="System.String"/>
			<ns1:parameter name="ParentID" value="0" 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

- GetDataItem: for getting the content of a single DataItem

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

- StoreData: for storing Xml data in the Vision application

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-07