Skip to main content

Task

Task schema.

data objectrequired

A JSON object containing the task data, structured in JSON Schema format. This field includes a detailed schema representation of the task, as well as an embedded HTML description for visual rendering. The schema contains metadata about the form, including labels, input elements, and structure, which can be used to render a dynamic form in a UI.

property name*any

A JSON object containing the task data, structured in JSON Schema format. This field includes a detailed schema representation of the task, as well as an embedded HTML description for visual rendering. The schema contains metadata about the form, including labels, input elements, and structure, which can be used to render a dynamic form in a UI.

Example: {"schema":{"description":"<table>\n <tbody>\n <tr>\n <th>User: </th>\n <td>example@treasuryspring.com</td>\n </tr>\n <tr>\n <th>First name: </th>\n <td>John</td>\n </tr>\n <tr>\n <th>Last name: </th>\n <td>Doe</td>\n </tr>\n <tr>\n <th>Role: </th>\n <td>None</td>\n </tr>\n <tr>\n <th>Entity: </th>\n <td>TEST0001</td>\n </tr>\n <tr>\n <th>Branding: </th>\n <td>None</td>\n </tr>\n <tr>\n <th>Include in default mailing list: </th>\n <td>True</td>\n </tr>\n <tr>\n <th>Phone: </th>\n <td>None</td>\n </tr>\n <tr>\n <th>Send welcome email: </th>\n <td>True</td>\n </tr>\n </tbody>\n</table>","properties":{"approve":{"type":"boolean"}},"type":"object"},"ui":{}}
expirydate-timenullablerequired

The expiry datetime of the task (timezone aware). Null if the task does not expire.

Example: 2024-01-01T00:00:00
uidstringrequired

Task uid

Example: edd29e94ebe2417f8fedbcbdc039da84
Task
{
  "data": {
    "schema": {
      "description": "<table>\n <tbody>\n <tr>\n <th>User: </th>\n <td>example@treasuryspring.com</td>\n </tr>\n <tr>\n <th>First name: </th>\n <td>John</td>\n </tr>\n <tr>\n <th>Last name: </th>\n <td>Doe</td>\n </tr>\n <tr>\n <th>Role: </th>\n <td>None</td>\n </tr>\n <tr>\n <th>Entity: </th>\n <td>TEST0001</td>\n </tr>\n <tr>\n <th>Branding: </th>\n <td>None</td>\n </tr>\n <tr>\n <th>Include in default mailing list: </th>\n <td>True</td>\n </tr>\n <tr>\n <th>Phone: </th>\n <td>None</td>\n </tr>\n <tr>\n <th>Send welcome email: </th>\n <td>True</td>\n </tr>\n </tbody>\n</table>",
      "properties": {
        "approve": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "ui": {}
  },
  "expiry": "2024-01-01T00:00:00",
  "uid": "edd29e94ebe2417f8fedbcbdc039da84"
}