category: Case Management
sectionorder:
- Connect
- Collect
provider: Ivanti
commonfields:
  id: Cherwell
  version: -1
configuration:
- display: 'URL (example: https://my.domain.com)'
  name: url
  required: true
  type: 0
  section: Connect
- display: Username
  name: credentials
  required: true
  type: 9
  section: Connect
- display: Client id
  name: client_id
  required: true
  type: 0
  section: Connect
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
  section: Connect
- display: Use system proxy settings
  name: proxy
  type: 8
  required: false
  section: Connect
- defaultvalue: 3 days
  display: First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
  name: fetch_time
  type: 0
  required: false
  section: Collect
- defaultvalue: incident
  display: 'CSV list of objects to fetch. The default is incident, for example: incident,problem,service)'
  name: objects_to_fetch
  type: 0
  required: false
  section: Collect
- defaultvalue: '30'
  display: Max results to fetch (defualt is 30)
  name: max_results
  type: 0
  required: false
  section: Collect
- display: Advanced Query to fetch (see integration detailed instructions)
  name: query_string
  type: 0
  required: false
  section: Collect
- display: Fetch attachments (include attachements in fetch process)
  name: fetch_attachments
  type: 8
  required: false
  section: Collect
- display: Fetch incidents
  name: isFetch
  type: 8
  required: false
  section: Collect
- display: Incident type
  name: incidentType
  type: 13
  required: false
  section: Collect
- display: Incidents Fetch Interval
  name: incidentFetchInterval
  defaultvalue: '1'
  required: false
  type: 19
  advanced: true
  section: Collect
