How to include relationship object in response composer-rest-server?

Question

We have defined Asset as:

asset PurchaseOrder identified by orderId {
  o String orderId
    --> SupplierChainParticipant createdBy
    --> SupplierChainParticipant assignedTo
  o String description    
  o String status
  o Integer quantity
  o String assetId    
}

and Participant as :

participant SupplierChainParticipant  identified by participantId {
  o String participantId
  o String identity
  o String type     
}

Now When I am fetching Asset details using REST API of composer-rest-server, I receive response as:

{
  "orderId": "o5",
  "createdBy": "resource:com.supplychain-network.SupplierChainParticipant#p1",
  "assignedTo": "resource:com.supplychain-network.SupplierChainParticipant#p2",
  "description": "New Engine",
  "status": "created",
  "quantity": 1,
  "assetId": "a1"
}

As currently its only returning participantId only while fetching Asset details, Is there a way to fetch details of participant along with Asset as JSON response?

score 3 · Accepted Answer · answered Jun 15 '17 at 20:00

3

If you specify a filter key called include and set the value to resolve then relationships will be resolved and the related assets will also be returned.

answered Jun 15 '17 at 20:00

Dan Selman

2,287
2
9
18

As part of request, I need to add field called "include" and value as "resolve"? – deepak parmar Jun 16 '17 at 05:21
can you add an example? – Diego Puente Jul 12 '18 at 12:51
'http://localhost:3000/api/CommodityAsset?filter={"where":{"assetId":"A01"},"include":"resolve"}' – appbootup Aug 25 '18 at 09:58
'http://localhost:3000/api/CommodityAsset?filter={"where":{"assetId":"A01"},"include":"resolve"}' – appbootup Aug 25 '18 at 09:58

score 1 · Answer 2 · answered Aug 25 '18 at 10:00

1

To improve upon the accepted answer with example -

1. 'http://localhost:3000/api/PurchaseOrder?filter={"where":{"orderId":"A01"},"include":"resolve"}'

2. 'http://localhost:3000/api/PurchaseOrder?filter={"include":"resolve"}'

answered Aug 25 '18 at 10:00

appbootup

9,537
3
33
65

How to include relationship object in response composer-rest-server?

2 Answers2