create_form

Create an application form, optionally bound to a model.

settings.on_success_redirect accepts a static application-relative path or {{record.id}}, {{data.field}} and {{record.data.field}} tokens resolved from persisted non-credential fields on this form. Rules’ redirects take priority. A successful submit also returns record: {id, data} with that filtered projection. Edit bindings belong to page form source.target_mode/source.record_id, rather than settings on this standalone create form.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "application_id": {
      "title": "Application Id",
      "type": "string"
    },
    "idempotency_key": {
      "title": "Idempotency Key",
      "type": "string"
    },
    "model_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Model Id"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "settings": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Settings"
    }
  },
  "required": [
    "application_id",
    "name",
    "idempotency_key"
  ],
  "title": "create_formArguments",
  "type": "object"
}

Output schema

{
  "properties": {
    "application_id": {
      "format": "uuid",
      "title": "Application Id",
      "type": "string"
    },
    "created_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created At"
    },
    "created_by": {
      "format": "uuid",
      "title": "Created By",
      "type": "string"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "is_default": {
      "title": "Is Default",
      "type": "boolean"
    },
    "layout": {
      "additionalProperties": true,
      "title": "Layout",
      "type": "object"
    },
    "mode": {
      "enum": [
        "simple",
        "advanced"
      ],
      "title": "Mode",
      "type": "string"
    },
    "model_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Model Id"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "position": {
      "title": "Position",
      "type": "integer"
    },
    "settings": {
      "additionalProperties": true,
      "title": "Settings",
      "type": "object"
    },
    "style_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Style Id"
    },
    "type": {
      "title": "Type",
      "type": "string"
    },
    "updated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "type",
    "layout",
    "style_id",
    "is_default",
    "settings",
    "position",
    "model_id",
    "mode",
    "application_id",
    "created_by",
    "created_at",
    "updated_at"
  ],
  "title": "FormResponse",
  "type": "object"
}