description: Cloud-based IT service management solution.
display: Cherwell
name: Cherwell
script:
  commands:
  - arguments:
    - description: ' Business object type, for example: "Incident". '
      name: type
      required: true
    - description: |-
        Data JSON containing the relevant fields and their values, for example:
        {"title": "some value"}).
      name: json
      required: true
    description: Creates a business object.
    name: cherwell-create-business-object
    outputs:
    - contextPath: Cherwell.BusinessObjects.RecordId
      description: 'Business object record ID. '
      type: String
    - contextPath: Cherwell.BusinessObjects.PublicId
      description: 'Business object public ID. '
      type: String
  - arguments:
    - description: ' Business object type, for example: "Incident". '
      name: type
      required: true
    - description: Data JSON containing the relevant fields and their values.
      name: json
      required: true
    - description: Public ID or record ID.
      name: id_value
      required: true
    - auto: PREDEFINED
      description: Type of ID.
      name: id_type
      predefined:
      - public_id
      - record_id
      required: true
    description: Update a business object with the specified fields.
    name: cherwell-update-business-object
    outputs:
    - contextPath: Cherwell.BusinessObjects.RecordId
      description: 'Business object record ID. '
      type: String
    - contextPath: Cherwell.BusinessObjects.PublicId
      description: 'Business object public ID. '
      type: Unknown
  - arguments:
    - description: ' Business object type, for example: "Incident". '
      name: type
      required: true
    - description: Public ID or record ID.
      name: id_value
      required: true
    - auto: PREDEFINED
      description: Type of ID.
      name: id_type
      predefined:
      - public_id
      - record_id
      required: true
    description: Deletes a given business object.
    name: cherwell-delete-business-object
  - arguments:
    - description: ' Business object type, for example: "Incident". '
      name: type
      required: true
    - description: Public ID or record ID.
      name: id_value
      required: true
    - auto: PREDEFINED
      description: Type of ID.
      name: id_type
      predefined:
      - record_id
      - public_id
      required: true
    description: Gets a business object by an ID.
    name: cherwell-get-business-object
  - arguments:
    - description: ' Business object type, for example: "Incident". '
      name: type
      required: true
    - auto: PREDEFINED
      description: Type of ID.
      name: id_type
      predefined:
      - public_id
      - record_id
      required: true
    - description: Public ID or record ID.
      name: id_value
      required: true
    description: Downloads imported attachements from a specified business object.
    name: cherwell-download-attachments
    outputs:
    - contextPath: File
      description: File result entries.
      type: Unknown
  - arguments:
    - description: ' Business object type, for example: "Incident". '
      name: type
      required: true
    - auto: PREDEFINED
      description: Type of ID.
      name: id_type
      predefined:
      - record_id
      - public_id
      required: true
    - description: Public ID or record ID.
      name: id_value
      required: true
    - description: File entry ID.
      name: file_entry_id
      required: true
    description: Uploads an attachment to a specified business object.
    name: cherwell-upload-attachment
    outputs:
    - contextPath: Cherwell.UploadedAttachments.AttachmentFileId
      description: AttachmentFileId to use to get information about the attachment.
      type: String
    - contextPath: Cherwell.UploadedAttachments.BusinessObjectType
      description: ' Business object type, for example: "Incident". '
      type: String
    - contextPath: Cherwell.UploadedAttachments.PublicId
      description: 'Public ID. '
      type: String
    - contextPath: Cherwell.UploadedAttachments.RecordId
      description: Record ID.
      type: String
  - arguments:
    - description: Parent business object type name.
      name: parent_type
      required: true
    - description: Parent business object record ID.
      name: parent_record_id
      required: true
    - description: Child business object type name.
      name: child_type
      required: true
    - description: Child business object record ID.
      name: child_record_id
      required: true
    - description: Relationship ID.
      name: relationship_id
      required: true
    description: Links business objects that are related.
    name: cherwell-link-business-objects
  - arguments:
    - description: Parent business object type name.
      name: parent_type
      required: true
    - description: Parent business object record ID.
      name: parent_record_id
      required: true
    - description: Child business object type name.
      name: child_type
      required: true
    - description: Child business object record ID.
      name: child_record_id
      required: true
    - description: Relationship ID.
      name: relationship_id
      required: true
    description: Unlinks business objects that are linked and related.
    name: cherwell-unlink-business-objects
  - arguments:
    - description: ' Business object type, for example: "Incident". '
      name: type
      required: true
    - auto: PREDEFINED
      description: Type of ID.
      name: id_type
      predefined:
      - record_id
      - public_id
      required: true
    - description: Public ID or record ID.
      name: id_value
      required: true
    - auto: PREDEFINED
      description: Type of attachment.
      name: attachment_type
      predefined:
      - linked
      - imported
      - url
      required: true
    description: Gets information for business object attachments.
    name: cherwell-get-attachments-info
    outputs:
    - contextPath: Cherwell.AttachmentsInfo.AttachmentFiledId
      description: Attachment field ID.
      type: String
    - contextPath: Cherwell.AttachmentsInfo.FileName
      description: File name.
      type: String
    - contextPath: Cherwell.AttachmentsInfo.AttachmentId
      description: Attachment ID.
      type: String
    - contextPath: Cherwell.AttachmentsInfo.BusinessObjectType
      description: ' Business object type, for example: "Incident". '
      type: String
    - contextPath: Cherwell.AttachmentsInfo.BusinessObjectPublicId
      description: Business object public ID.
      type: String
    - contextPath: Cherwell.AttachmentsInfo.BusinessObjectRecordId
      description: Business object record ID.
      type: String
  - arguments:
    - description: ' Business object type, for example: "Incident". '
      name: type
      required: true
    - auto: PREDEFINED
      description: Type of ID.
      name: id_type
      predefined:
      - record_id
      - public_id
      required: true
    - description: Public ID or record ID.
      name: id_value
      required: true
    - description: Attachment ID to reomve.
      name: attachment_id
      required: true
    description: Remove the attachment from the specified business object.
    name: cherwell-remove-attachment
  - arguments:
    - description: ' Business object type, for example: "Incident". '
      name: type
      required: true
    - description: "The query to run. A CSV list of filters such that each filter is of the form: [\"field_name\",\"operator\",\"value\"] and operator is one of: 'eq'=equal, 'gt'=grater-than, 'lt'=less-than, 'contains', 'startwith'. Special characters should be escaped.\nExample: `[[\"CreatedDateTime\":\"gt\":\"4/10/2019 3:10:12 PM\"][\"Priority\",\"eq\",\"1\"]]`. \nNOTE: If multiple filters are received for the same field name, an 'OR' operation between the filters will be performed, if the field names are different an 'AND' operation will be performed."
      name: query
      required: true
    - defaultValue: '30'
      description: Maximum number of results to pull.
      name: max_results
    description: Runs advanced queries to search in a specified business object.
    name: cherwell-query-business-object
  - arguments:
    - description: ' Business object type, for example: "Incident". '
      name: type
      required: true
    - description: Field property to search by (Name, DIsplay Name or Field id).
      name: field_property
      required: true
    description: Gets information for a field, by one of its properties (Name, Display Name, or id).
    name: cherwell-get-field-info
    outputs:
    - contextPath: Cherwell.FieldInfo.DisplayName
      description: Field display name (as it displays in the Cherwell UI).
      type: String
    - contextPath: Cherwell.FieldInfo.FieldId
      description: Field ID.
      type: String
    - contextPath: Cherwell.FieldInfo.Name
      description: The name to use when working with business object commands.
      type: String
  - arguments:
    - description: Business object association ID for the saved search.
      name: association_id
      required: true
    - description: Scope name or ID for the saved search.
      name: scope
      required: true
    - description: Scope owner ID for the saved search. Use "(None)" when no scope owner exists.
      name: scope_owner
      required: true
    - description: Name of the saved search.
      name: search_name
      required: true
    description: Returns the results of a saved search.
    name: cherwell-run-saved-search
  - arguments:
    - description: Business object name.
      name: business_object_name
      required: true
    description: Get a general business object id by name
    name: cherwell-get-business-object-id
    outputs:
    - contextPath: Cherwell.BusinessObjectInfo.BusinessObjectId
      description: Business object ID.
      type: String
    - contextPath: Cherwell.BusinessObjectInfo.BusinessObjectName
      description: Business object name.
      type: String
  - arguments:
    - description: The name of the business object.
      name: name
    - description: The ID of the business object.
      name: id
    description: Get a business object summary by name or ID.
    name: cherwell-get-business-object-summary
    outputs:
    - contextPath: Cherwell.BusinessObjectSummary.supporting
      description: Whether the business object is a supporting business object or not.
      type: Boolean
    - contextPath: Cherwell.BusinessObjectSummary.major
      description: Whether the business object is a major business object or not.
      type: Boolean
    - contextPath: Cherwell.BusinessObjectSummary.group
      description: Whether the business object is a group business object or not.
      type: Boolean
    - contextPath: Cherwell.BusinessObjectSummary.name
      description: The name of the business object.
      type: String
    - contextPath: Cherwell.BusinessObjectSummary.stateFieldId
      description: The ID of the business object state field.
      type: String
    - contextPath: Cherwell.BusinessObjectSummary.busObId
      description: The ID of the business object.
      type: String
    - contextPath: Cherwell.BusinessObjectSummary.states
      description: The valid states of the business object.
      type: String
    - contextPath: Cherwell.BusinessObjectSummary.lookup
      description: Whether the object is a lookup object or not.
      type: Boolean
    - contextPath: Cherwell.BusinessObjectSummary.displayName
      description: The display name of the business object.
      type: String
    - contextPath: Cherwell.BusinessObjectSummary.firstRecIdField
      description: The ID value of the first business object record ID (RecID) field.
      type: String
    - contextPath: Cherwell.BusinessObjectSummary.recIdFields
      description: The IDs of business object record ID (RecID) fields.
      type: String
  - arguments:
    - description: The ID of the business object.
      name: busobjectid
      required: true
    description: Get One-Step Actions by business object ID.
    name: cherwell-get-one-step-actions-for-business-object
    outputs:
    - contextPath: Cherwell.OneStepActions.BusinessObjectId
      description: The ID of the business object.
      type: String
    - contextPath: Cherwell.OneStepActions.Actions
      description: The business object actions.
      type: Unknown
  - arguments:
    - description: The ID of the business object.
      name: busobjectid
      required: true
    - description: The ID of the business object record.
      name: busobrecid
      required: true
    - description: The key to find the One-Step Action to run. You can get it using the command cherwell-get-one-step-actions-for-business-object.
      name: oneStepAction_StandInKey
      required: true
    - description: Additional information to run the action in JSON format.
      name: prompt_values
      required: true
    description: Run a One-Step Action using a OneStepActionRequest. This request is used to start a One-Step Action run with additional information, such as prompt values.
    name: cherwell-run-one-step-action-on-business-object
    outputs: []
  dockerimage: demisto/python3:3.12.13.10116658
  isfetch: true
  script: '-'
  type: python
  subtype: python3
tests:
- Cherwell - test
fromversion: 5.0.0