iSheets API version 2 - Common objects - iSheet item - Advance search - common object
OVERVIEW
Common object for request xml while running an advanced search
<filterdata>
<allofthesewords><![CDATA[ ]]></allofthesewords>
<anyofthesewords><![CDATA[ ]]></anyofthesewords>
<excludethesewords><![CDATA[ ]]></excludethesewords>
<data>
<!-- date time type column -->
<column attributecolumnid="1130">
<rawdata>
<fromdate><![CDATA[9 Oct 2017]]></fromdate>
<todate><![CDATA[9 Oct 2017]]></todate>
</rawdata>
</column>
<!-- choice type column -->
<column attributecolumnid="1136">
<rawdata>
<choices>
<choice>
<label><![CDATA[Option 1]]></label>
</choice>
<choice>
<label><![CDATA[Option 3]]></label>
</choice>
</choices>
</rawdata>
</column>
<!-- Score[choice] type column applicable from 5.1-->
<column attributecolumnid="1136">
<rawdata>
<choices>
<choice>
<label><![CDATA[Score[Choice1]]]></label>
</choice>
<choice>
<label><![CDATA[Score[Choice2]]]></label>
</choice>
</choices>
</rawdata>
</column>
<!-- user lookup type of column -->
<column attributecolumnid="1142">
<rawdata>
<value>11</value>
</rawdata>
</column>
<!-- other type of column (single line) -->
<column attributecolumnid="1133">
<rawdata>
<value>
<![CDATA[updated]]>
</value>
</rawdata>
</column>
</data>
</filterdata>
Note:
1. Date and time type column - The string should be in the required format for the particular column. For example, if the column is configured for 'DD.MM.YYYY' the string should be in the format of '15.11.2017'.
Toufik Maafi
- please raise a ticket with support@highq.com and we will investigate it for you.
Peter Simpson Thanks for the fast reply, I used your JSON to test, it works but now it shows me all the data from the iSheets :( .
"data": {
"column": [
{
"attributecolumnid": "10073",
"rawdata": {
"value": "Turkey"
}
}
]
}
}
Peter Simpson Hello Peter, thank you for your answer I am not sure exactly what you meant, I tried to move it to under the column object but no luck it's giving me an error.
Unrecognized field "anyofthesewords" (class com.os.api.dbo.isheet.ItemDBO), not marked as ignorable (5 known properties: "itemsequence", "itemid", "externalid", "column", "alerteroption"]) at [Source: (org.glassfish.jersey.message.internal.ReaderInterceptorExecutor$UnCloseableInputStream); line: 10, column: 43] (through reference chain: com.os.api.dbo.isheet.IsheetItemSearchDBO["data"]->com.os.api.dbo.isheet.DataDBO["item"]->java.util.ArrayList[0]->com.os.api.dbo.isheet.ItemDBO["anyofthesewords"])
Any other ideas? Thank you !
Toufik Maafi
Try removing the search term from the search-wide 'anyofthesewords' and putting the term 'underneath' the column object.
Hello, is it possible to search only in a specific column?
I tried this:
{
"anyofthesewords": "Turkey",
"data": {
"item": [
{
"column": [
{
"sequence": 2,
"attributecolumnid": 10073
}
]
}
]
}
}
I want to search only is the column named "Countries" and it's also looking in other columns.
Thank you!
Peter Simpson ok, thanks a lot for the help
Javier Quintana .. not without using the excludethesewords flag, (assuming you know the terms you want to exclude prior). With Regards to searching text, the system is going to be as voracious as possible and return a subset of results wherever possible. The use case in mind is to be more like a 'search-engine' i.e provide a user with numerous results and then they select the most relevant. If you want to be targetting a single record each time and you are aware of a unique property of the record before hand, you could try using the externalid (we have a 'GET single record by external Id endpoint).... failing that I guess you could reduce the list of objects on your side, once we return the search response to you.
Peter Simpson I think I could change to number type in this case, but it'll be a problem in other cases
So, isn't there a way to search for an exact value in a text field?
For example, if I'm searching for value "test" I don't want to get values "test 1" or "final test"
Given:
If the column type is text, I can replicate:
If I put the same values in a number type column, it works as you expect:
I'd need to check with the product manangers whether or not this is expected behaviour. Are you searching for exact matches within blocks of text containd within a column, or can you switch over to using a number type column, for your use-case?
Hi Javier Quintana are you passing your digit into any/all nodes under the filterdata or to a specific column?
Hi,
Is there any way to search filtering by an exact value
When I search with:
I get records with value 2, 12, 20, etc.
Thanks
FYI: Score choice format given above in wiki page is incorrect. Format should be
Hi Andrew Parsons, in your particular use-case, the API endpoint you want to use is this one.
Or in Swagger UI... showSwaggerUI.action#/ISheet%20API/getIsheetRecordID
Given you know the docID/fileID, then this endpoint will return the iSheet itemID for that document. You can then use this to retrieve all the meta-data fields - assuming you know the iSheetID of the file meta-data iSheet.
Hope this helps
Well, it seems we can search by file name.
<![CDATA[my_file_name]]>
Is it possible to query by file ID?
I expected the following to return the iSheet item (a "record"? the row, basically) associated with a column holding a given `docid`:
```
```
ââââââ
Alas, this returns the entire iSheet.
Edit: my goal is to get the `itemid` of a row representing a document (in a File metadata iSheet).
Comments
17 Comments