> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Business Objects

Run an ad-hoc search for business object records.

<Note>
  External Documentation

  To learn more, visit the [Cherwell documentation](https://help.ivanti.com/ch/help/en_US/CSM/10.4/documentation_bundle/api/csm_api-swagger.html?Highlight=%2Fapi%2FV1%2Fgetsearchresults#searchesGetSearchResultsAdHocV1).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Business Object ID | The ID of the business object type.<br /><br />Can be obtained from the `List Business Objects` action.                                                                                                                                                                                                                                                                                                                                                                                                     |
  | Fields             | A comma-separated list of field names to return for each record.                                                                                                                                                                                                                                                                                                                                                                                                                                            |
  | Filters            | The filters to apply to the search, as a JSON array. For more information about filters refer to [Cherwell documentation](https://help.ivanti.com/ch/help/en_US/CSM/10.4/documentation_bundle/api/csm_api-swagger.html?Highlight=%2Fapi%2FV1%2Fgetsearchresults#Trebuchet.WebApi.DataContracts.Searches.FilterInfo).<br /><br />**For example:**<br /><pre><code>\[<br />  \{<br />    "fieldId": "93e1249069904d918a45",<br />    "operator": "eq", <br />    "value": "Open"<br />  }<br />]</code></pre> |
  | Include All Fields | Select to include all fields of the business object in the results.                                                                                                                                                                                                                                                                                                                                                                                                                                         |
  | Page Number        | The page number of the results to retrieve.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  | Page Size          | The maximum number of records to return per page.                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | Return All Pages   | Automatically fetch all resources, page by page.                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
  | Search Text        | The free-text value to search for.                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
  | Sorting            | The fields to sort the results by, as a JSON array. For more information about sorting refer to [Cherwell documentation](https://help.ivanti.com/ch/help/en_US/CSM/10.4/documentation_bundle/api/csm_api-swagger.html?Highlight=%2Fapi%2FV1%2Fgetsearchresults#Trebuchet.WebApi.DataContracts.Searches.SortInfo).<br /><br />**For example:**<br /><pre><code>\[<br />  \{<br />    "fieldId": "93e1249069904d918a45", <br />    "sortDirection": 0<br />  }<br />]</code></pre>                            |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Association               | The association scope of a saved search to run.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | Association Name          | The name of the association scope of a saved search to run.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | Custom Grid Definition ID | The ID of a custom grid definition to use to format the results.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
  | Date Time Formatting      | The format to return date and time field values in.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | Field ID                  | The ID of a single field to search on.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | Include Schema            | Select to include the business object's schema in the results.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
  | Language                  | The culture code to localize the response with.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | Locale                    | The locale to localize the response with.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  | Prompt Values             | The values to supply for a saved search's runtime prompts, as a JSON array. For more information about prompt values rerfer to [Cherwell documentation](https://help.ivanti.com/ch/help/en_US/CSM/10.4/documentation_bundle/api/csm_api-swagger.html?Highlight=%2Fapi%2FV1%2Fgetsearchresults#Trebuchet.WebApi.DataContracts.Core.PromptValue).<br /><br />**For example:**<br /><pre><code>\[<br />  \{<br />    "promptId": "93e1249069904d918a45", <br />    "fieldId": "93e1249069904d918a45", <br />    "value": "Open"<br />  }<br />]</code></pre> |
  | Scope                     | The scope of a saved search to run.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | Scope Owner               | The owner of the saved search's scope.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | Search ID                 | The ID of a saved search to run.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
  | Search Name               | The name of a saved search to run.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
</div>

## Example Output

```json theme={"dark"}
{
	"busObId": "93e1249016c5457c8ca0f75db8767db4",
	"fieldNames": [
		"IncidentID",
		"Status",
		"ShortDescription"
	],
	"businessObjects": [
		{
			"busObRecId": "9585a3b1c2e94b6ab35f4b8e9d6b6a10",
			"busObPublicId": "12345",
			"fieldNames": [
				"IncidentID",
				"Status",
				"ShortDescription"
			],
			"fieldValues": [
				"12345",
				"Open",
				"Cannot access VPN"
			]
		}
	],
	"hasError": false,
	"totalRows": 1
}
```

## Workflow Library Example

[List Business Objects with Cherwell and Send Results Via Email](https://library.blinkops.com/workflows/list-business-objects-with-cherwell-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-business-objects-with-cherwell-and-send-results-via-email/canvas" />
</div>