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
Data and records
Overview
Records
Record types
Fields and field types
Relationships between records
Related data
Comments, files, tags, and activity
History and audit
Data structure
Overview
Entity definitions
Overview
What an entity definition is
General settings
Data model
Fields and schema
Projection
Location
Governance
Access model
Data transfer
Automation & logic
Logic overview
Presentation and statements
User interface
Display fields
Runtime screens
UI surface library
Templates
Catalogs
Classifiers
Relationships and containment
Working with records
Overview
Lists
Details
Creating and editing
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
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 and business logic
Overview
When automation is needed
Field behavior
Statements
Presentation rules
Validation
Before-save changes
Actions
Triggers
Schedules
Run history
Access and governance
Overview
Roles
Permissions
Entity access models
Assignments vs permissions
Field access
Delegated access
Audit trail
Configuration and technical docs
Configuration guide
Business logic
Overview
Declarative logic
Entity-scoped logic
Global logic
C# business logic
Operations and diagnostics
Developer documentation
API reference
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
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 status-level responsibility state for one board status.
GET
Replace status-level responsible subjects for one board status.
PUT
Return recent status-level responsibility history for one board status.
GET
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
Attach an existing file reference to one board item using board create policy.
POST
Search readable and manageable item-link candidates.
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 active responsibility assignments for one readable board item.
GET
Return the primary Entity Instance through board-context delegated access.
GET
Return a related Entity Instance through board-context delegated access.
GET
Replace active item responsibility assignments for one board item.
PUT
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
Replace assignments.
PUT
List assignment targets.
GET
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 entity-list page bootstrap payload for the data explorer page.
GET
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 the drawer bootstrap payload for one entity instance.
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
On-premise operations
Glossary
Select theme
Dark
Light
Auto
Overview
Boards Runtime
Section titled “Boards Runtime”
Runtime Moltaro Boards API for viewing boards and moving existing target objects.
Operations
Section titled “Operations”
GET
/api/workspace/boards
GET
/api/workspace/boards/{boardIdOrKey}/view-shell
GET
/api/workspace/boards/{boardIdOrKey}/filters
POST
/api/workspace/boards/{boardIdOrKey}/filters
GET
/api/workspace/boards/{boardIdOrKey}/cycles
POST
/api/workspace/boards/{boardIdOrKey}/cycles
PUT
/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}
DELETE
/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}
POST
/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/activate
POST
/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/close/validate
POST
/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/rollover/validate
POST
/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/rollover
POST
/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/close
POST
/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/archive
PUT
/api/workspace/boards/{boardIdOrKey}/filters/{savedFilterId}
DELETE
/api/workspace/boards/{boardIdOrKey}/filters/{savedFilterId}
GET
/api/workspace/boards/{boardIdOrKey}/statuses/{boardStatusId}/responsibilities
PUT
/api/workspace/boards/{boardIdOrKey}/statuses/{boardStatusId}/responsibilities
GET
/api/workspace/boards/{boardIdOrKey}/statuses/{boardStatusId}/responsibilities/history
GET
/api/workspace/boards/entity-instances/{entityDefinitionId}/{entityInstanceId}/context
GET
/api/workspace/boards/entitlements/{entitlementId}/context
GET
/api/workspace/boards/{boardIdOrKey}/items
POST
/api/workspace/boards/{boardIdOrKey}/items
POST
/api/workspace/boards/{boardIdOrKey}/items/search
POST
/api/workspace/boards/{boardIdOrKey}/items/by-ids
GET
/api/workspace/boards/{boardIdOrKey}/items/create-context
POST
/api/workspace/boards/{boardIdOrKey}/items/add-context
POST
/api/workspace/boards/{boardIdOrKey}/items/create
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/links
POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/links
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-activity-feed
POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-comments
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-attachments
POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-attachments
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-attachments/{fileReferenceId}/download
POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-attachments/from-catalog
POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/link-candidates
POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/links/{boardItemLinkId}/remove
POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/links/{boardItemLinkId}/close
POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/move
POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/remove
PUT
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/cycle
POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/move/validate
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/move-options
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/history
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/audit-trail
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/board-data/form
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/board-data/card
PUT
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/board-data
PUT
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/due-date
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/responsibilities
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/entity
GET
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/related/{relationKey}
PUT
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/responsibilities/item