Save Database Schema

save Database Schema.

A schema defines a collection's fields, types, and validation. Schemas support drafts, versions, and publishing.

This endpoint creates the database schema and returns its id.

post

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Body

SaveDatabaseSchemaRequest

correlationIdstring · nullableOptional

CorrelationId for each request

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

dataSchemastring · nullableOptional

Raw JSON string matching the Norbix data meta-schema (https://norbix.ai/schemas/meta/v1.json). When unsure of the shape, read an existing schema with get_database_schema first.

schemaNamestringRequired

Human-entered schema title (e.g. "Company Employees"); a slug is derived server-side.

viewIdstring · nullableOptional

Empty to create a new schema; set to an existing schema id (from get_database_schemas) to update its draft.

visualSchemastring · nullableOptional

OPTIONAL raw JSON string matching the Norbix UI/visual meta-schema (https://norbix.ai/schemas/ui/v1.json), describing the record form layout. If omitted or invalid, the backend auto-generates a flat-list form from the data schema; provide it to control the layout.

Responses

200

OK

application/json

idstring · nullableOptional

statusstring · nullableOptional

post/{version}/database/schemas

POST /{version}/database/schemas HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 249

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "dataSchema": "text",
  "schemaName": "text",
  "settings": {
    "softDelete": true,
    "hasRecordOwner": true,
    "description": "text"
  },
  "viewId": "text",
  "visualSchema": "text"
}

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "id": "text",
  "status": "text"
}

In the dashboard

Manage this visually in Norbix Cloud — see Database.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Save Database Schema in the SDK reference, with examples in every language.