Search API Help

27228

How can I call the search api to only return results where my search criteria is found in a particular column. For example, I want the results to contain all records where the word "test" is found in the matter name only but not where the word test is found in other columns.

 

This is the body I am passing in, I assume this would force it to search on columnid 39005 only but that does not seem to be the case.

{

"allofthesewords": "test",

  "data": {

    "item": [

      {

        "column": [

          {

             "columnid": 39005

          }

        

      }

    ]

  }

}

Results:

isheet 1, mattername=test, assignee=darren

isheet 2. mattername=blah blah, assignee=test

 

In the above scenario, I only want isheet1 to be returned

 

I have also tried creating a view that just contains column 39005 and calling the search api on that view only, but still the other items are returned.

Also, the allColumnRequired=false parameter does not seem to be working in this scenario as all columns are being returned, I would have thought it would respect the columns in the view and return just column 39005?

 

 

 

]]>
Parents
  • Darren Chappell, standard use iSheet search API doesn't suport exact matches on Single/Multi Line text fields. In the past we had to use elaborate methods to get it to perform the way you want.

    However, now from Collaborate version 5.6 (API version 13) onwards, you can use expression queries that will do this, e.g. for your use case:

    {
       "expressionquery": "col_39005 = 'Test 1'"
    }
    

    Other operators exist, like:

     

    Operator Type Operator Symbol
    OPERATOR_TYPE_EQUALS_TO =
    OPERATOR_TYPE_NOT_EQUALS_TO !=
    OPERATOR_TYPE_CONTAINS ~
    OPERATOR_TYPE_NOT_CONTAINS !~
    OPERATOR_TYPE_BEGINS_WITH ^
    OPERATOR_TYPE_NOT_BEGINS_WITH !^
    OPERATOR_TYPE_GREATER_THAN >
    OPERATOR_TYPE_GREATER_THAN_EQUAL >=
    OPERATOR_TYPE_LESS_THAN_EQUAL_TO <=
    OPERATOR_TYPE_ENDS_WITH $
    OPERATOR_TYPE_LESS_THAN <
    OPERATOR_TYPE_NOT_ENDS_WITH !$

    There is zero documentation on this, so you will need to reach out to the HighQ support to get them to find some for you. The notes indicate to refer to the swagger UI, but there is nothing there about it.

    Hope this helps,

    Andrew

Reply
  • Darren Chappell, standard use iSheet search API doesn't suport exact matches on Single/Multi Line text fields. In the past we had to use elaborate methods to get it to perform the way you want.

    However, now from Collaborate version 5.6 (API version 13) onwards, you can use expression queries that will do this, e.g. for your use case:

    {
       "expressionquery": "col_39005 = 'Test 1'"
    }
    

    Other operators exist, like:

     

    Operator Type Operator Symbol
    OPERATOR_TYPE_EQUALS_TO =
    OPERATOR_TYPE_NOT_EQUALS_TO !=
    OPERATOR_TYPE_CONTAINS ~
    OPERATOR_TYPE_NOT_CONTAINS !~
    OPERATOR_TYPE_BEGINS_WITH ^
    OPERATOR_TYPE_NOT_BEGINS_WITH !^
    OPERATOR_TYPE_GREATER_THAN >
    OPERATOR_TYPE_GREATER_THAN_EQUAL >=
    OPERATOR_TYPE_LESS_THAN_EQUAL_TO <=
    OPERATOR_TYPE_ENDS_WITH $
    OPERATOR_TYPE_LESS_THAN <
    OPERATOR_TYPE_NOT_ENDS_WITH !$

    There is zero documentation on this, so you will need to reach out to the HighQ support to get them to find some for you. The notes indicate to refer to the swagger UI, but there is nothing there about it.

    Hope this helps,

    Andrew

Children
No Data