Object schemas
The attribute definitions object kinds are described by — the fields a product, a venue or a course carries.
List object schemas
Beta — this operation may change on 30 days notice. See versioning.
Returns the workspace's object schemas, including the field definitions of each.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
query Parameters
cursor^[A-Za-z0-9_-]+$form_activeform_createdform_descriptionform_idform_managed_byform_nameform_updatedlimitoffsetsort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List object schemas › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Create an object schema
Beta — this operation may change on 30 days notice. See versioning.
Declares the attributes a kind of object has. Point an object at it with obj_form to have its obj_content validated against these fields.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create an object schema › Request Body
form_nameform_descriptionform_configform_metadataCreate an object schema › Responses
Created
form_idform_nameform_descriptionform_configform_metadataform_managed_byform_activeform_createdform_updatedGet an object schema
Beta — this operation may change on 30 days notice. See versioning.
Returns the schema with its field definitions.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get an object schema › Responses
Success
form_idform_nameform_descriptionform_configform_metadataform_managed_byform_activeform_createdform_updatedDelete an object schema
Beta — this operation may change on 30 days notice. See versioning.
Deactivates the schema. Objects pointing at it stop accepting writes to obj_content until they are pointed at another one.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete an object schema › Responses
Success. No content.
Update an object schema
Beta — this operation may change on 30 days notice. See versioning.
Applies the form_-prefixed fields present in the body. Objects already stored keep the values they were stored with — removing a field hides it rather than erasing what was collected.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update an object schema › Request Body optional
form_nameform_descriptionform_activeform_configform_metadataUpdate an object schema › Responses
Success
form_idform_nameform_descriptionform_configform_metadataform_managed_byform_activeform_createdform_updated