# finding

State Resource

This is a State Resource as provided by the tymly-core-plugin plugin.

# Purpose

Finds documents in a specified model that meet specified criteria and adds it to the tymly context

# Usage

# Example

{
  "Finding": {
    "Type": "Task",
    "Resource": "module:finding",
    "ResourceConfig": {
      "modelId": "namespace_model",
      "filter": {
        "where": {
          "modelProperty1": {
            "equals": "$.modelProperty1"
          },
          "booleanProperty": {
            "equals": true
          }
        }
      }
    },
    "ResultPath": "$.results",
    "End": true
  }
}

# Options

# Required properties

# modelId

This is the id of a model from which zero or more documents will be fetched.

  • Type: string

# Optional properties

# filter

Conditions which documents must meet to be returned.

  • Type: object
Last Updated: 9/10/2023, 11:30:14 AM