---
title: Full-Text Search
slug: neurons-for-itsm/admin-user-help/enu/latest/full-text-search
createdAt: 2026-07-14T19:16:45.871Z
---
Executes a search based on the keyword in single or in multiple business objects.
## Search in Single Business Object
Executes search in the defined specific single business object.
:::ExpandableHeading
## Search in Single Business Object - Example
Here is an example to execute a search based on the search keyword in an incident business object.
| URL | https\://\{tenant url}/api/rest/search/fulltext |
| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Method | POST |
| Header Name | Authorization: JWT Token/Session Key/REST API Key |
| Status Code | 200 |
| Request Payload | \{
"Text" : "Printer",
"ObjectType" : "Incident",
"Top":20,
"Skip": 20
} |
| Response Payload | \{
"data": \[
\{
"IncidentNumber": 10005,
"Subject": "The printer near user's desk small like it is very hot.",
"RecId": "DAB00E0C24454B07B0A355420D6B0E1C"
},
\{
"IncidentNumber": 10021,
"Subject": "The printer near user's desk small like it is very hot.",
"RecId": "EFAA6661BB3E49DEB14A1AEB50B9BECB"
},
\{
"IncidentNumber": 10081,
"Subject": "Printer is jamming with labels.",
"RecId": "D9C47BB249B7443C866EB9E7939ECA54"
},
\{
"IncidentNumber": 10155,
"Subject": "Printer is jamming with labels.",
"RecId": "45CFEE518CD74E2CAC59A5D94ABBC008"
},
\{
"IncidentNumber": 10205,
"Subject": "Check the printer setup in the HR dept",
"RecId": "81DEE4064D84437CA902F00B4879A81F"
}
],
"metaData": \[
\{
"FieldRef": "IncidentNumber",
"DisplayName": "Incident ID",
"DataType": 6
},
\{
"FieldRef": "Subject",
"DisplayName": "Summary",
"DataType": 1
},
\{
"FieldRef": "RecId",
"DisplayName": "RecId",
"DataType": 4
}
],
"totalRows": 20,
"keyRef": "RecId",
"searchText": "Printer"
} |
:::
### Unsuccessful Responses - Search in Single Business Object
:::ExpandableHeading
## Empty Search Parameter (Keyword)
Scenario: Executing a search without entering a search keyword.
https\://\{tenant url}/api/rest/search/fulltext
Header Name:
**Authorization: Sessionkey**
| Code | ISM\_4000 |
| --------------------------------------------- | ------------------------------------------------------------------ |
| Description | Bad Request |
| Message | "Search keyword cannot be blank, provide a keyword and try again". |
| HTTP STATUS CODE | **400** |
:::
:::ExpandableHeading
## Empty Search Parameter (Business Object Type)
Scenario: Executing a search without defining the business object type in the request body.
https\://\{tenant url}/api/rest/search/fulltext
Header Name:
**Authorization: Sessionkey**
| Code | ISM\_4000 |
| --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| Description | Bad Request |
| Message | "ObjectType cannot be blank. Please provide the business object
name in the ObjectType field and try again". |
| HTTP STATUS CODE | **400** |
:::
## Search in Multiple Business Objects
Executes search in multiple business objects.
::::ExpandableHeading
## Search in Multiple Business Object - Example
:::hint{type="info"}
The business objects on which search is executed is based on the search configurations.
:::
Here is an example to execute a search in multiple business objects.
| URL | https\://\{tenant url}/api/rest/Search |
| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Method | POST |
| Header Name | Authorization : Sessionkey/REST API Key |
| Status Code | 200 |
| Request Payload | `{
`
`"Text":"Phone"
`
`}` |
| Response Payload | `{`
`"Items": [`
`{`
`"title": "How to access my voicemail from my desk phone or cell?",`
`"description": "Accessing from your own Cisco phone: \r\nDial 1790`
`(or press the Envelope button if you have a 7940 model)\r\nEnter your`
`PIN followed by # \r\nStart listening to messages\r\nPress 0 to return`
`to main menu for more options, e.g. press 2 to record greetings as you`
`wish",`
`"tableRef": "FAQ#",`
`"objectId": "70AEE924D22D487CB99D02B0DE090305",`
`"formName": "FAQ.Brief",`
`"objectType": "FAQ",`
`"createdDateTime": "May 9, 2007",`
`"score": null,`
`"numberOfLines": 3,`
`"k__BackingField": null`
`},`
`{`
`"title": "Network Maintenance",`
`"description": "Scheduled maintenance will be peformed for all Routers`
`for APAC region. All network access, include phone, internet, and email,`
`will be down the weekend of 11/2/2007 - 11/3/2007 and will resume`
`11/4/2007.",`
`"tableRef": "Announcement#",`
`"objectId": "BD9FE5ABB34D480ABFADBC29E018F2A2",`
`"formName": "Announcement.Brief",`
`"objectType": "Announcement",`
`"createdDateTime": "May 15, 2007",`
`"score": null,`
`"numberOfLines": 3,`
`"k__BackingField": null`
`}`
`],`
`"TotalRecords": 2,`
`"ErrorMessage": null`
`}` |
::::
### Unsuccessful Response - Search in Multiple Business Objects
:::ExpandableHeading
## Empty Search Parameter (Keyword)
Scenario: Executing a search without entering a search keyword.
https\://\{tenant url}/api/rest/Search
Header Name:
**Authorization: Sessionkey**
| Code | ISM\_4000 |
| --------------------------------------------- | ------------------------------------------------------------------ |
| Description | Bad Request |
| Message | "Search keyword cannot be blank, provide a keyword and try again". |
| HTTP STATUS CODE | **400** |
:::