The Custom Object detail screen (Documentation Index
Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt
Use this file to discover all available pages before exploring further.
/settings/data-manager/custom/:apiName) loads a specific user-defined object from the Data Manager by its API name, then provides tabbed management of its records, fields, and settings.
Overview
The page reads:apiName from the URL via useParams, fetches the object definition via useCustomObject, and loads its fields via useCustomObjectFields. The header displays the object name, API name badge, active/inactive status, and category. Three tabs are available: Records (lists all records for the object with inline create/edit), Fields (field schema management via CustomObjectFieldManager), and Settings (object metadata and a danger zone for deletion). Deleting an object permanently removes all associated fields and records and navigates back to /settings/data-manager.
Who it’s for
No explicit permission gate on this route — access depends on the parent Data Manager page granting navigation here.Before you start
- Navigate to
/settings/data-managerand open a custom object. - Ensure the custom object is active if you need to create or edit records.
Steps
Open a custom object
From
/settings/data-manager, click a custom-type object. The URL changes to /settings/data-manager/custom/:apiName.Manage records
The Records tab is active by default. Click New Record to open the record creation dialog. Click a row’s edit icon to modify an existing record.
Manage fields
Switch to the Fields tab to add, reorder, or remove field definitions via the
CustomObjectFieldManager component.View or update settings
Switch to Settings to review the object’s name, API name, category, and attachment configuration.
Key concepts
API name
API name
The
api_name is the machine-readable identifier used in the URL and in data queries. It is set at creation and cannot be changed.Record count and field count
Record count and field count
The header badges reflect
record_count and field_count returned from useCustomObject. These update on page load, not in real time.Allow attachments
Allow attachments
When
allow_attachments is enabled on the object, records may store file attachments. Consult your SME for PHI implications.Related
Platform Foundation
Platform Foundation overview.
Governance & parity
Documentation coverage and governance.
This page documents shipped product behavior. It is not medical, legal, or
billing advice. Verify against your organization’s policies and applicable
regulations before using it for clinical, compliance, or billing decisions.
Protected health information (PHI) shown in the product is governed by your
tenant’s access controls and is never exposed in this documentation.
Documentation sources
Documentation sources
- src/routes/platform.tsx
- src/platform/data-manager/pages/CustomObjectDetailPage.tsx
- src/platform/data-manager/hooks/useCustomObject.ts
- src/platform/data-manager/hooks/useCustomObjectFields.ts