How to create OData V2 entity path dynamically in UI5?

Question

I want to update a table populated with OData service. I am using this approach:

oModel.update("/Products(999)", data, {/*...*/});

I have the selected index stored in a variable (myVar1) and I need to pass that variable to the path string. The problem is Products(999) - this is working with the hard coded row but how to replace 999 with a variable?

Answer 1

Create the path dynamically via the API createKey from the V2 ODataModel:

const path = "/" + myODataV2Model.createKey("Products", {
  // Key(s) and value(s) of that entity set
  "ProductID": myVar1, // with the value 999 for example
  "AnotherKeyProperty": "...",
});
myODataV2Model.update(path/*, ...*/); // applies also to .remove

Compared to concatenating strings for the path manually, createKey offers the following advantages:

• It outputs the key value always in the correct format corresponding to the EDM type of the given property (using ODataUtils.formatValue internally). E.g.: If ProductID has the type Edm.Int64, UI5 appends the character "l" in the output string aligning with the OData specification: "999" → "999l"
• It makes sure that all keys are encoded according to the URI standard (using encodeURIComponent^api internally). E.g.: ProductID='sp ace' → ProductID='sp%20ace'
• It outputs the key values always in the correct order no matter which backend system serves the metadata. Given the same metadata definition, it is possible that one system serves the metadata with keys in different orders than others. In such cases, if keys are just concatenated manually, the app would fail horribly throwing vague errors when it's transported to the system serving different key orders.

---

Note

Since createKey relies on the information from the service metadata, the API should be performed after the $metadata is loaded. For this, the promise based API metadataLoaded can be used.

myODataV2Model.metadataLoaded(true).then(/*createKey*/);