Operation: Read | X4Documentation

Mit der Operation Readdes Data Object Web App Adapters lesen Sie ein Data Object aus und zeigen die Daten entsprechend eines zuvor definierten View Models in Ihrer Web App an.

Weitere Informationen zu anderen Operationen des Data Object Web App Adapters finden Sie unter Data Object Web App Adapter.

Hinweis:

Um Ihre Daten mithilfe des Adapters in einer Web App anzuzeigen, müssen Sie ein entsprechendes View Model festlegen. Weitere Informationen zum Anlegen eines View Models finden Sie unter Data Model in einer X4 Web App nutzen.

Parameter

referenceId

Gibt die ID des Data Objects an, das gelesen werden soll.

Mögliche Werte:

UUID des Data Objects

name

Gibt den Namen des Data Objects an, das gelesen werden soll.

Mögliche Werte:

Beliebige Zeichenkette, z. B. Order

viewModelReference

Gibt den Namen des zu verwendenden View Models an.

Mögliche Werte:

Name der VIEWMODEL-Datei, z. B. ViewModel.viewmodel

Statuswerte

`1`	Die Operation wurde erfolgreich ausgeführt.
`-1`	Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen.

Input

Der Adapter erwartet keinen spezifischen Input.

Output

Der Adapter gibt das zu lesende Data Object innerhalb eines Elements <Ok> als XML aus.

Hinweise:

Wenn Sie einzelne Elemente Ihres Data Objects nicht im entsprechenden View Model definiert haben, werden die entsprechenden Elemente nicht mit ausgelesen.
Wenn Sie im entsprechenden View Model Elemente definiert haben, die nicht im zu lesenden Data Object enthalten sind, werden die entsprechenden Elemente im Output leer ausgegeben, z. B. das Element </MyColor> im folgenden Beispieloutput.

<?xml version="1.0" encoding="UTF-8"?>
<Ok>
 <Dataobject>  
  <Order>
    <OrderID>12345</Order>
    <OrderDate>2025-03-06</OrderDate>
    <Customer>
      <CustomerID>67890</CustomerID>
      <Name>John Doe</Name>
      <Email>johndoe@example.com</Email>
      <Phone>+49-7243-56175-0</Phone>
      <BillingAddress>
        <Street>Am Erlengraben 3</Street>
        <City>Ettlingen</City>
        <ZipCode>76275</ZipCode>
        <Country>Germany</Country>
      </BillingAddress>
      <ShippingAddress>
        <Street>Am Erlengraben 3</Street>
        <City>Ettlingen</City>
        <State>Baden-Württemberg</State>
        <ZipCode>76275</ZipCode>
        <Country>Germany</Country>
      </ShippingAddress>
    </Customer>
    <Items>
      <Item>
        <ItemID>98765</ItemID>
        <ProductName>MyProduct</ProcuctName>
        <Quantity>5</Quantity>
        <UnitPrice>49,99</UnitPrice>
      </Item>
      <Item>
        <ItemID>54321</ItemID>
        <ProductName>MyProduct2</ProcuctName>
        <Quantity>10</Quantity>
        <UnitPrice>19,99</UnitPrice>
      </Item>
    </Items>
    <OrderTotal>449,85</OrderTotal>
  </Order>
 </Dataobject> 
  <MyColor/>
</Ok>