Guid primitive literals non compliant with OASIS OData url conventions (v4.0)

[kinekt4]

I'm using a REST api and have been successful filtering by string and decimals etc.

But when filtering a guid column I get a 400 Bad Response with the following error:

A binary operator with incompatible types was detected. Found operand types 'Edm.Guid' and 'Edm.String' for operator kind 'Equal'.

I'm currently filtering like this:

$item = $odataClient->from('Item')->where('id', '=', 'ec11-80f1-0022489308a6')->get();

I see that the issue is related to the single quotes being added to the value in Grammar::prepareValue().

To prevent single quotes being added, it seems I have to explicitly define the type as a prefix Grammar::isSpecialPrimitiveDataType()

return preg_match("/^(binary|datetime|guid|time|datetimeoffset)(\'[\w\:\-\.]+\')$/i", $value);

So I've modified the guid value to something like this:

$item = $odataClient->from('Item')->where('id', '=', "guid'ec11-80f1-0022489308a6'")->get();

Which resulted in a different error.

Can anyone suggest anything else I can try?

Thanks!

• odata-client: v0.7.3
• REST API: MS Dynamics 365 (D365)

Edit

• It seems that the API I'm using (MS Dynamics 365) doesn't support the guid'<value>' syntax
• And there's no way to passthrough the value without the value being stringified by this library (I believe)
• I'm proposing a possible fix here:
• https://github.com/saintsystems/odata-client-php/pull/156

Edit 02

• I just noticed this PR:
• https://github.com/saintsystems/odata-client-php/pull/105
• Which deals with passing through the whole raw statement

  ---

Rest API

Test done via Postman	Filter	Response
id eq 'ec11-80f1-0022489308a6'	Error: A binary operator with incompatible types was detected. Found operand types 'Edm.Guid' and 'Edm.String' for operator kind 'Equal'.
id eq guid'ec11-80f1-0022489308a6'	Error: Unrecognized 'Edm.String' literal...
id eq ec11-80f1-0022489308a6	OK

[kinekt4]

• According to OASIS OData documentation (v4.0)
• https://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html
• 5.1.1.11.1 Primitive Literals
• GuidValue eq 01234567-89ab-cdef-0123-456789abcdef
• They are represented according to the primitiveLiteral rule in [[OData-ABNF]]
• https://docs.oasis-open.org/odata/odata/v4.0/cs01/abnf/odata-abnf-construction-rules.txt

[kinekt4]

• I just found this issue which relates to what I'm trying to achieve:

• 76; and this PR

• https://github.com/saintsystems/odata-client-php/pull/105

[kinekt4]

Whereas PR #105 allows users to pass through the whole raw expression; eg.

$whereRaw = "id eq ec11-80f1-0022489308a6";
$item = $odataClient->from('Item')->whereRaw($whereRaw)->get();

My PR #156 only aims to pass through the raw value, while maintaining the regular syntax as before

$item = $odataClient->from('Item')->where('id', '=', "raw'ec11-80f1-0022489308a6'")->get();

[kinekt4]

I found my solution in #137, I should do this instead (undocumented):

$item = $odataClient->from('Item')->whereKey('ec11-80f1-0022489308a6')->get();

[anderly]

Will see about updating samples and docs with this.

[anderly]

@kinekt4, also curious if the following would work for your case if it's an ID/PK field:

    $odataClient->from('Item')->find('ec11-80f1-0022489308a6');

This is example is on the wiki, but wanted to check if it worked in your example.