Error in CreateRequest when a lookup field is null/undefined in target object

[khoait]

Hi,

I'm using dataverse-ify version 2.0.7. I'm trying to send a batch request using the executeMultiple function. When the target object contains a lookup field with undefined/null value, I get the below error.

Error identified in Payload provided by the user for Entity :'(entity name removed)', For more information on this error please follow this help link https://go.microsoft.com/fwlink/?linkid=2195293 
----> InnerException : Microsoft.Crm.CrmException: Invalid property '(lookup field name removed)' was found in entity 'Microsoft.Dynamics.CRM.(entity name removed)'. 
---> Microsoft.OData.ODataException: Does not support untyped value in non-open type.

I also checked the normal create function and got the same error. The target object looks like this:

{
  logicalName: "new_entityname",
  new_name: "some name",
  new_lookupfield: null
}

[khoait]

I just tested with create request Web API in Postman. Turns out setting null to a lookup field we need to use the Schema Name instead of the Logical Name. It's quite inconvenient when they are different, usually upper case vs lower case like this:

Display Name: Lookup Field
Schema name: new_LookupField
Logical name: new_lookupfield

so the payload should look like this:

{
  logicalName: "new_entityname",
  new_name: "some name",
  new_LookupField: null
}

Can we have some logic to check for this scenario and construct the payload correctly?

[khoait]

Proposed a fix in a PR

[scottdurow]

Hi @khoait - I completely missed this PR - sorry it's take me over a year to get to it! I merged in and the nullvalues integration test started to fail:

dataverse-ify/src/dataverse-ify/__tests__/integration-tests/nullvalues.test.ts

Line 76 in 3e2a6bb

expect(account1Retrieved2.preferredsystemuserid).toBeUndefined();

Perhaps this issue is specific to batch requests?

[khoait]

Thanks @scottdurow ! It happens to a single create request as well. I'll review the tests.

[khoait]

@scottdurow I added unit tests and passed all tests. please have a look.

[scottdurow]

Ah - ha! So it's the case sensitivity of the lookup field. Awesome job in spotting and fixing this!

[khoait]

yeah! it was very tricky when I first encountered the error.

I came up with a convention within the team to always modify the logical name to lowercase whenever we create a new field to keep it consistent for sdk and odata.

I hope the fix will be available soon! Cheers!

[scottdurow]

I'll get this merged and published asap!
I want to move v2 out of beta by the end of the year. Do you have anything that you could share to improve the documentation for dataverse-ify?

[khoait]

That's great to hear! Thanks @scottdurow !
First thing comes to mind is adding quick installation in the Readme. I'll create another issue/discussion with more details.