# createTodoEntry

State Resource

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

# Purpose

Creates a new todo entry. Note that after creating the todo, the ResultPath object will have a property called idProperties, which will have a sub-property called id - which will hold the id of the newly created todo.

# Usage

# Example

{
  "CreateTodoEntry": {
    "Type": "Task",
    "Resource": "module:createTodoEntry",
    "Parameters": {
      "todoTitle": "Book Dance Classes",
      "description": "Book a Dance Class for an individual",
      "stateMachineTitle": "Book Dance Classes",
      "stateMachineCategory": "dance",
      "launches": [
        {
          "title": "Book",
          "stateMachineName": "dance_bookClass_1_0",
          "input": {
            "id.$": "$.id"
          }
        }
      ]
    },
    "ResultPath": "$.todo",
    "Next": "NextState"
  }
}

# Options

# Required properties

# todoTitle

The text of the clickable link on the todo.

  • Type: string

# description

The text displayed under the clickable link on the todo.

  • Type: string

# stateMachineTitle

This will be stored in the database to identify an execution - this will typically be the same as todoTitle.

  • Type: string

# stateMachineCategory

The blueprint namespace (see the namespace property in your blueprint.json file).

  • Type: string

# Optional properties

# id

An optional property allowing you to specify the id of the todo. Note that this property wouldn't typically be specified and would be set automatically.

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