cancel
Showing results for 
Search instead for 
Did you mean: 

String values for keyword operators

Jacob_Dahlke6
Star Contributor
Star Contributor

In the Rest API you pass string values "Equal" or "Not Equal" for alphanumeric keywords. Is there a list of those string values for numeric/date keywords? The SDK and programmers guide only uses equal or not equal as an example and no other mention is made. I have a customer requesting this information nd looking to update our own internal documentation. 

Thanks.

1 ACCEPTED ANSWER

Justin_Carlson
Employee
Employee

In the reference section of the SDK under Document Query request properties, you can expand the “queryKeywordCollection” property which then lists the valid enum values for the operator and relation properties. 

Valid values for the operator enum are: "Equal", "LessThan", "GreaterThan", "LessThanEqual", "GreaterThanEqual", "NotEqual", "Literal".
It doesn’t specifically list which will work with which data type, like less than doesn’t work with alphanumeric. One way to verify if you are unsure if one should work is in the Unity client the document retrieval keyword panel limits the operator based on data type, which could confirm if it should work through the API. 
7ccea012942e4e398ca39d51ee4d7dc7

View answer in original post

2 REPLIES 2

Justin_Carlson
Employee
Employee

In the reference section of the SDK under Document Query request properties, you can expand the “queryKeywordCollection” property which then lists the valid enum values for the operator and relation properties. 

Valid values for the operator enum are: "Equal", "LessThan", "GreaterThan", "LessThanEqual", "GreaterThanEqual", "NotEqual", "Literal".
It doesn’t specifically list which will work with which data type, like less than doesn’t work with alphanumeric. One way to verify if you are unsure if one should work is in the Unity client the document retrieval keyword panel limits the operator based on data type, which could confirm if it should work through the API. 
7ccea012942e4e398ca39d51ee4d7dc7

Jacob_Dahlke6
Star Contributor
Star Contributor

Thank you Justin!