Form – Oblax

Form

A Form represents a data collection schema. It holds a name, an auto-generated slug, and an array of Field definitions that describe what data to collect and how to validate it. Forms are the top-level resource in the Forms module and serve as the parent for fields and entries.

Sample Object

{
  "id": "frm_abc123def456",
  "name": "customer_feedback",
  "slug": "customer_feedback",
  "fields": [
    {
      "id": "fld_abc123def457",
      "form_id": "frm_abc123def456",
      "name": "rating",
      "data_type": "int",
      "options": [1, 2, 3, 4, 5],
      "required": true,
      "depends_field": "",
      "depends_field_value": ""
    },
    {
      "id": "fld_abc123def458",
      "form_id": "frm_abc123def456",
      "name": "comment",
      "data_type": "text",
      "options": null,
      "required": false,
      "depends_field": "",
      "depends_field_value": ""
    }
  ]
}

Fields

Field	Type	Description
`id`	string	Unique identifier for the form. Auto-generated on creation.
`name`	string	Human-readable name for the form. Required.
`slug`	string	URL-friendly identifier derived from the name. Auto-generated.
`fields`	array	Array of Field objects defining the form schema. Each field specifies name, data type, validation rules, and optional conditional logic.

Actions

Creating a form

Create a new form with an optional set of inline field definitions. Fields can be added later using the field sub-resource endpoints.

obx app forms init

Edit the generated file to add the form name and fields, then run:

obx app forms push init

const form = await oblax.forms.form.create({
  name: "support_ticket",
  fields: [
    {
      name: "subject",
      data_type: "string",
      required: true,
    },
    {
      name: "priority",
      data_type: "string",
      options: ["low", "medium", "high"],
      required: true,
    },
  ],
});

POST /api/v1/forms

{
  "name": "support_ticket",
  "fields": [
    {
      "name": "subject",
      "data_type": "string",
      "required": true
    },
    {
      "name": "priority",
      "data_type": "string",
      "options": ["low", "medium", "high"],
      "required": true
    }
  ]
}

Successful response

{
  "id": "frm_mno345pqr678",
  "name": "support_ticket",
  "slug": "support_ticket",
  "fields": [
    {
      "id": "fld_mno345pqr679",
      "form_id": "frm_mno345pqr678",
      "name": "subject",
      "data_type": "string",
      "options": null,
      "required": true,
      "depends_field": "",
      "depends_field_value": ""
    },
    {
      "id": "fld_mno345pqr680",
      "form_id": "frm_mno345pqr678",
      "name": "priority",
      "data_type": "string",
      "options": ["low", "medium", "high"],
      "required": true,
      "depends_field": "",
      "depends_field_value": ""
    }
  ]
}

Getting a form by ID

Retrieve a single form including its full field definitions.

obx app forms get frm_abc123def456

GET /api/v1/forms/frm_abc123def456

Successful response

{
  "id": "frm_abc123def456",
  "name": "customer_feedback",
  "slug": "customer_feedback",
  "fields": [
    {
      "id": "fld_abc123def457",
      "form_id": "frm_abc123def456",
      "name": "rating",
      "data_type": "int",
      "options": [1, 2, 3, 4, 5],
      "required": true,
      "depends_field": "",
      "depends_field_value": ""
    }
  ]
}

Listing all forms

Retrieve all forms in the project.

obx app forms list

GET /api/v1/forms

Successful response

{
  "items": [
    {
      "id": "frm_abc123def456",
      "name": "customer_feedback",
      "slug": "customer_feedback",
      "fields": [
        {
          "id": "fld_abc123def457",
          "form_id": "frm_abc123def456",
          "name": "rating",
          "data_type": "int",
          "options": [1, 2, 3, 4, 5],
          "required": true,
          "depends_field": "",
          "depends_field_value": ""
        }
      ]
    },
    {
      "id": "frm_mno345pqr678",
      "name": "support_ticket",
      "slug": "support_ticket",
      "fields": [
        {
          "id": "fld_mno345pqr679",
          "form_id": "frm_mno345pqr678",
          "name": "subject",
          "data_type": "string",
          "options": null,
          "required": true,
          "depends_field": "",
          "depends_field_value": ""
        }
      ]
    }
  ]
}

Updating a form

Update the form name and replace its field definitions. Provide the full set of fields in the request. Fields not included are removed from the schema.

obx app forms push frm_abc123def456

await oblax.forms.form.update("frm_abc123def456", {
  name: "updated_feedback",
  fields: [
    {
      id: "fld_abc123def457",
      name: "rating",
      data_type: "int",
      options: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
      required: true,
    },
    {
      name: "comment",
      data_type: "text",
      required: false,
    },
  ],
});

PUT /api/v1/forms/frm_abc123def456

{
  "name": "updated_feedback",
  "fields": [
    {
      "id": "fld_abc123def457",
      "name": "rating",
      "data_type": "int",
      "options": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
      "required": true
    },
    {
      "name": "comment",
      "data_type": "text",
      "required": false
    }
  ]
}

Successful response

No response body.

Deleting a form

Delete a form permanently. This removes the form schema and all associated entries.

obx app forms delete frm_abc123def456

Field