Get Business Objects by Search
2 min
fetches business object records based on the defined search keyword for example, you can define to fetch incidents that contains boardroom in it base url https //{tenant url}/api/odata/businessobject/{business object name}?$search={search keyword} ensure the business object name is suffixed with an "s" get business object by search example here is an example to fetch incidents that contains boardroom url https //{tenant url}/api/odata/businessobject/incidents?$search=boardroom \<font color="#ffffff">method\</font> get header name authorization jtw token/session key/rest api key \<font color="#ffffff">status code\</font> 200 \<font color="#ffffff">response payload\</font> click to view the response payload { "@odata context" "{tenant url}/api/odata/$metadata#incidents", "@odata count" 2, "value" \[ { "actualcategory valid" "14348c1ffa044d8ab1e93005b4a0a287", "actualcategory" "missing item", "category valid" "14348c1ffa044d8ab1e93005b4a0a287", "category" "missing item", "causecode valid" "e2489f3f7da34b898ccd9569ca5541f2", "causecode" "other", "closedby" "jclerk", "createdby" "jclerk", "email" " kdavidson\@saasitdemo com ", "recid" "003b58c0b4554e4baa30dfd88876582a", "subject" "remote control for projector in boardroom is are missing ", "symptom" "this is an issue as it is roof mounted and cannot be switched on/off without the remote", "urgency valid" "44021b6cc6e44e598868c4b3306053ae", "urgency" "medium", "loginid" "kdavidson", }, { "actualcategory valid" "14348c1ffa044d8ab1e93005b4a0a287", "actualcategory" "missing item", "category valid" "14348c1ffa044d8ab1e93005b4a0a287", "category" "missing item", "causecode valid" "", "causecode" "", "closedby" null, "createdby" "sdavis", "recid" "fac9b02cb80041768d99eace6a5dad43", "subject" "remote control for projector in boardroom is are missing ", "symptom" "this is an issue as it is roof mounted and cannot be switched on/off without the remote", "urgency valid" "44021b6cc6e44e598868c4b3306053ae", "urgency" "medium", "loginid" "kdavidson", }, unsuccessful response no records scenario trying to fetch incidents with search keyword that does not have any records https //{tenant url}/api/odata/businessobject/incidents?$search=xxx header name authorization sessionkey code ism 4000 description bad request message "no such entry exists" \<font color="#ffffff">http status code\</font> 400