When related temp-tables are returned as a response from a Business Entity executed on WEB transport using the DataObjectHandler the data are NOT nested, but rather display at the same level in the JSON output.

Given a dataset defined with a data-relation

DEFINE TEMP-TABLE Customer NO-UNDO
    FIELD CustNum AS INTEGER
    FIELD CustName AS CHARACTER.

DEFINE TEMP-TABLE Order NO-UNDO
    FIELD OrderNum AS INTEGER
    FIELD OrderTotal AS DECIMAL
    FIELD CustNum AS INTEGER.
  
DEFINE DATASET dsEntityInfo FOR Customer, Order 
    DATA-RELATION Relation1 FOR Customer, Order 
        RELATION-FIELDS (CustNum,CustNum).

When this table’s data is returned using the DOH, the table data is not nested. The Customer and Order tables are sibling properties:

{
  "dsEntityInfo": {
    "Customer": [
      {
        "CustNum": 1,
        "CustName": "Lift Tours"
      },
      {
        "CustNum": 3,
        "CustName": "Hoops"
      }
    ],
    "Order": [
      {
        "OrderNum": 100,
        "OrderTotal": 1234.89,
        "Customer_id": 67840
      },
      {
        "OrderNum": 150,
        "OrderTotal": 999.99,
        "Customer_id": 67840
      },
      {
        "OrderNum": 200,
        "OrderTotal": 1899.99,
        "Customer_id": 67841
      }
    ]
  }
}

 

The data should be structured as in this example:

{"dsEntityInfo": {
  "Customer": [
    {
      "CustNum": 1,
      "CustName": "Lift Tours",
      "Order": [
        {
          "OrderNum": 100,
          "OrderTotal": 1234.89,
          "Customer_id": 67840
        },
        {
          "OrderNum": 150,
          "OrderTotal": 999.99,
          "Customer_id": 67840
        }
      ]
    },
    {
      "CustNum": 3,
      "CustName": "Hoops",
      "Order": [
        {

 

The exact cause is not known at this time.

Defect OCTA-16585 was fixed in 11.7.6, however the other defects were not done in time for the release. 

 

In order to make this work in 11.7.6 one must upgrade to 11.7.6 then add the table relationships to the <service-name>.gen (e.g. testWebService.gen) file in one or both of the following locations for each dataset defined in the Web Service:

In the PDSOE project:

• PASOEContent/WEB-INF/openedge

In the PASOE instance:

• webapps/<app-name>/WEB-INF/openedge

The format of the <service-name>.gen file is documented in detail here. 

Note: The <service-name>.gen file gets re-generated in the PDSOE project every time you update your service definition. Ensure you backup the .gen file with your relationship information because it will be overwritten each time the service definition is updated/re-generated in PDSOE.

What does a relationship definition look like?
The relationship definition looks like the following:

"attr": {
    "relations": [
    {
      "parentTable": "Customer",
      "childTable": "Order",
      "fields": [
      {
        "parentField": "CustNum",
        "childField": "CustNum"
      }
      ],
      "name": "Relation1",
      "active": true,
      "nested": true
    }
    ]
  },

The <service-name>.gen file, as generated by PDSOE contains information about the business entity and the dataset, including table definitions.  The above JSON should be added to the <service-name>.gen file immediately after the dataset definition, before the first table definition.

For example:

"schemas": {"dscustord": {
        "Customer": {

Now appears like:

"schemas": {"dscustord": {
        "attr": 
        { 
           "relations": [ 
           { 
              "parentTable": "Customer", 
              "childTable": "Order", 
              "fields": [ 
              { 
                 "parentField": "CustNum", 
                 "childField": "CustNum" 
              } 
              ], 
           "name": "Relation1", 
           "active": true, 
           "nested": true 
        } 
        ] 
     },
     "ttcustomer": {

 

References to Other Documentation:

Progress Documentation:
http://docs.progress.com/bundle/openedge-abl-develop-services/page/Entity-handler-properties.html