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".

Here is an example to fetch incidents that contains boardroom.

URL	https://{tenant url}/api/odata/businessobject/incidents?$search=Boardroom
Method	GET
Header Name	Authorization: JTW Token/Session Key/REST API Key
Status Code	200
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": "[email protected]", "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

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