Skip to content
Moltaro Docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Documentation overview
User documentation
Overview
Getting started
Overview
What Moltaro is
Product map
Core terms
Navigation and search
Records and data concepts
Overview
Records
Record types
Fields and field types
Relationships between records
Related data
Comments, files, tags, and activity
History and audit
Record workflows
Overview
Lists
Details
Creating and editing
Related tables in forms
Search and filters
Import and export
Responsibility and assignments
Boards
Overview
What boards are
Board screen
Cards
Statuses
Transitions
Moving items
Creating board items
Targets
Fields on board items
Due dates
Responsibilities
Links between items
Comments and attachments
Filters and saved views
Cycles
Board history
Board constraints
Automation rules (future)
Work Schedule
Overview
Working Schedule
Working Calendars
Assignments and inheritance
Exceptions and effective result
Access and troubleshooting
Entitlement Operations
Overview
What entitlements are
Models
Parties and resources
Plans
Conditions
Granting entitlements
Coverage
Limits and usage
Periods and renewal
Issued terms
Ledger and activity
Automation
Workspace pages
Access and governance
Overview
Roles
Permissions
Entity access models
Assignments vs permissions
Field access
Audit trail
External identity and SSO
Configuration
Overview
Data model
Overview
Entity definitions
Overview
What an entity definition is
General settings
Schema and projection
Fields and schema
Projection
Location
Governance
Access model
Data transfer
Automation and logic
Logic overview
Presentation and statements
User interface
Display fields
Runtime screens
UI surface library
Templates
Duplicate detection
Catalogs
Classifiers
Relationships and containment
Record behavior
Record search
Reference Eligibility
Hierarchy Selector
Manual Order
Screens and navigation
Card item layout
Form Related tables
Table filters and sorting
User menus
Hierarchies and Tree View
Overview
Using Tree View
Configuring Parent Tree View
Developer and API guide
Security, performance, and data integrity
Expression language (DSL)
Overview
Syntax and types
Function reference
Field behavior conditions
Presentation rules
Statements
Board Statements
Validation rules
Reference Eligibility
Calculated fields
Developer documentation
Overview
Start here
Connect to a workspace API
Integration quickstart
Configuration quickstart
AI agent development
API clients and operations
Reliable API automation
Asynchronous operations
Errors and responses
Error code reference
Entity and record APIs
Entity search
Entity Instance Query
Form Related Table API
Record matching
Module walkthroughs
Boards: configuration
Boards: items and moves
Work Schedule
Entitlement Operations
Record history and audit
Business logic and .NET
Business logic
Overview
Declarative logic
C# business logic (Net Operation Project)
C# runtime recipes
Managed secrets
Entity functions
Global functions
Commands and API functions
Actions
HTTP endpoint functions (webhooks)
Schedules
Operations and diagnostics
.NET SDK
.NET reference
Workspace UI Project
Overview
Project structure
Pages, components, and stores
Moltaro API client
External API client
Design system
Build, publish, and upgrade
Observability and troubleshooting
API reference
Runtime API
Overview
Account
Overview
Return the authenticated workspace user's profile.
GET
Update the authenticated workspace user's profile fields.
PUT
Change the authenticated workspace user's password.
POST
Activity Feed
Overview
Return owned and related activity for one resource.
POST
Attachments
Overview
Return owned and related attachments for a Resource Catalog identity.
POST
Return a compact owned and related attachment summary for a Resource Catalog identity.
POST
Upload a file attachment for an entity.
POST
Attach a file from the file system catalog.
POST
Return an attachment by id.
GET
Update attachment metadata.
PUT
Delete an attachment.
DELETE
Download an attachment.
GET
Auth
Overview
Authenticate a workspace user by user name or email.
POST
Return the current workspace user profile.
GET
Sign out the current workspace user.
POST
Boards Runtime
Overview
Returns the current assignment timeline for one Board Item responsibility.
GET
Replaces one Board Item responsibility timeline.
PUT
Returns immutable history for one Board Item responsibility.
GET
Queries subjects eligible for one Board Item responsibility.
POST
Returns the current assignment timeline for one Board Status responsibility.
GET
Replaces one Board Status responsibility timeline.
PUT
Returns immutable history for one Board Status responsibility.
GET
Queries subjects eligible for one Board Status responsibility.
POST
Return active runtime boards available through the Boards module.
GET
Return one runtime board shell without loading card items.
GET
Return personal saved filters and server-provided quick views for one runtime board.
GET
Create a personal saved filter for one runtime board.
POST
Return runtime cycles, counts, resolution facts, warnings, and caller actions for one board.
GET
Create a planned runtime cycle for one board.
POST
Update an eligible runtime cycle for one board.
PUT
Hard-delete an empty non-active runtime cycle.
DELETE
Activate a planned runtime cycle and complete the previous active cycle when possible.
POST
Validate whether one active runtime cycle can be closed.
POST
Validate moving all open items from one active cycle into a destination cycle.
POST
Move all open items from one active cycle into a destination cycle.
POST
Close an active runtime cycle when there are no open item blockers.
POST
Archive a completed runtime cycle.
POST
Update a personal saved filter for one runtime board.
PUT
Delete a personal saved filter for one runtime board.
DELETE
Return Boards context for one Entity Instance across active boards.
GET
Return Boards context for one Entitlement across active boards.
GET
Return one paged runtime board item slice for a board status.
GET
Add an existing readable target object to a runtime board.
POST
Search readable runtime board items across one or more statuses.
POST
Return specific readable runtime board items by id for realtime refreshes.
POST
Return bootstrap data for creating a board item directly from the runtime board.
GET
Return admission data for adding an existing target object from the runtime board screen.
POST
Create a target and board item atomically from the runtime board screen.
POST
Return active links grouped for one readable board item.
GET
Create an active link for one readable board item.
POST
Return policy-aware process activity for one readable board item.
GET
Create a process comment for one readable board item using board create policy.
POST
Return process attachments for one readable board item using board read policy.
GET
Upload a process attachment for one readable board item using board create policy.
POST
Download one readable process attachment using board read policy.
GET
Create or idempotently resume a managed process-attachment upload.
POST
Rename one process attachment using Board manage policy.
PUT
Delete one process attachment using Board manage policy.
DELETE
Attach an existing file reference to one board item using board create policy.
POST
Search readable and manageable item-link candidates. An explicit target-definition filter scopes target-provider search, owning Board Data search, and the final candidate query.
POST
Remove an active board item link.
POST
Remove an active board item link.
POST
Move an open board item through an active transition.
POST
Remove an open board item from the board without deleting its target object.
POST
Assign an open board item to another runtime cycle.
PUT
Validate a board item move without mutating runtime state.
POST
Return server-computed move options for one readable board item.
GET
Return movement history for one readable board item.
GET
Return typed audit trail for one readable board item.
GET
Return owner-scoped board data form bootstrap and current values for one readable board item.
GET
Return generated standard board data card bootstrap and current values for one readable board item.
GET
Update board-owned data on one board item.
PUT
Update the due date process field on one board item.
PUT
Return the primary Entity Instance after Board Context:View and independent Entity SQL authorization.
GET
Return a related Entity Instance after Board Context:View and independent Entity SQL authorization.
GET
Commands
Overview
Invoke a published command function and return its typed result.
POST
Comments
Overview
Return a comment by id.
GET
Update a comment.
PUT
Delete a comment.
DELETE
Create a comment for an entity.
POST
Context
Overview
Return workspace settings such as locale and time zone.
GET
Entitlement Operations Entitlements
Overview
Return runtime entitlements matching the supplied filters.
GET
Create a runtime entitlement from one active plan.
POST
Return compact operational counters for runtime entitlements.
GET
Return one runtime entitlement.
GET
Preview a runtime entitlement grant.
POST
Renew an existing runtime entitlement.
POST
Suspend a pending or active runtime entitlement.
POST
Resume a suspended runtime entitlement.
POST
Revoke a non-terminal runtime entitlement.
POST
Expire a non-terminal runtime entitlement immediately.
POST
Consume a positive quantity from an issued entitlement limit.
POST
Reverse a positive quantity from a prior consume ledger row.
POST
Set an issued quantity limit to an absolute consumed balance.
POST
Entitlement Operations Ledger
Overview
Return entitlement ledger rows matching the supplied filters.
GET
Export entitlement ledger rows matching the supplied filters as CSV.
GET
Return one entitlement ledger row.
GET
Entitlement Operations Renewal
Overview
Return renewal workflow operations matching the supplied filters.
GET
Create one renewal workflow operation.
POST
Return one renewal workflow operation.
GET
Retry one renewal workflow operation.
POST
Cancel one renewal workflow operation.
POST
Entity Data Transfer
Overview
List export profiles.
GET
List JSON import profiles.
GET
Export JSON.
POST
Export CSV ZIP.
POST
Download JSON import template.
GET
Plan JSON import.
POST
Apply JSON import.
POST
Entity Definitions
Overview
List entity definitions.
GET
Return one entity definition.
GET
Entity Instances
Overview
Query subjects that the current actor may assign to one Entity responsibility.
POST
Read the current assignment timeline for one Entity responsibility.
GET
Atomically replace the current assignment timeline for one Entity responsibility.
PUT
Read immutable assignment history for one Entity responsibility.
GET
Replace one common responsibility timeline for an Entity instance.
PUT
List changes.
GET
Return instance file metadata.
GET
Download instance file.
GET
Evaluate create-form mutation effects without saving a record.
POST
Evaluate update-form mutation effects without saving a record.
POST
Create instance.
POST
Return instance.
GET
Delete instance.
DELETE
Patch instance.
PATCH
Archive instance.
DELETE
Restore instance.
POST
Query instances.
POST
Return query options.
GET
Return tag filter options.
GET
Return the runtime UI target that should open for one entity instance.
GET
Entity UI
Overview
Return the runtime bootstrap payload for a directly selected Table Surface.
POST
Return one lazy child sibling page for the direct Table Surface endpoint.
POST
Return a role-resolved lookup-table bootstrap payload for a persisted source form item.
POST
Return the dedicated generic Reference picker table bootstrap.
POST
Return one lazy child sibling page for the hosted Data Explorer table.
POST
Return one lazy child sibling page for a generic Reference picker.
POST
Return one lazy child sibling page for a persisted Reference Lookup form item.
POST
Return one actor-shaped child table bound to a persisted related-table Form item. The server re-resolves the inverse relation and locked parent filter; clients cannot submit either.
POST
Return one lazy child sibling page for a related-table Form item in Tree View.
POST
Return one additional root sibling page for a related-table Form item in Tree View.
POST
Return one lazy child sibling page for a server-bound related table in Details or Drawer.
POST
Return one additional root sibling page for a server-bound related table in Details or Drawer.
POST
Return the runtime entity-list page bootstrap payload for the data explorer page.
GET
Return the role-resolved hosted table bootstrap payload for a host surface.
POST
Return persisted grid settings for a trusted related-table Form item context.
GET
Patch persisted grid settings for a trusted related-table Form item context.
PATCH
Return the role-resolved hosted card model for a host surface.
GET
Return the role-resolved hosted form model for a host surface.
GET
Return the role-resolved edit form model for one table-row action.
GET
Return ordered display payloads for selected lookup reference values.
POST
Return the effective runtime form model for the active caller.
GET
Return the effective runtime card model for the active caller.
GET
Return the current rule evaluation context for locally executed backend-compiled rule plans.
GET
Return the details-page bootstrap payload for one entity instance.
GET
Return one object-hosted layout block payload for a details page or drawer.
POST
Return the drawer bootstrap payload for one entity instance.
GET
File System
Overview
Return the non-secret browser upload capabilities for this workspace.
GET
Create or idempotently resume a managed multipart upload.
POST
Force-abort an upload session as a workspace administrator.
POST
List active upload reservations with safe source and recovery diagnostics.
GET
Release selected or all bounded expired/orphaned upload reservations.
POST
Retry publication of a verified upload after a transient policy or conflict block.
POST
Return current state and provider-confirmed uploaded parts.
GET
Authorize short-lived direct-upload URLs for exact part numbers.
POST
Return provider-confirmed parts for interruption recovery.
GET
Complete the exact provider multipart inventory and enter mandatory verification.
POST
Abort a caller-owned upload and release its storage reservation.
POST
Function Actions
Overview
List actions available for a supported runtime surface.
GET
Return one available action with its input metadata.
GET
List active queued or running action executions for runtime UI state.
GET
Validate action input before enqueue.
POST
Validate and enqueue one action for asynchronous execution.
POST
Function API Jobs
Overview
Enqueue a published global function and return the queued job status.
POST
Return the status and latest execution of a job enqueued through the functions API.
GET
Cancel a queued job enqueued through the functions API.
POST
Record Matching
Overview
List enabled record-matching launch options for an entity page surface.
GET
Run bounded target-wide duplicate detection for one entity definition.
POST
Run complete exact-normalized or fuzzy duplicate detection anchored to one visible entity instance. The anchored candidate phase is bounded to 250 distinct matches and a five-second SQL budget.
POST
Queue a complete exact or fuzzy target-wide scan owned by the current actor.
POST
Load the latest actor-owned full scan for one profile and archive scope.
GET
Load one actor-owned full-scan job and a bounded result page.
GET
Request cancellation of one actor-owned queued or processing full scan.
POST
Retry one actor-owned failed or cancelled full scan as a new durable job.
POST
Load one bounded candidate page from a successful actor-owned full-scan group.
GET
Responsibility Groups
Overview
List responsibility groups.
GET
Return one responsibility group.
GET
Roles
Overview
Return the list of workspace roles.
GET
Tags
Overview
Return tags owned by a resource.
POST
Return distinct tag suggestions for one resource family.
POST
Return a tag by id.
GET
Update a tag.
PUT
Delete a tag.
DELETE
Create a tag for a resource.
POST
User Menu
Overview
Resolve the first visible user menu for the current caller or null.
GET
Users
Overview
Return the list of workspace users.
GET
Configuration API
Overview
Admin Record Matching
Overview
List configured record-matching profiles.
GET
Create one record-matching profile.
POST
Return one record-matching profile.
GET
Replace one record-matching profile.
PUT
Delete one record-matching profile.
DELETE
Return entity definitions and compatible fields for profile configuration.
GET
Run a bounded exact or fuzzy record-matching profile from Constructor.
POST
Admin Responsibility Groups
Overview
Create one responsibility group.
POST
Update one responsibility group.
PUT
Delete one responsibility group.
DELETE
Replace users assigned to one responsibility group.
PUT
Admin Roles
Overview
Return details for a workspace role.
GET
Update a workspace role.
PUT
Delete a workspace role.
DELETE
Create a new workspace role.
POST
Update role membership.
PUT
Return available permissions for roles.
GET
Return permissions assigned to a role.
GET
Update permissions assigned to a role.
PUT
Roles
Overview
Return the list of workspace roles.
GET
Admin Users
Overview
Return details for a workspace user.
GET
Update a workspace user profile.
PUT
Soft delete a workspace user.
DELETE
Lists every active Worker available to an administrator linking a user. Worker Entity Security does not filter this administrative lookup.
GET
Create a workspace or service user, optionally setting an initial local password for a workspace user.
POST
Update role assignments for a user.
PUT
Block a workspace user and revoke active tokens.
POST
Unblock a workspace user.
POST
Users
Overview
Return the list of workspace users.
GET
Agent Integration
Overview
Return agent integration facts for this installation. This endpoint does not discover an unknown workspace host.
GET
Download the workspace-specific guide after installation bootstrap. The same response may be saved as AGENTS.md or CLAUDE.md.
GET
Create a trusted Service user with Admin and Configurator roles and download its one-time, 90-day agent access kit as a ZIP archive.
POST
API Functions
Overview
List discovered command and API enqueue publications.
GET
Get one publication.
GET
Update admin-owned publication settings.
PUT
Boards Configuration
Overview
Return current Boards module summary and configured boards.
GET
Return Boards administration setup data.
GET
Return role assignments for Boards global module permissions.
GET
Replace role assignments for Boards global module permissions.
PUT
Return board summaries.
GET
Create a board configuration.
POST
Return one board configuration.
GET
Delete a board that has no runtime board items.
DELETE
Update board identity fields.
PATCH
Return the board-owned Part entity definition used for board data.
GET
Create a primary field in the board-owned Part entity definition.
POST
Update a primary field in the board-owned Part entity definition.
PUT
Delete a primary field from the board-owned Part entity definition.
DELETE
Plan a primary field update in the board-owned Part entity definition.
POST
Change a primary field type in the board-owned Part entity definition.
PUT
Plan a primary field type change in the board-owned Part entity definition.
POST
Plan a primary field delete in the board-owned Part entity definition.
POST
Reorder primary fields in the board-owned Part entity definition.
PUT
Return reference UI preference for a board data field.
GET
Upsert reference UI preference for a board data field.
PUT
Delete reference UI preference for a board data field.
DELETE
Upsert board-owned visibility metadata for a board data field.
PUT
Enable the Boards module lifecycle.
POST
Disable the Boards module lifecycle.
POST
Replace a board due-date process policy.
PUT
Replace a board AttentionSignal projection and delivery policy.
PUT
Activate a board for runtime process use.
POST
Deactivate a board without deleting configuration.
POST
Return Board Statements configured for one board.
GET
Create a reusable Board Statement.
POST
Return one Board Statement.
GET
Update a reusable Board Statement.
PUT
Delete an unreferenced Board Statement.
DELETE
Return the server-owned Board Statement DSL authoring schema.
GET
Validate and bind a Board Statement expression without persisting it.
POST
Evaluate a Board Statement against an explicit proposed context.
POST
Reorder Board Statements.
POST
Return Board Constraints configured for one board.
GET
Create a draft Board Constraint.
POST
Return one Board Constraint with activation health.
GET
Update a Board Constraint.
PUT
Delete a Board Constraint and its bindings.
DELETE
Validate a Board Constraint Binding without persisting it.
POST
Reorder Board Constraints.
POST
Create one draft Board Constraint Binding.
POST
Update one Board Constraint Binding.
PUT
Delete one Board Constraint Binding.
DELETE
Reorder bindings inside one Board Constraint.
POST
Create a board status.
POST
Update a board status.
PUT
Reorder board statuses.
POST
Delete a board status and optionally move current items to another status.
POST
Create a board transition.
POST
Update a board transition.
PUT
Delete or deactivate a board transition.
DELETE
Reorder board transitions.
POST
Create a canonical board target definition.
POST
Update a canonical board target definition.
PUT
Delete a canonical board target definition.
DELETE
Return provider-declared card field catalog for a canonical board target definition.
GET
Return configured card fields for a canonical board target definition.
GET
Replace configured card fields for a canonical board target definition.
PUT
Return compatible initial field mapping catalog for a canonical board target definition.
GET
Return configured initial field mappings for a canonical board target definition.
GET
Replace configured initial field mappings for a canonical board target definition.
PUT
Boards Security
Overview
Returns both Board Security profile groups with their shared row version.
GET
Returns stable authoring options shared by both Board Security profiles.
GET
Returns the exact permission catalog for one Board resource kind.
GET
Returns Access Policies, capability groups, exact Permissions, and health for one Board profile.
GET
Plans one atomic Board Access Policy change.
POST
Applies one unchanged Board Access Policy plan atomically.
POST
Plans an atomic partial replacement of exact Board Permission bindings.
POST
Applies one unchanged exact Board Permission binding plan atomically.
POST
Plans explicit removal of structurally redundant Board Data field refinements.
POST
Applies one unchanged redundant Board Data field normalization plan atomically.
POST
Creates one immediately effective Security Statement.
POST
Updates one immediately effective Security Statement.
PUT
Deletes one unused Security Statement.
DELETE
Creates one Permission Assignment.
POST
Deletes one Permission Assignment.
DELETE
Creates one named Responsibility Definition.
POST
Updates one named Responsibility Definition.
PUT
Deletes one unused named Responsibility Definition.
DELETE
Creates one initial responsibility assignment rule.
POST
Updates one initial responsibility assignment rule.
PUT
Deletes one initial responsibility assignment rule.
DELETE
Creates one responsibility assignment rule.
POST
Atomically creates or replaces one Assignment Rule per selected assignment actor.
POST
Updates one responsibility assignment rule.
PUT
Deletes one responsibility assignment rule.
DELETE
Entitlement Operations
Overview
Return current module configuration summary and entitlement models.
GET
Return role assignments for Entitlement Operations global module permissions.
GET
Replace role assignments for Entitlement Operations global module permissions.
PUT
Return model editor bootstrap data.
GET
Return selectable relationship paths for one root record type.
GET
Validate setup input without writing changes.
POST
Enable the module lifecycle without creating an entitlement model.
POST
Create a software license entitlement model.
POST
Create a membership entitlement model.
POST
Create an information service access entitlement model.
POST
Create a warranty entitlement model.
POST
Return one software license entitlement model.
GET
Update a software license entitlement model.
PUT
Delete a software license entitlement model.
DELETE
Return one membership entitlement model.
GET
Update a membership entitlement model.
PUT
Delete a membership entitlement model.
DELETE
Return one information service access entitlement model.
GET
Update an information service access entitlement model.
PUT
Delete an information service access entitlement model.
DELETE
Return one warranty entitlement model.
GET
Update a warranty entitlement model.
PUT
Delete a warranty entitlement model.
DELETE
Return model-bound security grants for one entitlement model.
GET
Replace model-bound security grants for one entitlement model.
PUT
Deactivate a software license entitlement model without deleting it.
POST
Deactivate a membership entitlement model without deleting it.
POST
Deactivate an information service access entitlement model without deleting it.
POST
Deactivate a warranty entitlement model without deleting it.
POST
Reactivate a software license entitlement model without changing its shape.
POST
Reactivate a membership entitlement model without changing its shape.
POST
Reactivate an information service access entitlement model without changing its shape.
POST
Reactivate a warranty entitlement model without changing its shape.
POST
Disable the module while preserving its entitlement models.
POST
Entitlement Operations Plans
Overview
Return active entitlement models available to runtime plan pages.
GET
Return plan families owned by the selected entitlement model.
GET
Create one plan family.
POST
Return one plan family.
GET
Update one plan family.
PUT
Delete one unused plan family.
DELETE
Return software license plan editor bootstrap metadata.
GET
Return software license plans owned by the selected entitlement model.
GET
Create a software license plan.
POST
Return one software license plan.
GET
Update a software license plan.
PUT
Delete an unused software license plan.
DELETE
Return the full resource hierarchy available to a software license plan.
GET
Persist explicit software license plan ordering.
PUT
Return membership plan editor bootstrap metadata.
GET
Return membership plans owned by the selected entitlement model.
GET
Create a membership plan.
POST
Return one membership plan.
GET
Update a membership plan.
PUT
Delete an unused membership plan.
DELETE
Return the full resource hierarchy available to a membership plan.
GET
Persist explicit membership plan ordering.
PUT
Return information service access plan editor bootstrap metadata.
GET
Return information service access plans owned by the selected entitlement model.
GET
Create an information service access plan.
POST
Return one information service access plan.
GET
Update an information service access plan.
PUT
Delete an unused information service access plan.
DELETE
Return the full resource hierarchy available to an information service access plan.
GET
Persist explicit information service access plan ordering.
PUT
Return warranty plan editor bootstrap metadata.
GET
Return warranty plans owned by the selected entitlement model.
GET
Create a warranty plan.
POST
Return one warranty plan.
GET
Update a warranty plan.
PUT
Delete an unused warranty plan.
DELETE
Persist explicit warranty plan ordering.
PUT
Entitlement Operations Renewal
Overview
Return renewal policies owned by one entitlement model.
GET
Create one renewal policy.
POST
Return one renewal policy.
GET
Update one renewal policy.
PUT
Delete one unused renewal policy.
DELETE
Entity Data Transfer Profiles
Overview
List data transfer profiles for one entity definition.
GET
Create one data transfer profile for an entity definition.
POST
Return one data transfer profile.
GET
Soft-delete one data transfer profile.
DELETE
Create one JSON export profile for the Sprint 2 export editor.
POST
Update base metadata for one data transfer profile.
PUT
Update one JSON export profile slice for the Sprint 2 export editor.
PUT
Replace all configured profile fields.
PUT
Replace all configured profile reference resolvers.
PUT
Entity Definition Portability
Overview
Export an entity definition as a YAML document.
GET
Generate an import plan from a YAML document.
POST
Apply an approved import plan.
POST
Entity Definitions
Overview
List configured entity definitions.
GET
Create a new entity definition and its physical tables.
POST
Return one entity definition with its business schema and current Security configuration references.
GET
Delete one entity definition immediately or schedule deferred deletion.
DELETE
Create a new data entity definition configured as a simple dictionary.
POST
Create a new association entity definition with locked endpoint and inverse fields.
POST
Update core entity definition naming metadata.
PUT
Plan a base entity definition update and return schema-impacting warnings.
POST
Update entity feature toggles.
PUT
Replace the configured PostgreSQL search paths for an entity definition.
PUT
Update audit trail settings for an entity definition.
PUT
Update numbering and display settings for an entity definition.
PUT
Replace read-time display fields for an entity definition.
PUT
Replace object-context facts for an entity definition.
PUT
Return projection-entity configuration for one entity definition.
GET
Replace projection-entity configuration for one entity definition.
PUT
Return live row consistency counters for one enabled projection entity definition.
GET
Rebuild materialized projection rows for one enabled projection entity definition.
POST
Validate one rule or template expression before saving metadata.
POST
Return recent calculated-field recalculation jobs for an entity definition.
GET
Manually queue a full calculated-field recalculation for an entity definition.
POST
Requeue a failed or cancelled calculated-field recalculation job.
POST
Plan an entity definition delete and return schema-impacting warnings.
POST
Cancel a pending entity definition deletion.
POST
List unique constraints for one entity definition.
GET
Create a unique constraint for one entity definition.
POST
Delete a unique constraint from one entity definition.
DELETE
List non-unique indexes for one entity definition.
GET
Create a non-unique index for one entity definition.
POST
Delete a non-unique index from one entity definition.
DELETE
Entity Fields
Overview
List field metadata for one entity definition table.
GET
Create a field inside one entity definition table.
POST
Return one field metadata record.
GET
Update field metadata without changing the field type.
PUT
Permanently delete a field and drop its physical storage.
DELETE
Return Reference Eligibility metadata owned by one dependent Reference field.
GET
Create or replace disabled Reference Eligibility metadata for one Reference field.
PUT
Delete disabled Reference Eligibility metadata using optimistic concurrency.
DELETE
Validate a Reference Eligibility expression without saving it.
POST
Preview active and archived data plus saved-surface impact for a proposed expression.
POST
Update a field calculation expression.
PUT
Validate a calculation expression for one field without saving it.
POST
Plan a field metadata update and return schema-impacting warnings.
POST
Change field type and rebuild physical storage.
PUT
Plan a field type change and return schema-impacting warnings.
POST
Plan a field delete and return schema-impacting warnings.
POST
Reorder fields inside one entity definition table.
PUT
Entity Mutation Effects
Overview
List mutation effects for one entity definition.
GET
Create one mutation effect for an entity definition.
POST
Return one mutation effect.
GET
Update one mutation effect.
PUT
Delete one mutation effect.
DELETE
Entity Security
Overview
Returns the current Entity Security configuration.
GET
Returns the canonical permissions that can be assigned to Security Statements.
GET
Returns roles and other stable authoring options for Security Statements.
GET
Returns Access Policies, exact capability groups, Permissions, and configuration health.
GET
Plans one atomic Access Policy change without mutating live configuration.
POST
Applies one unchanged Access Policy plan atomically.
POST
Plans an atomic partial replacement of exact Permission bindings.
POST
Applies one unchanged exact Permission binding plan atomically.
POST
Plans explicit removal of exact redundant field refinements.
POST
Applies one unchanged redundant-field normalization plan atomically.
POST
Creates one immediately effective Security Statement.
POST
Updates one immediately effective Security Statement.
PUT
Deletes an unused Security Statement.
DELETE
Assigns one canonical permission to one Security Statement.
POST
Deletes one Permission Assignment.
DELETE
Creates one immediately effective Responsibility Definition.
POST
Updates one immediately effective Responsibility Definition.
PUT
Deletes an unused Responsibility Definition.
DELETE
Creates one immediately effective Initial Assignment Rule.
POST
Updates one immediately effective Initial Assignment Rule.
PUT
Deletes one Initial Assignment Rule.
DELETE
Creates one immediately effective responsibility Assignment Rule.
POST
Atomically creates or replaces one Assignment Rule per selected assignment actor.
POST
Updates one immediately effective responsibility Assignment Rule.
PUT
Deletes one responsibility Assignment Rule.
DELETE
Entity Statements
Overview
List statements for one entity definition.
GET
Create one statement for an entity definition.
POST
Return one statement.
GET
Update one statement.
PUT
Soft-delete one statement.
DELETE
Entity UI Actions
Overview
Return designer data for configuring function-backed UI actions.
GET
List function-backed UI actions for an entity definition.
GET
Create a function-backed UI action.
POST
Update a function-backed UI action.
PUT
Delete a function-backed UI action.
DELETE
Entity UI Surfaces
Overview
Return the effective field UI preferences for one field.
GET
Create or update explicit field UI preferences for one field.
PUT
Delete the explicit field UI preferences row and fall back to platform defaults.
DELETE
Return the read-only surface catalog for one surface type.
GET
Return resolved selector dependencies connected to this entity definition's UI surfaces.
GET
Create a custom entity-list, details-page, or drawer host surface.
POST
Clone an entity-list, details-page, or drawer host surface.
POST
Set an entity-list, details-page, or drawer host surface as its family's default.
PUT
Delete a custom entity-list, details-page, or drawer host surface.
DELETE
Create a custom table surface for this entity definition.
POST
Clone a custom table surface for this entity definition.
POST
Set a table surface as the default table for this entity definition.
PUT
Unset a table surface as the default table for this entity definition.
DELETE
Delete a custom table surface for this entity definition.
DELETE
Return the explicit table surface configuration for one table surface.
GET
Replace the explicit table surface configuration for one table surface.
PUT
Delete the explicit table surface configuration for one table surface.
DELETE
Return visual editor options for table surface configuration.
GET
Create a custom card surface for this entity definition.
POST
Set a card surface as the default card for this entity definition.
PUT
Unset a card surface as the default card for this entity definition.
DELETE
Clone a custom card surface for this entity definition.
POST
Delete a custom card surface for this entity definition.
DELETE
Return the explicit card surface configuration for one card surface.
GET
Replace the explicit card surface configuration for one card surface.
PUT
Delete the explicit card surface configuration for one card surface.
DELETE
Return visual editor options for card surface configuration.
GET
Create a custom form surface for this entity definition.
POST
Set a form surface as the default form for this entity definition.
PUT
Unset a form surface as the default form for this entity definition.
DELETE
Clone a custom form surface for this entity definition.
POST
Delete a custom form surface for this entity definition.
DELETE
Return the explicit form surface configuration for one form surface.
GET
Replace the explicit form surface configuration for one form surface.
PUT
Delete the explicit form surface configuration for one form surface.
DELETE
Return visual editor options for form surface configuration.
GET
Return the explicit entity list-page configuration.
GET
Replace the explicit entity list-page configuration.
PUT
Delete the explicit entity list-page configuration.
DELETE
Return the explicit entity details host-surface configuration.
GET
Replace the explicit entity details host-surface configuration.
PUT
Return the details page object-hosted navigation and section layout.
GET
Replace the details page object-hosted navigation and section layout.
PUT
Delete the custom details page object-hosted layout and return to automatic generation.
DELETE
Return the explicit drawer host-surface configuration.
GET
Replace the explicit drawer host-surface configuration.
PUT
Return the drawer object-hosted section layout.
GET
Replace the drawer object-hosted section layout.
PUT
Delete the custom drawer object-hosted layout and return to the default renderer.
DELETE
Entity Validation Rules
Overview
List validation rules for one entity definition.
GET
Create one validation rule for an entity definition.
POST
Return one validation rule.
GET
Update one validation rule.
PUT
Soft-delete one validation rule.
DELETE
Replace validation rule order for one entity definition.
PUT
Validate one validation-rule expression before saving metadata.
POST
File System
Overview
Return file system settings.
GET
Update file system settings.
PUT
Function Catalog
Overview
List business functions from the synchronized runtime catalog.
GET
Return one business function from the synchronized runtime catalog.
GET
List immutable versions for one business function.
GET
Run a published business function with supplied test context.
POST
List function bindings for one entity definition.
GET
List function binding summaries across entity definitions.
GET
Function Operations
Overview
Return queue counts, recent runs, and failed or retrying queued runs.
GET
List persisted business-function runs.
GET
List persisted business-function runs as a page.
GET
Return one persisted business-function run.
GET
Return one queued function run.
GET
List queued function runs.
GET
List queued function runs as a page.
GET
Cancel a queued run or request cancellation for a running function.
POST
Stop the complete retry chain for an active queued job. Queued or expired work is cancelled immediately; a leased attempt receives cooperative cancellation and can never be retried.
POST
Cancel a running function run when it supports manual cancellation.
POST
Function Schedules
Overview
List configured business-function schedules.
GET
Create a business-function schedule.
POST
Return one business-function schedule.
GET
Update one business-function schedule.
PUT
Delete one business-function schedule.
DELETE
Geo Location Sources
Overview
Return Location source configurations for one Resource Catalog context.
GET
Create or replace one named Location source for one Resource Catalog context.
PUT
Return valid source modes and address-field candidates for one Resource Catalog context.
GET
Disable one named Location source for one Resource Catalog context.
POST
HTTP Endpoint Functions
Overview
List discovered inbound HTTP endpoint functions.
GET
Get HTTP endpoint function settings and secret metadata.
GET
Update admin-owned HTTP endpoint function settings.
PUT
Create or rotate a managed HTTP endpoint secret. Plaintext is returned only once.
POST
Managed Secrets
Overview
List managed-secret metadata for an owner or administrator. Values are never returned.
GET
Create an enabled managed secret at value version 1. The submitted value is never returned.
POST
Get managed-secret metadata for an owner or administrator. The value is never returned.
GET
Rotate an active or disabled secret, replacing its value and incrementing its value version.
POST
Disable trusted C# resolution without changing the value version.
POST
Re-enable trusted C# resolution without changing the value version.
POST
Permanently retire a managed secret, increment its version, and erase its ciphertext.
POST
Net Operation Project
Overview
Return current Net Operation Project status, creating the starter revision if needed.
GET
Return immutable Net Operation Project source revisions ordered newest first.
GET
Return Net Operation Project build/check history ordered newest first.
GET
Queue a Net Operation Project build or check for the working revision.
POST
Return one Net Operation Project build/check record.
GET
Return stored files for one Net Operation Project source revision.
GET
Return source tree metadata for the current working or requested Net Operation Project revision.
GET
Return one source file from the current working or requested Net Operation Project revision.
GET
Create a manual Net Operation Project source revision from file changes.
POST
Return package references for the current working or requested Net Operation Project revision.
GET
Create a manual Net Operation Project source revision from package reference changes.
POST
Return the available server-generated Net Operation Project source templates and their input requirements.
GET
Return the supported Net Operation Project assemblies, generated-contract behavior, and injectable services.
GET
Preview a server-generated Net Operation Project source template without creating a revision.
POST
Search public NuGet.org packages for Net Operation Project package management.
GET
Return public NuGet.org versions for one package.
GET
Return C# completion items for the current Net Operation Project source buffer.
POST
Return C# diagnostics for the current Net Operation Project source buffer.
POST
Return C# hover information for the current Net Operation Project source buffer.
POST
Return C# signature help for the current Net Operation Project source buffer.
POST
Return the read-only Studio source index for the current or requested Net Operation Project revision.
GET
Delete a non-current Net Operation Project source revision that has not produced an artifact.
DELETE
Download a ZIP archive for the current or requested Net Operation Project revision.
GET
Upload a full project ZIP archive and create a new immutable source revision.
POST
Responsibility Groups
Overview
List responsibility groups.
GET
Return one responsibility group.
GET
User Menus
Overview
List configured user menus.
GET
Create one user menu.
POST
List registered built-in module pages for user-menu configuration.
GET
Return one configured user menu.
GET
Replace one user menu.
PUT
Delete one user menu.
DELETE
Workspace UI Project
Overview
Return current Workspace UI project status, provisioning an empty source skeleton only for source-capable users.
GET
List immutable Workspace UI source revisions ordered newest first.
GET
Return one immutable Workspace UI source revision.
GET
Delete a disposable source revision and its completed non-artifact build history.
DELETE
Return source-tree metadata for one requested revision.
GET
Return one UTF-8 source file from a Workspace UI revision.
GET
Create one immutable manual-edit source revision.
POST
List deterministic Workspace UI source templates available to authoring clients.
GET
Preview deterministic template changes without modifying Workspace UI source.
POST
Atomically apply a deterministic template as one immutable Workspace UI source revision.
POST
Return typed page-generator, entity-field, working-page, and optional runtime-menu capabilities.
GET
Preview all deterministic source changes and optional root-leaf menu placement for one page.
POST
Re-plan and create one TemplateApply source revision, then independently attempt optional menu placement.
POST
Download a deterministic source and generated IDE-project ZIP.
GET
Upload a ZIP and create one immutable source revision without automatically queuing a build.
POST
List Workspace UI checks and builds ordered newest first.
GET
Queue a Workspace UI Check or Build for one immutable revision.
POST
Return one Workspace UI check or build.
GET
Request cancellation of one queued or running Workspace UI build.
POST
List stored Workspace UI artifacts ordered newest first.
GET
Return one stored Workspace UI artifact.
GET
Return safe build-toolchain, runtime-contract, and optional artifact compatibility.
GET
Activate one compatible inactive Workspace UI artifact.
POST
Deactivate the currently active Workspace UI artifact.
POST
Roll back to one compatible previously published Workspace UI artifact.
POST
Purge bytes from one inactive Workspace UI artifact while retaining history metadata.
POST
Release notes
On-premise operations
Glossary
Select theme
Dark
Light
Auto
Overview
Entity UI
Section titled “Entity UI”
Runtime UI metadata endpoints for entity surfaces.
Operations
Section titled “Operations”
POST
/api/workspace/entity/{entityIdOrKey}/ui/table/bootstrap
POST
/api/workspace/entity/{entityIdOrKey}/ui/table/tree/children
POST
/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/lookup-table/bootstrap
POST
/api/workspace/entity/{entityIdOrKey}/ui/reference-picker/table/bootstrap
POST
/api/workspace/entity/{entityIdOrKey}/ui/hosted/table/tree/children
POST
/api/workspace/entity/{entityIdOrKey}/ui/reference-picker/table/tree/children
POST
/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/lookup-table/tree/children
POST
/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/related-table
POST
/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/related-table/tree/children
POST
/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/related-table/tree/roots
POST
/api/workspace/entity/{entityIdOrKey}/ui/hosted-layout/related/tree/children
POST
/api/workspace/entity/{entityIdOrKey}/ui/hosted-layout/related/tree/roots
GET
/api/workspace/entity/{entityIdOrKey}/ui/entity-list-page
POST
/api/workspace/entity/{entityIdOrKey}/ui/hosted/table/bootstrap
GET
/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/related-table/grid-settings
PATCH
/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/related-table/grid-settings
GET
/api/workspace/entity/{entityIdOrKey}/ui/hosted/card
GET
/api/workspace/entity/{entityIdOrKey}/ui/hosted/form
GET
/api/workspace/entity/{entityIdOrKey}/ui/table/actions/{actionId}/form
POST
/api/workspace/entity/{entityIdOrKey}/ui/reference/display-values
GET
/api/workspace/entity/{entityIdOrKey}/ui/form
GET
/api/workspace/entity/{entityIdOrKey}/ui/card
GET
/api/workspace/entity/{entityIdOrKey}/ui/rule-evaluation-context
GET
/api/workspace/entity/{entityIdOrKey}/ui/details-page
POST
/api/workspace/entity/{entityIdOrKey}/ui/hosted-layout/block
GET
/api/workspace/entity/{entityIdOrKey}/ui/drawer
