AMEE API / AMEE Data API / Data Item Value Resource

Overview

This resource is responsible for providing representations of and interactions with Data Item Values. Data Item Values can be viewed and updated via the GET and PUT HTTP methods.

Data Item Values are retrieved via their unique URLs. Data Item Value URLs can be determined by browsing the parent nodes in the resource URL structure (the Data Categories and Data Items).

Example Data Item URL: /data/transport/transport/7E01C0CD8EA0/transportType

Example JSON Response

{"dataItem":{"modified":"2007-03-02 16:26:21.0","created":"2007-03-02 16:26:21.0","itemDefinition":{"uid":"7FC15CCA1E7E"},"dataCategory":{"uid":"AB69E4AE213B","path":"transport"},"uid":"7E01C0CD8EA0","environment":{"uid":"9AC1A541501A"},"path":"","name":""},"itemValue":{"item":{"uid":"7E01C0CD8EA0","path":""},"modified":"2007-03-02 16:26:21.0","created":"2007-03-02 16:26:21.0","value":"car","uid":"A3AE23B5E2E6","path":"transportType","name":"transportType","itemValueDefinition":{"uid":"E3F4B7E9909B","path":"transportType"}}}

Example XML Response

The example XML shows the Data Item Value (in the 'ItemValue' node) represented by this resource. 

<?xml version="1.0" encoding="UTF-8"?>
<Resources>
    <DataItemValueResource>
        <DataItem uid="7E01C0CD8EA0"/>
        <ItemValue created="2007-03-02 16:26:21.0" modified="2007-03-02 16:26:21.0" uid="A3AE23B5E2E6">
            <path>transportType</path>
            <name>transportType</name>
            <value>car</value>
            <ItemValueDefinition uid="E3F4B7E9909B"/>
            <Item uid="7E01C0CD8EA0"/>
        </ItemValue>
    </DataItemValueResource>
</Resources>

Supported HTTP Methods

  • GET - View the Data Item Value
  • PUT - Update the Data Item Value

Parameter Definition

ParameterDefinitionMethods
valueThe updated value for this Data Item Value.PUT