The SBM documentation is pretty good on explaining these different calls to access the data.

For example, the GetItemsByItemID returns items based on the Item ID as described. It doesn't filter on the fields.

The GetItemsByListingReport returns a set of items based on the defined report, not a single item. When I use this call, I usually use the Report Reference Name as it is easier to find then the report id. If you want to retrieve a single item, use GetItem.

For GetItemsByReportFilter, which may work in your scenario to filter based on Field1, requires that you have created the filter in SBM workspace or SBM Composer and deployed the application.

If your goal is to return a list of items based on filtering via a field, I would use the GetItemsByListingReport. You can set up a query at runtime parameter and pass that in via the post data.

I have create a report already in my workspace the report id is 498 and there is a query parameter in the search filter but it didn't work



I posted a screenshot to have the URLs in it

the URLs got hidden when I posted my reply here

Aah, that helps.

If you use the report id instead of the reference name, then you must use the field id instead of the field name, e.g.:

.../jsonapi/GetitemsByListingReport/498?hasruntimeparams=1&F5034=1222

vs

.../jsonapi/GetitemsByListingReport/USR_TABLENAME/REFERENCENAME?hasruntimeparams=1&F_TS_TRANSGUID=1222

I got the FieldID from the TS_FIELDS table, but it didn't work with or without the F letter, my field ID based in the TS_FIELDS table is 6447 :



it didn't work and it retrieved all records regardless of whether the parameter is correct or not, it should return nothing if the parameters are not valid,  

Do you only have one item in the table? I see that the returned results were only 1.

You can try the UUID of the report and the field name to see what returns:

.../jsonapi/GetitemsByListingReport/D677....?hasruntimeparams=1&F_TS_TRANSGUID=1222

Yes it should return one result but I cant see the desired result in the response JSON, the report should return :

If your table has more than one record, but only one is being returned, then the filter is probably working. You can see the one result in your screenshot.

Is the filter text that you are passing in correct if you are getting the wrong item back?

Thank you Michael for your time. Yes, the filter is working if pass a correct value for the filter then I get some items in the "items": [] in the response, and if I pass something wrong the "items": [] will be empty.

an example of a returned result for a valid filter (I've changed some values for privacy purposes) :

 
so the field 'Client Long Name' is not included in the response,  as I mentioned before the report on the UI shows :



so I thought the same three fields would be retrieved in the JSON response.

.

You would assume that, but SBM requires that you have manually specify the fields to return.

You'll need to pass in the specific fields in the item options.