External DocumentationTo learn more, visit the Cherwell documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Business Object ID | The ID of the business object type. 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. For example: |
| 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. For example: |
Advanced Parameters
| 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. For example: |
| 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. |
Example Output
{
"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