CherwellQueryIncidents

Details

ID	`CherwellQueryIncidents`
Language	python
From Version	5.0.0
Docker Image	`demisto/python3:3.12.13.10116658`
Tags	Cherwell

README

This script is an example script of how to query incidents from Cherwell. The script wraps the cherwell-query-business-object command of the cherwell integration. When writing your own script to query business objects, follow the instructions found in the configuration section of the script, but do not change the execution section.

Script Data

Name	Description
Script Type	python3
Tags	Cherwell
Cortex XSOAR Version	5.0.0

Dependencies

This script uses the following commands and scripts.

cherwell-query-business-object

Inputs

Argument Name	Description
query	The query to run. The query is a list of comma-seperated filters such that each filter should be of the form: [“field_name”,”operator”,”value”] and operator is one of: ‘eq’=equal, ‘gt’=greater-than, ‘lt’=less-than, ‘contains’, ‘startwith’. Special characters shoud be escaped. Example: `[[“CreatedDateTime”:”gt”:”4/10/2019 3:10:12 PM”][“Priority”,”eq”,”1”]]`. NOTICE: If multiple filters are received for the same field name, an ‘OR’ operation between the filters is performed. If the field names are different, an ‘AND’ operation is performed.

Argument Name

Description

query

The query to run. The query is a list of comma-seperated filters such that each filter should be of the form: [“field_name”,”operator”,”value”] and operator is one of: ‘eq’=equal, ‘gt’=greater-than, ‘lt’=less-than, ‘contains’, ‘startwith’. Special characters shoud be escaped.
Example: `[[“CreatedDateTime”:”gt”:”4/10/2019 3:10:12 PM”][“Priority”,”eq”,”1”]]`.
NOTICE: If multiple filters are received for the same field name, an ‘OR’ operation between the filters is performed. If the field names are different, an ‘AND’ operation is performed.

Outputs

Path	Description	Type
Cherwell.QueryResults.RecordId	Recoed ID	String
Cherwell.QueryResults.PublicId	Public ID	String
Cherwell.QueryResults.Description	Incident description	String
Cherwell.QueryResults.Priority	Incident ptiority	Number
Cherwell.QueryResults.OwnedBy	Incident owned by field	String
Cherwell.QueryResults.Service	Service needed for the incident	String
Cherwell.QueryResults.CustomerDisplayName	Incident reporting customer	String
Cherwell.BusinessObject.CreatedDateTime	Created date time	String
Cherwell.BusinessObject.TotalTasks	Total tasks for this incident	Number

Source

CherwellQueryIncidents.py CherwellQueryIncidents.yml

Download History Raw

args:
- description: "The query to run. The query is a list of comma-seperated filters such that each filter should be of the form: [\"field_name\",\"operator\",\"value\"] and operator is one of: 'eq'=equal, 'gt'=greater-than, 'lt'=less-than, 'contains', 'startwith'. Special characters shoud be escaped.\nExample: `[[\"CreatedDateTime\":\"gt\":\"4/10/2019 3:10:12 PM\"][\"Priority\",\"eq\",\"1\"]]`. \nNOTICE: If multiple  filters are received for the same field name, an 'OR' operation between the filters is performed. If the field names are different, an 'AND' operation is performed."
  name: query
  required: true
comment: This script is an example script of how to query incidents from Cherwell. The script wraps the cherwell-query-business-object command of the cherwell integration. When writing your own script to query  business objects, follow the instructions found in the configuration section of the script, but do not change the execution section.
commonfields:
  id: CherwellQueryIncidents
  version: -1
name: CherwellQueryIncidents
tags: [Cherwell]
dependson:
  must:
  - Cherwell|||cherwell-query-business-object
outputs:
- contextPath: Cherwell.QueryResults.RecordId
  description: Recoed ID
  type: String
- contextPath: Cherwell.QueryResults.PublicId
  description: Public ID
  type: String
- contextPath: Cherwell.QueryResults.Description
  description: Incident description
  type: String
- contextPath: Cherwell.QueryResults.Priority
  description: Incident ptiority
  type: Number
- contextPath: Cherwell.QueryResults.OwnedBy
  description: Incident owned by field
  type: String
- contextPath: Cherwell.QueryResults.Service
  description: Service needed for the incident
  type: String
- contextPath: Cherwell.QueryResults.CustomerDisplayName
  description: 'Incident reporting customer '
  type: String
- contextPath: Cherwell.BusinessObject.CreatedDateTime
  description: Created date time
  type: String
- contextPath: Cherwell.BusinessObject.TotalTasks
  description: Total tasks for this incident
  type: Number
script: '-'
timeout: '0'
type: python
dockerimage: demisto/python3:3.12.13.10116658
subtype: python3
tests:
- Cherwell Example Scripts - test
fromversion: 5.0.0
skipprepare:
- script-name-incident-to-alert