# findingById

State Resource

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

# Purpose

Finds a single document that has the specified id and adds it to the tymly context

# Usage

# Example

{
  "findingById": {
    "Type": "Task",
    "Resource": "module:findingById",
    "InputPath": "$.id",
    "ResourceConfig": {
      "modelId": "namespace_model"
    },
    "ResultSelector": {
      "results.$": "$"
    },
    "End": true
  }
}

# Options

# Required properties

# `modelId`

This is the id of a model which will be searched for the specified document.

Type: string

# Links

State Resource class on GitHub