iris_cases data source

blackstork/iris, v0.4.2

Description

Retrieve cases from Iris API

Installation

To use the iris_cases data source locally via blackstork-cli, you must declare the blackstork/iris plugin as a dependency in your global configuration block.

blackstork {
  plugin_versions = {
    "blackstork/iris" = ">= v0.4.2"
  }
}

After declaring the dependency, execute blackstork-cli install to fetch the plugin. See Configuration for details.

Configuration

This data source accepts the following configuration arguments within a config data iris_cases block:

config data iris_cases {
  # Iris API url
  #
  # Required string.
  # Must be non-empty
  #
  # For example:
  api_url = "some string"

  # Iris API Key
  #
  # Required string.
  # Must be non-empty
  #
  # For example:
  api_key = "some string"

  # Enable/disable insecure TLS
  #
  # Optional bool.
  # Default value:
  insecure = false
}

Usage

This data source accepts the following arguments within a data iris_cases block:

data iris_cases {
  # List of Case IDs
  #
  # Optional list of number.
  # Default value:
  case_ids = null

  # Case Customer ID
  #
  # Optional number.
  # Default value:
  customer_id = null

  # Case Owner ID
  #
  # Optional number.
  # Default value:
  owner_id = null

  # Case Severity ID
  #
  # Optional number.
  # Default value:
  severity_id = null

  # Case State ID
  #
  # Optional number.
  # Default value:
  state_id = null

  # Case SOC ID
  #
  # Optional string.
  # Default value:
  soc_id = null

  # Case opening date - lower boundary
  #
  # Optional string.
  # Default value:
  start_open_date = null

  # Case opening date - higher boundary
  #
  # Optional string.
  # Default value:
  end_open_date = null

  # Sort order
  #
  # Optional string.
  # Must be one of: "desc", "asc"
  # Default value:
  sort = "desc"

  # Size limit to retrieve
  #
  # Optional number.
  # Must be >= 0
  # Default value:
  size = 0
}