{ "openapi": "3.0.4", "info": { "title": "Moltaro Public Integration API", "description": "Public runtime and integration API for Moltaro.\r\n\r\nServer and URL\r\n- This document may be viewed as a public reference copy on `moltaro.com/docs`, but `moltaro.com` is not a customer workspace API host.\r\n- Resolve every `/api/workspace/...` path against the API base URL of the target Moltaro installation.\r\n- For actual integration work, prefer the OpenAPI document served by that installation at `/openapi/moltaro-public-v1.json`; it matches the installed release.\r\n- The workspace Web Application URL and workspace API URL may differ. Use the API base URL supplied by the workspace administrator; do not derive it from the Web Application or portal hostname.\r\n\r\nWorkspace endpoints\r\n- Moltaro OnPrem resolves the single workspace database from runtime configuration.\r\n- Use `Authorization: Bearer ` for authenticated routes.\r\n- Service API keys use the same bearer header (`Authorization: Bearer `).\r\n- API keys are created and governed from the Moltaro admin UI; API-key administration endpoints are not part of this public reference.\r\n- If headers are not possible, pass the token as `access_token` query parameter (use only when needed).\r\n\r\nScope\r\n- This reference is curated for runtime integrations.\r\n- It includes runtime entity, transfer, collaboration, lookup, resumable FileSystem uploads, Boards runtime, and Entitlement Operations runtime endpoints.\r\n- It includes business-logic invocation: published function commands, API function enqueue with job tracking, and entity UI actions.\r\n- It intentionally excludes administration, entity-builder, Boards setup, entitlement setup, and internal diagnostic APIs. Business-logic authoring and operations endpoints are published in the Configuration API.\r\n\r\nResponses\r\n- Most endpoints return `ApiResponse` with `Success`, `Data`, `Errors`, and `Warnings`.", "contact": { "name": "Moltaro", "url": "https://moltaro.com" }, "version": "moltaro-public-v1" }, "paths": { "/api/workspace/account/profile": { "get": { "tags": [ "Account" ], "summary": "Return the authenticated workspace user's profile.", "operationId": "account-get-profile", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceAccountProfileResponseEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceAccountProfileResponseEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Account" ], "summary": "Update the authenticated workspace user's profile fields.", "operationId": "account-update-profile", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceAccountProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceAccountProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceAccountProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceAccountProfileResponseEnvelope" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceAccountProfileResponseEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceAccountProfileResponseEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/account/change-password": { "post": { "tags": [ "Account" ], "summary": "Change the authenticated workspace user's password.", "operationId": "account-change-password", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeWorkspaceAccountPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeWorkspaceAccountPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeWorkspaceAccountPasswordRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeWorkspaceAccountPasswordResponseEnvelope" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeWorkspaceAccountPasswordResponseEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeWorkspaceAccountPasswordResponseEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/activity-feed": { "post": { "tags": [ "Activity Feed" ], "summary": "Return owned and related activity for one resource.", "operationId": "activity-feed-query", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityFeedRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityFeedRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivityFeedRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityFeedPageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityFeedPageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/attachments/resource-list": { "post": { "tags": [ "Attachments" ], "summary": "Return owned and related attachments for a Resource Catalog identity.", "operationId": "attachments-resource-list", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourceListRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourceListRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourceListRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourcePageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourcePageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourcePageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourcePageResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/attachments/resource-summary": { "post": { "tags": [ "Attachments" ], "summary": "Return a compact owned and related attachment summary for a Resource Catalog identity.", "operationId": "attachments-resource-summary", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourceSummaryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourceSummaryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourceSummaryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourceSummaryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourceSummaryResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourceSummaryResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResourceSummaryResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/attachments": { "post": { "tags": [ "Attachments" ], "summary": "Upload a file attachment for an entity.", "operationId": "attachments-upload", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Description": { "type": "string" }, "OwnerResourceKind": { "type": "string" }, "OwnerModuleKey": { "type": "string" }, "OwnerContextResourceId": { "type": "string" }, "OwnerResourceObjectId": { "type": "string" }, "RelationsJson": { "type": "string" }, "OperationKey": { "type": "string", "format": "uuid" } } }, "encoding": { "File": { "style": "form" }, "Description": { "style": "form" }, "OwnerResourceKind": { "style": "form" }, "OwnerModuleKey": { "style": "form" }, "OwnerContextResourceId": { "style": "form" }, "OwnerResourceObjectId": { "style": "form" }, "RelationsJson": { "style": "form" }, "OperationKey": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResultResponse" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/attachments/from-catalog": { "post": { "tags": [ "Attachments" ], "summary": "Attach a file from the file system catalog.", "operationId": "attachments-attach-from-catalog", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachFileFromCatalogRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttachFileFromCatalogRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AttachFileFromCatalogRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/attachments/{fileId}": { "get": { "tags": [ "Attachments" ], "summary": "Return an attachment by id.", "operationId": "attachments-get", "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Attachments" ], "summary": "Update attachment metadata.", "operationId": "attachments-update", "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameFileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenameFileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenameFileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Attachments" ], "summary": "Delete an attachment.", "operationId": "attachments-delete", "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAttachmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAttachmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteAttachmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/attachments/{fileId}/download": { "get": { "tags": [ "Attachments" ], "summary": "Download an attachment.", "operationId": "attachments-download", "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/auth/login": { "post": { "tags": [ "Auth" ], "summary": "Authenticate a workspace user by user name or email.", "description": "Locale is resolved from the workspace settings.", "operationId": "auth-login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponseEnvelope" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponseEnvelope" } } } } } } }, "/api/workspace/auth/me": { "get": { "tags": [ "Auth" ], "summary": "Return the current workspace user profile.", "description": "Locale is resolved from the workspace settings.", "operationId": "auth-me", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeResponseEnvelope" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/auth/logout": { "post": { "tags": [ "Auth" ], "summary": "Sign out the current workspace user.", "operationId": "auth-logout", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardId}/items/{resourceObjectId}/responsibilities/{responsibilityKey}": { "get": { "tags": [ "Boards Runtime" ], "summary": "Returns the current assignment timeline for one Board Item responsibility.", "operationId": "board-responsibilities-get-item", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceObjectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityAssignmentSetResponse" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Boards Runtime" ], "summary": "Replaces one Board Item responsibility timeline.", "operationId": "board-responsibilities-replace-item", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceObjectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceRuntimeResponsibilitiesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceRuntimeResponsibilitiesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceRuntimeResponsibilitiesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedResponsibilityStateResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardId}/items/{resourceObjectId}/responsibilities/{responsibilityKey}/history": { "get": { "tags": [ "Boards Runtime" ], "summary": "Returns immutable history for one Board Item responsibility.", "operationId": "board-responsibilities-get-item-history", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceObjectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityAssignmentHistoryResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardId}/items/{resourceObjectId}/responsibilities/{responsibilityKey}/eligible-targets/query": { "post": { "tags": [ "Boards Runtime" ], "summary": "Queries subjects eligible for one Board Item responsibility.", "operationId": "board-responsibilities-query-item-targets", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceObjectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardEligibleResponsibilityTargetQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardEligibleResponsibilityTargetQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardEligibleResponsibilityTargetQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedEligibleResponsibilityTargetResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardId}/statuses/{resourceObjectId}/responsibilities/{responsibilityKey}": { "get": { "tags": [ "Boards Runtime" ], "summary": "Returns the current assignment timeline for one Board Status responsibility.", "operationId": "board-responsibilities-get-status", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceObjectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityAssignmentSetResponse" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Boards Runtime" ], "summary": "Replaces one Board Status responsibility timeline.", "operationId": "board-responsibilities-replace-status", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceObjectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceRuntimeResponsibilitiesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceRuntimeResponsibilitiesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceRuntimeResponsibilitiesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedResponsibilityStateResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardId}/statuses/{resourceObjectId}/responsibilities/{responsibilityKey}/history": { "get": { "tags": [ "Boards Runtime" ], "summary": "Returns immutable history for one Board Status responsibility.", "operationId": "board-responsibilities-get-status-history", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceObjectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityAssignmentHistoryResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardId}/statuses/{resourceObjectId}/responsibilities/{responsibilityKey}/eligible-targets/query": { "post": { "tags": [ "Boards Runtime" ], "summary": "Queries subjects eligible for one Board Status responsibility.", "operationId": "board-responsibilities-query-status-targets", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceObjectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardEligibleResponsibilityTargetQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardEligibleResponsibilityTargetQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardEligibleResponsibilityTargetQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedEligibleResponsibilityTargetResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/boards": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return active runtime boards available through the Boards module.", "operationId": "boards-runtime-list", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeSummaryListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/view-shell": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return one runtime board shell without loading card items.", "operationId": "boards-runtime-view-shell", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cycle", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeViewShellResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeViewShellResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeViewShellResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeViewShellResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/filters": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return personal saved filters and server-provided quick views for one runtime board.", "operationId": "boards-runtime-filters", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeFiltersResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeFiltersResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeFiltersResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Boards Runtime" ], "summary": "Create a personal saved filter for one runtime board.", "operationId": "boards-runtime-create-filter", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBoardRuntimeSavedFilterRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardRuntimeSavedFilterRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardRuntimeSavedFilterRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeSavedFilterResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeSavedFilterResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeSavedFilterResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeSavedFilterResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/cycles": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return runtime cycles, counts, resolution facts, warnings, and caller actions for one board.", "operationId": "boards-runtime-list-cycles", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Boards Runtime" ], "summary": "Create a planned runtime cycle for one board.", "operationId": "boards-runtime-create-cycle", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBoardRuntimeCycleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardRuntimeCycleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardRuntimeCycleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}": { "put": { "tags": [ "Boards Runtime" ], "summary": "Update an eligible runtime cycle for one board.", "operationId": "boards-runtime-update-cycle", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardCycleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardRuntimeCycleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardRuntimeCycleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardRuntimeCycleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Runtime" ], "summary": "Hard-delete an empty non-active runtime cycle.", "operationId": "boards-runtime-delete-cycle", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardCycleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteBoardRuntimeCycleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteBoardRuntimeCycleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteBoardRuntimeCycleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/activate": { "post": { "tags": [ "Boards Runtime" ], "summary": "Activate a planned runtime cycle and complete the previous active cycle when possible.", "operationId": "boards-runtime-activate-cycle", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardCycleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/close/validate": { "post": { "tags": [ "Boards Runtime" ], "summary": "Validate whether one active runtime cycle can be closed.", "operationId": "boards-runtime-validate-close-cycle", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardCycleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleCloseValidationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleCloseValidationResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleCloseValidationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/rollover/validate": { "post": { "tags": [ "Boards Runtime" ], "summary": "Validate moving all open items from one active cycle into a destination cycle.", "operationId": "boards-runtime-validate-rollover-cycle", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardCycleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverValidationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverValidationResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverValidationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/rollover": { "post": { "tags": [ "Boards Runtime" ], "summary": "Move all open items from one active cycle into a destination cycle.", "operationId": "boards-runtime-rollover-cycle", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardCycleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/close": { "post": { "tags": [ "Boards Runtime" ], "summary": "Close an active runtime cycle when there are no open item blockers.", "operationId": "boards-runtime-close-cycle", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardCycleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/cycles/{boardCycleId}/archive": { "post": { "tags": [ "Boards Runtime" ], "summary": "Archive a completed runtime cycle.", "operationId": "boards-runtime-archive-cycle", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardCycleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleLifecycleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCycleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/filters/{savedFilterId}": { "put": { "tags": [ "Boards Runtime" ], "summary": "Update a personal saved filter for one runtime board.", "operationId": "boards-runtime-update-filter", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "savedFilterId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardRuntimeSavedFilterRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardRuntimeSavedFilterRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardRuntimeSavedFilterRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeSavedFilterResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeSavedFilterResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeSavedFilterResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeSavedFilterResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Runtime" ], "summary": "Delete a personal saved filter for one runtime board.", "operationId": "boards-runtime-delete-filter", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "savedFilterId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/entity-instances/{entityDefinitionId}/{entityInstanceId}/context": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return Boards context for one Entity Instance across active boards.", "operationId": "boards-runtime-entity-instance-context", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entityInstanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceBoardContextResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceBoardContextResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceBoardContextResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceBoardContextResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/entitlements/{entitlementId}/context": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return Boards context for one Entitlement across active boards.", "operationId": "boards-runtime-entitlement-context", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementBoardContextResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementBoardContextResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementBoardContextResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementBoardContextResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return one paged runtime board item slice for a board status.", "operationId": "boards-runtime-items", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardStatusId", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "cursorRankKey", "in": "query", "schema": { "type": "string" } }, { "name": "cursorBoardItemId", "in": "query", "schema": { "type": "string" } }, { "name": "cycle", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsPageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsPageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsPageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsPageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Boards Runtime" ], "summary": "Add an existing readable target object to a runtime board.", "operationId": "boards-runtime-add-item", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddBoardItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddBoardItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddBoardItemRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CorrelatedProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/search": { "post": { "tags": [ "Boards Runtime" ], "summary": "Search readable runtime board items across one or more statuses.", "operationId": "boards-runtime-search-items", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchPageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchPageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchPageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchPageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/by-ids": { "post": { "tags": [ "Boards Runtime" ], "summary": "Return specific readable runtime board items by id for realtime refreshes.", "operationId": "boards-runtime-items-by-ids", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsByIdsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsByIdsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemsByIdsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/create-context": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return bootstrap data for creating a board item directly from the runtime board.", "operationId": "boards-runtime-create-context", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCreateContextResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCreateContextResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeCreateContextResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/add-context": { "post": { "tags": [ "Boards Runtime" ], "summary": "Return admission data for adding an existing target object from the runtime board screen.", "operationId": "boards-runtime-add-context", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeAddContextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeAddContextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeAddContextRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeAddContextResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeAddContextResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeAddContextResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeAddContextResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/create": { "post": { "tags": [ "Boards Runtime" ], "summary": "Create a target and board item atomically from the runtime board screen.", "operationId": "boards-runtime-create-item", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBoardRuntimeItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardRuntimeItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardRuntimeItemRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/links": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return active links grouped for one readable board item.", "operationId": "boards-runtime-item-links", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Boards Runtime" ], "summary": "Create an active link for one readable board item.", "operationId": "boards-runtime-create-item-link", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBoardItemLinkRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardItemLinkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardItemLinkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-activity-feed": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return policy-aware process activity for one readable board item.", "operationId": "boards-runtime-process-activity-feed", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "Kinds", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityFeedContentKind" } } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeProcessActivityFeedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeProcessActivityFeedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeProcessActivityFeedResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeProcessActivityFeedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-comments": { "post": { "tags": [ "Boards Runtime" ], "summary": "Create a process comment for one readable board item using board create policy.", "operationId": "boards-runtime-create-process-comment", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBoardProcessCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardProcessCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardProcessCommentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-attachments": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return process attachments for one readable board item using board read policy.", "operationId": "boards-runtime-process-attachments", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeProcessAttachmentsListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeProcessAttachmentsListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeProcessAttachmentsListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeProcessAttachmentsListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Boards Runtime" ], "summary": "Upload a process attachment for one readable board item using board create policy.", "operationId": "boards-runtime-upload-process-attachment", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Description": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "Description": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-attachments/{fileReferenceId}/download": { "get": { "tags": [ "Boards Runtime" ], "summary": "Download one readable process attachment using board read policy.", "operationId": "boards-runtime-download-process-attachment", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileReferenceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-attachments/uploads": { "post": { "tags": [ "Boards Runtime" ], "summary": "Create or idempotently resume a managed process-attachment upload.", "operationId": "boards-runtime-create-managed-process-attachment-upload", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBoardProcessManagedUploadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardProcessManagedUploadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardProcessManagedUploadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardManagedFileUploadSessionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardManagedFileUploadSessionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardManagedFileUploadSessionResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardManagedFileUploadSessionResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardManagedFileUploadSessionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-attachments/{fileReferenceId}": { "put": { "tags": [ "Boards Runtime" ], "summary": "Rename one process attachment using Board manage policy.", "operationId": "boards-runtime-rename-process-attachment", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileReferenceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameBoardProcessAttachmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenameBoardProcessAttachmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenameBoardProcessAttachmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Runtime" ], "summary": "Delete one process attachment using Board manage policy.", "operationId": "boards-runtime-delete-process-attachment", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileReferenceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-attachments/from-catalog": { "post": { "tags": [ "Boards Runtime" ], "summary": "Attach an existing file reference to one board item using board create policy.", "operationId": "boards-runtime-attach-process-file-from-catalog", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachBoardProcessFileFromCatalogRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttachBoardProcessFileFromCatalogRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AttachBoardProcessFileFromCatalogRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/link-candidates": { "post": { "tags": [ "Boards Runtime" ], "summary": "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.", "operationId": "boards-runtime-link-candidates", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinkCandidatesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinkCandidatesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinkCandidatesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinkCandidatesPageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinkCandidatesPageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinkCandidatesPageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinkCandidatesPageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/links/{boardItemLinkId}/remove": { "post": { "tags": [ "Boards Runtime" ], "summary": "Remove an active board item link.", "operationId": "boards-runtime-remove-item-link-remove", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemLinkId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveBoardItemLinkRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveBoardItemLinkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoveBoardItemLinkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/links/{boardItemLinkId}/close": { "post": { "tags": [ "Boards Runtime" ], "summary": "Remove an active board item link.", "operationId": "boards-runtime-remove-item-link-close", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemLinkId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveBoardItemLinkRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveBoardItemLinkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoveBoardItemLinkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemLinksResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/move": { "post": { "tags": [ "Boards Runtime" ], "summary": "Move an open board item through an active transition.", "operationId": "boards-runtime-move-item", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveBoardItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveBoardItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveBoardItemRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/remove": { "post": { "tags": [ "Boards Runtime" ], "summary": "Remove an open board item from the board without deleting its target object.", "operationId": "boards-runtime-remove-item", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveBoardItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveBoardItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoveBoardItemRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/cycle": { "put": { "tags": [ "Boards Runtime" ], "summary": "Assign an open board item to another runtime cycle.", "operationId": "boards-runtime-update-item-cycle", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardItemCycleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardItemCycleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardItemCycleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/move/validate": { "post": { "tags": [ "Boards Runtime" ], "summary": "Validate a board item move without mutating runtime state.", "operationId": "boards-runtime-validate-move-item", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveBoardItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveBoardItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveBoardItemRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeMoveValidationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeMoveValidationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeMoveValidationResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeMoveValidationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/move-options": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return server-computed move options for one readable board item.", "operationId": "boards-runtime-move-options", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeMoveOptionsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeMoveOptionsResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeMoveOptionsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/history": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return movement history for one readable board item.", "operationId": "boards-runtime-history", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemHistoryListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemHistoryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/audit-trail": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return typed audit trail for one readable board item.", "operationId": "boards-runtime-audit-trail", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemAuditTrailListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemAuditTrailListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/board-data/form": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return owner-scoped board data form bootstrap and current values for one readable board item.", "operationId": "boards-runtime-board-data-form", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeBoardDataFormResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeBoardDataFormResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeBoardDataFormResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/board-data/card": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return generated standard board data card bootstrap and current values for one readable board item.", "operationId": "boards-runtime-board-data-card", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeBoardDataCardResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeBoardDataCardResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeBoardDataCardResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/board-data": { "put": { "tags": [ "Boards Runtime" ], "summary": "Update board-owned data on one board item.", "operationId": "boards-runtime-update-item-data", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardItemDataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardItemDataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardItemDataRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/due-date": { "put": { "tags": [ "Boards Runtime" ], "summary": "Update the due date process field on one board item.", "operationId": "boards-runtime-update-item-due-date", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardItemDueDateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardItemDueDateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardItemDueDateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRuntimeItemResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/entity": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return the primary Entity Instance after Board Context:View and independent Entity SQL authorization.", "operationId": "boards-runtime-item-entity", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/related/{relationKey}": { "get": { "tags": [ "Boards Runtime" ], "summary": "Return a related Entity Instance after Board Context:View and independent Entity SQL authorization.", "operationId": "boards-runtime-related-entity", "parameters": [ { "name": "boardIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "relationKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/commands/{functionKey}": { "post": { "tags": [ "Commands" ], "summary": "Invoke a published command function and return its typed result.", "operationId": "business-function-commands-invoke", "parameters": [ { "name": "functionKey", "in": "path", "description": "Callable command function key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Optional command arguments and correlation identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvokeBusinessFunctionCommandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvokeBusinessFunctionCommandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InvokeBusinessFunctionCommandRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionCommandResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionCommandResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionCommandResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/comments/{commentId}": { "get": { "tags": [ "Comments" ], "summary": "Return a comment by id.", "operationId": "comments-get", "parameters": [ { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Comments" ], "summary": "Update a comment.", "operationId": "comments-update", "parameters": [ { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCommentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Comments" ], "summary": "Delete a comment.", "operationId": "comments-delete", "parameters": [ { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteCommentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/comments": { "post": { "tags": [ "Comments" ], "summary": "Create a comment for an entity.", "operationId": "comments-create", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/context": { "get": { "tags": [ "Context" ], "summary": "Return workspace settings such as locale and time zone.", "operationId": "context-get", "parameters": [ { "name": "trackOpen", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceContextResponseEnvelope" } } } } } } }, "/api/workspace/entitlement-operations/entitlements": { "get": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Return runtime entitlements matching the supplied filters.", "operationId": "entitlement-operations-entitlements-list", "parameters": [ { "name": "ModelId", "in": "query", "description": "Optional entitlement model filter.", "schema": { "type": "string" } }, { "name": "PlanId", "in": "query", "description": "Optional entitlement plan filter.", "schema": { "type": "string" } }, { "name": "PlanFamilyIds", "in": "query", "description": "Optional plan family ids that at least one current linked plan family must match.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ConditionFamily", "in": "query", "description": "Optional active condition family on the current linked plan.", "schema": { "$ref": "#/components/schemas/EntitlementLimitFamily" } }, { "name": "TermKind", "in": "query", "description": "Optional derived active term shape on the current linked plan.", "schema": { "$ref": "#/components/schemas/EntitlementPlanTermKind" } }, { "name": "TermValue", "in": "query", "description": "Optional duration/window value paired with TermKind.", "schema": { "type": "integer", "format": "int32" } }, { "name": "TermUnit", "in": "query", "description": "Optional duration/window unit paired with TermKind.", "schema": { "$ref": "#/components/schemas/EntitlementTimeUnit" } }, { "name": "RenewalPolicyId", "in": "query", "description": "Optional renewal policy currently assigned to the linked plan.", "schema": { "type": "string" } }, { "name": "OwnerPartyRoleId", "in": "query", "description": "Optional owner party role filter.", "schema": { "type": "string" } }, { "name": "OwnerEntityInstanceId", "in": "query", "description": "Optional owner party instance filter.", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "description": "Optional lifecycle status filter.", "schema": { "$ref": "#/components/schemas/EntitlementStatus" } }, { "name": "StartsFromUtc", "in": "query", "description": "Optional inclusive start boundary.", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartsToUtc", "in": "query", "description": "Optional inclusive start boundary end.", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndsFromUtc", "in": "query", "description": "Optional inclusive end boundary.", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndsToUtc", "in": "query", "description": "Optional inclusive end boundary end.", "schema": { "type": "string", "format": "date-time" } }, { "name": "Search", "in": "query", "description": "Optional search text matched against plan/model/party display names.", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "description": "One-based page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "description": "Requested page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Create a runtime entitlement from one active plan.", "operationId": "entitlement-operations-entitlements-grant", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantEntitlementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GrantEntitlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GrantEntitlementRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/summary": { "get": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Return compact operational counters for runtime entitlements.", "operationId": "entitlement-operations-entitlements-summary", "parameters": [ { "name": "ModelId", "in": "query", "description": "Optional entitlement model filter.", "schema": { "type": "string" } }, { "name": "PlanId", "in": "query", "description": "Optional entitlement plan filter.", "schema": { "type": "string" } }, { "name": "PlanFamilyIds", "in": "query", "description": "Optional plan family ids that at least one current linked plan family must match.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ConditionFamily", "in": "query", "description": "Optional active condition family on the current linked plan.", "schema": { "$ref": "#/components/schemas/EntitlementLimitFamily" } }, { "name": "TermKind", "in": "query", "description": "Optional derived active term shape on the current linked plan.", "schema": { "$ref": "#/components/schemas/EntitlementPlanTermKind" } }, { "name": "TermValue", "in": "query", "description": "Optional duration/window value paired with TermKind.", "schema": { "type": "integer", "format": "int32" } }, { "name": "TermUnit", "in": "query", "description": "Optional duration/window unit paired with TermKind.", "schema": { "$ref": "#/components/schemas/EntitlementTimeUnit" } }, { "name": "RenewalPolicyId", "in": "query", "description": "Optional renewal policy currently assigned to the linked plan.", "schema": { "type": "string" } }, { "name": "ExpiringSoonDays", "in": "query", "description": "Look-ahead window in days. Defaults to 30.", "schema": { "type": "integer", "format": "int32" } }, { "name": "UsagePressureThresholdPercent", "in": "query", "description": "Remaining quantity threshold percent. Defaults to 20.", "schema": { "type": "integer", "format": "int32" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRuntimeSummaryResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/{entitlementId}": { "get": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Return one runtime entitlement.", "operationId": "entitlement-operations-entitlements-get", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/grant-preview": { "post": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Preview a runtime entitlement grant.", "operationId": "entitlement-operations-entitlements-preview-grant", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantEntitlementPreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GrantEntitlementPreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GrantEntitlementPreviewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantEntitlementPreviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantEntitlementPreviewResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantEntitlementPreviewResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/{entitlementId}/renew": { "post": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Renew an existing runtime entitlement.", "operationId": "entitlement-operations-entitlements-renew", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewEntitlementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenewEntitlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenewEntitlementRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/{entitlementId}/suspend": { "post": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Suspend a pending or active runtime entitlement.", "operationId": "entitlement-operations-entitlements-suspend", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/{entitlementId}/resume": { "post": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Resume a suspended runtime entitlement.", "operationId": "entitlement-operations-entitlements-resume", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/{entitlementId}/revoke": { "post": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Revoke a non-terminal runtime entitlement.", "operationId": "entitlement-operations-entitlements-revoke", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/{entitlementId}/expire": { "post": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Expire a non-terminal runtime entitlement immediately.", "operationId": "entitlement-operations-entitlements-expire", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementLifecycleActionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/{entitlementId}/quantity/consume": { "post": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Consume a positive quantity from an issued entitlement limit.", "operationId": "entitlement-operations-entitlements-consume-quantity", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumeEntitlementQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsumeEntitlementQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConsumeEntitlementQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/{entitlementId}/quantity/reverse": { "post": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Reverse a positive quantity from a prior consume ledger row.", "operationId": "entitlement-operations-entitlements-reverse-quantity", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReverseEntitlementQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReverseEntitlementQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReverseEntitlementQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/entitlements/{entitlementId}/quantity/adjust": { "post": { "tags": [ "Entitlement Operations Entitlements" ], "summary": "Set an issued quantity limit to an absolute consumed balance.", "operationId": "entitlement-operations-entitlements-adjust-quantity", "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustEntitlementQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdjustEntitlementQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdjustEntitlementQuantityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/ledger": { "get": { "tags": [ "Entitlement Operations Ledger" ], "summary": "Return entitlement ledger rows matching the supplied filters.", "operationId": "entitlement-operations-ledger-list", "parameters": [ { "name": "ModelId", "in": "query", "description": "Optional entitlement model filter.", "schema": { "type": "string" } }, { "name": "PlanId", "in": "query", "description": "Optional entitlement plan filter.", "schema": { "type": "string" } }, { "name": "EntitlementId", "in": "query", "description": "Optional entitlement id filter.", "schema": { "type": "string" } }, { "name": "EntitlementNumber", "in": "query", "description": "Optional human-readable entitlement number filter.", "schema": { "type": "integer", "format": "int64" } }, { "name": "PartyEntityInstanceId", "in": "query", "description": "Optional owner party instance filter.", "schema": { "type": "string" } }, { "name": "ResourceEntityInstanceId", "in": "query", "description": "Optional resource instance filter.", "schema": { "type": "string" } }, { "name": "Operation", "in": "query", "description": "Optional ledger movement type.", "schema": { "$ref": "#/components/schemas/EntitlementLedgerOperation" } }, { "name": "EntitlementStatus", "in": "query", "description": "Optional current entitlement status filter.", "schema": { "$ref": "#/components/schemas/EntitlementStatus" } }, { "name": "SourceType", "in": "query", "description": "Optional source type filter.", "schema": { "$ref": "#/components/schemas/EntitlementSourceType" } }, { "name": "RenewalOperationId", "in": "query", "description": "Optional renewal workflow id filter.", "schema": { "type": "string" } }, { "name": "OccurredFromUtc", "in": "query", "description": "Optional inclusive occurrence start.", "schema": { "type": "string", "format": "date-time" } }, { "name": "OccurredToUtc", "in": "query", "description": "Optional inclusive occurrence end.", "schema": { "type": "string", "format": "date-time" } }, { "name": "Search", "in": "query", "description": "Optional search across entitlement number, ids, plan/model names, owner display, reason, source, and correlation.", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "description": "One-based page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "description": "Requested page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementLedgerListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/ledger/export": { "get": { "tags": [ "Entitlement Operations Ledger" ], "summary": "Export entitlement ledger rows matching the supplied filters as CSV.", "operationId": "entitlement-operations-ledger-export", "parameters": [ { "name": "ModelId", "in": "query", "description": "Optional entitlement model filter.", "schema": { "type": "string" } }, { "name": "PlanId", "in": "query", "description": "Optional entitlement plan filter.", "schema": { "type": "string" } }, { "name": "EntitlementId", "in": "query", "description": "Optional entitlement id filter.", "schema": { "type": "string" } }, { "name": "EntitlementNumber", "in": "query", "description": "Optional human-readable entitlement number filter.", "schema": { "type": "integer", "format": "int64" } }, { "name": "PartyEntityInstanceId", "in": "query", "description": "Optional owner party instance filter.", "schema": { "type": "string" } }, { "name": "ResourceEntityInstanceId", "in": "query", "description": "Optional resource instance filter.", "schema": { "type": "string" } }, { "name": "Operation", "in": "query", "description": "Optional ledger movement type.", "schema": { "$ref": "#/components/schemas/EntitlementLedgerOperation" } }, { "name": "EntitlementStatus", "in": "query", "description": "Optional current entitlement status filter.", "schema": { "$ref": "#/components/schemas/EntitlementStatus" } }, { "name": "SourceType", "in": "query", "description": "Optional source type filter.", "schema": { "$ref": "#/components/schemas/EntitlementSourceType" } }, { "name": "RenewalOperationId", "in": "query", "description": "Optional renewal workflow id filter.", "schema": { "type": "string" } }, { "name": "OccurredFromUtc", "in": "query", "description": "Optional inclusive occurrence start.", "schema": { "type": "string", "format": "date-time" } }, { "name": "OccurredToUtc", "in": "query", "description": "Optional inclusive occurrence end.", "schema": { "type": "string", "format": "date-time" } }, { "name": "Search", "in": "query", "description": "Optional search across entitlement number, ids, plan/model names, owner display, reason, source, and correlation.", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "description": "One-based page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "description": "Requested page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/EntitlementLedgerExportResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementLedgerExportResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/ledger/{ledgerEntryId}": { "get": { "tags": [ "Entitlement Operations Ledger" ], "summary": "Return one entitlement ledger row.", "operationId": "entitlement-operations-ledger-get", "parameters": [ { "name": "ledgerEntryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementLedgerEntryDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementLedgerEntryDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/renewal-operations": { "get": { "tags": [ "Entitlement Operations Renewal" ], "summary": "Return renewal workflow operations matching the supplied filters.", "operationId": "entitlement-operations-renewal-list-operations", "parameters": [ { "name": "ModelId", "in": "query", "schema": { "type": "string" } }, { "name": "PlanId", "in": "query", "schema": { "type": "string" } }, { "name": "EntitlementId", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationStatus" } }, { "name": "OperationKind", "in": "query", "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationKind" } }, { "name": "DueFromUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "DueToUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entitlement Operations Renewal" ], "summary": "Create one renewal workflow operation.", "operationId": "entitlement-operations-renewal-create-operation", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/renewal-operations/{renewalOperationId}": { "get": { "tags": [ "Entitlement Operations Renewal" ], "summary": "Return one renewal workflow operation.", "operationId": "entitlement-operations-renewal-get-operation", "parameters": [ { "name": "renewalOperationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/renewal-operations/{renewalOperationId}/retry": { "post": { "tags": [ "Entitlement Operations Renewal" ], "summary": "Retry one renewal workflow operation.", "operationId": "entitlement-operations-renewal-retry-operation", "parameters": [ { "name": "renewalOperationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationRetryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationRetryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationRetryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/renewal-operations/{renewalOperationId}/cancel": { "post": { "tags": [ "Entitlement Operations Renewal" ], "summary": "Cancel one renewal workflow operation.", "operationId": "entitlement-operations-renewal-cancel-operation", "parameters": [ { "name": "renewalOperationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationCancelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationCancelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationCancelRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/data-transfer/export-profiles": { "get": { "tags": [ "Entity Data Transfer" ], "summary": "List export profiles.", "description": "Returns active JSON and CSV ZIP data transfer profiles that support export for one runtime entity definition.", "operationId": "entity-data-transfer-list-export-profiles", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferRuntimeProfileListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferRuntimeProfileListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferRuntimeProfileListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/data-transfer/import-profiles": { "get": { "tags": [ "Entity Data Transfer" ], "summary": "List JSON import profiles.", "description": "Returns active JSON data transfer profiles that support import for one runtime entity definition.", "operationId": "entity-data-transfer-list-import-profiles", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferRuntimeProfileListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferRuntimeProfileListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferRuntimeProfileListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/data-transfer/export/json": { "post": { "tags": [ "Entity Data Transfer" ], "summary": "Export JSON.", "description": "Exports matching entity instances as a JSON file using one data transfer profile.", "operationId": "entity-data-transfer-export-json", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Profile identifier and current entity instance list query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportEntityInstancesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExportEntityInstancesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExportEntityInstancesRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/data-transfer/export/csv-zip": { "post": { "tags": [ "Entity Data Transfer" ], "summary": "Export CSV ZIP.", "description": "Exports matching entity instances as a CSV ZIP package using one data transfer profile.", "operationId": "entity-data-transfer-export-csv-zip", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Profile identifier and current entity instance list query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportEntityInstancesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExportEntityInstancesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExportEntityInstancesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EntityCsvZipExportResultResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntityCsvZipExportResultResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityCsvZipExportResultResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EntityCsvZipExportResultResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntityCsvZipExportResultResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityCsvZipExportResultResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EntityCsvZipExportResultResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntityCsvZipExportResultResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityCsvZipExportResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/data-transfer/import/json/template": { "get": { "tags": [ "Entity Data Transfer" ], "summary": "Download JSON import template.", "description": "Returns a sample JSON package shaped for the selected import profile.", "operationId": "entity-data-transfer-download-json-import-template", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "description": "Data transfer profile identifier.", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityJsonExportResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/data-transfer/import/json/plan": { "post": { "tags": [ "Entity Data Transfer" ], "summary": "Plan JSON import.", "description": "Generates a non-destructive import plan for an uploaded JSON entity export package.", "operationId": "entity-data-transfer-plan-json-import", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ProfileId": { "type": "string", "description": "Data transfer profile identifier." }, "File": { "type": "string", "description": "Uploaded JSON export package.", "format": "binary" } } }, "encoding": { "ProfileId": { "style": "form" }, "File": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonImportPlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonImportPlanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonImportPlanResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonImportPlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/data-transfer/import/json/apply": { "post": { "tags": [ "Entity Data Transfer" ], "summary": "Apply JSON import.", "description": "Applies selected rows from an uploaded JSON entity export package.", "operationId": "entity-data-transfer-apply-json-import", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "OperationKey": { "type": "string", "description": "Stable client-generated key for replay-safe import application.", "format": "uuid" }, "ProfileId": { "type": "string", "description": "Data transfer profile identifier." }, "File": { "type": "string", "description": "Uploaded JSON export package.", "format": "binary" }, "SelectedRowIndexes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "One-based uploaded record indexes to apply." } } }, "encoding": { "OperationKey": { "style": "form" }, "ProfileId": { "style": "form" }, "File": { "style": "form" }, "SelectedRowIndexes": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonImportApplyResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonImportApplyResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonImportApplyResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJsonImportApplyResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity-definitions": { "get": { "tags": [ "Entity Definitions" ], "summary": "List entity definitions.", "operationId": "entity-definitions-list", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity-definitions/{entityDefinitionId}": { "get": { "tags": [ "Entity Definitions" ], "summary": "Return one entity definition.", "operationId": "entity-definitions-get", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/responsibilities/{responsibilityKey}/eligible-targets/query": { "post": { "tags": [ "Entity Instances" ], "summary": "Query subjects that the current actor may assign to one Entity responsibility.", "operationId": "entity-instances-assignments-query-eligible-targets", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibleResponsibilityTargetQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EligibleResponsibilityTargetQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EligibleResponsibilityTargetQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedEligibleResponsibilityTargetResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedEligibleResponsibilityTargetResultResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedEligibleResponsibilityTargetResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedEligibleResponsibilityTargetResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/responsibilities/{responsibilityKey}": { "get": { "tags": [ "Entity Instances" ], "summary": "Read the current assignment timeline for one Entity responsibility.", "operationId": "entity-instances-assignments-get-responsibility", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityAssignmentSetResponse" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity Instances" ], "summary": "Atomically replace the current assignment timeline for one Entity responsibility.", "operationId": "entity-instances-assignments-replace-responsibility", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceRuntimeResponsibilitiesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceRuntimeResponsibilitiesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceRuntimeResponsibilitiesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IResponsibilityMutationResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/responsibilities/{responsibilityKey}/history": { "get": { "tags": [ "Entity Instances" ], "summary": "Read immutable assignment history for one Entity responsibility.", "operationId": "entity-instances-assignments-get-responsibility-history", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "responsibilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityAssignmentHistoryResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/assignments/{relationDefinitionId}": { "put": { "tags": [ "Entity Instances" ], "summary": "Replace one common responsibility timeline for an Entity instance.", "operationId": "entity-instances-assignments-replace-assignments", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized key.", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "description": "Entity instance identifier.", "required": true, "schema": { "type": "string" } }, { "name": "relationDefinitionId", "in": "path", "description": "Stable responsibility code. The route parameter name is retained by the frozen Sprint 2 route contract;\r\nit no longer identifies an Entity relation definition.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Replay-safe complete responsibility timeline replacement.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReplaceResponsibilitiesCommandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityReplaceResponsibilitiesCommandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityReplaceResponsibilitiesCommandRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityMutationResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityMutationResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityMutationResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/changes": { "get": { "tags": [ "Entity Instances" ], "summary": "List changes.", "description": "Returns paginated change history for one entity instance.\r\nThe caller must hold both the effective read permission for the current archive state and `ReadChangesHistory`.\r\nHistory payloads are already structured for display and ordered newest-first.", "operationId": "entity-instances-changes-list-changes", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "description": "Entity instance identifier.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "One-based page number. Values below 1 are normalized to 1 and values above 100 are capped to 100.", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Requested page size. The default is 25 and the maximum is 200.", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceChangeListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceChangeListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceChangeListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/files/{fileId}": { "get": { "tags": [ "Entity Instances" ], "summary": "Return instance file metadata.", "description": "Returns file-reference metadata for a file that is reachable through the readable fields of one entity instance.\r\nThis endpoint follows record-surface access rules instead of direct folder visibility.", "operationId": "entity-instances-files-get-file", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileReferenceResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/files/{fileId}/download": { "get": { "tags": [ "Entity Instances" ], "summary": "Download instance file.", "description": "Downloads file content for a file that is reachable through the readable fields of one entity instance.\r\nThis endpoint follows record-surface access rules instead of direct folder visibility.", "operationId": "entity-instances-files-download-file", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/form-evaluation": { "post": { "tags": [ "Entity Instances" ], "summary": "Evaluate create-form mutation effects without saving a record.", "operationId": "entity-instances-mutations-evaluate-create-form", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateEntityInstanceFormRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateEntityInstanceFormRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EvaluateEntityInstanceFormRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceFormEvaluationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceFormEvaluationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceFormEvaluationResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/form-evaluation": { "post": { "tags": [ "Entity Instances" ], "summary": "Evaluate update-form mutation effects without saving a record.", "operationId": "entity-instances-mutations-evaluate-update-form", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateEntityInstanceFormRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateEntityInstanceFormRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EvaluateEntityInstanceFormRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceFormEvaluationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceFormEvaluationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceFormEvaluationResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances": { "post": { "tags": [ "Entity Instances" ], "summary": "Create instance.", "description": "The current Entity Security configuration must allow Create, every caller-supplied field must allow\r\nCreateWrite, every caller-proposed responsibility must match a StageOnCreate assignment rule,\r\nand the complete staged record must remain visible. Any denial rolls the entire create back.", "operationId": "entity-instances-mutations-create", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Dynamic instance payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreateCommandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityCreateCommandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityCreateCommandRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreateResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreateResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreateResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreateResultResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreateResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}": { "patch": { "tags": [ "Entity Instances" ], "summary": "Patch instance.", "description": "PATCH uses tri-state field semantics: omitted keys are undefined and remain unchanged, explicit `null` clears a field,\r\nand any other value replaces the stored value. Undefined fields do not pass through required validation.\r\nUnauthorized field inputs are skipped and returned as warnings.", "operationId": "entity-instances-mutations-patch", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "description": "Entity instance identifier.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Partial mutation payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUpdateCommandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityUpdateCommandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityUpdateCommandRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Instances" ], "summary": "Delete instance.", "description": "Permanently deletes one archived entity instance.\r\nActive rows must be archived before permanent deletion.\r\nReturns HTTP 409 with `moltaro.instances.delete.referenced` when a\r\nReference field configured with Restrict still points to this record.\r\nHard delete removes child-table rows and assignment rows and writes the final audit snapshot when audit is enabled.", "operationId": "entity-instances-mutations-delete", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "description": "Entity instance identifier.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Expected runtime row version for optimistic concurrency.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityIdentityCommandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityIdentityCommandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityIdentityCommandRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDeleteResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDeleteResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDeleteResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDeleteResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "get": { "tags": [ "Entity Instances" ], "summary": "Return instance.", "description": "Returns one entity instance by identifier.\r\nReturns `404` when the entity definition or instance does not exist.\r\nReturns `403` when the instance exists but the caller does not have effective read access for the current archive state.\r\nArchived instances are returned only when the caller has effective `ReadArchive` access.", "operationId": "entity-instances-read-get-by-id", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "description": "Entity instance identifier.", "required": true, "schema": { "type": "string" } }, { "name": "include", "in": "query", "description": "Optional repeated dot-separated include paths.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/archive": { "delete": { "tags": [ "Entity Instances" ], "summary": "Archive instance.", "description": "Archives one active entity instance and cascades the archive state to child-table rows.", "operationId": "entity-instances-mutations-archive", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "description": "Entity instance identifier.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Expected runtime row version for optimistic concurrency.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityIdentityCommandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityIdentityCommandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityIdentityCommandRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/restore": { "post": { "tags": [ "Entity Instances" ], "summary": "Restore instance.", "description": "Restores one archived entity instance and cascades the archive-state reset to child-table rows.", "operationId": "entity-instances-mutations-restore", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "description": "Entity instance identifier.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Expected runtime row version for optimistic concurrency.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityIdentityCommandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityIdentityCommandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityIdentityCommandRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/query": { "post": { "tags": [ "Entity Instances" ], "summary": "Query instances.", "description": "Queries entity instances for one runtime entity definition.\r\nThe list is always filtered by runtime security in SQL before materialization.\r\nFields denied by the current Security configuration are omitted from the response payload.", "operationId": "entity-instances-query-list", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "JSON query model with paging, filtering, sorting, and include placeholders.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstancePageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstancePageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstancePageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstancePageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/query/options": { "get": { "tags": [ "Entity Instances" ], "summary": "Return query options.", "description": "Returns backend-approved filter and sort options for one runtime entity definition.\r\nThe payload is security-shaped for the current caller and includes only query targets that the backend would\r\nactually accept for filtering, sorting, and child-table row predicates.", "operationId": "entity-instances-query-get-query-options", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceQueryOptionsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceQueryOptionsResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceQueryOptionsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/query/tag-options": { "get": { "tags": [ "Entity Instances" ], "summary": "Return tag filter options.", "description": "Returns distinct tag filter options for one runtime entity definition.\r\nOptions are collected only from instances visible to the current caller.", "operationId": "entity-instances-query-get-tag-filter-options", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceTagListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceTagListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceTagListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/open-target": { "get": { "tags": [ "Entity Instances" ], "summary": "Return the runtime UI target that should open for one entity instance.", "description": "Normal entity rows resolve to themselves. Enabled Projection Entity rows resolve to the concrete source row behind\r\nthe projection row. The caller must be able to read both the requested row and the resolved target row.", "operationId": "entity-instances-read-get-open-target", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Entity definition identifier or normalized entity key.", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "description": "Requested entity instance identifier.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceOpenTargetResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceOpenTargetResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceOpenTargetResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceOpenTargetResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/table/bootstrap": { "post": { "tags": [ "Entity UI" ], "summary": "Return the runtime bootstrap payload for a directly selected Table Surface.", "operationId": "entity-ui-get-table-bootstrap", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tableSurfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/table/tree/children": { "post": { "tags": [ "Entity UI" ], "summary": "Return one lazy child sibling page for the direct Table Surface endpoint.", "operationId": "entity-ui-get-table-tree-children", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tableSurfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeChildrenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeChildrenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeChildrenRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/lookup-table/bootstrap": { "post": { "tags": [ "Entity UI" ], "summary": "Return a role-resolved lookup-table bootstrap payload for a persisted source form item.", "operationId": "entity-ui-get-lookup-table-bootstrap", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSurfaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityLookupTableBootstrapRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityLookupTableBootstrapRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityLookupTableBootstrapRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/reference-picker/table/bootstrap": { "post": { "tags": [ "Entity UI" ], "summary": "Return the dedicated generic Reference picker table bootstrap.", "operationId": "entity-ui-get-reference-picker-table-bootstrap", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tableSurfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/hosted/table/tree/children": { "post": { "tags": [ "Entity UI" ], "summary": "Return one lazy child sibling page for the hosted Data Explorer table.", "operationId": "entity-ui-get-hosted-table-tree-children", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hostSurface", "in": "query", "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeChildrenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeChildrenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeChildrenRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/reference-picker/table/tree/children": { "post": { "tags": [ "Entity UI" ], "summary": "Return one lazy child sibling page for a generic Reference picker.", "operationId": "entity-ui-get-reference-picker-table-tree-children", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tableSurfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeChildrenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeChildrenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeChildrenRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/lookup-table/tree/children": { "post": { "tags": [ "Entity UI" ], "summary": "Return one lazy child sibling page for a persisted Reference Lookup form item.", "operationId": "entity-ui-get-lookup-table-tree-children", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSurfaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityLookupTableTreeChildrenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityLookupTableTreeChildrenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityLookupTableTreeChildrenRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/related-table": { "post": { "tags": [ "Entity UI" ], "summary": "Return one actor-shaped child table bound to a persisted related-table Form item.\r\nThe server re-resolves the inverse relation and locked parent filter; clients cannot submit either.", "operationId": "entity-ui-get-form-related-table", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSurfaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/related-table/tree/children": { "post": { "tags": [ "Entity UI" ], "summary": "Return one lazy child sibling page for a related-table Form item in Tree View.", "operationId": "entity-ui-get-form-related-table-tree-children", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSurfaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableTreeChildrenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableTreeChildrenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableTreeChildrenRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/related-table/tree/roots": { "post": { "tags": [ "Entity UI" ], "summary": "Return one additional root sibling page for a related-table Form item in Tree View.", "operationId": "entity-ui-get-form-related-table-tree-roots", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSurfaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableTreeRootsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableTreeRootsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityFormRelatedTableTreeRootsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/hosted-layout/related/tree/children": { "post": { "tags": [ "Entity UI" ], "summary": "Return one lazy child sibling page for a server-bound related table in Details or Drawer.", "operationId": "entity-ui-get-related-table-tree-children", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hostSurface", "in": "query", "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRelatedTableTreeChildrenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityRelatedTableTreeChildrenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityRelatedTableTreeChildrenRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/hosted-layout/related/tree/roots": { "post": { "tags": [ "Entity UI" ], "summary": "Return one additional root sibling page for a server-bound related table in Details or Drawer.", "operationId": "entity-ui-get-related-table-tree-roots", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hostSurface", "in": "query", "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRelatedTableTreeRootsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityRelatedTableTreeRootsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityRelatedTableTreeRootsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableTreeNodePageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/entity-list-page": { "get": { "tags": [ "Entity UI" ], "summary": "Return the runtime entity-list page bootstrap payload for the data explorer page.", "operationId": "entity-ui-get-entity-list-page", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListPageBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListPageBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListPageBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListPageBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/hosted/table/bootstrap": { "post": { "tags": [ "Entity UI" ], "summary": "Return the role-resolved hosted table bootstrap payload for a host surface.", "operationId": "entity-ui-get-hosted-table-bootstrap", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hostSurface", "in": "query", "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTablePageBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/related-table/grid-settings": { "get": { "tags": [ "Entity UI" ], "summary": "Return persisted grid settings for a trusted related-table Form item context.", "operationId": "entity-ui-get-form-related-table-grid-settings", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSurfaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "expectedContextRevision", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableUserGridSettingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableUserGridSettingsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableUserGridSettingsResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableUserGridSettingsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "patch": { "tags": [ "Entity UI" ], "summary": "Patch persisted grid settings for a trusted related-table Form item context.", "operationId": "entity-ui-patch-form-related-table-grid-settings", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formSurfaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "formItemId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "expectedContextRevision", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchEntityTableUserGridSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PatchEntityTableUserGridSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PatchEntityTableUserGridSettingsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableUserGridSettingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableUserGridSettingsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableUserGridSettingsResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTableUserGridSettingsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/hosted/card": { "get": { "tags": [ "Entity UI" ], "summary": "Return the role-resolved hosted card model for a host surface.", "operationId": "entity-ui-get-hosted-card", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hostSurface", "in": "query", "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCardSurfaceBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCardSurfaceBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCardSurfaceBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCardSurfaceBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/hosted/form": { "get": { "tags": [ "Entity UI" ], "summary": "Return the role-resolved hosted form model for a host surface.", "operationId": "entity-ui-get-hosted-form", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hostSurface", "in": "query", "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/table/actions/{actionId}/form": { "get": { "tags": [ "Entity UI" ], "summary": "Return the role-resolved edit form model for one table-row action.", "operationId": "entity-ui-get-table-action-form", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "actionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tableSurfaceId", "in": "query", "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/reference/display-values": { "post": { "tags": [ "Entity UI" ], "summary": "Return ordered display payloads for selected lookup reference values.", "operationId": "entity-ui-get-reference-display-values", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceDisplayValuesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceDisplayValuesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityReferenceDisplayValuesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceDisplayValuesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceDisplayValuesResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceDisplayValuesResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceDisplayValuesResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/form": { "get": { "tags": [ "Entity UI" ], "summary": "Return the effective runtime form model for the active caller.", "operationId": "entity-ui-get-form", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/card": { "get": { "tags": [ "Entity UI" ], "summary": "Return the effective runtime card model for the active caller.", "operationId": "entity-ui-get-card", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCardSurfaceBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCardSurfaceBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCardSurfaceBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/rule-evaluation-context": { "get": { "tags": [ "Entity UI" ], "summary": "Return the current rule evaluation context for locally executed backend-compiled rule plans.", "operationId": "entity-ui-get-rule-evaluation-context", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRuleEvaluationContextResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRuleEvaluationContextResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRuleEvaluationContextResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/details-page": { "get": { "tags": [ "Entity UI" ], "summary": "Return the details-page bootstrap payload for one entity instance.", "operationId": "entity-ui-get-details-page", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDetailsPageBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDetailsPageBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDetailsPageBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDetailsPageBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/hosted-layout/block": { "post": { "tags": [ "Entity UI" ], "summary": "Return one object-hosted layout block payload for a details page or drawer.", "operationId": "entity-ui-get-host-layout-block", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hostSurface", "in": "query", "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/drawer": { "get": { "tags": [ "Entity UI" ], "summary": "Return the drawer bootstrap payload for one entity instance.", "operationId": "entity-ui-get-drawer", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "query", "schema": { "type": "string" } }, { "name": "surfaceKey", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDrawerBootstrapResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDrawerBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDrawerBootstrapResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDrawerBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads/capabilities": { "get": { "tags": [ "File System" ], "summary": "Return the non-secret browser upload capabilities for this workspace.", "operationId": "file-system-upload-sessions-get-capabilities", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadCapabilitiesResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadCapabilitiesResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads": { "post": { "tags": [ "File System" ], "summary": "Create or idempotently resume a managed multipart upload.", "operationId": "file-system-upload-sessions-create", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManagedFileUploadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateManagedFileUploadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateManagedFileUploadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads/{uploadSessionId}/administrative-abort": { "post": { "tags": [ "File System" ], "summary": "Force-abort an upload session as a workspace administrator.", "operationId": "file-system-upload-sessions-abort-administratively", "parameters": [ { "name": "uploadSessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadAdministrativeAbortResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadAdministrativeAbortResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadAdministrativeAbortResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadAdministrativeAbortResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads/administration/active": { "get": { "tags": [ "File System" ], "summary": "List active upload reservations with safe source and recovery diagnostics.", "operationId": "file-system-upload-sessions-list-active-administratively", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadAdministrationItemListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads/administration/recover": { "post": { "tags": [ "File System" ], "summary": "Release selected or all bounded expired/orphaned upload reservations.", "operationId": "file-system-upload-sessions-recover-administratively", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoverManagedFileUploadsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecoverManagedFileUploadsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecoverManagedFileUploadsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadRecoveryResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads/{uploadSessionId}/retry-publication": { "post": { "tags": [ "File System" ], "summary": "Retry publication of a verified upload after a transient policy or conflict block.", "operationId": "file-system-upload-sessions-retry-publication", "parameters": [ { "name": "uploadSessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransitionManagedFileUploadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransitionManagedFileUploadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransitionManagedFileUploadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads/{uploadSessionId}": { "get": { "tags": [ "File System" ], "summary": "Return current state and provider-confirmed uploaded parts.", "operationId": "file-system-upload-sessions-get", "parameters": [ { "name": "uploadSessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads/{uploadSessionId}/parts/authorize": { "post": { "tags": [ "File System" ], "summary": "Authorize short-lived direct-upload URLs for exact part numbers.", "operationId": "file-system-upload-sessions-authorize-parts", "parameters": [ { "name": "uploadSessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeManagedFileUploadPartsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizeManagedFileUploadPartsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizeManagedFileUploadPartsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFilePartAuthorizationResponseEnvelope" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFilePartAuthorizationResponseEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFilePartAuthorizationResponseEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFilePartAuthorizationResponseEnvelope" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFilePartAuthorizationResponseEnvelope" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads/{uploadSessionId}/parts": { "get": { "tags": [ "File System" ], "summary": "Return provider-confirmed parts for interruption recovery.", "operationId": "file-system-upload-sessions-list-parts", "parameters": [ { "name": "uploadSessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadedPartListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadedPartListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadedPartListResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadedPartListResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads/{uploadSessionId}/complete": { "post": { "tags": [ "File System" ], "summary": "Complete the exact provider multipart inventory and enter mandatory verification.", "operationId": "file-system-upload-sessions-complete", "parameters": [ { "name": "uploadSessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransitionManagedFileUploadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransitionManagedFileUploadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransitionManagedFileUploadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/files/uploads/{uploadSessionId}/abort": { "post": { "tags": [ "File System" ], "summary": "Abort a caller-owned upload and release its storage reservation.", "operationId": "file-system-upload-sessions-abort", "parameters": [ { "name": "uploadSessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransitionManagedFileUploadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransitionManagedFileUploadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransitionManagedFileUploadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedFileUploadSessionResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/actions": { "get": { "tags": [ "Function Actions" ], "summary": "List actions available for a supported runtime surface.", "operationId": "business-function-actions-list", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Surface", "in": "query", "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionRuntimeActionListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionRuntimeActionListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionRuntimeActionListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/actions/{actionId}": { "get": { "tags": [ "Function Actions" ], "summary": "Return one available action with its input metadata.", "operationId": "business-function-actions-get", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "actionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionRuntimeActionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionRuntimeActionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/actions/active": { "get": { "tags": [ "Function Actions" ], "summary": "List active queued or running action executions for runtime UI state.", "operationId": "business-function-actions-list-active", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ActionId", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "EntityInstanceId", "in": "query", "schema": { "type": "string" } }, { "name": "SelectedEntityInstanceIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionExecutionListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionExecutionListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/actions/{actionId}/validate": { "post": { "tags": [ "Function Actions" ], "summary": "Validate action input before enqueue.", "operationId": "business-function-actions-validate", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "actionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvokeBusinessFunctionActionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvokeBusinessFunctionActionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InvokeBusinessFunctionActionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionInvocationValidationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionInvocationValidationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionInvocationValidationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/ui/actions/{actionId}/enqueue": { "post": { "tags": [ "Function Actions" ], "summary": "Validate and enqueue one action for asynchronous execution.", "operationId": "business-function-actions-enqueue", "parameters": [ { "name": "entityIdOrKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "actionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvokeBusinessFunctionActionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvokeBusinessFunctionActionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InvokeBusinessFunctionActionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionEnqueueResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionEnqueueResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionEnqueueResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/functions/{functionKey}/enqueue": { "post": { "tags": [ "Function API Jobs" ], "summary": "Enqueue a published global function and return the queued job status.", "operationId": "business-function-api-jobs-enqueue", "parameters": [ { "name": "functionKey", "in": "path", "description": "Callable function key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Optional function arguments and queue options.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueBusinessFunctionApiJobRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnqueueBusinessFunctionApiJobRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EnqueueBusinessFunctionApiJobRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiJobStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiJobStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiJobStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/functions/jobs/{jobId}": { "get": { "tags": [ "Function API Jobs" ], "summary": "Return the status and latest execution of a job enqueued through the functions API.", "operationId": "business-function-api-jobs-get-job", "parameters": [ { "name": "jobId", "in": "path", "description": "Queued job identifier.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiJobStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiJobStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/functions/jobs/{jobId}/cancel": { "post": { "tags": [ "Function API Jobs" ], "summary": "Cancel a queued job enqueued through the functions API.", "operationId": "business-function-api-jobs-cancel-job", "parameters": [ { "name": "jobId", "in": "path", "description": "Queued job identifier.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiJobStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiJobStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiJobStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/record-matching/launch-options": { "get": { "tags": [ "Record Matching" ], "summary": "List enabled record-matching launch options for an entity page surface.", "operationId": "record-matching-runtime-list-launch-options", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Target entity definition identifier or key.", "required": true, "schema": { "type": "string" } }, { "name": "surface", "in": "query", "description": "Entity page surface requesting matching launch options.", "schema": { "$ref": "#/components/schemas/RecordMatchingLaunchSurface" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingLaunchOptionsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingLaunchOptionsResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingLaunchOptionsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/record-matching/run": { "post": { "tags": [ "Record Matching" ], "summary": "Run bounded target-wide duplicate detection for one entity definition.", "description": "Fuzzy execution, comparison, readable-value, and 2,000-group response bounds fail without returning\r\npartial groups. Budget expiry returns HTTP 503; deterministic fuzzy bounds return HTTP 409.", "operationId": "record-matching-runtime-run-target-wide", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Target entity definition identifier or key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Profile, archive scope, and compatibility scan limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunResultResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/record-matching/run": { "post": { "tags": [ "Record Matching" ], "summary": "Run complete exact-normalized or fuzzy duplicate detection anchored to one visible entity instance.\r\nThe anchored candidate phase is bounded to 250 distinct matches and a five-second SQL budget.", "description": "Returns HTTP 409 with `recordMatching.anchor.tooBroad` and only\r\n`MaxCandidateCount=250` metadata when more candidates match, or with\r\n`recordMatching.anchor.unsupported` when the configured rule cannot be compiled safely.\r\nFuzzy value and comparison bounds also return HTTP 409 without values or candidate identifiers.\r\nReturns HTTP 503 with `recordMatching.anchor.executionBudgetExceeded` or\r\n`recordMatching.fuzzy.executionBudgetExceeded` when the SQL budget expires.\r\nClient cancellation cancels the query and produces no partial matching response.", "operationId": "record-matching-runtime-run-anchored", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Target entity definition identifier or key.", "required": true, "schema": { "type": "string" } }, { "name": "instanceId", "in": "path", "description": "Visible anchor record identifier.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Profile and archive scope; the compatibility limit is ignored for anchored matching.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunResultResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingRunResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/record-matching/full-scans": { "post": { "tags": [ "Record Matching" ], "summary": "Queue a complete exact or fuzzy target-wide scan owned by the current actor.", "description": "The HTTP request never performs the scan. The Worker Host persists progress and a bounded,\r\nactor-owned result. Reusing an idempotency key with a different request, submitting an\r\nunsupported profile, or attempting to start a duplicate active scan returns HTTP 409.\r\nA disabled full-scan worker returns HTTP 503. The response never exposes another actor's\r\njob or result identifiers.", "operationId": "record-matching-runtime-enqueue-full-scan", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Target entity definition identifier or key.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "description": "Profile, archive scope, and idempotency key for the durable scan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/record-matching/full-scans/latest": { "get": { "tags": [ "Record Matching" ], "summary": "Load the latest actor-owned full scan for one profile and archive scope.", "description": "Returns queued/running progress or a bounded page over a complete persisted result. If the\r\nactor, definition, profile, or saved candidate access has drifted, the result is invalidated\r\nand HTTP 409 is returned without candidate identifiers.", "operationId": "record-matching-runtime-get-latest-full-scan", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Target entity definition identifier or key.", "required": true, "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "description": "Matching profile identifier.", "schema": { "type": "string" } }, { "name": "archiveMode", "in": "query", "description": "Active, archived, or combined result scope.", "schema": { "$ref": "#/components/schemas/ArchiveMode" } }, { "name": "page", "in": "query", "description": "One-based group page.", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Requested group page size.", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/record-matching/full-scans/{jobId}": { "get": { "tags": [ "Record Matching" ], "summary": "Load one actor-owned full-scan job and a bounded result page.", "description": "page is one-based. pageSize is clamped to the server\r\n group-page bound. Successful jobs are reauthorized before any group is returned.", "operationId": "record-matching-runtime-get-full-scan", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Target entity definition identifier or key.", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "Persisted actor-owned job identifier.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "One-based group page.", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Requested group page size.", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/record-matching/full-scans/{jobId}/cancel": { "post": { "tags": [ "Record Matching" ], "summary": "Request cancellation of one actor-owned queued or processing full scan.", "description": "Cancellation is durable and fenced by the active Worker attempt. A completed result is not\r\nconverted into a partial result.", "operationId": "record-matching-runtime-cancel-full-scan", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Target entity definition identifier or key.", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "Persisted queued or processing job identifier.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/record-matching/full-scans/{jobId}/retry": { "post": { "tags": [ "Record Matching" ], "summary": "Retry one actor-owned failed or cancelled full scan as a new durable job.", "description": "Retry captures a new authoritative actor/profile/definition proof and creates a new job;\r\nthe previous terminal job remains immutable until retention cleanup.", "operationId": "record-matching-runtime-retry-full-scan", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Target entity definition identifier or key.", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "Persisted failed or cancelled job identifier.", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanJobResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entity/{entityIdOrKey}/record-matching/full-scans/{jobId}/groups/{groupId}/candidates": { "get": { "tags": [ "Record Matching" ], "summary": "Load one bounded candidate page from a successful actor-owned full-scan group.", "description": "page is one-based and pageSize is clamped to the\r\n server candidate-page bound. The complete saved result is reauthorized before the requested\r\n page is materialized; stale or inaccessible results return HTTP 409 without partial data.", "operationId": "record-matching-runtime-get-full-scan-group-candidates", "parameters": [ { "name": "entityIdOrKey", "in": "path", "description": "Target entity definition identifier or key.", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "Persisted successful job identifier.", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "Persisted group identifier from the published attempt.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "One-based candidate page.", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Requested candidate page size.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanGroupCandidatesPageResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanGroupCandidatesPageResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingFullScanGroupCandidatesPageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/responsibility-groups": { "get": { "tags": [ "Responsibility Groups" ], "summary": "List responsibility groups.", "operationId": "responsibility-groups-list", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/responsibility-groups/{responsibilityGroupId}": { "get": { "tags": [ "Responsibility Groups" ], "summary": "Return one responsibility group.", "operationId": "responsibility-groups-get", "parameters": [ { "name": "responsibilityGroupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/roles": { "get": { "tags": [ "Roles" ], "summary": "Return the list of workspace roles.", "operationId": "roles-get-roles", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/tags/resource-list": { "post": { "tags": [ "Tags" ], "summary": "Return tags owned by a resource.", "operationId": "tags-list-by-resource", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTagsByResourceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListTagsByResourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ListTagsByResourceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CorrelatedProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/tags/resource-suggestions": { "post": { "tags": [ "Tags" ], "summary": "Return distinct tag suggestions for one resource family.", "operationId": "tags-list-suggestions", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTagSuggestionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListTagSuggestionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ListTagSuggestionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagSuggestionListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagSuggestionListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CorrelatedProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/tags/{tagId}": { "get": { "tags": [ "Tags" ], "summary": "Return a tag by id.", "operationId": "tags-get", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CorrelatedProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Tags" ], "summary": "Update a tag.", "operationId": "tags-update", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTagRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTagRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CorrelatedProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Tags" ], "summary": "Delete a tag.", "operationId": "tags-delete", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CorrelatedProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/tags": { "post": { "tags": [ "Tags" ], "summary": "Create a tag for a resource.", "operationId": "tags-create", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CorrelatedProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/runtime-menu/resolve": { "get": { "tags": [ "User Menu" ], "summary": "Resolve the first visible user menu for the current caller or null.", "operationId": "runtime-menu-resolve", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvedRuntimeMenuResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/users": { "get": { "tags": [ "Users" ], "summary": "Return the list of workspace users.", "operationId": "users-get-users", "parameters": [ { "name": "access_token", "in": "query", "description": "Optional access token for clients that cannot set Authorization headers. Prefer `Authorization: Bearer ` when possible.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } } }, "components": { "schemas": { "ActionPlacement": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Start", "End", "Toolbar" ], "x-enum-descriptions": { "0": "Show the action in the leading row action area", "1": "Show the action in the trailing row action area", "2": "Show the action in the surface toolbar instead of on rows" } }, "ActivityFeedContentKind": { "enum": [ 1, 2 ], "type": "integer", "description": "Content type represented by an activity feed item.", "format": "int32", "x-enum-varnames": [ "Comment", "Attachment" ], "x-enum-descriptions": { "1": "Item represents a comment on the resource", "2": "Item represents a file attached to the resource" } }, "ActivityFeedEventKind": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "description": "User-facing activity event type.", "format": "int32", "x-enum-varnames": [ "CommentCreated", "CommentUpdated", "CommentDeleted", "AttachmentAdded", "AttachmentDeleted" ], "x-enum-descriptions": { "1": "A comment was created on the resource", "2": "An existing comment was edited", "3": "A comment was removed from the resource", "4": "A file was attached to the resource", "5": "An attached file was removed from the resource" } }, "ActivityFeedItem": { "type": "object", "properties": { "EventKind": { "$ref": "#/components/schemas/ActivityFeedEventKind" }, "ContentKind": { "$ref": "#/components/schemas/ActivityFeedContentKind" }, "ContentId": { "type": "string", "nullable": true }, "Owner": { "$ref": "#/components/schemas/ActivityFeedResourceContext" }, "RelatedTarget": { "$ref": "#/components/schemas/ActivityFeedResourceContext" }, "Source": { "$ref": "#/components/schemas/ActivityFeedResourceContext" }, "Comment": { "$ref": "#/components/schemas/Comment" }, "Attachment": { "$ref": "#/components/schemas/FileReference" }, "ActivityAt": { "type": "string", "format": "date-time" }, "CreatedAt": { "type": "string", "format": "date-time" }, "ModifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "DeletedAt": { "type": "string", "format": "date-time", "nullable": true }, "Permissions": { "$ref": "#/components/schemas/ActivityFeedPermissions" } }, "additionalProperties": false, "description": "One resource-aware activity feed item." }, "ActivityFeedPage": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityFeedItem" }, "nullable": true }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" }, "TotalCount": { "type": "integer", "format": "int32" }, "HasMore": { "type": "boolean" } }, "additionalProperties": false, "description": "Paginated resource activity feed." }, "ActivityFeedPageResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ActivityFeedPage" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ActivityFeedPermissions": { "type": "object", "properties": { "CanView": { "type": "boolean" }, "CanEdit": { "type": "boolean" }, "CanDelete": { "type": "boolean" }, "CanReply": { "type": "boolean" }, "CanDownload": { "type": "boolean" } }, "additionalProperties": false, "description": "Actions available for an activity feed item." }, "ActivityFeedRequest": { "type": "object", "properties": { "Resource": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" }, "Scope": { "$ref": "#/components/schemas/ActivityFeedResourceScope" }, "Kinds": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityFeedContentKind" }, "nullable": true } }, "additionalProperties": false, "description": "Resource activity feed query." }, "ActivityFeedResourceContext": { "type": "object", "properties": { "Identity": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "DisplayName": { "type": "string", "nullable": true }, "SafeLabel": { "type": "string", "nullable": true }, "OpenTarget": { "$ref": "#/components/schemas/ResourceOpenTarget" }, "CanOpen": { "type": "boolean" } }, "additionalProperties": false, "description": "Display and navigation context for a resource referenced by an activity feed item." }, "ActivityFeedResourceScope": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Scope for resource activity feed reads.", "format": "int32", "x-enum-varnames": [ "All", "Owned", "Related" ], "x-enum-descriptions": { "0": "Activity of the resource itself and of its related resources", "1": "Only activity that happened directly on the resource", "2": "Only activity of resources related to the resource" } }, "AddBoardItemRequest": { "required": [ "OperationKey" ], "type": "object", "properties": { "OperationKey": { "type": "string", "description": "Required caller-owned UUID for replay-safe admission. Reuse it only when retrying the exact same request.", "format": "uuid" }, "TargetKind": { "$ref": "#/components/schemas/BoardTargetKind" }, "TargetModelId": { "type": "string", "description": "Optional target model identifier.", "nullable": true }, "TargetObjectId": { "type": "string", "description": "Optional target object identifier.", "nullable": true }, "RepeatMode": { "$ref": "#/components/schemas/BoardItemRepeatMode" }, "Subject": { "type": "string", "description": "Optional board item subject.", "nullable": true }, "Description": { "type": "string", "description": "Optional board item description.", "nullable": true }, "TargetBoardStatusId": { "type": "string", "description": "Optional initial board status identifier.", "nullable": true }, "Position": { "$ref": "#/components/schemas/BoardItemPositionRequest" }, "BoardCycleId": { "type": "string", "description": "Optional board cycle identifier.", "nullable": true }, "Fields": { "type": "object", "additionalProperties": { "type": "object", "nullable": true }, "description": "Optional values for additional board data fields.", "nullable": true }, "DueDate": { "type": "string", "description": "Optional due date.", "format": "date", "nullable": true }, "DueTime": { "type": "string", "description": "Optional due time.", "format": "time", "nullable": true }, "MarkdownAttachmentDraftSessionId": { "type": "string", "description": "Optional Board Data Markdown attachment draft adopted by the new item.", "nullable": true }, "MarkdownAttachmentDestinationCreateNonce": { "type": "string", "description": "Destination nonce binding the Markdown draft to this board item create.", "nullable": true } }, "additionalProperties": false, "description": "Request to add an existing target object to a board." }, "AdjustEntitlementQuantityRequest": { "type": "object", "properties": { "EntitlementLimitId": { "type": "string", "description": "Optional selected issued limit id. Required when multiple quantity limits exist.", "nullable": true }, "LimitFamily": { "$ref": "#/components/schemas/EntitlementLimitFamily" }, "NewConsumedAmount": { "type": "number", "description": "New absolute consumed balance.", "format": "double" }, "RowVersion": { "type": "string", "description": "Optional concurrency token from the latest entitlement limit detail.", "format": "uuid", "nullable": true }, "ReasonCode": { "type": "string", "description": "Optional structured reason for support and audit review.", "nullable": true }, "ReasonText": { "type": "string", "description": "Optional free-form reason for support and audit review.", "nullable": true }, "IdempotencyKey": { "type": "string", "description": "Optional key that prevents repeating the same adjust command.", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "description": "Nullable JSON or text metadata for the source command.", "nullable": true } }, "additionalProperties": false, "description": "Set one issued entitlement quantity limit to an absolute consumed balance." }, "AlertTone": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Info", "Success", "Warning", "Error" ], "x-enum-descriptions": { "0": "Style the alert as neutral informational guidance", "1": "Style the alert as a positive confirmation", "2": "Style the alert as a caution that needs attention", "3": "Style the alert as a failure or blocking problem" } }, "ApiError": { "required": [ "Code", "Message" ], "type": "object", "properties": { "Code": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true }, "Target": { "type": "string", "nullable": true }, "Field": { "type": "string", "nullable": true }, "Metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Type": { "$ref": "#/components/schemas/ApiErrorType" }, "Severity": { "$ref": "#/components/schemas/ApiErrorSeverity" } }, "additionalProperties": false }, "ApiErrorSeverity": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Info", "Warning", "Error" ], "x-enum-descriptions": { "0": "Informational notice that does not indicate a failure", "1": "Non-blocking problem the caller should review", "2": "Failure that prevented the requested operation" } }, "ApiErrorType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Business", "Validation", "System" ], "x-enum-descriptions": { "0": "Domain rule rejected the operation even though the request was well formed", "1": "Request input failed validation and usually maps to a specific request field", "2": "Unexpected server-side failure not caused by the request content" } }, "ArchiveMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Active", "Archived", "All" ], "x-enum-descriptions": { "0": "Read only records that are not archived", "1": "Read only records that have been archived", "2": "Read both active and archived records" } }, "AttachBoardProcessFileFromCatalogRequest": { "type": "object", "properties": { "FileId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Attach an existing file system file through board runtime policy." }, "AttachFileFromCatalogRequest": { "type": "object", "properties": { "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "FileId": { "type": "string", "nullable": true }, "Relations": { "type": "array", "items": { "$ref": "#/components/schemas/MoltaroResourceRelationRequest" }, "nullable": true }, "Origin": { "$ref": "#/components/schemas/MoltaroResourceOriginRequest" }, "OperationKey": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AttachmentMutationResult": { "type": "object", "additionalProperties": false }, "AttachmentMutationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AttachmentMutationResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AttentionSignalSeverity": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Info", "Warning", "Danger" ], "x-enum-descriptions": { "0": "Informational signal that requires no immediate action", "1": "Signal that needs attention before it escalates", "2": "Critical signal that requires immediate attention" } }, "AuditTrailRetentionMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Disabled", "Forever", "Days" ], "x-enum-descriptions": { "0": "No audit trail entries are kept for the entity", "1": "Audit trail entries are kept indefinitely", "2": "Audit trail entries are kept only for the configured number of days" } }, "AuthorizeManagedFileUploadPartsRequest": { "type": "object", "properties": { "PartNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false, "description": "Request short-lived URLs for exact multipart part numbers." }, "AuthorizedResponsibilityState": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ResponsibilityStatePayload" }, "Kind": { "type": "string", "nullable": true, "readOnly": true }, "CanViewResult": { "type": "boolean", "readOnly": true } }, "additionalProperties": false, "description": "Returns authorized post-mutation responsibility state." }, "AuthorizedResponsibilityStateResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AuthorizedResponsibilityState" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardCycleActivationMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Manual", "DateDriven", "ManualWithDates" ], "x-enum-descriptions": { "0": "The active cycle is selected explicitly and cycle dates are optional", "1": "The cycle whose workspace-local date range contains the current date becomes the intended active cycle", "2": "The active cycle is selected explicitly while cycle dates are required, with warnings when the selection differs from the date-current cycle" } }, "BoardCycleLifecycleState": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Planned", "Active", "Completed", "Archived" ], "x-enum-descriptions": { "0": "The cycle is available for planning but is not the active operating cycle yet", "1": "The cycle is the current operating cycle for its board", "2": "The cycle is closed and kept for historical reporting", "3": "The cycle is hidden from normal pickers but retained for history" } }, "BoardCyclePromotionDecision": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "ActivateDateCurrentCycle", "BlockedByOpenItems", "NoDateCurrentCycle" ], "x-enum-descriptions": { "0": "No promotion action is required", "1": "The planned cycle containing the current date should be activated by a locked orchestration boundary", "2": "Promotion is blocked by open items in the current active cycle", "3": "No dated cycle contains the current workspace-local date" } }, "BoardCycleWarningCode": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "NoActiveCycle", "StaleActiveCycle", "ManualActiveCycleDoesNotMatchDates", "DateDrivenPromotionBlocked", "ItemWithoutCycle", "SelectedCycleCompleted", "SelectedCycleArchived" ], "x-enum-descriptions": { "0": "The cycle board has no resolved active cycle", "1": "The active cycle ended before the current workspace-local date", "2": "The manually selected active cycle differs from the cycle containing the current date", "3": "Date-driven promotion is blocked by open items in the stale active cycle", "4": "An item on the cycle board is not assigned to any cycle", "5": "The selected cycle is already completed", "6": "The selected cycle is already archived" } }, "BoardDueDateOffsetUnit": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Days", "Hours" ], "x-enum-descriptions": { "0": "The expectation threshold offset before the due date is measured in whole days", "1": "The expectation threshold offset before the due date is measured in whole hours" } }, "BoardDueDateTimeMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "DateOnly", "DateTime" ], "x-enum-descriptions": { "0": "Due dates are date-only and evaluate at the end of the workspace-local date", "1": "Due dates include a time and evaluate at the exact workspace-local date and time" } }, "BoardEligibleResponsibilityTargetQueryRequest": { "type": "object", "properties": { "Action": { "type": "string", "nullable": true }, "Search": { "type": "string", "nullable": true }, "Cursor": { "type": "string", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Queries subjects eligible for one keyed Board responsibility." }, "BoardInitialFieldMappingDestinationKind": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Subject", "Description", "DueDate", "BoardDataField" ], "x-enum-descriptions": { "0": "The mapped source value populates the board-owned subject field of the new item", "1": "The mapped source value populates the board-owned description field of the new item", "2": "The mapped source value sets the initial due date of the new item", "3": "The mapped source value populates a board-owned Part entity data field of the new item" } }, "BoardItemAuditBoardDataChangedPayload": { "type": "object", "properties": { "Subject": { "$ref": "#/components/schemas/BoardItemAuditTextChange" }, "Description": { "$ref": "#/components/schemas/BoardItemAuditTextChange" }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItemAuditBoardDataFieldValueChange" }, "nullable": true } }, "additionalProperties": false, "description": "Payload for board-owned data changes." }, "BoardItemAuditBoardDataFieldValueChange": { "type": "object", "properties": { "FieldId": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "ValueType": { "type": "string", "nullable": true }, "Before": { "type": "object", "nullable": true }, "After": { "type": "object", "nullable": true }, "BeforeDisplay": { "type": "object", "nullable": true }, "AfterDisplay": { "type": "object", "nullable": true }, "SemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "SemanticEvidenceState": { "$ref": "#/components/schemas/EntityInstanceAuditSemanticEvidenceState" }, "BeforePlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" }, "AfterPlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" } }, "additionalProperties": false, "description": "Board data field before/after value in board item audit." }, "BoardItemAuditCreatedPayload": { "type": "object", "properties": { "BoardStatusId": { "type": "string", "nullable": true }, "RankKey": { "type": "string", "nullable": true }, "RunNumber": { "type": "integer", "format": "int32" }, "PreviousBoardItemId": { "type": "string", "nullable": true }, "Subject": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "SubjectSemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "DescriptionSemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "SubjectSemanticEvidenceState": { "$ref": "#/components/schemas/EntityInstanceAuditSemanticEvidenceState" }, "DescriptionSemanticEvidenceState": { "$ref": "#/components/schemas/EntityInstanceAuditSemanticEvidenceState" }, "SubjectPlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" }, "DescriptionPlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" } }, "additionalProperties": false, "description": "Payload for board item creation audit entries." }, "BoardItemAuditCycleAssignedPayload": { "type": "object", "properties": { "PreviousBoardCycleId": { "type": "string", "nullable": true }, "BoardCycleId": { "type": "string", "nullable": true }, "ChangeReason": { "type": "string", "nullable": true }, "BulkOperationId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Payload for board item cycle assignment audit entries." }, "BoardItemAuditDueDateChangedPayload": { "type": "object", "properties": { "BeforeDueAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "AfterDueAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Payload for board item due-date changes." }, "BoardItemAuditLinkChangedPayload": { "type": "object", "properties": { "BoardItemLinkId": { "type": "string", "nullable": true }, "BoardItemLinkTypeId": { "type": "string", "nullable": true }, "LinkType": { "$ref": "#/components/schemas/BoardItemLinkTypeSystemKind" }, "SourceBoardItemId": { "type": "string", "nullable": true }, "TargetBoardItemId": { "type": "string", "nullable": true }, "Direction": { "$ref": "#/components/schemas/BoardItemLinkDirection" } }, "additionalProperties": false, "description": "Payload for board item link create and close audit entries." }, "BoardItemAuditMovedPayload": { "type": "object", "properties": { "BoardTransitionId": { "type": "string", "nullable": true }, "FromBoardStatusId": { "type": "string", "nullable": true }, "ToBoardStatusId": { "type": "string", "nullable": true }, "FromRankKey": { "type": "string", "nullable": true }, "ToRankKey": { "type": "string", "nullable": true }, "IsReopen": { "type": "boolean" }, "IsTerminal": { "type": "boolean" } }, "additionalProperties": false, "description": "Payload for board item movement and reopen audit entries." }, "BoardItemAuditRemovedPayload": { "type": "object", "properties": { "BoardStatusId": { "type": "string", "nullable": true }, "BoardCycleId": { "type": "string", "nullable": true }, "RankKey": { "type": "string", "nullable": true }, "RunNumber": { "type": "integer", "format": "int32" }, "RemoveReason": { "type": "string", "nullable": true }, "RemovedBoardItemLinkIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Payload for board item removal audit entries." }, "BoardItemAuditTagSnapshot": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "TagName": { "type": "string", "nullable": true }, "Color": { "type": "string", "nullable": true }, "Category": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Tag snapshot used by board item audit." }, "BoardItemAuditTagsChangedPayload": { "type": "object", "properties": { "Added": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItemAuditTagSnapshot" }, "nullable": true }, "Updated": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItemAuditTagSnapshot" }, "nullable": true }, "Removed": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItemAuditTagSnapshot" }, "nullable": true } }, "additionalProperties": false, "description": "Payload for board process tag changes." }, "BoardItemAuditTextChange": { "type": "object", "properties": { "Before": { "type": "string", "nullable": true }, "After": { "type": "string", "nullable": true }, "SemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "SemanticEvidenceState": { "$ref": "#/components/schemas/EntityInstanceAuditSemanticEvidenceState" }, "BeforePlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" }, "AfterPlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" } }, "additionalProperties": false, "description": "Text field before/after value in board item audit." }, "BoardItemLinkDirection": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Outgoing", "Incoming" ], "x-enum-descriptions": { "0": "The requested item is the source of the link", "1": "The requested item is the target of the link" } }, "BoardItemLinkTypeSystemKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Child", "Related" ], "x-enum-descriptions": { "0": "The source item acts as the parent and the target item acts as the child", "1": "The link is an informational relation between items on the same board" } }, "BoardItemPositionRequest": { "type": "object", "properties": { "PreviousBoardItemId": { "type": "string", "description": "Current item immediately before the requested position, or the current last item when no next boundary is supplied.", "nullable": true }, "NextBoardItemId": { "type": "string", "description": "Current item immediately after the requested position, or the current first item when no previous boundary is supplied.", "nullable": true } }, "additionalProperties": false, "description": "Position for a board item inside its destination status. With both boundaries omitted, the item is appended.\r\nA previous-only boundary must be the current last item, a next-only boundary must be the current first item,\r\nand two boundaries must be current adjacent items. Stale, foreign, or non-adjacent boundaries return HTTP 400\r\nwith `moltaroBoards.runtime.validation.positionInvalid`." }, "BoardItemRepeatMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ReopenTerminal", "NewPass" ], "x-enum-descriptions": { "0": "Reuse the latest terminal board item and move it back into the process", "1": "Keep the terminal board item as history and create a new process pass" } }, "BoardManagedFileUploadSession": { "type": "object", "properties": { "UploadSessionId": { "type": "string", "nullable": true }, "FileBodyGenerationId": { "type": "string", "nullable": true }, "TargetFolderId": { "type": "string", "nullable": true }, "RequestedFileName": { "type": "string", "nullable": true }, "DeclaredMimeType": { "type": "string", "nullable": true }, "DeclaredSizeBytes": { "type": "integer", "format": "int64" }, "ClientDeclaredSha256": { "type": "string", "nullable": true }, "PartSizeBytes": { "type": "integer", "format": "int32" }, "MaximumParallelParts": { "type": "integer", "format": "int32" }, "ExpiresAtUtc": { "type": "string", "format": "date-time" }, "ClientChecksumAlgorithm": { "type": "string", "nullable": true }, "ClientChecksumRequired": { "type": "boolean" }, "Status": { "$ref": "#/components/schemas/FileUploadSessionStatus" }, "RowVersion": { "type": "string", "format": "uuid" }, "AlreadyUploadedParts": { "type": "array", "items": { "$ref": "#/components/schemas/BoardManagedFileUploadedPart" }, "nullable": true }, "FailureCode": { "type": "string", "nullable": true }, "PublishedFileReferenceId": { "type": "string", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true } }, "additionalProperties": false, "description": "Managed process-attachment upload state." }, "BoardManagedFileUploadSessionResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardManagedFileUploadSession" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardManagedFileUploadedPart": { "type": "object", "properties": { "PartNumber": { "type": "integer", "format": "int32" }, "SizeBytes": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "description": "Provider-confirmed uploaded part." }, "BoardMoveLinkPrerequisiteSelectionRequest": { "type": "object", "properties": { "BoardTransitionLinkPrerequisiteId": { "type": "string", "description": "Configured transition prerequisite id.", "nullable": true }, "OtherBoardItemId": { "type": "string", "description": "Existing board item at the other end of the link.", "nullable": true }, "CreateItem": { "$ref": "#/components/schemas/CreateBoardRuntimeItemRequest" } }, "additionalProperties": false, "description": "Select an existing item or atomically create one to satisfy a transition link prerequisite." }, "BoardProcessContentAccessLevel": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ReadOnly", "Manage" ], "x-enum-descriptions": { "0": "Allows reading process content without creating or changing it", "1": "Allows creating and mutating process content" } }, "BoardResponsibilitySubjectType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "User", "ResponsibilityGroup" ], "x-enum-descriptions": { "0": "The assignment subject is a workspace user", "1": "The assignment subject is a workspace responsibility group" } }, "BoardRuntimeActorScopeFilterRequest": { "type": "object", "properties": { "AssignedToMe": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "description": "Runtime actor-scope filter for board item search." }, "BoardRuntimeAddContext": { "type": "object", "properties": { "Board": { "$ref": "#/components/schemas/BoardRuntimeSummary" }, "TargetDefinition": { "$ref": "#/components/schemas/BoardRuntimeTargetDefinition" }, "Statuses": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeStatus" }, "nullable": true }, "CanAdd": { "type": "boolean" }, "DisabledReasonCode": { "type": "string", "nullable": true }, "ExistingOpenItem": { "$ref": "#/components/schemas/BoardTargetContextItem" }, "LatestClosedItem": { "$ref": "#/components/schemas/BoardTargetContextItem" }, "RepeatModes": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItemRepeatMode" }, "nullable": true }, "BoardDataForm": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrap" }, "DueDatePolicy": { "$ref": "#/components/schemas/BoardRuntimeDueDatePolicy" }, "BoardData": { "$ref": "#/components/schemas/BoardRuntimeBoardData" } }, "additionalProperties": false, "description": "Board-context admission state for adding an existing target to the runtime board screen." }, "BoardRuntimeAddContextRequest": { "type": "object", "properties": { "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "TargetObjectId": { "type": "string", "nullable": true }, "TargetBoardStatusId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Request to prepare board admission for an existing target object." }, "BoardRuntimeAddContextResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeAddContext" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeAttentionSignal": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "TypeKey": { "type": "string", "nullable": true }, "Severity": { "$ref": "#/components/schemas/AttentionSignalSeverity" }, "Title": { "type": "string", "nullable": true }, "Body": { "type": "string", "nullable": true }, "DueAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Active AttentionSignal row summarized on runtime board cards and details." }, "BoardRuntimeAttentionSignalFilterRequest": { "type": "object", "properties": { "TypeKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Severities": { "type": "array", "items": { "$ref": "#/components/schemas/AttentionSignalSeverity" }, "nullable": true } }, "additionalProperties": false, "description": "Runtime AttentionSignal filter for board item search." }, "BoardRuntimeAttentionSignalSummary": { "type": "object", "properties": { "Count": { "type": "integer", "format": "int32" }, "HighestSeverity": { "$ref": "#/components/schemas/AttentionSignalSeverity" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeAttentionSignal" }, "nullable": true } }, "additionalProperties": false, "description": "Active AttentionSignal summary for one runtime board item." }, "BoardRuntimeBoardData": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "nullable": true }, "DefaultFormSurfaceKey": { "type": "string", "nullable": true }, "DefaultCardSurfaceKey": { "type": "string", "nullable": true }, "QueryOptions": { "$ref": "#/components/schemas/EntityInstanceQueryOptions" }, "SubjectSemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "DescriptionSemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" } }, "additionalProperties": false, "description": "Board-owned Part entity identity and default runtime surfaces." }, "BoardRuntimeBoardDataCard": { "type": "object", "properties": { "BoardItemId": { "type": "string", "nullable": true }, "DataRecordId": { "type": "string", "nullable": true }, "Card": { "$ref": "#/components/schemas/EntityCardSurfaceBootstrap" }, "Instance": { "$ref": "#/components/schemas/EntityInstanceDetail" } }, "additionalProperties": false, "description": "Standard generated card surface and values for board item data in drawer/details surfaces." }, "BoardRuntimeBoardDataCardField": { "type": "object", "properties": { "FieldKey": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "ValueType": { "$ref": "#/components/schemas/EntityFieldType" }, "SortOrder": { "type": "integer", "format": "int32" }, "Value": { "type": "object", "nullable": true }, "DisplayValue": { "type": "string", "nullable": true }, "IsRestricted": { "type": "boolean" }, "SemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "PlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" } }, "additionalProperties": false, "description": "Server-materialized board-owned Part field row for card and detail rendering." }, "BoardRuntimeBoardDataCardResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeBoardDataCard" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeBoardDataForm": { "type": "object", "properties": { "BoardItemId": { "type": "string", "nullable": true }, "DataRecordId": { "type": "string", "nullable": true }, "Form": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrap" }, "Instance": { "$ref": "#/components/schemas/EntityInstanceDetail" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Owner-scoped board data form bootstrap and current Part values for one board item." }, "BoardRuntimeBoardDataFormResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeBoardDataForm" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeBoardDataQueryRequest": { "type": "object", "properties": { "Filter": { "$ref": "#/components/schemas/EntityInstanceQueryFilterGroupRequest" }, "Sort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Board-owned Part entity query payload for board item search." }, "BoardRuntimeCardProjection": { "type": "object", "properties": { "Number": { "type": "integer", "format": "int32" }, "Subject": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "LastComment": { "$ref": "#/components/schemas/BoardRuntimeProcessCommentSummary" }, "AttachmentFileCount": { "type": "integer", "format": "int32" }, "BoardStatusId": { "type": "string", "nullable": true }, "BoardStatusDisplayName": { "type": "string", "nullable": true }, "BoardStatusColor": { "type": "string", "nullable": true }, "Responsibilities": { "$ref": "#/components/schemas/BoardRuntimeCardResponsibilitySummary" }, "IsRestricted": { "type": "boolean" }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeBoardDataCardField" }, "nullable": true }, "Target": { "$ref": "#/components/schemas/BoardRuntimeTargetCardProjection" }, "DueDate": { "$ref": "#/components/schemas/BoardRuntimeDueDate" }, "AttentionSignals": { "$ref": "#/components/schemas/BoardRuntimeAttentionSignalSummary" }, "Tags": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceTag" }, "description": "Visible process tags assigned to this board item.", "nullable": true } }, "additionalProperties": false, "description": "Server-computed compact projection for runtime board cards." }, "BoardRuntimeCardProviderField": { "type": "object", "properties": { "Key": { "type": "string", "description": "Stable provider field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "User-facing field name.", "nullable": true }, "Value": { "type": "string", "description": "Raw provider value used for stable diagnostics and provider semantics.", "nullable": true }, "ValueType": { "$ref": "#/components/schemas/BoardRuntimeCardProviderFieldValueType" }, "DisplayValue": { "type": "string", "description": "Server-resolved display value; clients fall back to Moltaro.Boards.Runtime.Models.BoardRuntimeCardProviderFieldModel.Value when absent.", "nullable": true } }, "additionalProperties": false, "description": "Provider-specific compact field for board card rendering." }, "BoardRuntimeCardProviderFieldValueType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "Provider field value kind for compact board cards.", "format": "int32", "x-enum-varnames": [ "Text", "Number", "DateTime", "Boolean", "Status", "Address" ], "x-enum-descriptions": { "0": "Render the field value as plain text", "1": "Render the field value as a numeric value", "2": "Render the field value as a date and time", "3": "Render the field value as a yes/no flag", "4": "Render the field value as a status indicator", "5": "Render the field value as a postal address" } }, "BoardRuntimeCardResponsibilitySubject": { "type": "object", "properties": { "SubjectType": { "$ref": "#/components/schemas/BoardResponsibilitySubjectType" }, "SubjectId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "ResponsibilityKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Compact responsibility subject displayed on a board card." }, "BoardRuntimeCardResponsibilitySummary": { "type": "object", "properties": { "Item": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeCardResponsibilitySubject" }, "nullable": true }, "Status": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeCardResponsibilitySubject" }, "nullable": true } }, "additionalProperties": false, "description": "Compact responsibility summary displayed on a board card." }, "BoardRuntimeCloseBlockers": { "type": "object", "properties": { "TotalCount": { "type": "integer", "format": "int32" }, "HiddenCount": { "type": "integer", "format": "int32" }, "ReadableChildren": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeItemLinkItem" }, "nullable": true }, "HiddenChildren": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeHiddenCloseBlocker" }, "nullable": true } }, "additionalProperties": false, "description": "Open child items blocking a terminal move." }, "BoardRuntimeConstraintDecision": { "type": "object", "properties": { "BoardConstraintId": { "type": "string", "nullable": true }, "BoardConstraintBindingId": { "type": "string", "nullable": true }, "Passed": { "type": "boolean" }, "FailureCode": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One ordered Board Constraint decision produced by a move dry run." }, "BoardRuntimeCreateBoardDataRequest": { "type": "object", "properties": { "Subject": { "type": "string", "description": "Optional board item subject.", "nullable": true }, "Description": { "type": "string", "description": "Optional board item description.", "nullable": true }, "TargetBoardStatusId": { "type": "string", "description": "Optional initial board status identifier.", "nullable": true }, "Position": { "$ref": "#/components/schemas/BoardItemPositionRequest" }, "Fields": { "type": "object", "additionalProperties": { "type": "object", "nullable": true }, "description": "Optional values for additional board data fields.", "nullable": true }, "DueDate": { "type": "string", "description": "Optional due date.", "format": "date", "nullable": true }, "DueTime": { "type": "string", "description": "Optional due time.", "format": "time", "nullable": true }, "BoardCycleId": { "type": "string", "description": "Optional board cycle identifier.", "nullable": true }, "MarkdownAttachmentDraftSessionId": { "type": "string", "description": "Optional Board Data Markdown attachment draft adopted by the new item.", "nullable": true }, "MarkdownAttachmentDestinationCreateNonce": { "type": "string", "description": "Destination nonce binding the Markdown draft to this board item create.", "nullable": true }, "MutationIdempotencyKey": { "type": "string", "description": "Stable client-generated key for replay-safe Board Data submission.", "nullable": true } }, "additionalProperties": false, "description": "Board-owned data captured by the runtime board item creation wizard." }, "BoardRuntimeCreateContext": { "type": "object", "properties": { "Board": { "$ref": "#/components/schemas/BoardRuntimeSummary" }, "Statuses": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeStatus" }, "nullable": true }, "TargetOptions": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeCreateTargetOption" }, "nullable": true }, "DueDatePolicy": { "$ref": "#/components/schemas/BoardRuntimeDueDatePolicy" }, "BoardData": { "$ref": "#/components/schemas/BoardRuntimeBoardData" } }, "additionalProperties": false, "description": "Bootstrap payload for creating a board item directly from the runtime board screen." }, "BoardRuntimeCreateContextResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeCreateContext" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeCreateTargetCapabilities": { "type": "object", "properties": { "CanAddItem": { "type": "boolean" }, "CanCreateTarget": { "type": "boolean" }, "CanSelectExistingTarget": { "type": "boolean" }, "CanEditBoardData": { "type": "boolean" }, "CanEditDueDate": { "type": "boolean" } }, "additionalProperties": false, "description": "Per-target capabilities for the runtime board item creation wizard." }, "BoardRuntimeCreateTargetOption": { "type": "object", "properties": { "TargetDefinition": { "$ref": "#/components/schemas/BoardRuntimeTargetDefinition" }, "CanUse": { "type": "boolean" }, "RequiresTargetCreate": { "type": "boolean" }, "SupportsTargetCreate": { "type": "boolean" }, "SupportsExistingTargetSelect": { "type": "boolean" }, "CanSelectExistingTarget": { "type": "boolean" }, "DisabledReasonCode": { "type": "string", "nullable": true }, "ExistingTargetDisabledReasonCode": { "type": "string", "nullable": true }, "Capabilities": { "$ref": "#/components/schemas/BoardRuntimeCreateTargetCapabilities" }, "EntityForm": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrap" }, "BoardDataForm": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrap" } }, "additionalProperties": false, "description": "Runtime target path available to the board item creation wizard." }, "BoardRuntimeCycle": { "type": "object", "properties": { "Id": { "type": "string", "description": "Cycle id.", "nullable": true }, "BoardId": { "type": "string", "description": "Owning board id.", "nullable": true }, "Name": { "type": "string", "description": "Cycle name.", "nullable": true }, "Description": { "type": "string", "description": "Optional cycle description.", "nullable": true }, "LifecycleState": { "$ref": "#/components/schemas/BoardCycleLifecycleState" }, "StartDate": { "type": "string", "description": "Inclusive workspace-local start date.", "format": "date", "nullable": true }, "EndDate": { "type": "string", "description": "Inclusive workspace-local end date.", "format": "date", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order inside the board.", "format": "int32" }, "ItemCount": { "type": "integer", "description": "Total item count currently assigned to this cycle.", "format": "int32" }, "OpenItemCount": { "type": "integer", "description": "Open item count currently assigned to this cycle.", "format": "int32" }, "AssignmentHistoryCount": { "type": "integer", "description": "Cycle assignment history rows referencing this cycle.", "format": "int32" }, "StatusCounts": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeCycleStatusCount" }, "description": "Counts grouped by board status.", "nullable": true }, "Actions": { "$ref": "#/components/schemas/BoardRuntimeCycleActions" }, "CreatedAt": { "type": "string", "description": "UTC creation timestamp.", "format": "date-time" }, "ModifiedAt": { "type": "string", "description": "UTC modification timestamp.", "format": "date-time", "nullable": true }, "ActivatedAtUtc": { "type": "string", "description": "UTC activation timestamp.", "format": "date-time", "nullable": true }, "CompletedAtUtc": { "type": "string", "description": "UTC completion timestamp.", "format": "date-time", "nullable": true }, "ArchivedAtUtc": { "type": "string", "description": "UTC archive timestamp.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Optimistic concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Runtime cycle detail." }, "BoardRuntimeCycleActions": { "type": "object", "properties": { "CanEdit": { "type": "boolean", "description": "Whether the cycle can be edited." }, "CanActivate": { "type": "boolean", "description": "Whether the cycle can be activated." }, "CanValidateClose": { "type": "boolean", "description": "Whether close validation can be requested." }, "CanClose": { "type": "boolean", "description": "Whether the cycle can be closed now." }, "CanArchive": { "type": "boolean", "description": "Whether the cycle can be archived." }, "CanDelete": { "type": "boolean", "description": "Whether the cycle can be hard-deleted." } }, "additionalProperties": false, "description": "Server-computed cycle actions for the caller." }, "BoardRuntimeCycleCloseValidation": { "type": "object", "properties": { "Cycle": { "$ref": "#/components/schemas/BoardRuntimeCycle" }, "CanClose": { "type": "boolean", "description": "Whether the cycle can be closed now." }, "OpenItemCount": { "type": "integer", "description": "Total open item count blocking closure.", "format": "int32" }, "ReadableOpenItemCount": { "type": "integer", "description": "Open blockers readable by the caller.", "format": "int32" }, "HiddenOpenItemCount": { "type": "integer", "description": "Open blockers hidden from the caller.", "format": "int32" }, "OpenItemCounts": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeCycleStatusCount" }, "description": "Open blocker counts grouped by status.", "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/BoardCycleWarningCode" }, "description": "Board-level cycle warning codes.", "nullable": true }, "BlockerCodes": { "type": "array", "items": { "type": "string" }, "description": "Domain blocker codes returned by the close planner.", "nullable": true } }, "additionalProperties": false, "description": "Close validation result for one active runtime cycle." }, "BoardRuntimeCycleCloseValidationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeCycleCloseValidation" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeCycleLifecycleRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Optional optimistic concurrency token.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Lifecycle mutation request for a runtime board cycle." }, "BoardRuntimeCycleList": { "type": "object", "properties": { "Board": { "$ref": "#/components/schemas/BoardRuntimeSummary" }, "BoardType": { "$ref": "#/components/schemas/BoardType" }, "ActivationMode": { "$ref": "#/components/schemas/BoardCycleActivationMode" }, "LocalDate": { "type": "string", "description": "Current workspace-local date used for cycle resolution.", "format": "date" }, "CanCreate": { "type": "boolean", "description": "Whether the caller can create planned cycles." }, "Cycles": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeCycle" }, "description": "Cycles ordered for runtime management.", "nullable": true }, "Resolution": { "$ref": "#/components/schemas/BoardRuntimeCycleResolution" }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/BoardCycleWarningCode" }, "description": "Board-level cycle warning codes.", "nullable": true } }, "additionalProperties": false, "description": "Runtime cycle list for one board." }, "BoardRuntimeCycleListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeCycleList" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeCycleResolution": { "type": "object", "properties": { "PersistedActiveCycleId": { "type": "string", "description": "Cycle persisted as active, if any.", "nullable": true }, "ResolvedActiveCycleId": { "type": "string", "description": "Cycle resolved as active by current board rules, if any.", "nullable": true }, "DateCurrentCycleId": { "type": "string", "description": "Cycle containing the current workspace-local date, if any.", "nullable": true }, "PromotionDecision": { "$ref": "#/components/schemas/BoardCyclePromotionDecision" }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/BoardCycleWarningCode" }, "description": "Structured resolution warning codes.", "nullable": true }, "ViolationCodes": { "type": "array", "items": { "type": "string" }, "description": "Domain violation codes found in the stored snapshot.", "nullable": true } }, "additionalProperties": false, "description": "Read-only runtime cycle resolution facts." }, "BoardRuntimeCycleResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeCycle" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeCycleRolloverRequest": { "type": "object", "properties": { "DestinationBoardCycleId": { "type": "string", "description": "Optional destination cycle id; when omitted, the next planned cycle is used.", "nullable": true }, "SourceRowVersion": { "type": "string", "description": "Optional optimistic concurrency token for the source cycle.", "format": "uuid", "nullable": true }, "DestinationRowVersion": { "type": "string", "description": "Optional optimistic concurrency token for the destination cycle.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Validate or execute runtime cycle rollover." }, "BoardRuntimeCycleRolloverResult": { "type": "object", "properties": { "Preview": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverValidation" }, "SourceCycle": { "$ref": "#/components/schemas/BoardRuntimeCycle" }, "DestinationCycle": { "$ref": "#/components/schemas/BoardRuntimeCycle" }, "BulkOperationId": { "type": "string", "description": "Shared bulk operation id written to assignment history and item audit.", "nullable": true }, "MovedItemCount": { "type": "integer", "description": "Number of open items moved from source to destination.", "format": "int32" } }, "additionalProperties": false, "description": "Rollover execution result for one runtime cycle." }, "BoardRuntimeCycleRolloverResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeCycleRolloverValidation": { "type": "object", "properties": { "SourceCycle": { "$ref": "#/components/schemas/BoardRuntimeCycle" }, "DestinationCycle": { "$ref": "#/components/schemas/BoardRuntimeCycle" }, "CanRollover": { "type": "boolean", "description": "Whether open items can be rolled over now." }, "OpenItemCount": { "type": "integer", "description": "Total source open item count that would move.", "format": "int32" }, "ReadableOpenItemCount": { "type": "integer", "description": "Source open items readable by the caller.", "format": "int32" }, "HiddenOpenItemCount": { "type": "integer", "description": "Source open items hidden from the caller.", "format": "int32" }, "OpenItemCounts": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeCycleStatusCount" }, "description": "Source open item counts grouped by status.", "nullable": true }, "ReadableSampleItems": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeItem" }, "description": "Readable sample source items that would move.", "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/BoardCycleWarningCode" }, "description": "Board-level cycle warning codes.", "nullable": true }, "BlockerCodes": { "type": "array", "items": { "type": "string" }, "description": "Domain blocker codes returned by the rollover planner.", "nullable": true } }, "additionalProperties": false, "description": "Rollover validation result for one active runtime cycle." }, "BoardRuntimeCycleRolloverValidationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeCycleRolloverValidation" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeCycleStatusCount": { "type": "object", "properties": { "BoardStatusId": { "type": "string", "description": "Board status id.", "nullable": true }, "BoardStatusKey": { "type": "string", "description": "Optional board status key.", "nullable": true }, "BoardStatusName": { "type": "string", "description": "Board status display name.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Board status sort order.", "format": "int32" }, "ItemCount": { "type": "integer", "description": "Total item count in the cycle/status bucket.", "format": "int32" }, "OpenItemCount": { "type": "integer", "description": "Open item count in the cycle/status bucket.", "format": "int32" }, "ReadableOpenItemCount": { "type": "integer", "description": "Open items whose target is readable by the caller.", "format": "int32" }, "HiddenOpenItemCount": { "type": "integer", "description": "Open items hidden from the caller.", "format": "int32" } }, "additionalProperties": false, "description": "Runtime cycle counts for one board status." }, "BoardRuntimeDueDate": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "TimeMode": { "$ref": "#/components/schemas/BoardDueDateTimeMode" }, "DueAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "DueDate": { "type": "string", "format": "date", "nullable": true }, "DueTime": { "type": "string", "format": "time", "nullable": true }, "Severity": { "$ref": "#/components/schemas/AttentionSignalSeverity" }, "MatchedExpectationId": { "type": "string", "nullable": true }, "ThresholdUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Server-computed due-date state for runtime board cards and details." }, "BoardRuntimeDueDateFilterRequest": { "type": "object", "properties": { "HasDueDate": { "type": "boolean", "nullable": true }, "DueFromUtc": { "type": "string", "format": "date-time", "nullable": true }, "DueToUtc": { "type": "string", "format": "date-time", "nullable": true }, "IsOverdue": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "description": "Runtime due-date filter for board item search." }, "BoardRuntimeDueDatePolicy": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "TimeMode": { "$ref": "#/components/schemas/BoardDueDateTimeMode" }, "DisabledBoardStatusIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Expectations": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeDueDateStatusExpectation" }, "nullable": true } }, "additionalProperties": false, "description": "Runtime due-date policy included in the board shell." }, "BoardRuntimeDueDateSortRequest": { "type": "object", "properties": { "Direction": { "$ref": "#/components/schemas/EntityInstanceQuerySortDirection" } }, "additionalProperties": false, "description": "Runtime due-date sort for board item search." }, "BoardRuntimeDueDateStatusExpectation": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "ExpectedBoardStatusId": { "type": "string", "nullable": true }, "OffsetAmount": { "type": "integer", "format": "int32" }, "OffsetUnit": { "$ref": "#/components/schemas/BoardDueDateOffsetUnit" }, "Severity": { "$ref": "#/components/schemas/AttentionSignalSeverity" }, "SortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Runtime due-date status expectation row." }, "BoardRuntimeEntityDefinition": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "DisplayNameSingular": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "CanAdd": { "type": "boolean" }, "CanMove": { "type": "boolean" }, "CommentAccessLevel": { "$ref": "#/components/schemas/BoardProcessContentAccessLevel" }, "AttachmentAccessLevel": { "$ref": "#/components/schemas/BoardProcessContentAccessLevel" } }, "additionalProperties": false, "description": "Runtime entity definition attached to a board." }, "BoardRuntimeFieldValue": { "type": "object", "properties": { "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "SemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "Value": { "type": "string", "nullable": true }, "PlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" } }, "additionalProperties": false, "description": "Typed Board Subject or Description value with authoritative Markdown semantics." }, "BoardRuntimeFilters": { "type": "object", "properties": { "Board": { "$ref": "#/components/schemas/BoardRuntimeSummary" }, "QuickViews": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeQuickView" }, "nullable": true }, "SavedFilters": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeSavedFilter" }, "nullable": true } }, "additionalProperties": false, "description": "Saved filter catalog and server-provided quick views for a runtime board." }, "BoardRuntimeFiltersResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeFilters" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeHiddenCloseBlocker": { "type": "object", "properties": { "BoardDisplayName": { "type": "string", "nullable": true }, "RunNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Safe summary for a hidden child blocker." }, "BoardRuntimeInitialFieldMapping": { "type": "object", "properties": { "DestinationKind": { "$ref": "#/components/schemas/BoardInitialFieldMappingDestinationKind" }, "DestinationFieldKey": { "type": "string", "nullable": true }, "DestinationDisplayName": { "type": "string", "nullable": true }, "DestinationFieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "SourceFieldKey": { "type": "string", "nullable": true }, "SourceDisplayName": { "type": "string", "nullable": true }, "SourceFieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "SortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Initial mapping shown to runtime users and applied during target admission." }, "BoardRuntimeItem": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "BoardId": { "type": "string", "nullable": true }, "Target": { "$ref": "#/components/schemas/BoardRuntimeTarget" }, "TargetDisplayName": { "type": "string", "nullable": true }, "TargetSubtitle": { "type": "string", "nullable": true }, "BoardStatusId": { "type": "string", "nullable": true }, "RankKey": { "type": "string", "nullable": true }, "RunNumber": { "type": "integer", "format": "int32" }, "IsOpen": { "type": "boolean" }, "EnteredStatusAtUtc": { "type": "string", "format": "date-time" }, "CompletedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" }, "Actions": { "$ref": "#/components/schemas/BoardRuntimeItemActions" }, "ObjectInvariant": { "$ref": "#/components/schemas/ObjectInvariant" }, "EntityAccess": { "$ref": "#/components/schemas/BoardRuntimeItemEntityAccess" }, "ProcessContent": { "$ref": "#/components/schemas/BoardRuntimeItemProcessContent" }, "Card": { "$ref": "#/components/schemas/BoardRuntimeCardProjection" }, "Entity": { "$ref": "#/components/schemas/EntityInstanceListItem" }, "Subject": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "DueDate": { "$ref": "#/components/schemas/BoardRuntimeDueDate" }, "DataRecordId": { "type": "string", "nullable": true }, "AttentionSignals": { "$ref": "#/components/schemas/BoardRuntimeAttentionSignalSummary" }, "Cycle": { "$ref": "#/components/schemas/BoardRuntimeItemCycleSummary" }, "RemovedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "RemovedByUserId": { "type": "string", "nullable": true }, "RemoveReason": { "type": "string", "nullable": true }, "SubjectField": { "$ref": "#/components/schemas/BoardRuntimeFieldValue" }, "DescriptionField": { "$ref": "#/components/schemas/BoardRuntimeFieldValue" } }, "additionalProperties": false, "description": "Runtime board item." }, "BoardRuntimeItemActions": { "type": "object", "properties": { "CanReadHistory": { "type": "boolean" }, "CanViewAuditTrail": { "type": "boolean" } }, "additionalProperties": false, "description": "Server-computed Board Item read capabilities whose reserved Object Operation\r\nkeys are not admitted in v1." }, "BoardRuntimeItemAuditActivityKind": { "enum": [ 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 ], "type": "integer", "description": "Runtime board item audit activity kind.", "format": "int32", "x-enum-varnames": [ "Created", "Moved", "Reopened", "BoardDataChanged", "TagsChanged", "DueDateChanged", "ItemLinkCreated", "ItemLinkRemoved", "CycleAssigned", "Removed" ], "x-enum-descriptions": { "0": "The board item was created on the board", "1": "The board item moved to another status", "2": "A terminal board item was moved back into the process", "3": "Board-owned Part data field values changed", "4": "Process tags on the board item changed", "6": "The board item due date changed", "7": "A link between board items was created", "8": "A link between board items was removed", "9": "The board item was assigned or reassigned to a board cycle", "10": "The board item was removed from the board" } }, "BoardRuntimeItemAuditTrail": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "BoardItemId": { "type": "string", "nullable": true }, "ActivityKind": { "$ref": "#/components/schemas/BoardRuntimeItemAuditActivityKind" }, "ActorUserId": { "type": "string", "nullable": true }, "ActorUserName": { "type": "string", "nullable": true }, "OccurredAtUtc": { "type": "string", "format": "date-time" }, "Created": { "$ref": "#/components/schemas/BoardItemAuditCreatedPayload" }, "Moved": { "$ref": "#/components/schemas/BoardItemAuditMovedPayload" }, "BoardDataChanged": { "$ref": "#/components/schemas/BoardItemAuditBoardDataChangedPayload" }, "TagsChanged": { "$ref": "#/components/schemas/BoardItemAuditTagsChangedPayload" }, "DueDateChanged": { "$ref": "#/components/schemas/BoardItemAuditDueDateChangedPayload" }, "ItemLinkChanged": { "$ref": "#/components/schemas/BoardItemAuditLinkChangedPayload" }, "CycleAssigned": { "$ref": "#/components/schemas/BoardItemAuditCycleAssignedPayload" }, "Removed": { "$ref": "#/components/schemas/BoardItemAuditRemovedPayload" } }, "additionalProperties": false, "description": "Runtime board item audit row." }, "BoardRuntimeItemAuditTrailListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeItemAuditTrail" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeItemCycleSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "LifecycleState": { "$ref": "#/components/schemas/BoardCycleLifecycleState" }, "StartDate": { "type": "string", "format": "date", "nullable": true }, "EndDate": { "type": "string", "format": "date", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Compact cycle summary for a runtime board item." }, "BoardRuntimeItemEntityAccess": { "type": "object", "properties": { "CanRead": { "type": "boolean" }, "IsRestricted": { "type": "boolean" }, "Number": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Entity access state for the underlying Entity Instance inside a board item." }, "BoardRuntimeItemHistory": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "BoardItemId": { "type": "string", "nullable": true }, "BoardTransitionId": { "type": "string", "nullable": true }, "FromBoardStatusId": { "type": "string", "nullable": true }, "FromBoardStatusName": { "type": "string", "nullable": true }, "ToBoardStatusId": { "type": "string", "nullable": true }, "ToBoardStatusName": { "type": "string", "nullable": true }, "FromRankKey": { "type": "string", "nullable": true }, "ToRankKey": { "type": "string", "nullable": true }, "MovedByUserId": { "type": "string", "nullable": true }, "MovedAtUtc": { "type": "string", "format": "date-time" }, "IsReopen": { "type": "boolean" } }, "additionalProperties": false, "description": "Runtime movement history row." }, "BoardRuntimeItemHistoryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeItemHistory" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeItemLink": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "BoardItemLinkTypeId": { "type": "string", "nullable": true }, "LinkType": { "$ref": "#/components/schemas/BoardItemLinkTypeSystemKind" }, "Direction": { "$ref": "#/components/schemas/BoardItemLinkDirection" }, "SourceBoardItemId": { "type": "string", "nullable": true }, "TargetBoardItemId": { "type": "string", "nullable": true }, "CreatedAtUtc": { "type": "string", "format": "date-time" }, "CreatedByUserId": { "type": "string", "nullable": true }, "OtherItem": { "$ref": "#/components/schemas/BoardRuntimeItemLinkItem" }, "CanRemove": { "type": "boolean" } }, "additionalProperties": false, "description": "Runtime board item link row displayed relative to one item." }, "BoardRuntimeItemLinkCandidatesPage": { "type": "object", "properties": { "BoardId": { "type": "string", "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Limit": { "type": "integer", "format": "int32" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeItemLinkItem" }, "nullable": true } }, "additionalProperties": false, "description": "Server-backed item-link picker candidates." }, "BoardRuntimeItemLinkCandidatesPageResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeItemLinkCandidatesPage" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeItemLinkCandidatesRequest": { "type": "object", "properties": { "SearchText": { "type": "string", "description": "Optional free text or `#RunNumber` lookup.", "nullable": true }, "BoardTargetDefinitionIds": { "type": "array", "items": { "type": "string" }, "description": "Optional active target-definition ids. When supplied, the scope limits the complete search pipeline: target providers, owning Board Data, and the final candidate query. When omitted, search covers all active Boards and target definitions with bounded per-source presearch.", "nullable": true }, "LinkType": { "$ref": "#/components/schemas/BoardItemLinkTypeSystemKind" }, "Direction": { "$ref": "#/components/schemas/BoardItemLinkDirection" }, "Limit": { "type": "integer", "description": "Requested result limit from 1 through 50.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Search request for board item link picker candidates." }, "BoardRuntimeItemLinkFilterRequest": { "type": "object", "properties": { "HasOpenChildBlockers": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "description": "Runtime link-state filter for board item search." }, "BoardRuntimeItemLinkItem": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "BoardId": { "type": "string", "nullable": true }, "BoardKey": { "type": "string", "nullable": true }, "BoardDisplayName": { "type": "string", "nullable": true }, "RunNumber": { "type": "integer", "format": "int32" }, "DisplayName": { "type": "string", "nullable": true }, "Subtitle": { "type": "string", "nullable": true }, "BoardStatusId": { "type": "string", "nullable": true }, "BoardStatusDisplayName": { "type": "string", "nullable": true }, "BoardStatusColor": { "type": "string", "nullable": true }, "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "BoardTargetDefinitionDisplayName": { "type": "string", "nullable": true }, "IsOpen": { "type": "boolean" }, "IsRestricted": { "type": "boolean" } }, "additionalProperties": false, "description": "Compact board item summary used by item-link surfaces." }, "BoardRuntimeItemLinks": { "type": "object", "properties": { "BoardItemId": { "type": "string", "nullable": true }, "CanManage": { "type": "boolean" }, "Parent": { "$ref": "#/components/schemas/BoardRuntimeItemLink" }, "Children": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeItemLink" }, "nullable": true }, "Related": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeItemLink" }, "nullable": true } }, "additionalProperties": false, "description": "Grouped active board item links for one item." }, "BoardRuntimeItemLinksResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeItemLinks" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeItemListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeItem" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeItemProcessContent": { "type": "object", "properties": { "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "Comments": { "$ref": "#/components/schemas/BoardRuntimeProcessComments" }, "Attachments": { "$ref": "#/components/schemas/BoardRuntimeProcessAttachments" } }, "additionalProperties": false, "description": "Process content identity and summary for a board item." }, "BoardRuntimeItemResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeItem" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeItemViewAvailability": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Safe diagnostic for the caller's Board Item View formula.", "format": "int32", "x-enum-varnames": [ "Denied", "Conditional", "Unrestricted" ], "x-enum-descriptions": { "0": "The formula cannot match a Board Item for the captured actor and clock", "1": "The formula can match but requires Board Item or related resource data", "2": "The formula is allowed without Board Item or related resource data" } }, "BoardRuntimeItemsByIdsRequest": { "type": "object", "properties": { "BoardItemIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "CycleSelector": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Loads specific board items by ids for realtime refreshes." }, "BoardRuntimeItemsCursor": { "type": "object", "properties": { "RankKey": { "type": "string", "nullable": true }, "BoardItemId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Cursor for loading the next board item page inside one status." }, "BoardRuntimeItemsPage": { "type": "object", "properties": { "BoardId": { "type": "string", "nullable": true }, "BoardStatusId": { "type": "string", "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Limit": { "type": "integer", "format": "int32" }, "HasMore": { "type": "boolean" }, "NextCursor": { "$ref": "#/components/schemas/BoardRuntimeItemsCursor" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeItem" }, "nullable": true } }, "additionalProperties": false, "description": "Paged runtime board items for one board status." }, "BoardRuntimeItemsPageResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeItemsPage" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeItemsSearchCursor": { "type": "object", "properties": { "BoardCycleId": { "type": "string", "description": "Cycle identity at the page boundary, when cycle ordering is active.", "nullable": true }, "BoardStatusId": { "type": "string", "description": "Status identity at the page boundary.", "nullable": true }, "RankKey": { "type": "string", "description": "Board rank at the page boundary.", "nullable": true }, "BoardItemId": { "type": "string", "description": "Stable Board Item tie-breaker at the page boundary.", "nullable": true }, "BoardDataSortCursor": { "type": "string", "description": "Opaque Board Data sort tuple that must be returned unchanged in the next request.", "nullable": true } }, "additionalProperties": false, "description": "Cursor for loading the next cross-status board item search page." }, "BoardRuntimeItemsSearchCursorRequest": { "type": "object", "properties": { "BoardCycleId": { "type": "string", "description": "Cycle identity from the preceding page, when cycle ordering is active.", "nullable": true }, "BoardStatusId": { "type": "string", "description": "Status identity from the preceding page.", "nullable": true }, "RankKey": { "type": "string", "description": "Board rank from the preceding page.", "nullable": true }, "BoardItemId": { "type": "string", "description": "Stable Board Item tie-breaker from the preceding page.", "nullable": true }, "BoardDataSortCursor": { "type": "string", "description": "Opaque Board Data sort tuple from the preceding page; callers must return it unchanged.", "nullable": true } }, "additionalProperties": false, "description": "Cursor for searching board items across one or more statuses." }, "BoardRuntimeItemsSearchPage": { "type": "object", "properties": { "BoardId": { "type": "string", "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Limit": { "type": "integer", "format": "int32" }, "HasMore": { "type": "boolean" }, "NextCursor": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchCursor" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeItem" }, "nullable": true } }, "additionalProperties": false, "description": "Paged runtime board item search result across one or more statuses." }, "BoardRuntimeItemsSearchPageResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchPage" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeItemsSearchRequest": { "type": "object", "properties": { "SearchText": { "type": "string", "description": "Optional free text. The search covers Board item identity and run number, Board-owned data, target identity and\r\npresentation fallback, and the current configured Entity search targets for normally readable Entity targets.\r\nConfigured target matching uses each target definition's own Entity search contract and access boundary. When an\r\nEntity definition has no search targets, only the identity, presentation, and Board-owned fallbacks remain. Boards\r\ndoes not maintain a copied search index or reconciliation job: the query reads current Entity storage through its\r\nsupported PostgreSQL search/index contract, so configuration changes require no Board reindex or rebuild. Target\r\ncandidates and matches are processed in bounded keyset batches through request-local indexed PostgreSQL temporary\r\ntables. The complete search, including count and page materialization, is fail-closed; a timeout or provider failure returns the stable\r\n`moltaroBoards.runtime.searchProviderUnavailable` error instead of partial rows or counts.", "nullable": true }, "BoardStatusIds": { "type": "array", "items": { "type": "string" }, "description": "Optional status ids that narrow the result.", "nullable": true }, "BoardTargetDefinitionIds": { "type": "array", "items": { "type": "string" }, "description": "Optional Board target definition ids that narrow the result.", "nullable": true }, "Responsibilities": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeResponsibilityFilterRequest" }, "description": "Optional responsibility filters.", "nullable": true }, "ActorScope": { "$ref": "#/components/schemas/BoardRuntimeActorScopeFilterRequest" }, "DueDate": { "$ref": "#/components/schemas/BoardRuntimeDueDateFilterRequest" }, "Tags": { "$ref": "#/components/schemas/BoardRuntimeTagFilterRequest" }, "ItemLinks": { "$ref": "#/components/schemas/BoardRuntimeItemLinkFilterRequest" }, "BoardData": { "$ref": "#/components/schemas/BoardRuntimeBoardDataQueryRequest" }, "DueDateSort": { "$ref": "#/components/schemas/BoardRuntimeDueDateSortRequest" }, "Limit": { "type": "integer", "description": "Optional page size.", "format": "int32", "nullable": true }, "Cursor": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchCursorRequest" }, "AttentionSignals": { "$ref": "#/components/schemas/BoardRuntimeAttentionSignalFilterRequest" }, "TargetData": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeTargetDataQueryRequest" }, "description": "Optional queries over target-owned data.", "nullable": true }, "CycleSelector": { "type": "string", "description": "Optional cycle selector.", "nullable": true } }, "additionalProperties": false, "description": "Searches readable board items across one or more statuses." }, "BoardRuntimeMoveLinkPrerequisite": { "type": "object", "properties": { "BoardTransitionLinkPrerequisiteId": { "type": "string", "nullable": true }, "LinkType": { "$ref": "#/components/schemas/BoardItemLinkTypeSystemKind" }, "Direction": { "$ref": "#/components/schemas/BoardItemLinkDirection" }, "TargetBoardId": { "type": "string", "nullable": true }, "TargetBoardTargetDefinitionId": { "type": "string", "nullable": true }, "MinimumCount": { "type": "integer", "format": "int32" }, "MaximumCount": { "type": "integer", "format": "int32", "nullable": true }, "CurrentCount": { "type": "integer", "format": "int32" }, "MissingCount": { "type": "integer", "format": "int32" }, "Satisfied": { "type": "boolean" } }, "additionalProperties": false, "description": "Current satisfaction state of one transition link prerequisite." }, "BoardRuntimeMoveOption": { "type": "object", "properties": { "BoardStatusId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Color": { "type": "string", "nullable": true }, "Allowed": { "type": "boolean" }, "BoardTransitionId": { "type": "string", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "CloseBlockers": { "$ref": "#/components/schemas/BoardRuntimeCloseBlockers" }, "LinkPrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeMoveLinkPrerequisite" }, "nullable": true } }, "additionalProperties": false, "description": "Dry-run move option for one target board status." }, "BoardRuntimeMoveOptions": { "type": "object", "properties": { "BoardItemId": { "type": "string", "nullable": true }, "FromBoardStatusId": { "type": "string", "nullable": true }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeMoveOption" }, "nullable": true } }, "additionalProperties": false, "description": "Available move options for one board item." }, "BoardRuntimeMoveOptionsResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeMoveOptions" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeMoveValidation": { "type": "object", "properties": { "Allowed": { "type": "boolean" }, "BoardItemId": { "type": "string", "nullable": true }, "FromBoardStatusId": { "type": "string", "nullable": true }, "ToBoardStatusId": { "type": "string", "nullable": true }, "BoardTransitionId": { "type": "string", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "CloseBlockers": { "$ref": "#/components/schemas/BoardRuntimeCloseBlockers" }, "CapturedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "ConstraintDecisions": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeConstraintDecision" }, "nullable": true }, "LinkPrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeMoveLinkPrerequisite" }, "nullable": true } }, "additionalProperties": false, "description": "Dry-run result for one board item move request." }, "BoardRuntimeMoveValidationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeMoveValidation" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeProcessActivityFeed": { "type": "object", "properties": { "BoardItemOwner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "CreateCommentPolicy": { "$ref": "#/components/schemas/CreateCommentPolicy" }, "ReadCommentPolicy": { "$ref": "#/components/schemas/ReadCommentPolicy" }, "CreateAttachmentPolicy": { "$ref": "#/components/schemas/CreateAttachmentPolicy" }, "ReadAttachmentPolicy": { "$ref": "#/components/schemas/ReadAttachmentPolicy" }, "Feed": { "$ref": "#/components/schemas/ActivityFeedPage" } }, "additionalProperties": false, "description": "Policy-aware process activity feed for one board item." }, "BoardRuntimeProcessActivityFeedResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeProcessActivityFeed" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeProcessAttachments": { "type": "object", "properties": { "AccessLevel": { "$ref": "#/components/schemas/BoardProcessContentAccessLevel" }, "Count": { "type": "integer", "format": "int32" }, "HasAttachments": { "type": "boolean" }, "CreatePolicy": { "$ref": "#/components/schemas/CreateAttachmentPolicy" }, "ReadPolicy": { "$ref": "#/components/schemas/ReadAttachmentPolicy" } }, "additionalProperties": false, "description": "Process attachments state for a board item." }, "BoardRuntimeProcessAttachmentsList": { "type": "object", "properties": { "BoardItemOwner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "CreatePolicy": { "$ref": "#/components/schemas/CreateAttachmentPolicy" }, "ReadPolicy": { "$ref": "#/components/schemas/ReadAttachmentPolicy" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/FileReferenceResourceItem" }, "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Policy-aware process attachments list for one board item." }, "BoardRuntimeProcessAttachmentsListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeProcessAttachmentsList" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeProcessCommentSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "CommentText": { "type": "string", "nullable": true }, "CreatedByUserId": { "type": "string", "nullable": true }, "CreatedByUserName": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Process content comment summary for a board item." }, "BoardRuntimeProcessComments": { "type": "object", "properties": { "AccessLevel": { "$ref": "#/components/schemas/BoardProcessContentAccessLevel" }, "Count": { "type": "integer", "format": "int32" }, "LastComment": { "$ref": "#/components/schemas/BoardRuntimeProcessCommentSummary" }, "CreatePolicy": { "$ref": "#/components/schemas/CreateCommentPolicy" }, "ReadPolicy": { "$ref": "#/components/schemas/ReadCommentPolicy" } }, "additionalProperties": false, "description": "Process comments state for a board item." }, "BoardRuntimeQuickView": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Icon": { "type": "string", "nullable": true }, "Filter": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchRequest" }, "SortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Server-provided operational quick view for one runtime board." }, "BoardRuntimeResponsibilityFilterRequest": { "type": "object", "properties": { "ResponsibilityKey": { "type": "string", "description": "Named Board Item responsibility, or null to match the union of all active Board Item responsibility definitions.", "nullable": true }, "SubjectType": { "$ref": "#/components/schemas/BoardResponsibilitySubjectType" }, "SubjectId": { "type": "string", "description": "Subject identity to match.", "nullable": true } }, "additionalProperties": false, "description": "Responsibility filter for board item search." }, "BoardRuntimeSavedFilter": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Filter": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchRequest" }, "IsFavorite": { "type": "boolean" }, "IsDefault": { "type": "boolean" }, "IsInvalid": { "type": "boolean" }, "InvalidReasons": { "type": "array", "items": { "type": "string" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" }, "CreatedAtUtc": { "type": "string", "format": "date-time" }, "UpdatedAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Personal runtime saved filter for one board operator." }, "BoardRuntimeSavedFilterResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeSavedFilter" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeStatus": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Color": { "type": "string", "nullable": true }, "MetaType": { "$ref": "#/components/schemas/BoardStatusMetaType" }, "SortOrder": { "type": "integer", "format": "int32" }, "OpenItemCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Runtime board status." }, "BoardRuntimeSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "TagsEnabled": { "type": "boolean" }, "DueDateEnabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Runtime board summary available to the caller." }, "BoardRuntimeSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeSummary" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardRuntimeTagFilterRequest": { "type": "object", "properties": { "TagIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Runtime process tag filter for board item search." }, "BoardRuntimeTarget": { "type": "object", "properties": { "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "TargetKind": { "$ref": "#/components/schemas/BoardTargetKind" }, "TargetModelId": { "type": "string", "nullable": true }, "TargetObjectId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Runtime target identity for a board item." }, "BoardRuntimeTargetCardProjection": { "type": "object", "properties": { "Number": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Subtitle": { "type": "string", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeCardProviderField" }, "nullable": true } }, "additionalProperties": false, "description": "Server-computed compact target projection for runtime board cards." }, "BoardRuntimeTargetCreateRequest": { "type": "object", "properties": { "Fields": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true }, "MarkdownAttachmentDraftSessionId": { "type": "string", "nullable": true }, "MutationIdempotencyKey": { "type": "string", "nullable": true }, "MarkdownAttachmentDestinationCreateNonce": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Entity target creation payload for runtime board item creation." }, "BoardRuntimeTargetDataQueryRequest": { "type": "object", "properties": { "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "Filter": { "$ref": "#/components/schemas/EntityInstanceQueryFilterGroupRequest" } }, "additionalProperties": false, "description": "Target entity query payload for board item search." }, "BoardRuntimeTargetDefinition": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "TargetKind": { "$ref": "#/components/schemas/BoardTargetKind" }, "TargetModelId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "DisplayNameSingular": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "CanAdd": { "type": "boolean" }, "CanMove": { "type": "boolean" }, "CommentAccessLevel": { "$ref": "#/components/schemas/BoardProcessContentAccessLevel" }, "AttachmentAccessLevel": { "$ref": "#/components/schemas/BoardProcessContentAccessLevel" }, "CreateCommentPolicy": { "$ref": "#/components/schemas/CreateCommentPolicy" }, "ReadCommentPolicy": { "$ref": "#/components/schemas/ReadCommentPolicy" }, "CreateAttachmentPolicy": { "$ref": "#/components/schemas/CreateAttachmentPolicy" }, "ReadAttachmentPolicy": { "$ref": "#/components/schemas/ReadAttachmentPolicy" }, "QueryOptions": { "$ref": "#/components/schemas/EntityInstanceQueryOptions" }, "InitialFieldMappings": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeInitialFieldMapping" }, "nullable": true } }, "additionalProperties": false, "description": "Runtime target definition configured for a board." }, "BoardRuntimeTransition": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "FromBoardStatusId": { "type": "string", "nullable": true }, "ToBoardStatusId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "CanUse": { "type": "boolean" } }, "additionalProperties": false, "description": "Runtime transition rule." }, "BoardRuntimeViewShell": { "type": "object", "properties": { "Board": { "$ref": "#/components/schemas/BoardRuntimeSummary" }, "Statuses": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeStatus" }, "nullable": true }, "Transitions": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeTransition" }, "nullable": true }, "EntityDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeEntityDefinition" }, "nullable": true }, "TargetDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeTargetDefinition" }, "nullable": true }, "DueDatePolicy": { "$ref": "#/components/schemas/BoardRuntimeDueDatePolicy" }, "BoardData": { "$ref": "#/components/schemas/BoardRuntimeBoardData" }, "BoardType": { "$ref": "#/components/schemas/BoardType" }, "CycleActivationMode": { "$ref": "#/components/schemas/BoardCycleActivationMode" }, "RequestedCycleSelector": { "type": "string", "description": "Normalized selector requested by the caller.", "nullable": true }, "ResolvedCycle": { "$ref": "#/components/schemas/BoardRuntimeItemCycleSummary" }, "DateCurrentCycle": { "$ref": "#/components/schemas/BoardRuntimeItemCycleSummary" }, "PreviousCycle": { "$ref": "#/components/schemas/BoardRuntimeItemCycleSummary" }, "NextCycle": { "$ref": "#/components/schemas/BoardRuntimeItemCycleSummary" }, "CycleWarnings": { "type": "array", "items": { "$ref": "#/components/schemas/BoardCycleWarningCode" }, "description": "Structured cycle warnings relevant to the selected shell scope.", "nullable": true }, "Actions": { "$ref": "#/components/schemas/BoardRuntimeViewShellActions" }, "ItemViewAvailability": { "$ref": "#/components/schemas/BoardRuntimeItemViewAvailability" }, "BoardItemResponsibilityDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResponsibilityDefinition" }, "description": "Enabled named responsibilities for Board Item resources.", "nullable": true }, "BoardStatusResponsibilityDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResponsibilityDefinition" }, "description": "Enabled named responsibilities for Board Status resources.", "nullable": true } }, "additionalProperties": false, "description": "Runtime board shell without card items." }, "BoardRuntimeViewShellActions": { "type": "object", "properties": { "CanManageCycles": { "type": "boolean" } }, "additionalProperties": false, "description": "Server-computed runtime shell actions." }, "BoardRuntimeViewShellResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardRuntimeViewShell" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BoardStatusMetaType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Initial", "Active", "Terminal" ], "x-enum-descriptions": { "0": "Newly added board items are placed in this status", "1": "Items in this status remain open and in active processing", "2": "Entering this status closes the item's current board presence" } }, "BoardTargetAddOption": { "type": "object", "properties": { "Board": { "$ref": "#/components/schemas/BoardRuntimeSummary" }, "TargetDefinition": { "$ref": "#/components/schemas/BoardRuntimeTargetDefinition" }, "Statuses": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeStatus" }, "nullable": true }, "CanAdd": { "type": "boolean" }, "DisabledReasonCode": { "type": "string", "nullable": true }, "ExistingOpenItem": { "$ref": "#/components/schemas/BoardTargetContextItem" }, "LatestClosedItem": { "$ref": "#/components/schemas/BoardTargetContextItem" }, "RepeatModes": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItemRepeatMode" }, "nullable": true } }, "additionalProperties": false, "description": "Server-computed add option for adding one target object to a board." }, "BoardTargetContextItem": { "type": "object", "properties": { "Board": { "$ref": "#/components/schemas/BoardRuntimeSummary" }, "Status": { "$ref": "#/components/schemas/BoardRuntimeStatus" }, "Item": { "$ref": "#/components/schemas/BoardRuntimeItem" } }, "additionalProperties": false, "description": "Board item linked to one Entity Instance context." }, "BoardTargetKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "EntityDefinition", "Entitlement", "Itself" ], "x-enum-descriptions": { "0": "The board item represents an instance of a Moltaro Entity Definition", "1": "Advanced Entitlement Operations target without full Runtime Board UI support; prefer EntityDefinition for normal operational boards", "2": "The board item is self-contained and has no external target object" } }, "BoardType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Kanban", "Cycle" ], "x-enum-descriptions": { "0": "The board uses Kanban behavior without cycle planning", "1": "The board scopes work into planned operating cycles" } }, "BooleanResponse": { "type": "object", "properties": { "Data": { "type": "boolean" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BusinessFunctionActionEnqueueResult": { "type": "object", "properties": { "JobId": { "type": "string", "description": "Queued job identifier.", "nullable": true }, "Job": { "$ref": "#/components/schemas/BusinessFunctionActionQueuedJob" }, "Validation": { "$ref": "#/components/schemas/BusinessFunctionActionInvocationValidation" } }, "additionalProperties": false, "description": "Public result returned after a business-function action is queued." }, "BusinessFunctionActionEnqueueResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionActionEnqueueResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BusinessFunctionActionExecution": { "type": "object", "properties": { "JobId": { "type": "string", "nullable": true }, "ActionId": { "type": "string", "nullable": true }, "TargetKey": { "type": "string", "nullable": true }, "BusinessFunctionId": { "type": "string", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityInstanceId": { "type": "string", "nullable": true }, "DeduplicationKey": { "type": "string", "nullable": true }, "NextRunAt": { "type": "string", "format": "date-time" }, "CreatedAt": { "type": "string", "format": "date-time" }, "ModifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "LastError": { "type": "string", "nullable": true }, "ResultData": { "type": "object", "nullable": true } }, "additionalProperties": false, "description": "Active queued or running action execution visible to the runtime UI." }, "BusinessFunctionActionExecutionListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionActionExecution" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BusinessFunctionActionInvocationValidation": { "type": "object", "properties": { "ActionId": { "type": "string", "description": "Designer-owned action identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Business function identifier resolved from the action.", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "description": "Published function version selected for execution.", "nullable": true }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "EntityDefinitionId": { "type": "string", "description": "Resolved entity definition identifier, when applicable.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Resolved entity instance identifier, when applicable.", "nullable": true }, "SelectedEntityInstanceIds": { "type": "array", "items": { "type": "string" }, "description": "Normalized selected entity instance identifiers.", "nullable": true }, "ValidationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionValidationError" }, "description": "Validation errors returned by the platform or function.", "nullable": true }, "IsValid": { "type": "boolean", "description": "Whether the invocation passed validation.", "readOnly": true } }, "additionalProperties": false, "description": "Public validation result for a business-function action invocation." }, "BusinessFunctionActionInvocationValidationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionActionInvocationValidation" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BusinessFunctionActionQueuedJob": { "type": "object", "properties": { "Id": { "type": "string", "description": "Queued job identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Queued business function identifier.", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "description": "Captured function version identifier.", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" }, "Source": { "type": "string", "description": "Execution source.", "nullable": true }, "DeduplicationKey": { "type": "string", "description": "Optional deduplication key.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Related entity definition identifier.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Related entity instance identifier.", "nullable": true }, "ActionId": { "type": "string", "description": "Action identifier.", "nullable": true }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "CreatedAt": { "type": "string", "description": "Timestamp when the job was queued.", "format": "date-time" }, "NextRunAt": { "type": "string", "description": "Next eligible execution timestamp.", "format": "date-time" }, "LastError": { "type": "string", "description": "Last execution error summary.", "nullable": true } }, "additionalProperties": false, "description": "Public snapshot of a queued business-function action job." }, "BusinessFunctionActionTargetScope": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Global", "EntityInstance", "EntitySelection", "EntityCollection" ], "x-enum-descriptions": { "0": "Run the action at workspace level without any entity record context", "1": "Run the action against a single entity record", "2": "Run the action against the set of records the user has selected", "3": "Run the action against the entire record collection of the entity definition" } }, "BusinessFunctionApiJobRun": { "type": "object", "properties": { "RunId": { "type": "string", "description": "Function run identifier.", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionRunStatus" }, "StartedAt": { "type": "string", "description": "Run start timestamp.", "format": "date-time" }, "CompletedAt": { "type": "string", "description": "Run completion timestamp.", "format": "date-time", "nullable": true }, "DurationMs": { "type": "integer", "description": "Run duration in milliseconds.", "format": "int64", "nullable": true }, "ResultSummary": { "type": "string", "description": "Bounded result summary.", "nullable": true }, "ResultData": { "type": "object", "description": "Structured JSON result payload.", "nullable": true }, "ErrorSummary": { "type": "string", "description": "Bounded error summary.", "nullable": true } }, "additionalProperties": false, "description": "Latest execution of a job enqueued through the functions API." }, "BusinessFunctionApiJobStatus": { "type": "object", "properties": { "JobId": { "type": "string", "description": "Queued job identifier.", "nullable": true }, "FunctionKey": { "type": "string", "description": "Callable key of the enqueued function.", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" }, "CreatedAt": { "type": "string", "description": "Enqueue timestamp.", "format": "date-time" }, "NextRunAt": { "type": "string", "description": "Earliest execution timestamp.", "format": "date-time", "nullable": true }, "AttemptCount": { "type": "integer", "description": "Execution attempts so far.", "format": "int32" }, "DeduplicationKey": { "type": "string", "description": "Deduplication key of the job, when supplied.", "nullable": true }, "CorrelationId": { "type": "string", "description": "Correlation identifier of the job, when supplied.", "nullable": true }, "LastError": { "type": "string", "description": "Bounded last execution error summary.", "nullable": true }, "TimeoutSeconds": { "type": "integer", "description": "Optional execution timeout captured on the job and preserved across retries.", "format": "int32", "nullable": true }, "CanCancel": { "type": "boolean", "description": "Whether the job can still be cancelled." }, "Run": { "$ref": "#/components/schemas/BusinessFunctionApiJobRun" } }, "additionalProperties": false, "description": "Status of a job enqueued through the functions API." }, "BusinessFunctionApiJobStatusResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionApiJobStatus" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BusinessFunctionCommandResult": { "type": "object", "properties": { "RunId": { "type": "string", "description": "Persisted function run identifier.", "nullable": true }, "Message": { "type": "string", "description": "Optional result summary produced by the command.", "nullable": true }, "Result": { "type": "object", "description": "Structured JSON result payload produced by the command.", "nullable": true }, "DurationMs": { "type": "integer", "description": "Execution duration in milliseconds.", "format": "int64", "nullable": true }, "CorrelationId": { "type": "string", "description": "Correlation identifier of the run.", "nullable": true } }, "additionalProperties": false, "description": "Result of a synchronous command function invocation." }, "BusinessFunctionCommandResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionCommandResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BusinessFunctionJobStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Queued", "Leased", "Completed", "Failed", "Cancelled" ], "x-enum-descriptions": { "0": "Job is waiting in the queue for a worker to pick it up", "1": "Job has been claimed by a worker under an active lease", "2": "Job finished executing successfully", "3": "Job execution finished with an error", "4": "Job was cancelled before it could complete" } }, "BusinessFunctionRunStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Success", "ValidationFailure", "PermissionFailure", "Timeout", "RuntimeException", "Cancelled", "Running", "Skipped", "StoppedByWorkerRestart" ], "x-enum-descriptions": { "0": "The function run finished successfully", "1": "The function returned validation issues that rejected the operation", "2": "The run was refused because the actor or function lacked a required permission or capability", "3": "The run was aborted because it exceeded its allowed execution time", "4": "The run ended with an unhandled exception thrown by the function code", "5": "The run was cancelled before it completed", "6": "The run is currently executing and has no final outcome yet", "7": "The function chose not to act for this invocation and made no changes", "8": "The run was interrupted because the worker host restarted while it was executing" } }, "BusinessFunctionRuntimeAction": { "type": "object", "properties": { "ActionId": { "type": "string", "nullable": true }, "BusinessFunctionId": { "type": "string", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "nullable": true }, "OperationKey": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "Surface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "Placement": { "$ref": "#/components/schemas/ActionPlacement" }, "ToolbarPresentation": { "$ref": "#/components/schemas/EntityUiActionToolbarPresentation" }, "SortOrder": { "type": "integer", "format": "int32" }, "Label": { "type": "string", "nullable": true }, "Icon": { "type": "string", "nullable": true }, "Color": { "type": "string", "nullable": true }, "Variant": { "type": "string", "nullable": true }, "PermissionKey": { "type": "string", "nullable": true }, "HasInput": { "type": "boolean" }, "InputSchemaPayload": { "type": "string", "nullable": true }, "InputFormPayload": { "type": "string", "nullable": true }, "InputCardPayload": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Runtime action exposed on one supported entity UI surface. Input schema payloads include versioned\r\nnullability and typed Boolean or Select defaults when authored by the current Package SDK." }, "BusinessFunctionRuntimeActionListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionRuntimeAction" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BusinessFunctionRuntimeActionResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionRuntimeAction" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BusinessFunctionValidationError": { "type": "object", "properties": { "FieldKey": { "type": "string", "description": "Optional entity field key targeted by the error.", "nullable": true }, "Message": { "type": "string", "description": "User-facing validation message.", "nullable": true }, "Code": { "type": "string", "description": "Optional stable validation code.", "nullable": true } }, "additionalProperties": false, "description": "Structured validation error emitted by a Validation business function." }, "BusinessInvariantObjectState": { "type": "object", "properties": { "InvariantKey": { "type": "string", "description": "Stable invariant key.", "nullable": true }, "TargetKey": { "type": "string", "description": "Stable target key within the invariant.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether the invariant is active for the current resource state." }, "SafeMessage": { "type": "string", "description": "Localized safe active-state message, or null when inactive.", "nullable": true } }, "additionalProperties": false, "description": "Current safe state of one Business Invariant target for one resource." }, "CardFieldRenderer": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Default", "Text", "LongText", "Numeric", "Date", "DateTime", "Time", "BoolText", "BoolIcon", "SelectChip", "SelectText", "Reference", "ObjectContextFact" ], "x-enum-descriptions": { "0": "Use the renderer inferred from the field type", "1": "Render the value as short single-line text", "2": "Render the value as multi-line long text", "3": "Render the value as a formatted number", "4": "Render the value as a date without time", "5": "Render the value as a date with time", "6": "Render the value as a time of day", "7": "Render the Boolean value as yes/no text", "8": "Render the Boolean value as an icon", "9": "Render the select option as a chip", "10": "Render the select option as plain text", "11": "Render the referenced record presentation value", "12": "Render a module-provided context fact about the record" } }, "ChangeWorkspaceAccountPasswordRequest": { "type": "object", "properties": { "CurrentPassword": { "type": "string", "description": "Current password.", "nullable": true }, "NewPassword": { "type": "string", "description": "New password.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to change the authenticated workspace account password." }, "ChangeWorkspaceAccountPasswordResponse": { "type": "object", "properties": { "PasswordChanged": { "type": "boolean", "description": "Whether the password was changed." } }, "additionalProperties": false, "description": "Result of a workspace account password change." }, "ChangeWorkspaceAccountPasswordResponseEnvelope": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ChangeWorkspaceAccountPasswordResponse" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Comment": { "type": "object", "properties": { "Id": { "type": "string", "description": "Comment identifier.", "nullable": true }, "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "CommentText": { "type": "string", "description": "Comment text.", "nullable": true }, "DetectedLanguage": { "type": "string", "description": "Detected language for search.", "nullable": true }, "ParentCommentId": { "type": "string", "description": "Optional parent comment identifier.", "nullable": true }, "Relations": { "type": "array", "items": { "$ref": "#/components/schemas/MoltaroResourceRelation" }, "description": "Resource relations attached to the comment.", "nullable": true }, "Origin": { "$ref": "#/components/schemas/MoltaroResourceOrigin" }, "CreatedByUserId": { "type": "string", "description": "Creator user identifier.", "nullable": true }, "CreatedByUserName": { "type": "string", "description": "Creator display name.", "nullable": true }, "ModifiedByUserId": { "type": "string", "description": "Last modifier user identifier.", "nullable": true }, "ModifiedByUserName": { "type": "string", "description": "Last modifier display name.", "nullable": true }, "EditDeadline": { "type": "string", "description": "Edit deadline timestamp.", "format": "date-time", "nullable": true }, "IsEdited": { "type": "boolean", "description": "Whether the comment has been edited." }, "ReplyCount": { "type": "integer", "description": "Number of replies.", "format": "int32" }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "ModifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time", "nullable": true }, "IsDeleted": { "type": "boolean", "description": "Whether the comment is soft deleted." }, "RowVersion": { "type": "string", "description": "Deterministic concurrency token for comment mutations.", "format": "uuid" }, "Permissions": { "$ref": "#/components/schemas/CommentPermissions" } }, "additionalProperties": false, "description": "Comment details." }, "CommentMutationResult": { "type": "object", "additionalProperties": false }, "CommentMutationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/CommentMutationResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CommentPermissions": { "type": "object", "properties": { "CanView": { "type": "boolean", "description": "Whether the comment can be viewed." }, "CanEdit": { "type": "boolean", "description": "Whether the comment can be edited." }, "CanDelete": { "type": "boolean", "description": "Whether the comment can be deleted." }, "CanReply": { "type": "boolean", "description": "Whether a reply can be created." } }, "additionalProperties": false, "description": "Permissions for a comment evaluated for the current user." }, "CommentResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Comment" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ConsumeEntitlementQuantityRequest": { "type": "object", "properties": { "EntitlementLimitId": { "type": "string", "description": "Optional selected issued limit id. Required when multiple quantity limits exist.", "nullable": true }, "LimitFamily": { "$ref": "#/components/schemas/EntitlementLimitFamily" }, "Quantity": { "type": "number", "description": "Positive amount to consume.", "format": "double" }, "RowVersion": { "type": "string", "description": "Optional concurrency token from the latest entitlement limit detail.", "format": "uuid", "nullable": true }, "ReasonCode": { "type": "string", "description": "Optional structured reason for support and audit review.", "nullable": true }, "ReasonText": { "type": "string", "description": "Optional free-form reason for support and audit review.", "nullable": true }, "IdempotencyKey": { "type": "string", "description": "Optional key that prevents repeating the same consume command.", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "description": "Nullable JSON or text metadata for the source command.", "nullable": true } }, "additionalProperties": false, "description": "Consume a positive quantity from one issued entitlement limit." }, "CorrelatedProblemDetails": { "required": [ "correlationId" ], "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "correlationId": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "CreateAttachmentPolicy": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "BoardOnly", "RelatedToTarget", "TargetOnly" ], "x-enum-descriptions": { "0": "New attachments are owned only by the board item", "1": "New attachments are owned by the board item and related to the target resource", "2": "New attachments are owned by the target resource, with board context stored only as technical origin" } }, "CreateBoardItemLinkRequest": { "type": "object", "properties": { "LinkType": { "$ref": "#/components/schemas/BoardItemLinkTypeSystemKind" }, "Direction": { "$ref": "#/components/schemas/BoardItemLinkDirection" }, "OtherBoardItemId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Request to create an active board item link." }, "CreateBoardProcessCommentRequest": { "type": "object", "properties": { "CommentText": { "type": "string", "nullable": true }, "ParentCommentId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Create a process comment through board runtime policy." }, "CreateBoardProcessManagedUploadRequest": { "type": "object", "properties": { "RequestedFileName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "DeclaredMimeType": { "type": "string", "nullable": true }, "DeclaredSizeBytes": { "type": "integer", "format": "int64" }, "ClientDeclaredSha256": { "type": "string", "nullable": true }, "IdempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Create a managed multipart process attachment through board runtime policy." }, "CreateBoardRuntimeCycleRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Cycle name.", "nullable": true }, "Description": { "type": "string", "description": "Optional cycle description.", "nullable": true }, "StartDate": { "type": "string", "description": "Inclusive workspace-local start date.", "format": "date", "nullable": true }, "EndDate": { "type": "string", "description": "Inclusive workspace-local end date.", "format": "date", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order inside the board.", "format": "int32" } }, "additionalProperties": false, "description": "Create a planned runtime board cycle." }, "CreateBoardRuntimeItemRequest": { "type": "object", "properties": { "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "TargetCreate": { "$ref": "#/components/schemas/BoardRuntimeTargetCreateRequest" }, "BoardData": { "$ref": "#/components/schemas/BoardRuntimeCreateBoardDataRequest" } }, "additionalProperties": false, "description": "Request to create a target and board item atomically from the runtime board screen." }, "CreateBoardRuntimeSavedFilterRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Filter": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchRequest" }, "IsFavorite": { "type": "boolean" }, "IsDefault": { "type": "boolean" } }, "additionalProperties": false, "description": "Create a personal runtime saved filter." }, "CreateCommentPolicy": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "BoardOnly", "RelatedToTarget", "TargetOnly" ], "x-enum-descriptions": { "0": "New comments are owned only by the board item", "1": "New comments are owned by the board item and related to the target resource", "2": "New comments are owned by the target resource, with board context stored only as technical origin" } }, "CreateCommentRequest": { "type": "object", "properties": { "CommentText": { "type": "string", "description": "Comment text.", "nullable": true }, "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "ParentCommentId": { "type": "string", "description": "Optional parent comment identifier.", "nullable": true }, "Relations": { "type": "array", "items": { "$ref": "#/components/schemas/MoltaroResourceRelationRequest" }, "description": "Optional resource relations attached to the comment.", "nullable": true }, "Origin": { "$ref": "#/components/schemas/MoltaroResourceOriginRequest" }, "OperationKey": { "type": "string", "description": "Caller-owned idempotency key. Required for Core Entity mutations.", "format": "uuid" } }, "additionalProperties": false, "description": "Request payload to create a comment." }, "CreateManagedFileUploadRequest": { "type": "object", "properties": { "TargetFolderId": { "type": "string", "nullable": true }, "RequestedFileName": { "type": "string", "nullable": true }, "DeclaredMimeType": { "type": "string", "nullable": true }, "DeclaredSizeBytes": { "type": "integer", "format": "int64" }, "ClientDeclaredSha256": { "type": "string", "nullable": true }, "IdempotencyKey": { "type": "string", "nullable": true }, "OwnerModuleKey": { "type": "string", "nullable": true }, "OwnerResourceKind": { "type": "string", "nullable": true }, "OwnerContextResourceId": { "type": "string", "nullable": true }, "OwnerResourceObjectId": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Request to create an S3-backed managed FileSystem upload." }, "CreateTagRequest": { "type": "object", "properties": { "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "TagName": { "type": "string", "description": "Tag name.", "nullable": true }, "Color": { "type": "string", "description": "Optional color value.", "nullable": true }, "Category": { "type": "string", "description": "Optional category.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create a tag." }, "DeleteAttachmentRequest": { "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "RowVersion": { "type": "string", "format": "uuid" }, "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" } }, "additionalProperties": false }, "DeleteBoardRuntimeCycleRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Optional optimistic concurrency token.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Hard-delete request for a runtime board cycle." }, "DeleteCommentRequest": { "type": "object", "properties": { "OperationKey": { "type": "string", "description": "Caller-owned idempotency key.", "format": "uuid" }, "RowVersion": { "type": "string", "description": "Expected comment row version.", "format": "uuid" }, "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" } }, "additionalProperties": false, "description": "Request payload to delete a Core Entity comment." }, "EligibleResponsibilityTarget": { "type": "object", "properties": { "SubjectType": { "type": "string", "nullable": true }, "SubjectId": { "type": "string", "nullable": true }, "Display": { "type": "string", "nullable": true }, "Eligible": { "type": "boolean" }, "ReasonCodes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Describes one eligible responsibility target." }, "EligibleResponsibilityTargetQueryRequest": { "type": "object", "properties": { "Resource": { "$ref": "#/components/schemas/SecurityResourceSelector" }, "ResponsibilityKey": { "type": "string", "nullable": true }, "Action": { "type": "string", "nullable": true }, "Search": { "type": "string", "nullable": true }, "Cursor": { "type": "string", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Queries eligible responsibility targets." }, "EnqueueBusinessFunctionApiJobRequest": { "type": "object", "properties": { "Args": { "type": "object", "description": "Optional JSON arguments deserialized into the function argument type.", "nullable": true }, "DeduplicationKey": { "type": "string", "description": "Optional deduplication key that reuses an active queued job.", "nullable": true }, "RunAfter": { "type": "string", "description": "Optional earliest execution timestamp.", "format": "date-time", "nullable": true }, "CorrelationId": { "type": "string", "description": "Optional correlation identifier propagated to the queued job.", "nullable": true } }, "additionalProperties": false, "description": "Request payload for enqueueing a published global function through the functions API." }, "EntitlementBeneficiary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "BeneficiaryPartyRoleId": { "type": "string", "nullable": true }, "BeneficiaryPartyRoleDisplayName": { "type": "string", "nullable": true }, "Beneficiary": { "$ref": "#/components/schemas/EntitlementEntityReference" }, "SortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Issued beneficiary snapshot shown on entitlement detail." }, "EntitlementBoardContext": { "type": "object", "properties": { "EntitlementId": { "type": "string", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetContextItem" }, "nullable": true }, "AddOptions": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetAddOption" }, "nullable": true } }, "additionalProperties": false, "description": "Object-centric Boards context for one Entitlement." }, "EntitlementBoardContextResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementBoardContext" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntitlementDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable entitlement identifier.", "nullable": true }, "EntitlementNumber": { "type": "integer", "description": "Human-readable entitlement number used for support, audit review, and external references.", "format": "int64" }, "EntitlementModelId": { "type": "string", "description": "Entitlement model that owns the issued entitlement.", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "description": "Display name of the owning entitlement model.", "nullable": true }, "ModelType": { "$ref": "#/components/schemas/EntitlementModelType" }, "EntitlementPlanId": { "type": "string", "description": "Plan snapshot used to issue the entitlement.", "nullable": true }, "EntitlementPlanDisplayName": { "type": "string", "description": "Display name of the issued plan.", "nullable": true }, "EntitlementPlanDescription": { "type": "string", "description": "Optional plan description captured for detail display.", "nullable": true }, "Owner": { "$ref": "#/components/schemas/EntitlementEntityReference" }, "Status": { "$ref": "#/components/schemas/EntitlementStatus" }, "EffectiveState": { "$ref": "#/components/schemas/EntitlementEffectiveState" }, "StartsAtUtc": { "type": "string", "description": "UTC instant when the entitlement becomes effective.", "format": "date-time" }, "EndsAtUtc": { "type": "string", "description": "Optional UTC instant when the entitlement period ends.", "format": "date-time", "nullable": true }, "GraceUntilUtc": { "type": "string", "description": "Optional UTC instant when the grace window ends.", "format": "date-time", "nullable": true }, "IssuedAtUtc": { "type": "string", "description": "UTC instant when the entitlement was issued.", "format": "date-time" }, "IssuedByUserId": { "type": "string", "description": "User id that issued the entitlement when available.", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "description": "Optional source metadata captured with the issuing command.", "nullable": true }, "IssuedTermsTextSnapshot": { "type": "string", "description": "Terms text captured at issue time when the plan uses issued terms.", "nullable": true }, "IssuedTermsCapturedAtUtc": { "type": "string", "description": "UTC instant when issued terms were captured.", "format": "date-time", "nullable": true }, "Periods": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPeriod" }, "description": "Issued period history for the entitlement.", "nullable": true }, "Limits": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementLimit" }, "description": "Issued quantity or usage limits.", "nullable": true }, "QuantityLedger": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementQuantityLedgerEntry" }, "description": "Recent quantity ledger rows shown on the detail response.", "nullable": true }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementResource" }, "description": "Covered resources attached to the entitlement.", "nullable": true }, "Beneficiaries": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementBeneficiary" }, "description": "Explicit beneficiaries attached to the entitlement.", "nullable": true }, "RenewalPolicyIdSnapshot": { "type": "string", "description": "Renewal policy id captured from the plan at issue time.", "nullable": true }, "RenewalPolicyKeySnapshot": { "type": "string", "description": "Renewal policy key captured from the plan at issue time.", "nullable": true }, "RenewalModeSnapshot": { "$ref": "#/components/schemas/EntitlementRenewalMode" }, "RenewalLeadDaysSnapshot": { "type": "integer", "description": "Lead time captured from the renewal policy at issue time.", "format": "int32", "nullable": true }, "RenewalExternalPolicyKeySnapshot": { "type": "string", "description": "External renewal policy key captured at issue time.", "nullable": true }, "ObjectInvariant": { "$ref": "#/components/schemas/ObjectInvariant" }, "RowVersion": { "type": "string", "description": "Optimistic concurrency token for entitlement mutations.", "format": "uuid" } }, "additionalProperties": false, "description": "Runtime entitlement detail response returned after reads, grants, renewals, lifecycle actions, and quantity operations." }, "EntitlementDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementDetail" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntitlementEffectiveState": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 8 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Pending", "Active", "Grace", "Suspended", "Cancelled", "Expired", "Revoked", "Blocked" ], "x-enum-descriptions": { "0": "Coverage start is still in the future, so the entitlement does not grant access yet", "1": "The entitlement is inside a current coverage window and grants access", "2": "Coverage has ended but the configured grace window still grants access", "3": "A suspend command paused access without changing periods or limits until the entitlement is resumed", "4": "The entitlement was cancelled and no longer grants access", "5": "All coverage windows and any grace have ended, so access is no longer granted", "6": "A revoke command permanently withdrew access before natural expiry", "8": "Access is administratively blocked regardless of coverage timestamps" } }, "EntitlementEntityReference": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityDisplayName": { "type": "string", "nullable": true }, "EntityInstanceId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Compact customer-owned entity instance reference." }, "EntitlementLedgerActor": { "type": "object", "properties": { "Id": { "type": "string", "description": "User identifier or stable external actor identifier stored on the ledger row.", "nullable": true }, "DisplayName": { "type": "string", "description": "Display name resolved from the workspace security cache when available.", "nullable": true }, "Email": { "type": "string", "description": "User email when available.", "nullable": true }, "AvatarInitials": { "type": "string", "description": "Avatar initials.", "nullable": true }, "AvatarBackgroundColor": { "type": "string", "description": "Avatar background color.", "nullable": true }, "AvatarTextColor": { "type": "string", "description": "Avatar text color.", "nullable": true }, "UserType": { "$ref": "#/components/schemas/UserType" }, "IsDeleted": { "type": "boolean", "description": "Whether the resolved workspace user has been deleted." }, "IsMissing": { "type": "boolean", "description": "Whether the stored actor identifier no longer resolves to a workspace user." } }, "additionalProperties": false, "description": "Resolved user or actor display reference for entitlement ledger audit rows." }, "EntitlementLedgerEntryDetail": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntitlementId": { "type": "string", "nullable": true }, "EntitlementNumber": { "type": "integer", "format": "int64" }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "EntitlementPlanId": { "type": "string", "nullable": true }, "EntitlementPlanDisplayName": { "type": "string", "nullable": true }, "Owner": { "$ref": "#/components/schemas/EntitlementEntityReference" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementResource" }, "nullable": true }, "Operation": { "$ref": "#/components/schemas/EntitlementLedgerOperation" }, "EntitlementStatus": { "$ref": "#/components/schemas/EntitlementStatus" }, "EntitlementEffectiveState": { "$ref": "#/components/schemas/EntitlementEffectiveState" }, "Quantity": { "type": "number", "format": "double" }, "BalanceAfter": { "type": "number", "format": "double", "nullable": true }, "EntitlementLimitId": { "type": "string", "nullable": true }, "ReversesLedgerEntryId": { "type": "string", "nullable": true }, "RenewalOperationId": { "type": "string", "nullable": true }, "ReasonCode": { "type": "string", "nullable": true }, "ReasonText": { "type": "string", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "nullable": true }, "ActorUserId": { "type": "string", "nullable": true }, "Actor": { "$ref": "#/components/schemas/EntitlementLedgerActor" }, "OccurredAtUtc": { "type": "string", "format": "date-time" }, "CorrelationId": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Ledger detail row with resource context." }, "EntitlementLedgerEntryDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementLedgerEntryDetail" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntitlementLedgerEntrySummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntitlementId": { "type": "string", "nullable": true }, "EntitlementNumber": { "type": "integer", "format": "int64" }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "EntitlementPlanId": { "type": "string", "nullable": true }, "EntitlementPlanDisplayName": { "type": "string", "nullable": true }, "Owner": { "$ref": "#/components/schemas/EntitlementEntityReference" }, "Operation": { "$ref": "#/components/schemas/EntitlementLedgerOperation" }, "EntitlementStatus": { "$ref": "#/components/schemas/EntitlementStatus" }, "EntitlementEffectiveState": { "$ref": "#/components/schemas/EntitlementEffectiveState" }, "Quantity": { "type": "number", "format": "double" }, "BalanceAfter": { "type": "number", "format": "double", "nullable": true }, "EntitlementLimitId": { "type": "string", "nullable": true }, "ReversesLedgerEntryId": { "type": "string", "nullable": true }, "RenewalOperationId": { "type": "string", "nullable": true }, "ReasonCode": { "type": "string", "nullable": true }, "ReasonText": { "type": "string", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "nullable": true }, "ActorUserId": { "type": "string", "nullable": true }, "Actor": { "$ref": "#/components/schemas/EntitlementLedgerActor" }, "OccurredAtUtc": { "type": "string", "format": "date-time" }, "CorrelationId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Compact ledger row for operational lists, detail drawers, and workflow references." }, "EntitlementLedgerExport": { "type": "object", "properties": { "Content": { "type": "string", "format": "byte", "nullable": true }, "FileName": { "type": "string", "nullable": true }, "ContentType": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "CSV export payload for ledger rows." }, "EntitlementLedgerExportResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementLedgerExport" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntitlementLedgerList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementLedgerEntrySummary" }, "description": "Ledger rows in the requested page.", "nullable": true }, "TotalCount": { "type": "integer", "description": "Total number of matching ledger rows before pagination.", "format": "int32" }, "Page": { "type": "integer", "description": "One-based page number returned by the query.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Page size applied by the query.", "format": "int32" } }, "additionalProperties": false, "description": "Paginated ledger response for entitlement lifecycle, renewal, and quantity history." }, "EntitlementLedgerListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementLedgerList" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntitlementLedgerOperation": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Grant", "Consume", "Reverse", "Adjust", "Revoke", "Expire", "Renew", "Suspend", "Resume" ], "x-enum-descriptions": { "0": "Records the initial issue of an entitlement with its first period and limit snapshots", "1": "Records a positive quantity drawn from a consumable or time-bound quantity limit", "2": "Records the correction of a concrete prior consume entry, returning up to its unreversed amount", "3": "Records an administrative correction that sets the absolute consumed balance, storing the delta as the entry quantity", "4": "Records that access was permanently withdrawn and open or planned periods were marked revoked", "5": "Records that current and future coverage was ended at command time and the entitlement became expired", "6": "Records the creation of the next entitlement period with fresh limit snapshots from current plan terms", "7": "Records that access was paused from pending activation or active state", "8": "Records that a suspended entitlement was reactivated and its state recomputed from periods and the current time" } }, "EntitlementLifecycleActionRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Optional concurrency token from the latest entitlement detail.", "format": "uuid", "nullable": true }, "ReasonCode": { "type": "string", "description": "Optional structured reason for support and audit review.", "nullable": true }, "ReasonText": { "type": "string", "description": "Optional free-form reason for support and audit review.", "nullable": true }, "IdempotencyKey": { "type": "string", "description": "Optional key that prevents repeating the same lifecycle command.", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "description": "Nullable JSON or text metadata for the source command.", "nullable": true } }, "additionalProperties": false, "description": "Apply one administrative lifecycle action to an existing entitlement." }, "EntitlementLimit": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "LimitFamily": { "$ref": "#/components/schemas/EntitlementLimitFamily" }, "GrantedAmount": { "type": "number", "format": "double", "nullable": true }, "AvailableAmount": { "type": "number", "format": "double", "nullable": true }, "StartsAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "EndsAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "GraceUntilUtc": { "type": "string", "format": "date-time", "nullable": true }, "ConsumedAmountSnapshot": { "type": "number", "format": "double" }, "IsActive": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Issued limit snapshot shown on entitlement detail." }, "EntitlementLimitFamily": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Duration", "ConsumableQuantity", "TimeBoundQuantity", "CoveredPartyCount" ], "x-enum-descriptions": { "0": "Limits validity to a term measured from the grant moment, optionally extended by a grace period", "1": "Grants a fixed numeric allowance where the consuming operation defines what one unit means", "2": "Grants a fixed numeric allowance inside a repeating time window anchored to the grant moment or calendar periods", "3": "Caps how many explicit covered parties a delegated explicit organization or family grant may include" } }, "EntitlementList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementSummary" }, "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Paginated runtime entitlement list response." }, "EntitlementListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementList" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntitlementModelAccessMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Direct", "DelegatedImplicit", "DelegatedExplicit" ], "x-enum-descriptions": { "0": "The owner party receives access to the covered resources without any delegation", "1": "The owner grant automatically covers related delegate parties resolved on demand through the configured relationship path", "2": "The owner grant creates a pool of rights that only explicitly assigned delegate parties receive" } }, "EntitlementModelType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "SoftwareLicense", "Membership", "InformationServiceAccess", "Warranty" ], "x-enum-descriptions": { "0": "Grants license-like access to a software product or feature set using plan-selected resources and duration terms", "1": "Grants membership in a concrete community, group, or organization resource with duration terms and no resource hierarchy", "2": "Grants access to information services and content-like resources where duration and quantity usage limits apply", "3": "Grants warranty coverage for a sold, delivered, or serviced customer-owned resource selected at grant time" } }, "EntitlementPartyType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Person", "Organization", "Family" ], "x-enum-descriptions": { "0": "A single person receives the entitlement directly, so the model requires direct access without delegation", "1": "An organization owns the entitlement and delegates access to related people or records through a configured path", "2": "A family owns the entitlement and delegates access to related family members through a configured path" } }, "EntitlementPeriod": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "PeriodNumber": { "type": "integer", "format": "int32" }, "StartsAtUtc": { "type": "string", "format": "date-time" }, "EndsAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "GraceUntilUtc": { "type": "string", "format": "date-time", "nullable": true }, "Status": { "$ref": "#/components/schemas/EntitlementPeriodStatus" } }, "additionalProperties": false, "description": "Issued period snapshot shown on entitlement detail." }, "EntitlementPeriodStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Planned", "Active", "Grace", "Completed", "Cancelled", "Revoked" ], "x-enum-descriptions": { "0": "The period has not started yet and does not grant access", "1": "The period is inside its coverage window and grants access", "2": "The period coverage has ended but its grace window still grants access", "3": "The period and any grace window ended naturally and no longer grant access", "4": "The period was cancelled before completion and no longer counts toward coverage", "5": "A revoke command closed the period before its natural end" } }, "EntitlementPlanTermKind": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "OneTime", "Duration", "TimeBound", "Custom" ], "x-enum-descriptions": { "0": "Derived when the only active condition family is a consumable quantity allowance", "1": "Derived when the only active condition family is a validity term from the grant moment", "2": "Derived when the only active condition family is a quantity inside a repeating time window", "3": "Derived when active conditions mix families or match no single recognized shape" } }, "EntitlementQuantityLedgerEntry": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntitlementLimitId": { "type": "string", "nullable": true }, "Operation": { "$ref": "#/components/schemas/EntitlementLedgerOperation" }, "Quantity": { "type": "number", "format": "double" }, "BalanceAfter": { "type": "number", "format": "double", "nullable": true }, "ReversesLedgerEntryId": { "type": "string", "nullable": true }, "ReversibleQuantity": { "type": "number", "format": "double" }, "ReasonCode": { "type": "string", "nullable": true }, "ReasonText": { "type": "string", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "nullable": true }, "ActorUserId": { "type": "string", "nullable": true }, "OccurredAtUtc": { "type": "string", "format": "date-time" }, "CorrelationId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Compact quantity ledger row shown on entitlement detail." }, "EntitlementRenewalMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Disabled", "ManualReview", "External" ], "x-enum-descriptions": { "0": "No renewal workflow is created and no lead time or external policy key is stored", "1": "The worker opens a manual review renewal operation when the active period enters the configured lead window", "2": "A trusted external system decides when to renew using the stored external policy key" } }, "EntitlementRenewalOperationCancelRequest": { "type": "object", "properties": { "ReasonText": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Cancel one renewal workflow operation." }, "EntitlementRenewalOperationCreateRequest": { "type": "object", "properties": { "EntitlementId": { "type": "string", "nullable": true }, "OperationKind": { "$ref": "#/components/schemas/EntitlementRenewalOperationKind" }, "InitialStatus": { "$ref": "#/components/schemas/EntitlementRenewalOperationStatus" }, "DueAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "EntitlementPeriodId": { "type": "string", "nullable": true }, "FailureCode": { "type": "string", "nullable": true }, "FailureMessage": { "type": "string", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "nullable": true }, "ExternalReference": { "type": "string", "nullable": true }, "EntitlementNumber": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false, "description": "Create one renewal workflow operation." }, "EntitlementRenewalOperationDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable renewal operation identifier.", "nullable": true }, "EntitlementId": { "type": "string", "description": "Entitlement targeted by the renewal operation.", "nullable": true }, "EntitlementNumber": { "type": "integer", "description": "Human-readable entitlement number for support and external references.", "format": "int64" }, "EntitlementPlanId": { "type": "string", "description": "Plan associated with the targeted entitlement.", "nullable": true }, "EntitlementPlanDisplayName": { "type": "string", "description": "Display name of the associated plan.", "nullable": true }, "EntitlementModelId": { "type": "string", "description": "Entitlement model that owns the targeted entitlement.", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "description": "Display name of the owning entitlement model.", "nullable": true }, "EntitlementPeriodId": { "type": "string", "description": "Entitlement period that caused or receives the renewal operation when available.", "nullable": true }, "RenewalPolicyId": { "type": "string", "description": "Renewal policy snapshot used by the operation when available.", "nullable": true }, "RenewalPolicyKey": { "type": "string", "description": "Business key of the renewal policy when available.", "nullable": true }, "OperationKind": { "$ref": "#/components/schemas/EntitlementRenewalOperationKind" }, "DueAtUtc": { "type": "string", "description": "UTC instant when the renewal operation is due.", "format": "date-time" }, "Status": { "$ref": "#/components/schemas/EntitlementRenewalOperationStatus" }, "CompletedAtUtc": { "type": "string", "description": "UTC instant when the operation completed successfully.", "format": "date-time", "nullable": true }, "CompletedByUserId": { "type": "string", "description": "User id that completed the operation when it was user-driven.", "nullable": true }, "ExternalReference": { "type": "string", "description": "Optional external payment, subscription, or integration reference.", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "description": "Optional source metadata captured with the operation.", "nullable": true }, "FailureCode": { "type": "string", "description": "Structured failure code from the last failed attempt.", "nullable": true }, "FailureMessage": { "type": "string", "description": "Human-readable failure message from the last failed attempt.", "nullable": true }, "CancelledAtUtc": { "type": "string", "description": "UTC instant when the operation was cancelled.", "format": "date-time", "nullable": true }, "CancelledByUserId": { "type": "string", "description": "User id that cancelled the operation when available.", "nullable": true }, "CancelReason": { "type": "string", "description": "Optional cancellation reason.", "nullable": true }, "RelatedLedgerEntries": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementLedgerEntrySummary" }, "description": "Ledger entries produced by or related to the operation.", "nullable": true }, "RowVersion": { "type": "string", "description": "Optimistic concurrency token for renewal operation mutations.", "format": "uuid" } }, "additionalProperties": false, "description": "Runtime renewal operation detail for scheduled, manual, retried, or cancelled renewal work." }, "EntitlementRenewalOperationDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementRenewalOperationDetail" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntitlementRenewalOperationKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ManualReview", "ExternalFailure" ], "x-enum-descriptions": { "0": "A workflow item opened ahead of period end so an operator can decide whether to renew", "1": "A workflow item recording a failed external renewal attempt for diagnostics, retry, or cancel" } }, "EntitlementRenewalOperationList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementRenewalOperationSummary" }, "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Paginated renewal operation list response." }, "EntitlementRenewalOperationListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementRenewalOperationList" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntitlementRenewalOperationRetryRequest": { "type": "object", "properties": { "StartsAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "IdempotencyKey": { "type": "string", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "nullable": true }, "ExternalReference": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Retry one renewal workflow operation by executing the renewal command." }, "EntitlementRenewalOperationStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Open", "InProgress", "Completed", "Cancelled", "Failed" ], "x-enum-descriptions": { "0": "The operation awaits a renewal decision and can be retried or cancelled", "1": "A retry is currently executing the renew command for the operation", "2": "The renew command succeeded and the operation is closed", "3": "The operation was cancelled without renewing and is closed", "4": "The renew attempt failed and the operation stays actionable for retry or cancel" } }, "EntitlementRenewalOperationSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntitlementId": { "type": "string", "nullable": true }, "EntitlementNumber": { "type": "integer", "format": "int64" }, "EntitlementPlanId": { "type": "string", "nullable": true }, "EntitlementPlanDisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "EntitlementPeriodId": { "type": "string", "nullable": true }, "RenewalPolicyId": { "type": "string", "nullable": true }, "RenewalPolicyKey": { "type": "string", "nullable": true }, "OperationKind": { "$ref": "#/components/schemas/EntitlementRenewalOperationKind" }, "DueAtUtc": { "type": "string", "format": "date-time" }, "Status": { "$ref": "#/components/schemas/EntitlementRenewalOperationStatus" }, "ExternalReference": { "type": "string", "nullable": true }, "FailureCode": { "type": "string", "nullable": true }, "FailureMessage": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Renewal operation summary row." }, "EntitlementResource": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "ResourceRoleId": { "type": "string", "nullable": true }, "ResourceRoleDisplayName": { "type": "string", "nullable": true }, "Resource": { "$ref": "#/components/schemas/EntitlementEntityReference" }, "SortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Issued resource snapshot shown on entitlement detail." }, "EntitlementRuntimePlanFamily": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" } }, "additionalProperties": false, "description": "Plan family reference shown on runtime entitlement rows." }, "EntitlementRuntimeSummary": { "type": "object", "properties": { "GeneratedAtUtc": { "type": "string", "format": "date-time" }, "AppliedFilters": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "ActiveEntitlements": { "$ref": "#/components/schemas/EntitlementRuntimeSummaryCounter" }, "ExpiringSoon": { "$ref": "#/components/schemas/EntitlementRuntimeSummaryCounter" }, "FailedRenewals": { "$ref": "#/components/schemas/EntitlementRuntimeSummaryCounter" }, "UsagePressure": { "$ref": "#/components/schemas/EntitlementRuntimeSummaryCounter" } }, "additionalProperties": false, "description": "Operational summary for the runtime entitlements page." }, "EntitlementRuntimeSummaryCounter": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "Value": { "type": "integer", "format": "int64" }, "Severity": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Compact operational counter shown on the runtime entitlements page." }, "EntitlementRuntimeSummaryResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementRuntimeSummary" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntitlementSourceType": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Manual", "Api", "Import", "Renewal", "System" ], "x-enum-descriptions": { "0": "The command was initiated by an operator through the workspace UI", "1": "The command came from an external API integration such as a payment or order webhook", "2": "The command originated from a bulk data import", "3": "The command was produced by the renewal workflow, such as a renew or renewal operation retry", "4": "The command was produced by internal automation such as the lifecycle or renewal worker" } }, "EntitlementStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Draft", "PendingActivation", "Active", "Suspended", "Cancelled", "Expired", "Revoked" ], "x-enum-descriptions": { "0": "The entitlement is not issued yet and is excluded from runtime access evaluation and history", "1": "The entitlement is issued but its coverage start is still in the future", "2": "The entitlement is issued and currently within coverage or grace", "3": "A suspend command paused the entitlement until it is explicitly resumed", "4": "The entitlement was cancelled and the terminal state blocks further lifecycle commands", "5": "Coverage ended naturally or through an expire command and the terminal state blocks further lifecycle commands", "6": "A revoke command permanently withdrew the entitlement and the terminal state blocks further lifecycle commands" } }, "EntitlementSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntitlementNumber": { "type": "integer", "format": "int64" }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "ModelType": { "$ref": "#/components/schemas/EntitlementModelType" }, "EntitlementPlanId": { "type": "string", "nullable": true }, "EntitlementPlanDisplayName": { "type": "string", "nullable": true }, "Owner": { "$ref": "#/components/schemas/EntitlementEntityReference" }, "Status": { "$ref": "#/components/schemas/EntitlementStatus" }, "EffectiveState": { "$ref": "#/components/schemas/EntitlementEffectiveState" }, "StartsAtUtc": { "type": "string", "format": "date-time" }, "EndsAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "GraceUntilUtc": { "type": "string", "format": "date-time", "nullable": true }, "IssuedAtUtc": { "type": "string", "format": "date-time" }, "IssuedByUserId": { "type": "string", "nullable": true }, "ResourceCount": { "type": "integer", "format": "int32" }, "BeneficiaryCount": { "type": "integer", "format": "int32" }, "PlanFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementRuntimePlanFamily" }, "nullable": true }, "ObjectInvariant": { "$ref": "#/components/schemas/ObjectInvariant" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Runtime entitlement summary row." }, "EntitlementTimeUnit": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Days", "Months", "Years" ], "x-enum-descriptions": { "0": "Measures the validity term or quantity window in calendar days", "1": "Measures the validity term or quantity window in calendar months", "2": "Measures the validity term or quantity window in calendar years" } }, "EntityAssociationBinding": { "type": "object", "properties": { "Id": { "type": "string", "description": "Binding identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Association entity definition identifier.", "nullable": true }, "LeftEndpointEntityDefinitionId": { "type": "string", "description": "Left endpoint target entity definition identifier.", "nullable": true }, "RightEndpointEntityDefinitionId": { "type": "string", "description": "Right endpoint target entity definition identifier.", "nullable": true }, "LeftEndpointFieldId": { "type": "string", "description": "Left required reference field on the association entity.", "nullable": true }, "RightEndpointFieldId": { "type": "string", "description": "Right required reference field on the association entity.", "nullable": true }, "LeftInverseFieldId": { "type": "string", "description": "Generated inverse field on the left endpoint entity.", "nullable": true }, "RightInverseFieldId": { "type": "string", "description": "Generated inverse field on the right endpoint entity.", "nullable": true } }, "additionalProperties": false, "description": "Association endpoint and generated inverse binding metadata." }, "EntityCardSurfaceBootstrap": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "Selector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "Model": { "$ref": "#/components/schemas/EntityCardUi" }, "MissingSurface": { "$ref": "#/components/schemas/EntityUiMissingSurface" }, "RequiredIncludePaths": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryIncludeRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Runtime card surface payload resolved for the active caller." }, "EntityCardSurfaceBootstrapResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityCardSurfaceBootstrap" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityCardUi": { "type": "object", "properties": { "Id": { "type": "string", "description": "Surface identifier. This is empty when the model is not resolved.", "nullable": true }, "Surface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "RowVersion": { "type": "string", "description": "Concurrency token for persisted overrides.", "format": "uuid" }, "Tabs": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTab" }, "description": "Configured tabs.", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityCardUiItem" }, "description": "Effective card items.", "nullable": true }, "RuleEvaluationContext": { "$ref": "#/components/schemas/EntityRuleEvaluationContext" }, "LabelRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntityCardUiLabelRule" }, "description": "Ordered label rules for card surfaces.", "nullable": true } }, "additionalProperties": false, "description": "Persisted card surface." }, "EntityCardUiItem": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable item identifier.", "nullable": true }, "ItemType": { "$ref": "#/components/schemas/EntityUiItemType" }, "SortOrder": { "type": "integer", "description": "Display order.", "format": "int32" }, "TabId": { "type": "string", "description": "Owning tab when tabs are configured.", "nullable": true }, "Label": { "type": "string", "description": "Optional overridden label.", "nullable": true }, "Hint": { "type": "string", "description": "Optional hint text.", "nullable": true }, "Binding": { "$ref": "#/components/schemas/EntityUiFieldBinding" }, "Renderer": { "$ref": "#/components/schemas/CardFieldRenderer" }, "TextBlockStyle": { "$ref": "#/components/schemas/TextBlockStyle" }, "TextBlockText": { "type": "string", "description": "Text-block content when the item is a text block.", "nullable": true }, "AlertTone": { "$ref": "#/components/schemas/AlertTone" }, "AlertTitle": { "type": "string", "description": "Optional alert title.", "nullable": true }, "AlertText": { "type": "string", "description": "Alert body.", "nullable": true }, "MarginTop": { "type": "integer", "description": "Optional top margin in pixels.", "format": "int32", "nullable": true }, "MarginBottom": { "type": "integer", "description": "Optional bottom margin in pixels.", "format": "int32", "nullable": true }, "PaddingTop": { "type": "integer", "description": "Optional top padding in pixels.", "format": "int32", "nullable": true }, "PaddingBottom": { "type": "integer", "description": "Optional bottom padding in pixels.", "format": "int32", "nullable": true }, "PaddingLeft": { "type": "integer", "description": "Optional left padding in pixels.", "format": "int32", "nullable": true }, "PaddingRight": { "type": "integer", "description": "Optional right padding in pixels.", "format": "int32", "nullable": true }, "ColumnSpan": { "type": "integer", "description": "Responsive span from 1 through 3; null uses one column.", "format": "int32", "nullable": true }, "Visible": { "type": "boolean", "description": "Whether the item remains visible in the effective runtime model." }, "ReferenceInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "ReferenceRendererType": { "$ref": "#/components/schemas/ReferenceRendererType" }, "ReferenceLookupRenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Reference path configured for breadcrumb rendering.", "nullable": true }, "ReferenceOpenTarget": { "$ref": "#/components/schemas/EntityUiReferenceOpenTargetAdmin" }, "Projection": { "$ref": "#/components/schemas/EntityUiRelatedFieldProjection" } }, "additionalProperties": false, "description": "One card item." }, "EntityCardUiLabelRule": { "type": "object", "properties": { "StatementId": { "type": "string", "description": "Statement identifier used against instance predicates.", "nullable": true }, "Label": { "type": "string", "description": "Resolved chip text.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Stable evaluation order.", "format": "int32" }, "Color": { "type": "string", "description": "Normalized Vuetify chip color token.", "nullable": true }, "Variant": { "type": "string", "description": "Normalized Vuetify chip variant.", "nullable": true } }, "additionalProperties": false, "description": "Runtime card label chip rule." }, "EntityCreateCommandRequest": { "required": [ "EntityDefinitionKey", "ExpectedDefinitionRowVersion", "OperationKey", "ResponsibilityCandidates", "Values" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "EntityDefinitionKey": { "type": "string" }, "Values": { "type": "object", "additionalProperties": { "type": "object" } }, "ResponsibilityCandidates": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilityCandidatePayload" } }, "ExpectedDefinitionRowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "EntityCreateResult": { "type": "object", "additionalProperties": false }, "EntityCreateResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityCreateResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityCsvZipExportResult": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Download file name.", "nullable": true }, "ContentType": { "type": "string", "description": "Download content type.", "nullable": true }, "Content": { "type": "string", "description": "Serialized ZIP bytes.", "format": "byte", "nullable": true } }, "additionalProperties": false, "description": "Generated CSV ZIP export file content." }, "EntityCsvZipExportResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityCsvZipExportResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityDataTransferDirection": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Import", "Export", "ImportExport" ], "x-enum-descriptions": { "0": "Profile can only be used to bring records into the workspace", "1": "Profile can only be used to extract records out of the workspace", "2": "Profile supports both import and export runs" } }, "EntityDataTransferFormat": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Json", "CsvZip" ], "x-enum-descriptions": { "0": "Single JSON document payload", "1": "ZIP archive of CSV files with a separate file per included child table" } }, "EntityDataTransferIdentityMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Id", "Number", "Field" ], "x-enum-descriptions": { "0": "Match existing records by the runtime entity instance id", "1": "Match existing records by the visible entity number", "2": "Match existing records by the value of one configured root field" } }, "EntityDataTransferImportIssueCategory": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Validation", "Identity", "Reference", "Permission", "FileCompatibility", "TableCompatibility" ], "x-enum-descriptions": { "0": "Groups field or value validation problems that do not match a more specific category", "1": "Groups problems with resolving or matching record identity during import", "2": "Groups problems with resolving reference values to target records", "3": "Groups issues where the importing user lacks permission or access for the attempted change", "4": "Groups file, document, or format compatibility problems in the imported payload", "5": "Groups child table structure or row compatibility problems in the imported payload" } }, "EntityDataTransferImportIssueCategoryCount": { "type": "object", "properties": { "Category": { "$ref": "#/components/schemas/EntityDataTransferImportIssueCategory" }, "Severity": { "$ref": "#/components/schemas/ApiErrorSeverity" }, "Count": { "type": "integer", "description": "Number of row issues in this category and severity.", "format": "int32" } }, "additionalProperties": false, "description": "Aggregate import issue count grouped by stable UI category and severity." }, "EntityDataTransferImportMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "CreateOnly", "UpdateOnly", "Upsert" ], "x-enum-descriptions": { "0": "Import only creates new records and never updates existing ones", "1": "Import only updates matched existing records and never creates new ones", "2": "Import updates matched records and creates records that have no match" } }, "EntityDataTransferRuntimeProfile": { "type": "object", "properties": { "Id": { "type": "string", "description": "Profile identifier.", "nullable": true }, "Name": { "type": "string", "description": "User-facing profile name.", "nullable": true }, "Key": { "type": "string", "description": "Stable profile key.", "nullable": true }, "Direction": { "$ref": "#/components/schemas/EntityDataTransferDirection" }, "Format": { "$ref": "#/components/schemas/EntityDataTransferFormat" }, "IdentityMode": { "$ref": "#/components/schemas/EntityDataTransferIdentityMode" }, "FieldCount": { "type": "integer", "description": "Number of fields selected in the profile.", "format": "int32" }, "Description": { "type": "string", "description": "Optional user-facing workflow description.", "nullable": true } }, "additionalProperties": false, "description": "Runtime metadata for a data transfer profile that can be used from an entity record surface." }, "EntityDataTransferRuntimeProfileListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataTransferRuntimeProfile" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityDefinitionDefaultSortItem": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/EntityInstanceQuerySortTargetRequest" }, "Direction": { "$ref": "#/components/schemas/EntityInstanceQuerySortDirection" }, "SortOrder": { "type": "integer", "description": "Default sort order.", "format": "int32" } }, "additionalProperties": false, "description": "Entity-level default runtime sort item." }, "EntityDefinitionDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "Name": { "type": "string", "description": "Internal entity name.", "nullable": true }, "DisplayNameSingular": { "type": "string", "description": "User-facing singular name.", "nullable": true }, "DisplayNamePlural": { "type": "string", "description": "User-facing plural name.", "nullable": true }, "Description": { "type": "string", "description": "Optional entity description.", "nullable": true }, "CommentsEnabled": { "type": "boolean", "description": "Whether comments are enabled." }, "AttachmentsEnabled": { "type": "boolean", "description": "Whether attachments are enabled." }, "TagsEnabled": { "type": "boolean", "description": "Whether tags are enabled." }, "AuditTrailEnabled": { "type": "boolean", "description": "Whether audit trail is enabled." }, "AuditTrailRetentionMode": { "$ref": "#/components/schemas/AuditTrailRetentionMode" }, "AuditTrailRetentionDays": { "type": "integer", "description": "Retention days when mode is days-based.", "format": "int32", "nullable": true }, "NumberPrefix": { "type": "string", "description": "Configured number prefix.", "nullable": true }, "IsReadOnly": { "type": "boolean", "description": "Whether runtime writes are blocked for this entity." }, "DisabledOperations": { "$ref": "#/components/schemas/EntityOperationPolicy" }, "IsPendingDeletion": { "type": "boolean", "description": "Whether the definition is frozen pending deletion." }, "DeletionRequestedAt": { "type": "string", "description": "Timestamp when deferred deletion was requested.", "format": "date-time", "nullable": true }, "PurgeAfterUtc": { "type": "string", "description": "Scheduled purge timestamp.", "format": "date-time", "nullable": true }, "Tables": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionTable" }, "description": "Definition tables.", "nullable": true }, "UniqueConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionUniqueConstraint" }, "description": "Configured unique constraints.", "nullable": true }, "Indexes": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionIndex" }, "description": "Configured non-unique indexes.", "nullable": true }, "Statements": { "type": "array", "items": { "$ref": "#/components/schemas/EntityStatement" }, "description": "Configured entity statements.", "nullable": true }, "ValidationRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntityValidationRule" }, "description": "Configured entity validation rules.", "nullable": true }, "PresentationRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntityPresentationRule" }, "description": "Configured entity presentation rules.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "SchemaSource": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable Moltaro id when package-owned.", "nullable": true }, "UsageType": { "$ref": "#/components/schemas/EntityUsageType" }, "OwnerModuleKey": { "type": "string", "description": "Owning module key when the usage type is Part.", "nullable": true }, "OwnerAggregateType": { "type": "string", "description": "Owning aggregate type when the usage type is Part.", "nullable": true }, "OwnerAggregateId": { "type": "string", "description": "Owning aggregate identifier when the usage type is Part.", "nullable": true }, "AssociationBinding": { "$ref": "#/components/schemas/EntityAssociationBinding" }, "Projection": { "$ref": "#/components/schemas/EntityProjectionDefinition" }, "IsSystemDefined": { "type": "boolean", "description": "Whether the platform owns this definition. It cannot be deleted or renamed, and its protected fields cannot be changed." }, "SystemKey": { "type": "string", "description": "Stable platform key when the definition is system-defined.", "nullable": true }, "SearchMaxPathDepth": { "type": "integer", "description": "Maximum configured relation transitions accepted for a search target.", "format": "int32" }, "SearchMaxTargetsPerDefinition": { "type": "integer", "description": "Maximum number of explicit runtime search targets accepted for this definition.", "format": "int32" }, "SearchTargets": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionSearchTarget" }, "description": "Explicit runtime search targets.", "nullable": true }, "DefaultSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionDefaultSortItem" }, "description": "Entity-level default runtime sort sequence.", "nullable": true }, "DisplayFields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDisplayField" }, "description": "Read-time display fields available to table and card surfaces.", "nullable": true }, "ObjectContextFacts": { "type": "array", "items": { "$ref": "#/components/schemas/EntityObjectContextFact" }, "description": "ID-only object-context facts materialized onto entity-instance read models.", "nullable": true }, "ModuleEntityRoles": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleEntityDefinitionRole" }, "description": "Built-in module roles assigned to this system Entity Definition.", "nullable": true }, "ManualOrder": { "$ref": "#/components/schemas/EntityManualOrderDefinition" } }, "additionalProperties": false, "description": "Full entity definition detail." }, "EntityDefinitionDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityDefinitionDetail" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityDefinitionIndex": { "type": "object", "properties": { "Id": { "type": "string", "description": "Index identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "EntityDefinitionTableId": { "type": "string", "description": "Owning table identifier.", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionIndexField" }, "description": "Ordered participating fields.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Non-unique index configured for one entity definition table." }, "EntityDefinitionIndexField": { "type": "object", "properties": { "Id": { "type": "string", "description": "Field identifier.", "nullable": true }, "EntityDefinitionTableId": { "type": "string", "description": "Owning table identifier.", "nullable": true }, "Key": { "type": "string", "description": "Internal field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "User-facing field name.", "nullable": true } }, "additionalProperties": false, "description": "Field participating in one definition index." }, "EntityDefinitionSearchTarget": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Path": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionSearchTargetSegment" }, "nullable": true } }, "additionalProperties": false, "description": "Configured entity search target with resolved path metadata." }, "EntityDefinitionSearchTargetSegment": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "nullable": true }, "FieldId": { "type": "string", "nullable": true }, "FieldKey": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "SystemTarget": { "$ref": "#/components/schemas/EntitySearchSystemTarget" } }, "additionalProperties": false, "description": "Resolved segment of a configured entity search target." }, "EntityDefinitionSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "Name": { "type": "string", "description": "Internal entity name.", "nullable": true }, "DisplayNameSingular": { "type": "string", "description": "User-facing singular name.", "nullable": true }, "DisplayNamePlural": { "type": "string", "description": "User-facing plural name.", "nullable": true }, "Description": { "type": "string", "description": "Optional entity description.", "nullable": true }, "CommentsEnabled": { "type": "boolean", "description": "Whether comments are enabled." }, "AttachmentsEnabled": { "type": "boolean", "description": "Whether attachments are enabled." }, "TagsEnabled": { "type": "boolean", "description": "Whether tags are enabled." }, "AuditTrailEnabled": { "type": "boolean", "description": "Whether audit trail is enabled." }, "NumberPrefix": { "type": "string", "description": "Configured number prefix.", "nullable": true }, "IsReadOnly": { "type": "boolean", "description": "Whether runtime writes are blocked for this entity." }, "DisabledOperations": { "$ref": "#/components/schemas/EntityOperationPolicy" }, "IsPendingDeletion": { "type": "boolean", "description": "Whether the definition is frozen pending deletion." }, "DeletionRequestedAt": { "type": "string", "description": "Timestamp when deferred deletion was requested.", "format": "date-time", "nullable": true }, "PurgeAfterUtc": { "type": "string", "description": "Scheduled purge timestamp.", "format": "date-time", "nullable": true }, "UniqueConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionUniqueConstraint" }, "description": "Configured unique constraints.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "SchemaSource": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable Moltaro id when package-owned.", "nullable": true }, "UsageType": { "$ref": "#/components/schemas/EntityUsageType" }, "OwnerModuleKey": { "type": "string", "description": "Owning module key when the usage type is Part.", "nullable": true }, "OwnerAggregateType": { "type": "string", "description": "Owning aggregate type when the usage type is Part.", "nullable": true }, "OwnerAggregateId": { "type": "string", "description": "Owning aggregate identifier when the usage type is Part.", "nullable": true }, "IsSystemDefined": { "type": "boolean", "description": "Whether the definition is reconciled from a stable system contract and cannot be deleted." }, "SearchTargetCount": { "type": "integer", "description": "Number of explicitly configured runtime search targets.", "format": "int32" } }, "additionalProperties": false, "description": "Entity definition summary." }, "EntityDefinitionSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionSummary" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityDefinitionTable": { "type": "object", "properties": { "Id": { "type": "string", "description": "Table metadata identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "Name": { "type": "string", "description": "Logical table name.", "nullable": true }, "SchemaName": { "type": "string", "description": "Database schema name.", "nullable": true }, "PhysicalTableName": { "type": "string", "description": "Physical table name.", "nullable": true }, "IsPrimary": { "type": "boolean", "description": "Whether this is the primary entity table." }, "OwnerFieldId": { "type": "string", "description": "Owner field identifier for child tables.", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldDefinition" }, "description": "Fields that belong to the table.", "nullable": true }, "IsDeleted": { "type": "boolean", "description": "Whether the table metadata is soft-deleted." }, "DeletedAt": { "type": "string", "description": "Deletion timestamp.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "SchemaSource": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable Moltaro id when package-owned.", "nullable": true } }, "additionalProperties": false, "description": "Metadata for one physical table used by an entity definition." }, "EntityDefinitionUniqueConstraint": { "type": "object", "properties": { "Id": { "type": "string", "description": "Constraint identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "EntityDefinitionTableId": { "type": "string", "description": "Owning table identifier.", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionUniqueConstraintField" }, "description": "Ordered participating fields.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Unique constraint configured for one entity definition table." }, "EntityDefinitionUniqueConstraintField": { "type": "object", "properties": { "Id": { "type": "string", "description": "Field identifier.", "nullable": true }, "EntityDefinitionTableId": { "type": "string", "description": "Owning table identifier.", "nullable": true }, "Key": { "type": "string", "description": "Field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "User-facing field name.", "nullable": true } }, "additionalProperties": false, "description": "Field entry participating in an entity unique constraint." }, "EntityDeleteResult": { "type": "object", "additionalProperties": false }, "EntityDeleteResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityDeleteResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityDetailsBackTarget": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "EntityListPage", "Board" ], "x-enum-descriptions": { "0": "Return to an entity list page", "1": "Return to a configured board" } }, "EntityDetailsBackTargetRuntime": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/EntityDetailsBackTarget" }, "EntityListPageSelector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "TargetId": { "type": "string", "nullable": true }, "TargetKey": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "description": "Current provider-owned display name.", "nullable": true }, "RouteName": { "type": "string", "description": "Named WebApp route supplied by the owning module.", "nullable": true } }, "additionalProperties": false, "description": "Runtime breadcrumb target for a details page." }, "EntityDetailsPageBootstrap": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "Model": { "$ref": "#/components/schemas/EntityDetailsPageUi" }, "LayoutMode": { "$ref": "#/components/schemas/EntityUiHostLayoutMode" }, "ObjectHostedLayout": { "$ref": "#/components/schemas/EntityObjectHostedLayout" } }, "additionalProperties": false, "description": "Runtime bootstrap payload for the details surface." }, "EntityDetailsPageBootstrapResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityDetailsPageBootstrap" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityDetailsPageUi": { "type": "object", "properties": { "SummaryCard": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "EditForm": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "BackTarget": { "$ref": "#/components/schemas/EntityDetailsBackTargetRuntime" } }, "additionalProperties": false, "description": "Resolved details-page orchestration model." }, "EntityDisplayField": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Rules": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDisplayFieldRule" }, "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsDeleted": { "type": "boolean" }, "DeletedAt": { "type": "string", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Read-time display field metadata." }, "EntityDisplayFieldRule": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntityDisplayFieldId": { "type": "string", "nullable": true }, "Template": { "type": "string", "nullable": true }, "Condition": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsDeleted": { "type": "boolean" }, "DeletedAt": { "type": "string", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "One ordered rule for a read-time display field. Templates support optionLabel(SelectPath) for configured Select option captions." }, "EntityDrawerBootstrap": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "Model": { "$ref": "#/components/schemas/EntityDrawerUi" }, "LayoutMode": { "$ref": "#/components/schemas/EntityUiHostLayoutMode" }, "ObjectHostedLayout": { "$ref": "#/components/schemas/EntityObjectHostedLayout" } }, "additionalProperties": false, "description": "Runtime bootstrap payload for the drawer surface." }, "EntityDrawerBootstrapResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityDrawerBootstrap" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityDrawerSection": { "type": "object", "properties": { "SourceEntityDefinitionId": { "type": "string", "nullable": true }, "SourceReferenceFieldId": { "type": "string", "nullable": true }, "Label": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "Visible": { "type": "boolean" }, "TableBinding": { "$ref": "#/components/schemas/EntityTableBinding" } }, "additionalProperties": false, "description": "One related-section definition on the drawer surface." }, "EntityDrawerUi": { "type": "object", "properties": { "SummaryCard": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "EditForm": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "Sections": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDrawerSection" }, "nullable": true }, "DetailsPage": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" } }, "additionalProperties": false, "description": "Resolved drawer orchestration model." }, "EntityEditOperationMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "CreateAndUpdate", "Create", "Update" ], "x-enum-descriptions": { "0": "Applies both when a record is created and when it is updated", "1": "Applies only when a new record is created", "2": "Applies only when an existing record is updated" } }, "EntityFieldCalculationKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Local", "Aggregate" ], "x-enum-descriptions": { "0": "Value computed from the record's own field values during save", "1": "Value computed by aggregating child records that point at this record" } }, "EntityFieldDefaultValue": { "type": "object", "properties": { "Kind": { "$ref": "#/components/schemas/EntityFieldDefaultValueKind" }, "Value": { "type": "object", "description": "Canonical constant JSON value. A scalar Reference contains only the target\r\nentity-instance id string. Null for dynamic defaults.", "nullable": true } }, "additionalProperties": false, "description": "Configured default applied to an absent primary field on create or an absent\r\nchild field in a new table row. It does not change existing rows." }, "EntityFieldDefaultValueKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Constant", "CurrentDate", "CurrentDateTime" ], "x-enum-descriptions": { "0": "Use the configured constant value", "1": "Use the current calendar date in the workspace time zone", "2": "Use the current UTC instant" } }, "EntityFieldDefinition": { "type": "object", "properties": { "Id": { "type": "string", "description": "Field identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "EntityDefinitionTableId": { "type": "string", "description": "Entity definition table identifier.", "nullable": true }, "Key": { "type": "string", "description": "Field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Field display name.", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "VisibleWhen": { "type": "string", "description": "Visibility condition expression.", "nullable": true }, "RequiredWhen": { "type": "string", "description": "Requiredness condition expression.", "nullable": true }, "BusinessRequiredWhen": { "type": "string", "description": "Package-owned business requiredness condition expression.", "nullable": true }, "EditableWhen": { "type": "string", "description": "Editability condition expression.", "nullable": true }, "IsReadOnly": { "type": "boolean", "description": "Whether runtime writes should skip this field." }, "DecimalPrecision": { "type": "integer", "description": "Decimal precision when applicable.", "format": "int32", "nullable": true }, "DecimalScale": { "type": "integer", "description": "Decimal scale when applicable.", "format": "int32", "nullable": true }, "StringMaxLength": { "type": "integer", "description": "String max length when applicable.", "format": "int32", "nullable": true }, "AllowMultiple": { "type": "boolean", "description": "Whether multiple values are allowed." }, "ReferenceToEntityDefinitionId": { "type": "string", "description": "Target entity definition identifier for reference-style fields.", "nullable": true }, "PairedReferenceFieldId": { "type": "string", "description": "Paired reference field identifier for inverse reference fields.", "nullable": true }, "AllowSort": { "type": "boolean", "description": "Whether root-list sorting by linked display value is allowed." }, "ReferenceDeleteBehavior": { "$ref": "#/components/schemas/ReferenceDeleteBehavior" }, "SortOrder": { "type": "integer", "description": "Sort order inside the owning table.", "format": "int32" }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldOption" }, "description": "Select options when applicable.", "nullable": true }, "ChildTableId": { "type": "string", "description": "Child table metadata identifier for table fields.", "nullable": true }, "IsDeleted": { "type": "boolean", "description": "Whether the field is soft-deleted." }, "DeletedAt": { "type": "string", "description": "Deletion timestamp.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "AddressCoordinatesRequired": { "type": "boolean", "description": "Whether address values must carry latitude and longitude." }, "SchemaSource": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable Moltaro id when package-owned.", "nullable": true }, "Metadata": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldMetadata" }, "description": "Owner-scoped metadata attached to this field.", "nullable": true }, "SystemRole": { "$ref": "#/components/schemas/EntityFieldSystemRole" }, "VisibleWhenOperationMode": { "$ref": "#/components/schemas/EntityEditOperationMode" }, "RequiredWhenOperationMode": { "$ref": "#/components/schemas/EntityEditOperationMode" }, "EditableWhenOperationMode": { "$ref": "#/components/schemas/EntityEditOperationMode" }, "BaseCurrencyCode": { "type": "string", "description": "Base currency code for Money fields.", "nullable": true }, "CalculationExpression": { "type": "string", "description": "Stored calculated-field expression.", "nullable": true }, "CalculationKind": { "$ref": "#/components/schemas/EntityFieldCalculationKind" }, "ReferenceArchiveBehavior": { "$ref": "#/components/schemas/ReferenceArchiveBehavior" }, "ReferenceAuditRollupBehavior": { "$ref": "#/components/schemas/ReferenceAuditRollupBehavior" }, "SemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "SemanticRoleScopeFieldId": { "type": "string", "description": "Field identifier used as semantic scope, when the selected role requires one.", "nullable": true }, "ClassifierCatalogDefinitionId": { "type": "string", "description": "Bound Classifier Catalog Definition identifier.", "nullable": true }, "ClassifierCatalogKey": { "type": "string", "description": "Stable key of the bound Classifier Catalog Definition.", "nullable": true }, "ClassifierCatalogDisplayName": { "type": "string", "description": "Display name of the bound Classifier Catalog Definition.", "nullable": true }, "DefaultValue": { "$ref": "#/components/schemas/EntityFieldDefaultValue" }, "IsProtected": { "type": "boolean", "description": "Whether the field's system-owned structural shape is protected while administrator-owned metadata remains editable." } }, "additionalProperties": false, "description": "Metadata for one entity field definition." }, "EntityFieldMetadata": { "type": "object", "properties": { "Id": { "type": "string", "description": "Metadata row identifier.", "nullable": true }, "EntityFieldDefinitionId": { "type": "string", "description": "Owning field identifier.", "nullable": true }, "OwnerModuleKey": { "type": "string", "description": "Module that owns this metadata key.", "nullable": true }, "Key": { "type": "string", "description": "Metadata key inside the owner module.", "nullable": true }, "ValueJson": { "type": "object", "description": "Metadata value as JSON." }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Owner-scoped metadata attached to one entity field definition." }, "EntityFieldOption": { "type": "object", "properties": { "Id": { "type": "string", "description": "Option identifier.", "nullable": true }, "EntityFieldDefinitionId": { "type": "string", "description": "Owning field identifier.", "nullable": true }, "Key": { "type": "string", "description": "Option key.", "nullable": true }, "Value": { "type": "string", "description": "Option display value.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Sort order.", "format": "int32" } }, "additionalProperties": false, "description": "Option metadata for select fields." }, "EntityFieldSemanticRole": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "LineNumber", "Markdown", "TimeZone" ], "x-enum-descriptions": { "0": "No extra product meaning beyond the storage field type", "1": "Runtime-maintained dense ordering number scoped by a same-entity reference field; effectively read-only", "2": "Plain-text stored value that should be edited, rendered, and indexed as Markdown content", "3": "Canonical IANA time-zone identifier chosen from the platform catalog; sorts and filters as a closed value set" } }, "EntityFieldSystemRole": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "AssociationLeftEndpoint", "AssociationRightEndpoint", "AssociationLeftInverse", "AssociationRightInverse", "ProjectionMemberReference", "ManualOrderRank" ], "x-enum-descriptions": { "0": "Ordinary configured field not owned by a system feature", "1": "System-owned reference field on an association entity pointing at the left endpoint record", "2": "System-owned reference field on an association entity pointing at the right endpoint record", "3": "Generated inverse-reference field on the left endpoint definition listing its association rows", "4": "Generated inverse-reference field on the right endpoint definition listing its association rows", "5": "Reference field selected as a projection member link from a projection row to its source record", "6": "System-owned hidden rank field backing the entity definition Manual Order capability" } }, "EntityFieldType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Bool", "DateOnly", "TimeOnly", "User", "Role", "Integer", "Decimal", "File", "Address", "Select", "String", "Text", "Table", "Reference", "InverseReference", "Money", "Classifier", "DateTimeOffset" ], "x-enum-descriptions": { "0": "True/false value", "1": "Calendar date without a time component", "2": "Time of day without a date component", "3": "Reference to a workspace user account", "4": "Reference to a workspace security role", "5": "Whole number value", "6": "Fractional numeric value", "7": "Uploaded file stored through the workspace file system", "8": "Structured postal address value", "9": "Single or multi choice from configured options", "10": "Short single-line text value", "11": "Long multi-line text content", "12": "Embedded child table of rows owned by the record", "13": "Link to a record of a configured target entity definition", "14": "Read-only list of records whose reference field points back at this record", "15": "Monetary amount paired with a currency code, serialized with exact decimal precision", "16": "Category selected from a bound Classifier Catalog", "17": "Exact date and time instant stored in UTC and serialized with an explicit offset" } }, "EntityFormReferenceContextRuntimeDescriptor": { "type": "object", "properties": { "TargetFieldId": { "type": "string", "description": "Reference field identifier represented by the Form item.", "nullable": true }, "CurrentValueInputs": { "$ref": "#/components/schemas/EntityFormReferenceCurrentValueInputsRuntime" }, "ProjectedTargetFieldIds": { "type": "array", "items": { "type": "string" }, "description": "Target scalar or Money owner field identifiers required by one-hop Form field behavior plans.", "nullable": true }, "RequiresTargetValues": { "type": "boolean", "description": "Whether the Form must materialize the referenced target for system, scalar, or Money target values." } }, "additionalProperties": false, "description": "Actor-shaped Form context required by one scalar Reference field." }, "EntityFormReferenceCurrentValueInputsRuntime": { "type": "object", "properties": { "CreateDraftFieldIds": { "type": "array", "items": { "type": "string" }, "description": "Fields whose user-owned, currently editable create-draft values may be sent. A possible mutation-effect target remains listed because ownership is draft-specific.", "nullable": true }, "UpdateDraftFieldIds": { "type": "array", "items": { "type": "string" }, "description": "Fields whose editable update-draft values may be sent.", "nullable": true }, "LockedCreateFieldIds": { "type": "array", "items": { "type": "string" }, "description": "Fields whose server-owned related-create locks may be sent.", "nullable": true } }, "additionalProperties": false, "description": "Explicit allow-lists for client-owned Form Reference context values." }, "EntityFormRelatedTableBootstrap": { "type": "object", "properties": { "FormSurfaceId": { "type": "string", "nullable": true }, "FormItemId": { "type": "string", "nullable": true }, "State": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockRuntimeState" }, "Table": { "allOf": [ { "$ref": "#/components/schemas/EntityTableUi" } ], "nullable": true }, "Page": { "allOf": [ { "$ref": "#/components/schemas/EntityInstancePage" } ], "nullable": true }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" }, "MissingSurface": { "$ref": "#/components/schemas/EntityUiMissingSurface" }, "ErrorCode": { "type": "string", "nullable": true }, "CreateAction": { "$ref": "#/components/schemas/EntityRelatedCreateAction" }, "ChildEntityDefinitionId": { "type": "string", "description": "Resolved child entity definition identifier for row commands and navigation.", "nullable": true }, "ChildEntityDisplayNameSingular": { "type": "string", "description": "Actor-safe singular name of the child entity.", "nullable": true }, "AvailableArchiveModes": { "type": "array", "items": { "$ref": "#/components/schemas/ArchiveMode" }, "description": "Archive scopes the current actor may browse in this embedded table. Form Related Tables expose\r\nonly Moltaro.Enums.ArchiveModeEnum.Active and Moltaro.Enums.ArchiveModeEnum.Archived; the list is\r\nserver-computed and is the source of truth for the scope toggle.", "nullable": true }, "TreePage": { "allOf": [ { "$ref": "#/components/schemas/EntityTableTreeNodePage" } ], "nullable": true }, "RuntimeRows": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableRuntimeRowState" }, "description": "Actor-shaped runtime row flags returned for Flat mode.", "nullable": true }, "RuntimeSortItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceRuntimeSortItem" }, "description": "Runtime sort targets available in this related-table context.", "nullable": true }, "RuntimeUnavailableSortItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceUnavailableTarget" }, "description": "Configured sort targets unavailable in this related-table context.", "nullable": true }, "RuntimeDefaultSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Resolved configured default sort used when the user has no override.", "nullable": true }, "ContextRevision": { "type": "string", "description": "Opaque revision of the server-owned Form item, relation, roles, schema, and parent context.", "nullable": true } }, "additionalProperties": false, "description": "Actor-shaped runtime payload for one server-bound related-table Form item." }, "EntityFormRelatedTableBootstrapResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityFormRelatedTableBootstrap" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityFormRelatedTableRequest": { "type": "object", "properties": { "Page": { "type": "integer", "description": "One-based page number.", "format": "int32" }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" } }, "additionalProperties": false, "description": "Page request for one server-owned related-table Form item. The client supplies no binding or filter;\r\nthe server resolves both from the persisted Form item and the parent instance." }, "EntityFormRelatedTableTreeChildrenRequest": { "required": [ "ExpectedContextRevision", "ExpectedTableSurfaceId", "ExpectedTableSurfaceRowVersion", "ParentInstanceId" ], "type": "object", "properties": { "ExpectedContextRevision": { "minLength": 1, "type": "string", "description": "Opaque context revision returned by the related-table bootstrap." }, "ParentInstanceId": { "minLength": 1, "type": "string", "description": "Parent Tree node whose direct children are requested." }, "ExpectedTableSurfaceId": { "minLength": 1, "type": "string", "description": "Resolved child Table Surface identifier returned by the bootstrap." }, "ExpectedTableSurfaceRowVersion": { "type": "string", "description": "Resolved child Table Surface revision returned by the bootstrap.", "format": "uuid" }, "Page": { "type": "integer", "description": "One-based child sibling page.", "format": "int32" }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" } }, "additionalProperties": false, "description": "Context-preserving lazy child request for a related-table Form item in Tree View." }, "EntityFormRelatedTableTreeRootsRequest": { "required": [ "ExpectedContextRevision", "ExpectedTableSurfaceId", "ExpectedTableSurfaceRowVersion" ], "type": "object", "properties": { "ExpectedContextRevision": { "minLength": 1, "type": "string", "description": "Opaque context revision returned by the related-table bootstrap." }, "ExpectedTableSurfaceId": { "minLength": 1, "type": "string", "description": "Resolved child Table Surface identifier returned by the bootstrap." }, "ExpectedTableSurfaceRowVersion": { "type": "string", "description": "Resolved child Table Surface revision returned by the bootstrap.", "format": "uuid" }, "Page": { "type": "integer", "description": "One-based root sibling page.", "format": "int32" }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" } }, "additionalProperties": false, "description": "Context-preserving additional root request for a related-table Form item in Tree View." }, "EntityFormSurfaceBootstrap": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "Selector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "Model": { "$ref": "#/components/schemas/EntityFormUi" }, "MissingSurface": { "$ref": "#/components/schemas/EntityUiMissingSurface" }, "RequiredIncludePaths": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryIncludeRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Runtime form surface payload resolved for the active caller." }, "EntityFormSurfaceBootstrapResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityFormSurfaceBootstrap" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityFormUi": { "type": "object", "properties": { "Id": { "type": "string", "description": "Surface identifier. This is empty when the model is not resolved.", "nullable": true }, "Surface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "MaxWidth": { "type": "integer", "description": "Maximum layout width in pixels.", "format": "int32" }, "ColumnCount": { "type": "integer", "description": "Desktop column count.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Concurrency token for persisted overrides.", "format": "uuid" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFormUiItem" }, "description": "Effective form items.", "nullable": true }, "RuleEvaluationContext": { "$ref": "#/components/schemas/EntityRuleEvaluationContext" } }, "additionalProperties": false, "description": "Persisted form surface." }, "EntityFormUiItem": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable item identifier.", "nullable": true }, "ItemType": { "$ref": "#/components/schemas/EntityUiItemType" }, "SortOrder": { "type": "integer", "description": "Display order.", "format": "int32" }, "Column": { "type": "integer", "description": "Preferred desktop column.", "format": "int32" }, "Label": { "type": "string", "description": "Optional overridden label.", "nullable": true }, "Hint": { "type": "string", "description": "Optional hint text.", "nullable": true }, "Binding": { "$ref": "#/components/schemas/EntityUiFieldBinding" }, "Editor": { "$ref": "#/components/schemas/FormFieldEditor" }, "Editable": { "type": "boolean", "description": "Whether field editing is enabled." }, "EditorRows": { "type": "integer", "description": "Configured row count for textarea-style editors.", "format": "int32", "nullable": true }, "TextBlockStyle": { "$ref": "#/components/schemas/TextBlockStyle" }, "TextBlockText": { "type": "string", "description": "Text-block content when the item is a text block.", "nullable": true }, "AlertTone": { "$ref": "#/components/schemas/AlertTone" }, "AlertTitle": { "type": "string", "description": "Optional alert title.", "nullable": true }, "AlertText": { "type": "string", "description": "Alert body.", "nullable": true }, "MarginTop": { "type": "integer", "description": "Optional top margin in pixels.", "format": "int32", "nullable": true }, "MarginBottom": { "type": "integer", "description": "Optional bottom margin in pixels.", "format": "int32", "nullable": true }, "PaddingTop": { "type": "integer", "description": "Optional top padding in pixels.", "format": "int32", "nullable": true }, "PaddingBottom": { "type": "integer", "description": "Optional bottom padding in pixels.", "format": "int32", "nullable": true }, "PaddingLeft": { "type": "integer", "description": "Optional left padding in pixels.", "format": "int32", "nullable": true }, "PaddingRight": { "type": "integer", "description": "Optional right padding in pixels.", "format": "int32", "nullable": true }, "Visible": { "type": "boolean", "description": "Whether the item remains visible in the effective runtime model." }, "ColumnSpan": { "type": "integer", "description": "Desktop column span.", "format": "int32" }, "DatePickerAnchorMode": { "$ref": "#/components/schemas/EntityUiDatePickerAnchorMode" }, "DatePickerAnchorValue": { "type": "integer", "description": "Fixed year or relative year offset selected by Moltaro.Entity.Ui.Models.Form.EntityFormUiItemModel.DatePickerAnchorMode.", "format": "int32", "nullable": true }, "ReferenceInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "ReferenceRendererType": { "$ref": "#/components/schemas/ReferenceRendererType" }, "ReferenceLookupRenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Reference path configured for breadcrumb rendering.", "nullable": true }, "HierarchySourceKind": { "$ref": "#/components/schemas/EntityReferenceHierarchySourceKind" }, "ReferenceHierarchy": { "$ref": "#/components/schemas/EntityUiReferenceHierarchyConfigurationAdmin" }, "LookupTableSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware table selectors for lookup dialogs.", "nullable": true }, "CreateFormSelector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "CreateFormSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware create-form overrides used by admin authoring; an empty list inherits from the lookup table.", "nullable": true }, "RelatedTableSelector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "RelatedTableSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware child table surface selectors used by related-table admin authoring.", "nullable": true }, "ReferenceEligibility": { "$ref": "#/components/schemas/EntityReferenceEligibilityRuntimeDescriptor" }, "ReferenceContext": { "$ref": "#/components/schemas/EntityFormReferenceContextRuntimeDescriptor" } }, "additionalProperties": false, "description": "One form item." }, "EntityIdentityCommandRequest": { "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "EntityDefinitionKey": { "type": "string", "nullable": true }, "EntityInstanceId": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EntityInstanceAuditSemanticEvidenceState": { "enum": [ 0, 10 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "UnknownLegacy", "RecordedAtWrite" ], "x-enum-descriptions": { "0": "The legacy audit value does not carry semantic presentation evidence", "10": "Semantic presentation evidence was captured when the audit value was written" } }, "EntityInstanceBoardAddOption": { "type": "object", "properties": { "Board": { "$ref": "#/components/schemas/BoardRuntimeSummary" }, "TargetDefinition": { "$ref": "#/components/schemas/BoardRuntimeTargetDefinition" }, "Statuses": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRuntimeStatus" }, "nullable": true }, "CanAdd": { "type": "boolean" }, "DisabledReasonCode": { "type": "string", "nullable": true }, "ExistingOpenItem": { "$ref": "#/components/schemas/EntityInstanceBoardContextItem" }, "LatestClosedItem": { "$ref": "#/components/schemas/EntityInstanceBoardContextItem" }, "RepeatModes": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItemRepeatMode" }, "nullable": true } }, "additionalProperties": false, "description": "Server-computed add option for adding one Entity Instance to a board." }, "EntityInstanceBoardContext": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityInstanceId": { "type": "string", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceBoardContextItem" }, "nullable": true }, "AddOptions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceBoardAddOption" }, "nullable": true }, "HasRestrictedItems": { "type": "boolean", "description": "Whether the target has board items hidden by the caller's board permissions." } }, "additionalProperties": false, "description": "Object-centric Boards context for one Entity Instance." }, "EntityInstanceBoardContextItem": { "type": "object", "properties": { "Board": { "$ref": "#/components/schemas/BoardRuntimeSummary" }, "Status": { "$ref": "#/components/schemas/BoardRuntimeStatus" }, "Item": { "$ref": "#/components/schemas/BoardRuntimeItem" } }, "additionalProperties": false, "description": "Board item linked to one Entity Instance context." }, "EntityInstanceBoardContextResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityInstanceBoardContext" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityInstanceBusinessEvent": { "type": "object", "properties": { "Title": { "type": "string", "description": "Short event title.", "nullable": true }, "Message": { "type": "string", "description": "Optional event message.", "nullable": true }, "Values": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceBusinessEventValue" }, "description": "Display-safe event values.", "nullable": true }, "RelatedEntities": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceBusinessEventRelatedEntity" }, "description": "Related entity references.", "nullable": true } }, "additionalProperties": false, "description": "Display-safe business event stored in an entity audit entry." }, "EntityInstanceBusinessEventRelatedEntity": { "type": "object", "properties": { "EntityStableId": { "type": "string", "description": "Stable id of the related entity definition.", "nullable": true }, "InstanceId": { "type": "string", "description": "Related entity instance id.", "nullable": true }, "Label": { "type": "string", "description": "Optional relation label.", "nullable": true } }, "additionalProperties": false, "description": "One entity related to a business event." }, "EntityInstanceBusinessEventValue": { "type": "object", "properties": { "Key": { "type": "string", "description": "Stable value key.", "nullable": true }, "Label": { "type": "string", "description": "Human-readable value label.", "nullable": true }, "Value": { "type": "string", "description": "Display-safe value text.", "nullable": true } }, "additionalProperties": false, "description": "One display-safe business event value." }, "EntityInstanceChangeActor": { "type": "object", "properties": { "Id": { "type": "string", "description": "Actor user identifier when available.", "nullable": true }, "Name": { "type": "string", "description": "Resolved actor display name.", "nullable": true } }, "additionalProperties": false, "description": "Actor metadata for one entity-instance change." }, "EntityInstanceChangeContributor": { "type": "object", "properties": { "FunctionKey": { "type": "string", "description": "Related business-function key.", "nullable": true }, "FunctionRunId": { "type": "string", "description": "Related business-function run identifier.", "nullable": true }, "FunctionId": { "type": "string", "description": "Related business-function identifier.", "nullable": true }, "FunctionVersionId": { "type": "string", "description": "Related business-function version identifier.", "nullable": true }, "FunctionVersion": { "type": "integer", "description": "Related business-function version number.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Business-function contributor captured for one entity-instance change entry." }, "EntityInstanceChangeItem": { "type": "object", "properties": { "Id": { "type": "string", "description": "Change identifier.", "nullable": true }, "Operation": { "$ref": "#/components/schemas/EntityInstanceChangeOperation" }, "ChangedAt": { "type": "string", "description": "Change timestamp.", "format": "date-time" }, "Actor": { "$ref": "#/components/schemas/EntityInstanceChangeActor" }, "RecordContext": { "$ref": "#/components/schemas/EntityInstanceChangeRecordContext" }, "FieldChanges": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceFieldChange" }, "description": "Scalar and system-field changes.", "nullable": true }, "TableChanges": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceTableChange" }, "description": "Table-field row changes.", "nullable": true }, "ResponsibilityChanges": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResponsibilityChange" }, "description": "Assignment changes.", "nullable": true }, "Source": { "$ref": "#/components/schemas/EntityInstanceChangeSource" }, "BusinessEvent": { "$ref": "#/components/schemas/EntityInstanceBusinessEvent" }, "ManualOrderMove": { "allOf": [ { "$ref": "#/components/schemas/EntityInstanceManualOrderMove" } ], "nullable": true } }, "additionalProperties": false, "description": "One persisted entity-instance change entry." }, "EntityInstanceChangeList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceChangeItem" }, "description": "Change items for the requested page.", "nullable": true }, "TotalCount": { "type": "integer", "description": "Total matching change count.", "format": "int32" }, "Page": { "type": "integer", "description": "Normalized one-based page number.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Normalized page size.", "format": "int32" } }, "additionalProperties": false, "description": "Paged list of entity-instance changes." }, "EntityInstanceChangeListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityInstanceChangeList" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityInstanceChangeOperation": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Create", "Update", "Assignments", "Archive", "Restore", "Delete", "BusinessEvent" ], "x-enum-descriptions": { "0": "The record was created", "1": "Record field values were updated", "2": "Record assignment targets for a relation were replaced", "3": "The record was archived", "4": "The record was restored from the archive", "5": "The record was permanently deleted", "6": "A business event was appended to the record history by business logic" } }, "EntityInstanceChangeRecordContext": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier for the audited record.", "nullable": true }, "EntityDefinitionName": { "type": "string", "description": "Internal entity definition name for the audited record.", "nullable": true }, "DisplayNameSingular": { "type": "string", "description": "User-facing singular entity name.", "nullable": true }, "DisplayNamePlural": { "type": "string", "description": "User-facing plural entity name.", "nullable": true }, "UsageType": { "$ref": "#/components/schemas/EntityUsageType" }, "RecordContextKind": { "$ref": "#/components/schemas/EntityInstanceChangeRecordContextKind" }, "IsProjectedAssociation": { "type": "boolean", "description": "Whether the row is projected from an association record into an endpoint record history." }, "ReferenceFacts": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceChangeReferenceFact" }, "description": "Reference values that identify this audited record even when they did not change.", "nullable": true } }, "additionalProperties": false, "description": "Entity definition context for the record whose audit row produced a change item." }, "EntityInstanceChangeRecordContextKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Direct", "Association", "ReferenceRollup" ], "x-enum-descriptions": { "0": "The change was recorded directly on the requested record", "1": "The change is projected into the history from an associated record", "2": "The change is projected from a dependent source record through a roll-up reference field" } }, "EntityInstanceChangeReferenceFact": { "type": "object", "properties": { "FieldId": { "type": "string", "description": "Reference field identifier on the audited record.", "nullable": true }, "FieldKey": { "type": "string", "description": "Reference field key on the audited record.", "nullable": true }, "DisplayName": { "type": "string", "description": "Reference field display name.", "nullable": true }, "TargetEntityDefinitionId": { "type": "string", "description": "Target entity definition identifier.", "nullable": true }, "TargetDisplayNameSingular": { "type": "string", "description": "Target entity user-facing singular name.", "nullable": true }, "Value": { "$ref": "#/components/schemas/EntityReferenceValue" } }, "additionalProperties": false, "description": "Read-only reference fact that identifies the audited record even when the reference did not change." }, "EntityInstanceChangeSource": { "type": "object", "properties": { "SourceType": { "type": "string", "description": "Mutation source category such as `User`, `Function`, or `Schedule`.", "nullable": true }, "SourceLabel": { "type": "string", "description": "Human-readable source label.", "nullable": true }, "FunctionRunId": { "type": "string", "description": "First contributing business-function run identifier, when applicable.", "nullable": true }, "FunctionId": { "type": "string", "description": "First contributing business-function identifier, when applicable.", "nullable": true }, "FunctionVersionId": { "type": "string", "description": "First contributing business-function version identifier, when applicable.", "nullable": true }, "FunctionVersion": { "type": "integer", "description": "First contributing business-function version number, when applicable.", "format": "int32", "nullable": true }, "OriginalUserId": { "type": "string", "description": "Interactive user that initiated the mutation chain, when any.", "nullable": true }, "CorrelationId": { "type": "string", "description": "Correlation identifier linking related operations.", "nullable": true }, "Contributors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceChangeContributor" }, "description": "All contributing business functions. Before-save EntitySave changes remain `SourceType = User`\r\nand list functions here; direct host `data.*` mutations remain `SourceType = Function`.", "nullable": true }, "OriginalUserName": { "type": "string", "description": "Resolved user login/name for OriginalUserId, when available.", "nullable": true } }, "additionalProperties": false, "description": "Source metadata captured for one entity-instance change entry." }, "EntityInstanceCommentSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Comment identifier.", "nullable": true }, "CommentText": { "type": "string", "description": "Comment text.", "nullable": true }, "CreatedByUserId": { "type": "string", "description": "Comment author identifier.", "nullable": true }, "CreatedByUserName": { "type": "string", "description": "Comment author display name.", "nullable": true }, "CreatedAt": { "type": "string", "description": "Comment creation timestamp.", "format": "date-time" } }, "additionalProperties": false, "description": "Compact summary of the latest comment on an entity instance." }, "EntityInstanceDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Instance identifier.", "nullable": true }, "Number": { "type": "string", "description": "Server-generated entity number.", "nullable": true }, "DisplayName": { "type": "string", "description": "Resolved entity display name or fallback number.", "nullable": true }, "Subtitle": { "type": "string", "description": "Resolved entity subtitle from the presentation cache.", "nullable": true }, "CreatedAt": { "type": "string", "description": "Instance creation timestamp.", "format": "date-time" }, "CreatedByUserId": { "type": "string", "description": "Creating user identifier when available.", "nullable": true }, "ModifiedAt": { "type": "string", "description": "Last modification timestamp when available.", "format": "date-time", "nullable": true }, "ModifiedByUserId": { "type": "string", "description": "Last modifying user identifier when available.", "nullable": true }, "ArchivedAt": { "type": "string", "description": "Archive timestamp when the instance is archived.", "format": "date-time", "nullable": true }, "ArchivedByUserId": { "type": "string", "description": "Archiving user identifier when available.", "nullable": true }, "LastComment": { "$ref": "#/components/schemas/EntityInstanceCommentSummary" }, "Tags": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceTag" }, "description": "Visible tags for the instance.", "nullable": true }, "TagCount": { "type": "integer", "description": "Total number of tags on the instance.", "format": "int32" }, "LastActivityDateTime": { "type": "string", "description": "Last activity timestamp for the instance.", "format": "date-time" }, "RowVersion": { "type": "string", "description": "Runtime row-version token from the primary table.", "format": "uuid" }, "Fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EntityInstanceFieldEnvelope" }, "description": "All runtime fields keyed by field key. User and role fields return compact reference models. Table fields return table metadata together with child rows.", "nullable": true }, "Predicates": { "type": "object", "additionalProperties": { "type": "boolean" }, "description": "Runtime-evaluated statement results keyed by statement identifier.", "nullable": true }, "Assignments": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResponsibilitySubject" } }, "description": "Common responsibility subjects keyed by stable responsibility key.", "nullable": true }, "Permissions": { "$ref": "#/components/schemas/EntityInstanceItemPermissions" }, "ResponsibilityDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResponsibilityDefinition" }, "description": "Runtime relation metadata for record-scoped assignment sections.", "nullable": true }, "MergeState": { "$ref": "#/components/schemas/EntityInstanceMergeState" }, "DisplayFields": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Display-only computed fields keyed by display-field key.", "nullable": true }, "ObjectContextFacts": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Provider-owned object-context facts keyed by provider key.", "nullable": true }, "ObjectInvariant": { "$ref": "#/components/schemas/ObjectInvariant" } }, "additionalProperties": false, "description": "Detailed entity-instance response." }, "EntityInstanceDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityInstanceDetail" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityInstanceFieldChange": { "type": "object", "properties": { "Key": { "type": "string", "description": "Stable field key or system field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Field display name captured for display.", "nullable": true }, "SystemField": { "$ref": "#/components/schemas/EntitySystemField" }, "BeforeValue": { "type": "object", "description": "Serialized value before the change." }, "AfterValue": { "type": "object", "description": "Serialized value after the change." }, "FieldId": { "type": "string", "description": "Immutable field identifier when the change targets a user-defined field.", "nullable": true }, "SemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "SemanticEvidenceState": { "$ref": "#/components/schemas/EntityInstanceAuditSemanticEvidenceState" }, "BeforePlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" }, "AfterPlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" } }, "additionalProperties": false, "description": "Scalar or system-field diff for one change entry." }, "EntityInstanceFieldEnvelope": { "type": "object", "properties": { "State": { "$ref": "#/components/schemas/EntityInstanceFieldState" }, "Value": { "type": "object", "description": "Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.", "nullable": true }, "PlainTextPreview": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" } }, "additionalProperties": false, "description": "Field envelope for runtime entity-instance responses." }, "EntityInstanceFieldState": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Value", "Restricted" ], "x-enum-descriptions": { "0": "The field value is readable and included in the response", "1": "The caller cannot read the field, so the value is withheld" } }, "EntityInstanceFieldValueOrigin": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "User", "Effect", "Calculation", "Default" ], "x-enum-descriptions": { "0": "The value was supplied by the caller's mutation payload", "1": "The value was written by a mutation effect during server-side evaluation", "2": "The value was produced by a calculated or aggregate field recomputation", "3": "The value was supplied by the field definition for an omitted primary field or new child-row field" } }, "EntityInstanceFormEvaluationResult": { "type": "object", "properties": { "Patch": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Canonical changed field values keyed by field key.", "nullable": true }, "ReferencePatchValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EntityReferenceValue" }, "description": "Actor-shaped display and required projection payloads for scalar Reference values present in Patch.", "nullable": true }, "FieldOrigins": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EntityInstanceFieldValueOrigin" }, "description": "Authoritative value origins keyed by readable field key.", "nullable": true }, "LoadingFieldKeys": { "type": "array", "items": { "type": "string" }, "description": "Fields affected by the evaluation generation.", "nullable": true }, "FieldErrors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "description": "Field-scoped evaluation errors.", "nullable": true }, "Skips": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "description": "Non-fatal evaluation diagnostics.", "nullable": true } }, "additionalProperties": false, "description": "Result of server-side form mutation-effect evaluation." }, "EntityInstanceFormEvaluationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityInstanceFormEvaluationResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityInstanceHierarchyIssue": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "SelfParentCut", "CycleCut" ], "x-enum-descriptions": { "0": "No hierarchy integrity issue was detected for the node", "1": "The node referenced itself as parent, so the edge was cut and the node was exposed safely", "2": "The node participated in a finite parent cycle, so one edge was cut and the node was exposed safely" } }, "EntityInstanceItemPermissions": { "type": "object", "properties": { "CanRead": { "type": "boolean", "description": "Whether the caller can read the active instance." }, "CanReadArchive": { "type": "boolean", "description": "Whether the caller can read the instance while it is archived." }, "CanReadChangesHistory": { "type": "boolean", "description": "Whether the caller can read the change history for this instance." }, "CanReadComments": { "type": "boolean", "description": "Whether comments can be viewed for this instance." }, "CanReadTags": { "type": "boolean", "description": "Whether tags can be viewed for this instance." }, "CanReadAttachments": { "type": "boolean", "description": "Whether attachments can be viewed for this instance." } }, "additionalProperties": false, "description": "Item-level permissions for one entity instance." }, "EntityInstanceListItem": { "type": "object", "properties": { "Id": { "type": "string", "description": "Instance identifier.", "nullable": true }, "Number": { "type": "string", "description": "Server-generated entity number.", "nullable": true }, "DisplayName": { "type": "string", "description": "Resolved entity display name or fallback number.", "nullable": true }, "Subtitle": { "type": "string", "description": "Resolved entity subtitle from the presentation cache.", "nullable": true }, "CreatedAt": { "type": "string", "description": "Instance creation timestamp.", "format": "date-time" }, "CreatedByUserId": { "type": "string", "description": "Creating user identifier when available.", "nullable": true }, "ModifiedAt": { "type": "string", "description": "Last modification timestamp when available.", "format": "date-time", "nullable": true }, "ModifiedByUserId": { "type": "string", "description": "Last modifying user identifier when available.", "nullable": true }, "ArchivedAt": { "type": "string", "description": "Archive timestamp when the instance is archived.", "format": "date-time", "nullable": true }, "ArchivedByUserId": { "type": "string", "description": "Archiving user identifier when available.", "nullable": true }, "LastComment": { "$ref": "#/components/schemas/EntityInstanceCommentSummary" }, "Tags": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceTag" }, "description": "Visible tags for the instance. List payloads include the first few tags only.", "nullable": true }, "TagCount": { "type": "integer", "description": "Total number of tags on the instance.", "format": "int32" }, "LastActivityDateTime": { "type": "string", "description": "Last activity timestamp for the instance.", "format": "date-time" }, "RowVersion": { "type": "string", "description": "Runtime row-version token from the primary table.", "format": "uuid" }, "Fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EntityInstanceFieldEnvelope" }, "description": "Readable primary-table scalar fields keyed by field key. Denied fields are omitted.", "nullable": true }, "Predicates": { "type": "object", "additionalProperties": { "type": "boolean" }, "description": "Runtime-evaluated statement results keyed by statement identifier.", "nullable": true }, "Permissions": { "$ref": "#/components/schemas/EntityInstanceItemPermissions" }, "Assignments": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResponsibilitySubject" } }, "description": "Relation assignments keyed by relation key for record-scoped entities.", "nullable": true }, "MergeState": { "$ref": "#/components/schemas/EntityInstanceMergeState" }, "DisplayFields": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Display-only computed fields keyed by display-field key.", "nullable": true }, "ProjectionSource": { "$ref": "#/components/schemas/EntityInstanceProjectionSource" }, "ObjectContextFacts": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Provider-owned object-context facts keyed by provider key.", "nullable": true }, "ObjectInvariant": { "$ref": "#/components/schemas/ObjectInvariant" } }, "additionalProperties": false, "description": "List item for one entity instance." }, "EntityInstanceListQueryRequest": { "type": "object", "properties": { "Page": { "type": "integer", "description": "One-based page number. Values below 1 are normalized to 1.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Requested page size. The default is 25 and the maximum is 250.", "format": "int32" }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" }, "Filter": { "$ref": "#/components/schemas/EntityInstanceQueryFilterGroupRequest" }, "Sort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Optional multi-level sort list. Supports up to three sort items.", "nullable": true }, "Include": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryIncludeRequest" }, "description": "Optional reference include paths materialized into reference projected values.", "nullable": true }, "QueryStateSource": { "$ref": "#/components/schemas/EntityInstanceQueryStateSource" }, "BaseSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Sort owned by the complete saved/global/share query state. Moltaro.Entity.Instances.Requests.EntityInstanceListQueryRequest.Sort remains the\r\ncurrent explicit user request and therefore has higher precedence. Ordinary list APIs ignore\r\nthis value.", "nullable": true }, "ExpectedContainerSurfaceId": { "type": "string", "description": "Optional Entity List Page identity captured by a UI preflight. Hosted table endpoints\r\nreject the request when the route now resolves to a different container, including when\r\nthat replacement still selects the same Table Surface. An empty value explicitly expects\r\nno resolved container; null disables the check for older clients and\r\nnon-hosted requests.", "nullable": true }, "ExpectedTableSurfaceId": { "type": "string", "description": "Optional Table Surface identity captured by a UI preflight. Hosted table and generic\r\nReference picker endpoints reject the request when the host now resolves to a different\r\ntable, so a filter scoped to one surface is never executed against another. An empty value\r\nexplicitly expects no resolved table; null disables the check for older\r\nclients. Ordinary list APIs ignore this value.", "nullable": true } }, "additionalProperties": false, "description": "Request payload for runtime entity-instance list queries and table bootstrap queries." }, "EntityInstanceManualOrderMove": { "type": "object", "properties": { "Kind": { "$ref": "#/components/schemas/EntityManualOrderMoveKind" }, "Target": { "allOf": [ { "$ref": "#/components/schemas/EntityReferenceValue" } ], "nullable": true } }, "additionalProperties": false, "description": "Access-safe Manual Order move evidence returned by entity history." }, "EntityInstanceMergeState": { "type": "object", "properties": { "IsMergedAway": { "type": "boolean" }, "MergedIntoInstanceId": { "type": "string", "nullable": true }, "MergeOperationId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Merge state attached to entity instance payloads." }, "EntityInstanceOpenTarget": { "type": "object", "properties": { "RequestedEntityDefinitionId": { "type": "string", "nullable": true }, "RequestedInstanceId": { "type": "string", "nullable": true }, "TargetEntityDefinitionId": { "type": "string", "nullable": true }, "TargetInstanceId": { "type": "string", "nullable": true }, "TargetEntityDisplayNameSingular": { "type": "string", "nullable": true }, "TargetEntityDisplayNamePlural": { "type": "string", "nullable": true }, "IsProjectionUnwrapped": { "type": "boolean" }, "ProjectionReferenceFieldId": { "type": "string", "nullable": true }, "OpenTarget": { "$ref": "#/components/schemas/ResourceOpenTarget" } }, "additionalProperties": false, "description": "Resolved runtime target for opening one entity instance from UI navigation." }, "EntityInstanceOpenTargetResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityInstanceOpenTarget" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityInstancePage": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceListItem" }, "description": "Current page of instance summaries.", "nullable": true }, "TotalCount": { "type": "integer", "description": "Total accessible instance count for the active page filter.", "format": "int32" }, "Page": { "type": "integer", "description": "One-based page number.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Requested page size after normalization.", "format": "int32" }, "Permissions": { "$ref": "#/components/schemas/EntityInstancePagePermissions" }, "ResponsibilityDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResponsibilityDefinition" }, "description": "Runtime relation metadata for record-scoped assignment columns.", "nullable": true } }, "additionalProperties": false, "description": "Paginated entity-instance response for one runtime entity definition." }, "EntityInstancePagePermissions": { "type": "object", "properties": { "CanCreate": { "type": "boolean", "description": "Whether the caller can create a new instance for this entity definition." }, "CanReadActive": { "type": "boolean", "description": "Whether the caller can read active instances for this entity definition." }, "CanReadArchive": { "type": "boolean", "description": "Whether the caller can read archived instances for this entity definition." }, "CanReadChangesHistory": { "type": "boolean", "description": "Whether the caller can read change history for this entity definition." }, "CanMerge": { "type": "boolean", "description": "Whether the caller can potentially merge records for this entity definition." } }, "additionalProperties": false, "description": "Page-level permissions for entity instances." }, "EntityInstancePageResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityInstancePage" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityInstanceProjectionSource": { "type": "object", "properties": { "ProjectionMemberId": { "type": "string", "nullable": true }, "ReferenceFieldId": { "type": "string", "nullable": true }, "SourceEntityDefinitionId": { "type": "string", "nullable": true }, "Label": { "type": "string", "nullable": true }, "SourceEntityDisplayNameSingular": { "type": "string", "nullable": true }, "SourceEntityDisplayNamePlural": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Display-only source member metadata for a projection row." }, "EntityInstanceQueryBoundingBoxRequest": { "type": "object", "properties": { "SouthWest": { "$ref": "#/components/schemas/EntityInstanceQueryGeoPointRequest" }, "NorthEast": { "$ref": "#/components/schemas/EntityInstanceQueryGeoPointRequest" } }, "additionalProperties": false, "description": "Reserved WGS84 bounding box for future spatial queries." }, "EntityInstanceQueryConditionRequest": { "type": "object", "properties": { "Field": { "$ref": "#/components/schemas/EntityInstanceQueryFieldReferenceRequest" }, "Target": { "$ref": "#/components/schemas/EntityInstanceQueryConditionTargetRequest" }, "Operator": { "$ref": "#/components/schemas/EntityInstanceQueryOperator" }, "Values": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryOperandRequest" }, "description": "Operand list for the selected operator.", "nullable": true }, "RowsFilter": { "$ref": "#/components/schemas/EntityInstanceQueryFilterGroupRequest" }, "Spatial": { "$ref": "#/components/schemas/EntityInstanceQuerySpatialConditionRequest" } }, "additionalProperties": false, "description": "One leaf condition in the runtime list query tree." }, "EntityInstanceQueryConditionTargetRequest": { "type": "object", "properties": { "Path": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryFieldReferenceRequest" }, "description": "Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both\r\nare supplied they must resolve to the same field in the entity reached by the preceding segment.", "nullable": true } }, "additionalProperties": false, "description": "Typed server-side condition target. The first segment belongs to the queried entity; every\r\nintermediate segment must be a readable primary-table reference, and the terminal segment\r\ndetermines the field type, supported operators, and operand shape." }, "EntityInstanceQueryFieldReferenceRequest": { "type": "object", "properties": { "FieldId": { "type": "string", "description": "Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.", "nullable": true }, "FieldKey": { "type": "string", "description": "Field key resolved through the current entity's normalized-key index. If FieldId is also supplied, both must resolve to the same field.", "nullable": true }, "Special": { "$ref": "#/components/schemas/EntityInstanceQuerySpecialField" }, "StatementId": { "type": "string", "description": "Statement identifier resolved through the runtime statement index.", "nullable": true }, "StatementKey": { "type": "string", "description": "Statement key resolved through the runtime normalized-key index.", "nullable": true }, "ObjectContextFactId": { "type": "string", "description": "Configured object-context fact identifier.", "nullable": true }, "ObjectContextFactFilterKey": { "type": "string", "description": "Provider-owned object-context fact filter facet key.", "nullable": true } }, "additionalProperties": false, "description": "Reference to a runtime field by identifier, normalized key, or special query field. In a typed\r\npath the segment is resolved against the entity reached by the preceding reference." }, "EntityInstanceQueryFilterGroupRequest": { "type": "object", "properties": { "Operator": { "$ref": "#/components/schemas/EntityInstanceQueryGroupOperator" }, "Conditions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryConditionRequest" }, "description": "Direct conditions inside this group.", "nullable": true }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryFilterGroupRequest" }, "description": "Nested child groups.", "nullable": true } }, "additionalProperties": false, "description": "One nested logical filter group." }, "EntityInstanceQueryGeoPointRequest": { "type": "object", "properties": { "Latitude": { "type": "number", "description": "Latitude in decimal degrees.", "format": "double" }, "Longitude": { "type": "number", "description": "Longitude in decimal degrees.", "format": "double" }, "FullAddress": { "type": "string", "description": "Optional display address selected by the user.", "nullable": true } }, "additionalProperties": false, "description": "Geographic point in WGS84 coordinates." }, "EntityInstanceQueryGroupOperator": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "And", "Or" ], "x-enum-descriptions": { "0": "Match records that satisfy every condition and nested group in the filter group", "1": "Match records that satisfy at least one condition or nested group in the filter group" } }, "EntityInstanceQueryIncludeRequest": { "type": "object", "properties": { "Path": { "type": "array", "items": { "type": "string" }, "description": "Runtime field key path segments. Paths resolve through primary-table reference fields only.", "nullable": true } }, "additionalProperties": false, "description": "One post-load reference include path." }, "EntityInstanceQueryOperandKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Value", "Variable" ], "x-enum-descriptions": { "0": "Compare against the literal value supplied in the operand", "1": "Compare against a runtime variable resolved when the query executes" } }, "EntityInstanceQueryOperandRequest": { "type": "object", "properties": { "Kind": { "$ref": "#/components/schemas/EntityInstanceQueryOperandKind" }, "Value": { "type": "object", "description": "Literal JSON value used when Moltaro.Entity.Instances.Requests.EntityInstanceQueryOperandRequest.Kind is Moltaro.Enums.EntityInstanceQueryOperandKindEnum.Value.\r\nSelect and enum fields accept the string option key; numeric enum ordinals and display labels are not operands.", "nullable": true }, "Variable": { "$ref": "#/components/schemas/EntityInstanceQueryVariable" } }, "additionalProperties": false, "description": "One query operand." }, "EntityInstanceQueryOperator": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Eq", "Ne", "Gt", "Gte", "Lt", "Lte", "Between", "In", "NotIn", "Contains", "NotContains", "StartsWith", "EndsWith", "IsNull", "IsNotNull", "IsEmpty", "IsNotEmpty", "ContainsAny", "ContainsAll", "NotContainsAny", "HasAnyRows", "HasNoRows", "RowCountEq", "RowCountNe", "RowCountGt", "RowCountGte", "RowCountLt", "RowCountLte", "RowCountBetween", "HasRowsWhere", "WithinArea", "InBranch", "NotInBranch" ], "x-enum-descriptions": { "0": "Match values equal to the operand", "1": "Match values not equal to the operand", "2": "Match values greater than the operand", "3": "Match values greater than or equal to the operand", "4": "Match values less than the operand", "5": "Match values less than or equal to the operand", "6": "Match values within the inclusive range defined by two operands", "7": "Match values equal to any of the supplied operands", "8": "Match values equal to none of the supplied operands", "9": "Match values that contain the operand text", "10": "Match values that do not contain the operand text", "11": "Match values that start with the operand text", "12": "Match values that end with the operand text", "13": "Match records where the field has no stored value", "14": "Match records where the field has a stored value", "15": "Match records whose field value is missing, blank, or has no items", "16": "Match records whose field has a non-blank value or at least one item", "17": "Match multi-value fields containing at least one of the operand values", "18": "Match multi-value fields containing every operand value", "19": "Match multi-value fields containing none of the operand values", "20": "Match records whose table or inverse-reference field has at least one row", "21": "Match records whose table or inverse-reference field has no rows", "22": "Match records whose child row count equals the operand", "23": "Match records whose child row count differs from the operand", "24": "Match records whose child row count is greater than the operand", "25": "Match records whose child row count is greater than or equal to the operand", "26": "Match records whose child row count is less than the operand", "27": "Match records whose child row count is less than or equal to the operand", "28": "Match records whose child row count falls within the inclusive range defined by two operands", "29": "Match records having at least one child row that satisfies the nested rows filter", "30": "Match records whose stored address point lies inside the supplied spatial shape", "31": "Match classifier values assigned to the selected category or one of its descendants", "32": "Match non-null classifier values assigned outside the selected category branch" } }, "EntityInstanceQueryOption": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable option identifier.", "nullable": true }, "Label": { "type": "string", "description": "Localized user-facing label.", "nullable": true }, "Kind": { "$ref": "#/components/schemas/EntityInstanceQueryOptionKind" }, "Reference": { "$ref": "#/components/schemas/EntityInstanceQueryFieldReferenceRequest" }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "AllowMultiple": { "type": "boolean", "description": "Whether multiple values are allowed for the bound field." }, "DecimalPrecision": { "type": "integer", "description": "Decimal precision when applicable.", "format": "int32", "nullable": true }, "DecimalScale": { "type": "integer", "description": "Decimal scale when applicable.", "format": "int32", "nullable": true }, "StringMaxLength": { "type": "integer", "description": "String max length when applicable.", "format": "int32", "nullable": true }, "ReferenceToEntityDefinitionId": { "type": "string", "description": "Target entity definition identifier for reference-style fields.", "nullable": true }, "PairedReferenceFieldId": { "type": "string", "description": "Paired reference field identifier for inverse-reference fields.", "nullable": true }, "ReferenceDeleteBehavior": { "$ref": "#/components/schemas/ReferenceDeleteBehavior" }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldOption" }, "description": "Select options when applicable.", "nullable": true }, "CanFilter": { "type": "boolean", "description": "Whether the backend accepts filter predicates for this option." }, "FilterOperators": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryOperator" }, "description": "Operators accepted by the backend for this option.", "nullable": true }, "FilterVariables": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryVariable" }, "description": "Runtime variables accepted by the backend for this option.", "nullable": true }, "CanSort": { "type": "boolean", "description": "Whether the backend accepts sort items for this option." }, "RowsFilterOptions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryOption" }, "description": "Direct child options available inside `RowsFilter` for root table fields.", "nullable": true }, "BaseCurrencyCode": { "type": "string", "description": "Base currency code for Money fields.", "nullable": true }, "ClassifierCatalogDefinitionId": { "type": "string", "description": "Bound Classifier Catalog Definition identifier.", "nullable": true }, "SemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" } }, "additionalProperties": false, "description": "One runtime query target with backend-approved filter and sort capabilities." }, "EntityInstanceQueryOptionKind": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Field", "SystemField", "Statement", "Special", "ObjectContextFact" ], "x-enum-descriptions": { "0": "Targets a configured field of the entity definition", "1": "Targets a fixed runtime system field such as DisplayName or CreatedAt", "2": "Targets a computed statement predicate exposed to clients", "3": "Targets a special non-entity query surface such as configured SearchTerm", "4": "Targets a configured object-context fact instead of stored entity data" } }, "EntityInstanceQueryOptions": { "type": "object", "properties": { "Options": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryOption" }, "description": "Ordered list of query targets available to the current caller.", "nullable": true }, "MaxSortItems": { "type": "integer", "description": "Maximum number of accepted sort items.", "format": "int32" } }, "additionalProperties": false, "description": "Backend-approved query capabilities for one runtime entity definition." }, "EntityInstanceQueryOptionsResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityInstanceQueryOptions" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityInstanceQuerySortDirection": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Asc", "Desc" ], "x-enum-descriptions": { "0": "Sort values from lowest to highest", "1": "Sort values from highest to lowest" } }, "EntityInstanceQuerySortRequest": { "type": "object", "properties": { "Field": { "$ref": "#/components/schemas/EntityInstanceQueryFieldReferenceRequest" }, "Target": { "$ref": "#/components/schemas/EntityInstanceQuerySortTargetRequest" }, "Direction": { "$ref": "#/components/schemas/EntityInstanceQuerySortDirection" } }, "additionalProperties": false, "description": "One sort item in the runtime list query." }, "EntityInstanceQuerySortTargetRequest": { "type": "object", "properties": { "Path": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryFieldReferenceRequest" }, "description": "Ordered path of one to four segments ending in a sortable field or system field. Each segment\r\nmay contain an ID, a key, or both; an ID/key mismatch is rejected.", "nullable": true } }, "additionalProperties": false, "description": "Typed server-side sort target. The first segment belongs to the queried entity; every\r\nintermediate segment must be a readable, sortable primary-table reference." }, "EntityInstanceQuerySpatialConditionRequest": { "type": "object", "properties": { "ShapeKind": { "$ref": "#/components/schemas/EntityInstanceQuerySpatialShapeKind" }, "Center": { "$ref": "#/components/schemas/EntityInstanceQueryGeoPointRequest" }, "RadiusKm": { "type": "number", "description": "Radius in kilometers for radius-based queries.", "format": "double", "nullable": true }, "BoundingBox": { "$ref": "#/components/schemas/EntityInstanceQueryBoundingBoxRequest" }, "Polygon": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryGeoPointRequest" }, "description": "Reserved polygon payload for future spatial queries.", "nullable": true } }, "additionalProperties": false, "description": "Spatial operand for address-style runtime query conditions." }, "EntityInstanceQuerySpatialShapeKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Radius", "BoundingBox", "Polygon" ], "x-enum-descriptions": { "0": "Match points within the given radius in kilometers around a center coordinate", "1": "Reserved for rectangular bounding box matching and currently rejected as unsupported", "2": "Reserved for polygon area matching and currently rejected as unsupported" } }, "EntityInstanceQuerySpecialField": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "SearchTerm", "ManualOrder" ], "x-enum-descriptions": { "0": "Virtual query field that targets the configured search term instead of a stored field", "1": "Canonical Entity Definition Manual Order" } }, "EntityInstanceQueryStateSource": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Default", "GlobalDefaultView", "SavedView", "QueryShare", "ResolvedDefault" ], "x-enum-descriptions": { "0": "Normal runtime composition may overlay the current user's Table Surface sort", "1": "The visible global default saved view is the complete base query state", "2": "An explicitly opened saved view owns the complete query state", "3": "An explicitly opened query share owns the complete query state", "4": "A server-resolved ordinary default is frozen as the complete base for continuation requests" } }, "EntityInstanceQueryVariable": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "CurrentDate", "CurrentUserId" ], "x-enum-descriptions": { "0": "Resolves to today's date in the workspace time zone when the query executes", "1": "Resolves to the id of the user executing the query" } }, "EntityInstanceTableChange": { "type": "object", "properties": { "FieldKey": { "type": "string", "description": "Table field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Table field display name.", "nullable": true }, "RowChanges": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceTableRowChange" }, "description": "Changed rows inside the table field.", "nullable": true }, "FieldId": { "type": "string", "description": "Immutable table-field identifier.", "nullable": true } }, "additionalProperties": false, "description": "Diff for one table field." }, "EntityInstanceTableRowChange": { "type": "object", "properties": { "ChangeType": { "$ref": "#/components/schemas/EntityInstanceTableRowChangeType" }, "RowId": { "type": "string", "description": "Row identifier.", "nullable": true }, "BeforeSortOrder": { "type": "integer", "description": "Sort order before the change.", "format": "int32", "nullable": true }, "AfterSortOrder": { "type": "integer", "description": "Sort order after the change.", "format": "int32", "nullable": true }, "BeforeRow": { "$ref": "#/components/schemas/EntityInstanceTableRowSnapshot" }, "AfterRow": { "$ref": "#/components/schemas/EntityInstanceTableRowSnapshot" }, "FieldChanges": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceFieldChange" }, "description": "Changed cells for updated rows.", "nullable": true } }, "additionalProperties": false, "description": "Diff for one table row." }, "EntityInstanceTableRowChangeType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Added", "Updated", "Removed" ], "x-enum-descriptions": { "0": "The child table row was added during the change", "1": "The child table row's values were updated during the change", "2": "The child table row was removed during the change" } }, "EntityInstanceTableRowSnapshot": { "type": "object", "properties": { "Id": { "type": "string", "description": "Row identifier.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Stored row sort order.", "format": "int32" }, "Fields": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Serialized field values keyed by child field key.", "nullable": true }, "FieldIds": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Immutable child-field identifiers keyed by child field key.", "nullable": true }, "SemanticRoles": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "description": "Material semantic roles keyed by readable child field key.", "nullable": true }, "SemanticEvidenceStates": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EntityInstanceAuditSemanticEvidenceState" }, "description": "Evidence state keyed by readable child field key.", "nullable": true }, "PlainTextPreviews": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" }, "description": "Compact Markdown previews keyed by readable child field key.", "nullable": true } }, "additionalProperties": false, "description": "Snapshot of one table row stored alongside a row diff." }, "EntityInstanceTag": { "type": "object", "properties": { "Id": { "type": "string", "description": "Tag identifier.", "nullable": true }, "TagName": { "type": "string", "description": "Tag name.", "nullable": true }, "Color": { "type": "string", "description": "Optional color value.", "nullable": true }, "Category": { "type": "string", "description": "Optional category.", "nullable": true } }, "additionalProperties": false, "description": "Compact tag details for one entity instance." }, "EntityInstanceTagListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceTag" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityJsonExportEntity": { "type": "object", "properties": { "Id": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "Key": { "type": "string", "description": "Internal entity key.", "nullable": true }, "DisplayNameSingular": { "type": "string", "description": "User-facing singular display name.", "nullable": true }, "DisplayNamePlural": { "type": "string", "description": "User-facing plural display name.", "nullable": true } }, "additionalProperties": false, "description": "Entity definition metadata included in a JSON export document." }, "EntityJsonExportResult": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Download file name.", "nullable": true }, "ContentType": { "type": "string", "description": "Download content type.", "nullable": true }, "Content": { "type": "string", "description": "Serialized JSON bytes.", "format": "byte", "nullable": true } }, "additionalProperties": false, "description": "Generated JSON export file content." }, "EntityJsonExportResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityJsonExportResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityJsonImportApplyResult": { "type": "object", "properties": { "FormatVersion": { "type": "integer", "description": "JSON data transfer format version.", "format": "int32" }, "AppliedAtUtc": { "type": "string", "description": "UTC timestamp when apply finished.", "format": "date-time" }, "Entity": { "$ref": "#/components/schemas/EntityJsonExportEntity" }, "Profile": { "$ref": "#/components/schemas/EntityJsonImportPlanProfile" }, "Summary": { "$ref": "#/components/schemas/EntityJsonImportApplySummary" }, "IssueCategories": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataTransferImportIssueCategoryCount" }, "description": "Warning and error counts grouped into stable workflow categories.", "nullable": true }, "Rows": { "type": "array", "items": { "$ref": "#/components/schemas/EntityJsonImportApplyRow" }, "description": "Per-selected-row apply results.", "nullable": true } }, "additionalProperties": false, "description": "Result of applying selected rows from a JSON entity-instance import package." }, "EntityJsonImportApplyResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityJsonImportApplyResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityJsonImportApplyRow": { "type": "object", "properties": { "RowIndex": { "type": "integer", "description": "One-based row index in the uploaded JSON records array.", "format": "int32" }, "IdentityValue": { "description": "Resolved identity value used for matching.", "nullable": true }, "Action": { "$ref": "#/components/schemas/ImportPlanAction" }, "TargetInstanceId": { "type": "string", "description": "Matched runtime entity instance id when the row updated an existing record.", "nullable": true }, "ResultInstanceId": { "type": "string", "description": "Affected runtime entity instance id after a successful mutation.", "nullable": true }, "RowVersion": { "type": "string", "description": "Current optimistic-concurrency token after a successful mutation.", "format": "uuid", "nullable": true }, "ChangedFieldKeys": { "type": "array", "items": { "type": "string" }, "description": "Canonical field keys changed by the committed mutation.", "nullable": true }, "Status": { "$ref": "#/components/schemas/ImportPlanStatus" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "description": "Blocking row or mutation errors.", "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "description": "Non-blocking row or mutation warnings.", "nullable": true } }, "additionalProperties": false, "description": "Result for one selected JSON import row." }, "EntityJsonImportApplySummary": { "type": "object", "properties": { "RequestedRows": { "type": "integer", "description": "Selected uploaded row count.", "format": "int32" }, "SucceededRows": { "type": "integer", "description": "Rows applied successfully, including rows with warnings.", "format": "int32" }, "FailedRows": { "type": "integer", "description": "Rows that failed validation or mutation.", "format": "int32" }, "WarningRows": { "type": "integer", "description": "Rows applied with warnings.", "format": "int32" }, "CreateRows": { "type": "integer", "description": "Selected rows classified as creates.", "format": "int32" }, "UpdateRows": { "type": "integer", "description": "Selected rows classified as updates.", "format": "int32" }, "SkipRows": { "type": "integer", "description": "Selected rows classified as skipped.", "format": "int32" } }, "additionalProperties": false, "description": "Aggregate counts for a JSON import apply operation." }, "EntityJsonImportPlan": { "type": "object", "properties": { "FormatVersion": { "type": "integer", "description": "JSON data transfer format version.", "format": "int32" }, "GeneratedAtUtc": { "type": "string", "description": "UTC timestamp when the plan was generated.", "format": "date-time" }, "Entity": { "$ref": "#/components/schemas/EntityJsonExportEntity" }, "Profile": { "$ref": "#/components/schemas/EntityJsonImportPlanProfile" }, "Summary": { "$ref": "#/components/schemas/EntityJsonImportPlanSummary" }, "IssueCategories": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataTransferImportIssueCategoryCount" }, "description": "Warning and error counts grouped into stable workflow categories.", "nullable": true }, "Rows": { "type": "array", "items": { "$ref": "#/components/schemas/EntityJsonImportPlanRow" }, "description": "Per-record plan rows.", "nullable": true } }, "additionalProperties": false, "description": "Non-destructive JSON import plan for entity instances." }, "EntityJsonImportPlanProfile": { "type": "object", "properties": { "Id": { "type": "string", "description": "Profile identifier.", "nullable": true }, "Key": { "type": "string", "description": "Stable profile key.", "nullable": true }, "Name": { "type": "string", "description": "User-facing profile name.", "nullable": true }, "ImportMode": { "$ref": "#/components/schemas/EntityDataTransferImportMode" }, "IdentityMode": { "$ref": "#/components/schemas/EntityDataTransferIdentityMode" } }, "additionalProperties": false, "description": "Import profile metadata used to generate a JSON import plan." }, "EntityJsonImportPlanResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityJsonImportPlan" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityJsonImportPlanRow": { "type": "object", "properties": { "RowIndex": { "type": "integer", "description": "One-based row index in the uploaded JSON records array.", "format": "int32" }, "IdentityValue": { "description": "Resolved identity value used for matching.", "nullable": true }, "TargetInstanceId": { "type": "string", "description": "Matched runtime entity instance id when the row updates an existing record.", "nullable": true }, "Action": { "$ref": "#/components/schemas/ImportPlanAction" }, "Status": { "$ref": "#/components/schemas/ImportPlanStatus" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "description": "Blocking row or field errors.", "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "description": "Non-blocking row or field warnings.", "nullable": true } }, "additionalProperties": false, "description": "One planned JSON import row." }, "EntityJsonImportPlanSummary": { "type": "object", "properties": { "TotalRows": { "type": "integer", "description": "Total uploaded record count.", "format": "int32" }, "ValidRows": { "type": "integer", "description": "Rows that can move forward to apply in a later sprint.", "format": "int32" }, "ErrorRows": { "type": "integer", "description": "Rows with blocking errors.", "format": "int32" }, "WarningRows": { "type": "integer", "description": "Rows with non-blocking warnings.", "format": "int32" }, "CreateRows": { "type": "integer", "description": "Rows classified as creates.", "format": "int32" }, "UpdateRows": { "type": "integer", "description": "Rows classified as updates.", "format": "int32" }, "SkipRows": { "type": "integer", "description": "Rows classified as skipped.", "format": "int32" } }, "additionalProperties": false, "description": "Aggregate counts for a JSON import plan." }, "EntityListPageBootstrap": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "Model": { "$ref": "#/components/schemas/EntityListPageRuntime" }, "MissingSurface": { "$ref": "#/components/schemas/EntityUiMissingSurface" }, "ResolvedContainerSurfaceId": { "type": "string", "description": "Resolved Entity List Page surface id, or null when the container is unavailable.", "nullable": true }, "ResolvedTableSurfaceId": { "type": "string", "description": "Resolved Table surface id, or null when the selected table is unavailable.", "nullable": true } }, "additionalProperties": false, "description": "Runtime bootstrap payload for the top-level list page." }, "EntityListPageBootstrapResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityListPageBootstrap" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityListPageRuntime": { "type": "object", "properties": { "MainTableSelector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "HasConfiguredRuntimeFilterItems": { "type": "boolean" }, "RuntimeFilterItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceRuntimeFilterItem" }, "nullable": true }, "RuntimeUnavailableFilterItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceUnavailableTarget" }, "nullable": true }, "RuntimeSortItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceRuntimeSortItem" }, "nullable": true }, "RuntimeUnavailableSortItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceUnavailableTarget" }, "nullable": true }, "RuntimeDefaultSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Runtime top-level list-page orchestration model resolved from persisted configuration and current access." }, "EntityLookupTableBootstrapRequest": { "type": "object", "properties": { "Page": { "type": "integer", "description": "One-based page number. Values below 1 are normalized to 1.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Requested page size. The default is taken from the resolved table surface when omitted or invalid.", "format": "int32" }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" }, "Include": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryIncludeRequest" }, "description": "Optional reference include paths materialized into reference projected values.", "nullable": true }, "Filter": { "$ref": "#/components/schemas/EntityInstanceQueryFilterGroupRequest" }, "Sort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Optional sort applied to the resolved lookup target table.", "nullable": true }, "ExpectedFormSurfaceRowVersion": { "type": "string", "description": "Exact saved Form Surface revision that owns the Lookup item.", "format": "uuid" }, "ExpectedTableSurfaceId": { "type": "string", "description": "Table Surface id returned by the Lookup grid-settings preflight. The runtime rejects the\r\nrequest when role resolution now selects a different table.", "nullable": true }, "SourceInstanceId": { "type": "string", "description": "Existing source identifier for edit, or null for create.", "nullable": true }, "CurrentValues": { "$ref": "#/components/schemas/EntityReferenceCurrentValuesRequest" }, "QueryStateSource": { "$ref": "#/components/schemas/EntityInstanceQueryStateSource" }, "BaseSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Sort owned by the complete saved/global/share query state.", "nullable": true } }, "additionalProperties": false, "description": "Request payload for a lookup table resolved from a persisted form item UI context." }, "EntityLookupTableTreeChildrenRequest": { "required": [ "ExpectedLookupFormSurfaceRowVersion", "ExpectedTableSurfaceId", "ExpectedTableSurfaceRowVersion", "ParentInstanceId" ], "type": "object", "properties": { "ParentInstanceId": { "minLength": 1, "type": "string", "description": "Parent instance whose direct children are requested." }, "ExpectedTableSurfaceId": { "minLength": 1, "type": "string", "description": "Table Surface identifier returned by lookup bootstrap." }, "ExpectedTableSurfaceRowVersion": { "type": "string", "description": "Table Surface revision returned by lookup bootstrap.", "format": "uuid" }, "ExpectedLookupFormSurfaceRowVersion": { "type": "string", "description": "Source Form Surface revision returned by lookup bootstrap.", "format": "uuid" }, "SourceInstanceId": { "type": "string", "description": "Existing source identifier for edit, or null for create.", "nullable": true }, "CurrentValues": { "$ref": "#/components/schemas/EntityReferenceCurrentValuesRequest" }, "Page": { "type": "integer", "description": "One-based child sibling page.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Requested child sibling page size.", "format": "int32" }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" }, "Include": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQueryIncludeRequest" }, "description": "Requested materialization include paths.", "nullable": true }, "Filter": { "$ref": "#/components/schemas/EntityInstanceQueryFilterGroupRequest" }, "Sort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Current ordered sibling sort sequence.", "nullable": true }, "QueryStateSource": { "$ref": "#/components/schemas/EntityInstanceQueryStateSource" }, "BaseSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Sort owned by the complete saved/global/share query state.", "nullable": true } }, "additionalProperties": false, "description": "Context-preserving child request for a persisted Reference Lookup form item." }, "EntityManualOrderDefinition": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "SchemaSource": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "nullable": true }, "SourcePackageId": { "type": "string", "nullable": true }, "SourceStableId": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Admin-facing Manual Order capability metadata without protected rank storage details." }, "EntityManualOrderMoveKind": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "GlobalBefore", "GlobalAfter", "SiblingBefore", "SiblingAfter", "InsideLast", "RootStart", "RootEnd" ], "x-enum-descriptions": { "0": "Place before a target in the global canonical order", "1": "Place after a target in the global canonical order", "2": "Place before a target in its effective visible sibling set", "3": "Place after a target in its effective visible sibling set", "4": "Move inside a target parent as its last effective child", "5": "Move to the start of the effective visible root level", "6": "Move to the end of the effective visible root level" } }, "EntityManualOrderRuntimeCapabilityState": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Runtime availability of the Entity Definition's Manual Order capability.", "format": "int32", "x-enum-varnames": [ "Absent", "Available", "Unavailable" ], "x-enum-descriptions": { "0": "The Entity Definition has no Manual Order capability", "1": "The capability and its exact physical storage are available", "2": "The capability exists, but its metadata or physical storage is unavailable" } }, "EntityMutationResult": { "type": "object", "additionalProperties": false }, "EntityMutationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityMutationResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityObjectContextFact": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "ProviderKey": { "type": "string", "nullable": true }, "Target": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "SortOrder": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Object-context fact configuration for one entity definition." }, "EntityObjectHostedLayout": { "type": "object", "properties": { "Surface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityObjectHostedLayoutItem" }, "nullable": true } }, "additionalProperties": false, "description": "Object-hosted layout for a single record details page or drawer." }, "EntityObjectHostedLayoutItem": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "ItemKind": { "$ref": "#/components/schemas/EntityObjectHostedLayoutItemKind" }, "BlockKind": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockKind" }, "StandardBlock": { "$ref": "#/components/schemas/EntityUiStandardBlockKind" }, "ExtensionKey": { "type": "string", "nullable": true }, "BindingPath": { "$ref": "#/components/schemas/EntityUiHostLayoutBindingPath" }, "Settings": { "type": "object", "nullable": true }, "SettingsVersion": { "type": "integer", "format": "int32" }, "Title": { "type": "string", "nullable": true }, "Subtitle": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "Visible": { "type": "boolean" }, "CollapsedByDefault": { "type": "boolean" } }, "additionalProperties": false, "description": "One entry in an object-hosted layout for a single record surface." }, "EntityObjectHostedLayoutItemKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Section", "Caption" ], "x-enum-descriptions": { "0": "Render a content block section in the hosted layout", "1": "Render a heading row that titles the following layout sections" } }, "EntityOperationPolicy": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "Create", "Update", "Archive", "Restore", "Delete", "Assignments", "Import", "Export" ], "x-enum-descriptions": { "0": "No operations are disabled", "1": "Disables creating new records", "2": "Disables editing existing records", "4": "Disables archiving records", "8": "Disables restoring archived records", "16": "Disables deleting records", "32": "Disables managing record-scoped access assignments", "64": "Disables data import runs for the entity", "128": "Disables data export runs for the entity" } }, "EntityPresentationRule": { "type": "object", "properties": { "Id": { "type": "string", "description": "Presentation rule identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Owning entity definition identifier.", "nullable": true }, "Target": { "$ref": "#/components/schemas/EntityPresentationTarget" }, "Template": { "type": "string", "description": "Stored render template; optionLabel(SelectPath) renders a configured Select option caption.", "nullable": true }, "Condition": { "type": "string", "description": "Stored rule condition expression.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Stable ordering inside one presentation slot.", "format": "int32" }, "IsDeleted": { "type": "boolean", "description": "Whether the rule is soft-deleted." }, "DeletedAt": { "type": "string", "description": "Soft-delete timestamp when deleted.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "SchemaSource": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable Moltaro id when package-owned.", "nullable": true } }, "additionalProperties": false, "description": "Metadata for one entity presentation rule." }, "EntityPresentationTarget": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "DisplayName", "Subtitle" ], "x-enum-descriptions": { "0": "Rule builds the record's primary display name", "1": "Rule builds the record's secondary subtitle line" } }, "EntityProjectionDefinition": { "type": "object", "properties": { "Id": { "type": "string", "description": "Projection configuration identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Projection entity definition identifier.", "nullable": true }, "ProjectionKind": { "$ref": "#/components/schemas/EntityProjectionKind" }, "IsEnabled": { "type": "boolean", "description": "Whether projection synchronization is active." }, "OpenBehavior": { "$ref": "#/components/schemas/EntityProjectionOpenBehavior" }, "Members": { "type": "array", "items": { "$ref": "#/components/schemas/EntityProjectionMember" }, "description": "Configured source members, one per member reference field.", "nullable": true }, "Mappings": { "type": "array", "items": { "$ref": "#/components/schemas/EntityProjectionFieldMapping" }, "description": "Configured field mappings across all members.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token for the projection configuration.", "format": "uuid" } }, "additionalProperties": false, "description": "Projection-entity configuration for one entity definition." }, "EntityProjectionFieldMapping": { "type": "object", "properties": { "Id": { "type": "string", "description": "Mapping identifier.", "nullable": true }, "ProjectionDefinitionId": { "type": "string", "description": "Owning projection configuration identifier.", "nullable": true }, "ProjectionMemberId": { "type": "string", "description": "Member this mapping belongs to.", "nullable": true }, "ReferenceFieldId": { "type": "string", "description": "Reference field of the owning member.", "nullable": true }, "TargetKind": { "$ref": "#/components/schemas/EntityProjectionMappingTargetKind" }, "TargetFieldId": { "type": "string", "description": "Target projection field identifier when the target kind is Field.", "nullable": true }, "TargetFieldKey": { "type": "string", "description": "Key of the target projection field when the target kind is Field.", "nullable": true }, "TargetFieldDisplayName": { "type": "string", "description": "Display name of the target projection field when the target kind is Field.", "nullable": true }, "SourcePath": { "type": "array", "items": { "type": "string" }, "description": "Field-key path from the source row as ordered segments.", "nullable": true }, "TransformKind": { "$ref": "#/components/schemas/EntityProjectionTransformKind" }, "TransformSettingsJson": { "type": "string", "description": "Reserved transform settings; not read by the Copy transform.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Mapping order within the member.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Projection-entity field mapping rule." }, "EntityProjectionKind": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Union" ], "x-enum-descriptions": { "0": "Projection combines rows from multiple source member entities into one union read surface" } }, "EntityProjectionMappingTargetKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Field", "DisplayName", "Subtitle" ], "x-enum-descriptions": { "0": "Source value is mapped into a regular projection field", "1": "Source value feeds the projection row's display name", "2": "Source value feeds the projection row's subtitle" } }, "EntityProjectionMember": { "type": "object", "properties": { "Id": { "type": "string", "description": "Member identifier.", "nullable": true }, "ProjectionDefinitionId": { "type": "string", "description": "Owning projection configuration identifier.", "nullable": true }, "ReferenceFieldId": { "type": "string", "description": "Projection-managed reference field that links projection rows to source rows.", "nullable": true }, "ReferenceFieldKey": { "type": "string", "description": "Key of the member reference field.", "nullable": true }, "ReferenceFieldDisplayName": { "type": "string", "description": "Display name of the member reference field.", "nullable": true }, "SourceEntityDefinitionId": { "type": "string", "description": "Source entity definition identifier.", "nullable": true }, "SourceEntityDefinitionName": { "type": "string", "description": "Internal name of the source entity definition.", "nullable": true }, "SourceEntityDefinitionDisplayName": { "type": "string", "description": "Display name of the source entity definition.", "nullable": true }, "MemberKey": { "type": "string", "description": "Stable technical key of the member.", "nullable": true }, "DisplayName": { "type": "string", "description": "Administrative display name of the member.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Member order in administrative lists.", "format": "int32" }, "IsEnabled": { "type": "boolean", "description": "Whether rows of this source participate in synchronization." }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Projection-entity source member configuration." }, "EntityProjectionOpenBehavior": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "OpenSource" ], "x-enum-descriptions": { "0": "Opening a projection row navigates to the underlying source record" } }, "EntityProjectionTransformKind": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Copy" ], "x-enum-descriptions": { "0": "Source value is copied to the mapping target without transformation" } }, "EntityReferenceCurrentValuesRequest": { "type": "object", "additionalProperties": { "description": "A typed scalar or complex field value. Reference fields use the raw Entity Instance identifier string.", "nullable": true }, "description": "Dynamic Form draft values keyed by the server-declared source field keys.\r\nReference values are raw Entity Instance identifier strings, not value wrappers." }, "EntityReferenceDisplayBreadcrumbSegment": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Subtitle": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One breadcrumb segment for a selected reference value." }, "EntityReferenceDisplayValue": { "type": "object", "properties": { "InstanceId": { "type": "string", "nullable": true }, "State": { "$ref": "#/components/schemas/EntityReferenceValueState" }, "DisplayName": { "type": "string", "nullable": true }, "Subtitle": { "type": "string", "nullable": true }, "Breadcrumbs": { "type": "array", "items": { "$ref": "#/components/schemas/EntityReferenceDisplayBreadcrumbSegment" }, "nullable": true }, "ErrorCode": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Display payload for one selected reference value." }, "EntityReferenceDisplayValues": { "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/components/schemas/EntityReferenceDisplayValue" }, "nullable": true } }, "additionalProperties": false, "description": "Reference lookup display values returned in the same order as requested IDs." }, "EntityReferenceDisplayValuesRequest": { "type": "object", "properties": { "TargetEntity": { "type": "string", "description": "Target entity definition identifier or key for selected instance IDs.", "nullable": true }, "InstanceIds": { "type": "array", "items": { "type": "string" }, "description": "Selected instance identifiers in display order.", "nullable": true }, "RenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Reference field-key path to materialize when breadcrumbs are requested.", "nullable": true } }, "additionalProperties": false, "description": "Request payload for resolving display text or breadcrumbs for selected lookup values." }, "EntityReferenceDisplayValuesResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityReferenceDisplayValues" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityReferenceEligibilityRuntimeDescriptor": { "type": "object", "properties": { "TargetFieldId": { "type": "string", "description": "Dependent scalar Reference field identifier.", "nullable": true }, "DriverFieldIds": { "type": "array", "items": { "type": "string" }, "description": "Direct source-field identifiers required to build selection context.", "nullable": true }, "Enabled": { "type": "boolean", "description": "Whether the persisted rule currently participates in runtime selection and mutation." } }, "additionalProperties": false, "description": "Non-executable dependency metadata for one Reference field." }, "EntityReferenceHierarchySourceKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ExplicitPath", "RecursiveParent" ], "x-enum-descriptions": { "0": "Render a fixed cascade from an explicit reference path", "1": "Navigate an arbitrary-depth hierarchy through one self-reference parent field" } }, "EntityReferenceRuntimeContextState": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Ready", "ContextIncomplete", "ContextAmbiguous", "ContextInvalid", "DependencyUnavailable", "ConfigurationUnavailable", "ConditionNotMet" ], "x-enum-descriptions": { "0": "All declared dependencies are available and Candidate queries may execute", "1": "At least one required driver has no value", "2": "The supplied context contains duplicate or ambiguous driver participants", "3": "The supplied context contains a wrong-typed or forbidden driver overlay", "4": "A required driver or Candidate operand cannot be queried by the current actor", "5": "The saved eligibility configuration cannot be used safely", "6": "The current source values do not satisfy the Reference field behavior condition" } }, "EntityReferenceValue": { "type": "object", "properties": { "State": { "$ref": "#/components/schemas/EntityReferenceValueState" }, "Id": { "type": "string", "description": "Linked entity identifier when resolved.", "nullable": true }, "Number": { "type": "string", "description": "Linked entity number when resolved.", "nullable": true }, "DisplayName": { "type": "string", "description": "Linked entity display name from the presentation cache when resolved.", "nullable": true }, "Subtitle": { "type": "string", "description": "Linked entity subtitle from the presentation cache when resolved.", "nullable": true }, "ProjectedValues": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Linked entity definition identifier when resolved.", "nullable": true }, "ProjectedPlainTextPreviews": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MarkdownPlainTextPreview" }, "description": "Compact server-created previews for projected Markdown fields, keyed by target field key.", "nullable": true } }, "additionalProperties": false, "description": "Compact runtime payload for one resolved or unresolved entity reference." }, "EntityReferenceValueState": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Resolved", "NotFound", "Restricted" ], "x-enum-descriptions": { "0": "The linked target record was loaded and its compact payload is included", "1": "The stored reference value does not resolve to an existing target record", "2": "The caller may read the source field but cannot read the linked target record payload" } }, "EntityRelatedCreateAction": { "type": "object", "properties": { "CanCreate": { "type": "boolean" }, "TargetEntityDefinitionId": { "type": "string", "nullable": true }, "TargetEntityDisplayNameSingular": { "type": "string", "nullable": true }, "LockedFields": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "FormSurfaceKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Server-computed contextual create action for a direct related-data section." }, "EntityRelatedTableTreeChildrenRequest": { "required": [ "ExpectedContextRevision", "ExpectedTableSurfaceId", "ExpectedTableSurfaceRowVersion", "LayoutItemId", "ParentInstanceId" ], "type": "object", "properties": { "LayoutItemId": { "minLength": 1, "type": "string", "description": "Related-data layout item whose server-owned binding filter must be retained." }, "ExpectedContextRevision": { "minLength": 1, "type": "string", "description": "Opaque related binding revision returned by the root bootstrap." }, "ParentInstanceId": { "minLength": 1, "type": "string", "description": "Parent instance whose direct children are requested." }, "ExpectedTableSurfaceId": { "minLength": 1, "type": "string", "description": "Table Surface identifier returned by the related-data bootstrap." }, "ExpectedTableSurfaceRowVersion": { "type": "string", "description": "Table Surface revision returned by the related-data bootstrap.", "format": "uuid" }, "Page": { "type": "integer", "description": "One-based child sibling page.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Requested child sibling page size.", "format": "int32" }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" } }, "additionalProperties": false, "description": "Context-preserving child request for a related table in Details or Drawer." }, "EntityRelatedTableTreeRootsRequest": { "required": [ "ExpectedContextRevision", "ExpectedTableSurfaceId", "ExpectedTableSurfaceRowVersion", "LayoutItemId" ], "type": "object", "properties": { "LayoutItemId": { "minLength": 1, "type": "string", "description": "Related-data layout item whose server-owned binding filter must be retained." }, "ExpectedContextRevision": { "minLength": 1, "type": "string", "description": "Opaque related binding revision returned by the initial bootstrap." }, "ExpectedTableSurfaceId": { "minLength": 1, "type": "string", "description": "Table Surface identifier returned by the related-data bootstrap." }, "ExpectedTableSurfaceRowVersion": { "type": "string", "description": "Table Surface revision returned by the related-data bootstrap.", "format": "uuid" }, "Page": { "type": "integer", "description": "One-based root sibling page.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Requested root sibling page size.", "format": "int32" }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" } }, "additionalProperties": false, "description": "Context-preserving root sibling page request for a related table in Details or Drawer." }, "EntityReplaceResponsibilitiesCommandRequest": { "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "Resource": { "$ref": "#/components/schemas/ResourceIdentity" }, "ResponsibilityKey": { "type": "string", "nullable": true }, "Subjects": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilitySubjectPayload" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EntityResponsibilityChange": { "type": "object", "properties": { "ResponsibilityDefinitionId": { "type": "string", "description": "Stable common responsibility definition identifier.", "nullable": true }, "ResponsibilityKey": { "type": "string", "description": "Stable responsibility key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Responsibility display name.", "nullable": true }, "BeforeSubjects": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResponsibilitySubject" }, "description": "Subjects before the change.", "nullable": true }, "AfterSubjects": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResponsibilitySubject" }, "description": "Subjects after the change.", "nullable": true } }, "additionalProperties": false, "description": "Responsibility diff for one common definition." }, "EntityResponsibilityDefinition": { "type": "object", "properties": { "ResponsibilityDefinitionId": { "type": "string", "description": "Stable common responsibility definition identifier.", "nullable": true }, "ResponsibilityKey": { "type": "string", "description": "Stable definition-scoped responsibility key.", "nullable": true }, "DisplayName": { "type": "string", "description": "User-facing responsibility name.", "nullable": true }, "Description": { "type": "string", "description": "Optional user-facing description.", "nullable": true }, "Cardinality": { "type": "string", "description": "Common cardinality discriminator: One or Many.", "nullable": true }, "Required": { "type": "boolean", "description": "Whether an active resource must always have an assigned responsible subject." }, "SubjectMode": { "type": "string", "description": "Common subject-mode discriminator: User, Group or UserOrGroup.", "nullable": true } }, "additionalProperties": false, "description": "Active common responsibility definition published to Entity runtime surfaces." }, "EntityResponsibilitySubject": { "type": "object", "properties": { "SubjectType": { "type": "string", "description": "Common subject discriminator: User or ResponsibilityGroup.", "nullable": true }, "SubjectId": { "type": "string", "description": "Assigned subject identifier.", "nullable": true }, "DisplayName": { "type": "string", "description": "Display name resolved for the subject when available.", "nullable": true }, "Description": { "type": "string", "description": "Optional secondary subject description.", "nullable": true }, "EffectiveFrom": { "type": "string", "description": "Inclusive start of the responsibility interval.", "format": "date-time", "nullable": true }, "EffectiveTo": { "type": "string", "description": "Exclusive end of the responsibility interval, or null for an open interval.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Display-safe common responsibility subject in Entity runtime payloads." }, "EntityRowAction": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Preview", "OpenDetails", "Delete", "Archive", "Restore", "Edit", "BusinessFunction" ], "x-enum-descriptions": { "0": "Open a compact preview of the record", "1": "Open the record details page", "2": "Permanently delete the record when allowed", "3": "Archive the record when allowed", "4": "Restore the archived record when allowed", "5": "Open the record edit experience", "6": "Execute a configured business function for the record" } }, "EntityRuleEvaluationContext": { "type": "object", "properties": { "CurrentUserId": { "type": "string", "description": "Current workspace user identifier.", "nullable": true }, "CurrentLocalDate": { "type": "string", "description": "Workspace-local current date in ISO format.", "nullable": true }, "TimeZone": { "type": "string", "description": "Workspace time zone identifier.", "nullable": true }, "GeneratedAtUtc": { "type": "string", "description": "UTC instant when the context was generated.", "format": "date-time", "nullable": true }, "NextLocalMidnightUtc": { "type": "string", "description": "UTC instant for the next midnight in the workspace time zone.", "format": "date-time", "nullable": true }, "ContextValues": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Owner-scoped runtime values available to rule plans.", "nullable": true } }, "additionalProperties": false, "description": "Rule evaluation context shared with fast UI runtime evaluation." }, "EntityRuleEvaluationContextResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityRuleEvaluationContext" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityRulePlan": { "type": "object", "properties": { "RuleEngineVersion": { "type": "string", "description": "Stable rule engine version used to compile this plan.", "nullable": true }, "Root": { "$ref": "#/components/schemas/EntityRulePlanNode" } }, "additionalProperties": false, "description": "Compiled rule expression plan used by Moltaro runtime surfaces." }, "EntityRulePlanNode": { "type": "object", "properties": { "Kind": { "type": "string", "description": "Node kind, for example literal, path, eq, and, or.", "nullable": true }, "Operator": { "type": "string", "description": "Optional operator metadata.", "nullable": true }, "Path": { "type": "string", "description": "Field path for path nodes.", "nullable": true }, "LiteralKind": { "type": "string", "description": "Literal family for literal nodes.", "nullable": true }, "Text": { "type": "string", "description": "Text value or variable name.", "nullable": true }, "Number": { "type": "number", "description": "Numeric literal value, serialized as an invariant string to preserve decimal precision.", "format": "double", "nullable": true }, "Bool": { "type": "boolean", "description": "Boolean literal value.", "nullable": true }, "OffsetDays": { "type": "integer", "description": "Date variable day offset.", "format": "int32", "nullable": true }, "Left": { "$ref": "#/components/schemas/EntityRulePlanNode" }, "Right": { "$ref": "#/components/schemas/EntityRulePlanNode" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityRulePlanNode" }, "description": "Collection operands such as IN-list values.", "nullable": true }, "ResultFamily": { "type": "string", "description": "Typed result family resolved by the backend binder.", "nullable": true }, "SourceFamily": { "type": "string", "description": "Backend source family for lookup-like or complex fields.", "nullable": true }, "ResolvedPath": { "type": "string", "description": "Canonical field path resolved by the backend binder.", "nullable": true } }, "additionalProperties": false, "description": "Compiled rule expression node." }, "EntitySchemaSource": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Dynamic", "NET" ], "x-enum-descriptions": { "0": "Schema is authored and owned at runtime through Moltaro admin configuration", "1": "Schema is owned by .NET package code and managed through the package lifecycle" } }, "EntitySearchSystemTarget": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "DisplayName", "Number", "Comments", "Attachments" ], "x-enum-descriptions": { "0": "The computed record display name", "1": "The generated record number", "2": "Comments attached to the reached record", "3": "Attachment names and descriptions attached to the reached record" } }, "EntityStatement": { "type": "object", "properties": { "Id": { "type": "string", "description": "Statement identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Owning entity definition identifier.", "nullable": true }, "Name": { "type": "string", "description": "Stable technical statement key.", "nullable": true }, "DisplayName": { "type": "string", "description": "User-facing statement label.", "nullable": true }, "Expression": { "type": "string", "description": "Stored SQL-like statement expression.", "nullable": true }, "ExposeInClient": { "type": "boolean", "description": "Whether runtime payloads expose this statement as a predicate flag." }, "SortOrder": { "type": "integer", "description": "Statement ordering inside the entity definition.", "format": "int32" }, "IsDeleted": { "type": "boolean", "description": "Whether the statement is soft-deleted." }, "DeletedAt": { "type": "string", "description": "Soft-delete timestamp when deleted.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "SchemaSource": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable Moltaro id when package-owned.", "nullable": true } }, "additionalProperties": false, "description": "Administrative entity statement definition." }, "EntityStatementDescriptor": { "type": "object", "properties": { "Id": { "type": "string", "description": "Statement identifier.", "nullable": true }, "Name": { "type": "string", "description": "Stable technical statement key.", "nullable": true }, "DisplayName": { "type": "string", "description": "User-facing statement label.", "nullable": true } }, "additionalProperties": false, "description": "Runtime statement descriptor exposed to clients together with predicate payloads." }, "EntitySurfaceType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Table", "Form", "Card", "DetailsPage", "EntityListPage", "Drawer" ], "x-enum-descriptions": { "0": "Tabular list surface that renders entity records as rows", "1": "Form surface used to create or edit one record", "2": "Compact card surface that summarizes one record", "3": "Host surface for the full record details page", "4": "Host surface for the entity list page", "5": "Host surface for the record preview drawer" } }, "EntitySystemField": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Number", "DisplayName", "CreatedAt", "CreatedByUserId", "ModifiedAt", "ModifiedByUserId", "ArchivedAt", "ArchivedByUserId", "Tags", "LastComment", "LastActivityDateTime", "Subtitle", "Id", "ProjectionSource" ], "x-enum-descriptions": { "0": "Human-readable record number assigned by the numbering service", "1": "Computed display name maintained in the record presentation cache", "2": "Timestamp of when the record was created", "3": "Identifier of the user who created the record", "4": "Timestamp of the most recent modification to the record", "5": "Identifier of the user who last modified the record", "6": "Timestamp of when the record was archived", "7": "Identifier of the user who archived the record", "8": "Workspace tags currently assigned to the record", "9": "Summary of the most recent comment left on the record", "10": "Timestamp of the most recent recorded activity on the record", "11": "Secondary presentation line maintained in the record presentation cache", "12": "Unique identifier of the record", "13": "Identifies the source record link a projection-enabled record is currently built from" } }, "EntityTableBinding": { "type": "object", "properties": { "Selector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "PageSize": { "type": "integer", "format": "int32", "nullable": true }, "LockedFilters": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableBindingFilter" }, "nullable": true }, "InitialFilters": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableBindingFilter" }, "nullable": true }, "InitialSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableBindingSort" }, "nullable": true } }, "additionalProperties": false, "description": "Resolved table usage context for a hosted table surface." }, "EntityTableBindingFilter": { "type": "object", "properties": { "TargetKind": { "$ref": "#/components/schemas/EntityUiFieldRefKind" }, "FieldId": { "type": "string", "nullable": true }, "FieldKey": { "type": "string", "nullable": true }, "SystemField": { "$ref": "#/components/schemas/EntitySystemField" }, "Operator": { "$ref": "#/components/schemas/EntityInstanceQueryOperator" }, "ValueSource": { "$ref": "#/components/schemas/EntityTableBindingValueSource" }, "Value": { "type": "object", "nullable": true } }, "additionalProperties": false, "description": "One host-level table filter preset." }, "EntityTableBindingSort": { "type": "object", "properties": { "TargetKind": { "$ref": "#/components/schemas/EntityUiFieldRefKind" }, "FieldId": { "type": "string", "nullable": true }, "FieldKey": { "type": "string", "nullable": true }, "SystemField": { "$ref": "#/components/schemas/EntitySystemField" }, "Direction": { "$ref": "#/components/schemas/EntityInstanceQuerySortDirection" } }, "additionalProperties": false, "description": "One host-level initial sort preset for an embedded table binding." }, "EntityTableBindingValueSource": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Literal", "CurrentInstanceId" ], "x-enum-descriptions": { "0": "Filter with the fixed value stored in the binding configuration", "1": "Filter with the id of the base record hosting the embedded table" } }, "EntityTableFilterPlacement": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Primary", "Advanced", "Hidden" ], "x-enum-descriptions": { "0": "Show the filter in the primary quick filter bar", "1": "Show the filter in the advanced filters panel", "2": "Keep the filter out of the visible filter controls" } }, "EntityTablePageBootstrap": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "Model": { "$ref": "#/components/schemas/EntityTableUi" }, "Page": { "allOf": [ { "$ref": "#/components/schemas/EntityInstancePage" } ], "nullable": true }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" }, "MissingSurface": { "$ref": "#/components/schemas/EntityUiMissingSurface" }, "HasConfiguredRuntimeFilterItems": { "type": "boolean", "description": "True when the resolved table surface has at least one runtime filter item available to the caller." }, "RuntimeFilterItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceRuntimeFilterItem" }, "description": "Runtime filter items resolved from the active table surface and current access context.", "nullable": true }, "RuntimeUnavailableFilterItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceUnavailableTarget" }, "description": "Configured filter targets that are unavailable for the current access context or schema.", "nullable": true }, "RuntimeSortItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceRuntimeSortItem" }, "description": "Runtime sort items resolved from the active table surface and current access context.", "nullable": true }, "RuntimeUnavailableSortItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceUnavailableTarget" }, "description": "Configured sort targets that are unavailable for the current access context or schema.", "nullable": true }, "RuntimeDefaultSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Runtime default sort resolved from the active table surface and current access context.", "nullable": true }, "RuntimeRows": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableRuntimeRowState" }, "description": "Actor-shaped Manual Order projection flags for the returned Flat or root rows.", "nullable": true }, "TreePage": { "allOf": [ { "$ref": "#/components/schemas/EntityTableTreeNodePage" } ], "nullable": true }, "LookupFormSurfaceRowVersion": { "type": "string", "description": "Source Form Surface revision for persisted Reference Lookup context; null for every other host.", "format": "uuid", "nullable": true }, "ReferenceCandidateState": { "$ref": "#/components/schemas/EntityReferenceRuntimeContextState" }, "ReferenceCandidateErrorCode": { "type": "string", "description": "Stable guidance code when Moltaro.Entity.Ui.Models.Table.EntityTablePageBootstrapModel.ReferenceCandidateState is not ready.", "nullable": true } }, "additionalProperties": false, "description": "Runtime bootstrap payload for a resolved Table Surface." }, "EntityTablePageBootstrapResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityTablePageBootstrap" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityTablePostFormNavigation": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "Drawer", "Details" ], "x-enum-descriptions": { "0": "Stay on the table without opening the saved record", "1": "Open the saved record in the preview drawer", "2": "Navigate to the saved record details page" } }, "EntityTableReferenceEligibilityRuntimeDescriptor": { "type": "object", "properties": { "TargetFieldId": { "type": "string", "description": "Direct source field represented by this filter item.", "nullable": true }, "DriverFilterItemKeys": { "type": "array", "items": { "type": "string" }, "description": "Canonical direct driver item keys when this item is dependent.", "nullable": true }, "IsDriver": { "type": "boolean", "description": "Whether an active rule depends on this item." }, "IsDependent": { "type": "boolean", "description": "Whether an active rule governs this item's Reference values." }, "Singleton": { "type": "boolean", "description": "Whether the filter item may occur only once in a draft tree." }, "DependenciesAvailable": { "type": "boolean", "description": "Whether every driver is queryable by the current actor." } }, "additionalProperties": false, "description": "Dependency metadata for one direct runtime Table Surface filter item." }, "EntityTableRuntimeRowState": { "type": "object", "properties": { "InstanceId": { "type": "string", "description": "Returned entity-instance identifier.", "nullable": true }, "CanRequestReorder": { "type": "boolean", "description": "Whether exact reorder options may be requested for this row." }, "CanRequestReparent": { "type": "boolean", "description": "Whether exact hierarchy placement options may be requested for this row." }, "CanRequestMoveToRoot": { "type": "boolean", "description": "Whether an exact move-to-root option may be requested for this row." } }, "additionalProperties": false, "description": "Safe coarse Manual Order projection flags for one returned row." }, "EntityTableRuntimeSortSource": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "description": "Origin of the effective runtime sort selected by the server.", "format": "int32", "x-enum-varnames": [ "ExplicitRequest", "PersonalOverride", "GlobalDefaultView", "SavedView", "QueryShare", "TreeConfiguration", "TableSurfaceDefault", "EntityDefinitionDefault", "SystemFallback" ], "x-enum-descriptions": { "0": "The request supplied an explicit sort", "1": "The current user's host-neutral Table Surface settings supplied the sort", "2": "The visible global default saved view supplied the complete base query state", "3": "An explicitly opened saved view supplied the complete query state", "4": "An explicitly opened query share supplied the complete query state", "5": "The Parent Tree View configuration supplied the sibling sort", "6": "The Table Surface default supplied the sort", "7": "The Entity Definition default supplied the sort", "8": "The ordinary runtime system fallback supplied the sort" } }, "EntityTableRuntimeState": { "type": "object", "properties": { "EffectiveSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Exact sort executed for the returned root or Flat page.", "nullable": true }, "SortSource": { "$ref": "#/components/schemas/EntityTableRuntimeSortSource" }, "ManualOrderCapability": { "$ref": "#/components/schemas/EntityManualOrderRuntimeCapabilityState" }, "ManualOrderMode": { "type": "boolean", "description": "Whether the effective sort is sole ascending Manual Order." }, "CanRequestReorder": { "type": "boolean", "description": "Whether an active-row reorder may be attempted from this projection." }, "CanRequestReparent": { "type": "boolean", "description": "Whether a hierarchy reparent may be attempted from this projection." }, "CanRequestMoveToRoot": { "type": "boolean", "description": "Whether a hierarchy root move may be attempted from this projection." }, "RuntimeDefaultSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Exact server-resolved sort exposed when the personal override is cleared.\r\nThis is execution-generation state: paged projections must not merge rows\r\nresolved against different reset defaults even when a personal sort masks them.", "nullable": true }, "QueryStateSource": { "$ref": "#/components/schemas/EntityInstanceQueryStateSource" }, "ResolvedQueryState": { "$ref": "#/components/schemas/EntityTableSavedViewQueryState" }, "ResolvedGlobalSavedViewId": { "type": "string", "description": "Saved-view identity used when Moltaro.Entity.Ui.Models.Table.EntityTableRuntimeStateModel.QueryStateSource is the global default.", "nullable": true }, "ResolvedGlobalSavedViewRowVersion": { "type": "string", "description": "Exact row version of Moltaro.Entity.Ui.Models.Table.EntityTableRuntimeStateModel.ResolvedGlobalSavedViewId.", "format": "uuid", "nullable": true }, "ResolvedGlobalSavedViewColumns": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSavedViewColumnState" }, "description": "Authoritative column state of the resolved global default, for root/bootstrap hydration only.", "nullable": true }, "ResolvedGlobalSavedViewColumnOrder": { "type": "array", "items": { "type": "string" }, "description": "Authoritative column order of the resolved global default, for root/bootstrap hydration only.", "nullable": true }, "ResolvedPersonalGridColumns": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUserGridColumnState" }, "description": "Personal column layout resolved in the same settings snapshot as\r\nMoltaro.Entity.Ui.Models.Table.EntityTableRuntimeStateModel.PersonalSettingsRowVersion and the effective personal sort.", "nullable": true }, "ResolvedPersonalGridColumnOrder": { "type": "array", "items": { "type": "string" }, "description": "Personal column order from the same settings snapshot as the returned projection.", "nullable": true }, "DefinitionRowVersion": { "type": "string", "description": "Row version of the Entity Definition used to validate and materialize this projection.\r\nPaged roots and children must not be merged across different definition generations.", "format": "uuid" }, "DefinitionSnapshotVersion": { "type": "string", "description": "Dependency-aware Entity Definition cache snapshot used by query planning and materialization.\r\nThis also fences changes in referenced definitions whose display/query metadata affects rows.", "format": "uuid" }, "PersonalSettingsRowVersion": { "type": "string", "description": "Row version of the host-neutral personal settings snapshot used to resolve\r\nthis projection's sort and column layout, or System.Guid.Empty when no\r\nsettings snapshot exists. Continuation pages must not be merged across different values.", "format": "uuid" } }, "additionalProperties": false, "description": "Server-resolved runtime ordering state for one Table Surface projection.\r\nThe move flags are coarse presentation gates only; callers must still load\r\nversion-bound move options and run exact validation before mutation." }, "EntityTableSavedViewColumnState": { "type": "object", "properties": { "ColId": { "type": "string", "description": "Runtime table column identifier.", "nullable": true }, "Pinned": { "type": "string", "description": "Pinned side: left, right, or null.", "nullable": true }, "Hide": { "type": "boolean", "description": "Whether the column is hidden." } }, "additionalProperties": false, "description": "One column-layout entry captured by an entity table saved view." }, "EntityTableSavedViewQueryState": { "type": "object", "properties": { "Search": { "type": "string", "description": "Optional configured search term.", "nullable": true }, "TagIds": { "type": "array", "items": { "type": "string" }, "description": "Selected tag identifiers.", "nullable": true }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" }, "AdvancedFilter": { "$ref": "#/components/schemas/EntityInstanceQueryFilterGroupRequest" }, "Sort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Selected sort rules.", "nullable": true }, "PageSize": { "type": "integer", "description": "Selected page size.", "format": "int32" } }, "additionalProperties": false, "description": "Reproducible query state captured by an entity table saved view or share link." }, "EntityTableSurfaceRuntimeFilterItem": { "type": "object", "properties": { "Key": { "type": "string", "description": "Canonical complete-target identity used to restore configured and saved filters.", "nullable": true }, "Label": { "type": "string", "description": "Display label for the filter control.", "nullable": true }, "VisibleByDefault": { "type": "boolean", "description": "Whether the control is placed in the drawer initially." }, "SortOrder": { "type": "integer", "description": "Filter control display order.", "format": "int32" }, "FilterOption": { "$ref": "#/components/schemas/EntityInstanceQueryOption" }, "FilterTarget": { "$ref": "#/components/schemas/EntityInstanceQueryConditionTargetRequest" }, "ReferenceInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "ReferenceRendererType": { "$ref": "#/components/schemas/ReferenceRendererType" }, "ReferenceLookupRenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Reference path configured for breadcrumb rendering. This does not select the field being\r\nfiltered; Moltaro.Entity.Ui.Models.Table.EntityTableSurfaceRuntimeFilterItemModel.FilterTarget carries that query path.", "nullable": true }, "HierarchySourceKind": { "$ref": "#/components/schemas/EntityReferenceHierarchySourceKind" }, "ReferenceEligibility": { "$ref": "#/components/schemas/EntityTableReferenceEligibilityRuntimeDescriptor" } }, "additionalProperties": false, "description": "Runtime entity table-surface filter item resolved and permission-checked for the current user." }, "EntityTableSurfaceRuntimeSortItem": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "Label": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "SortTarget": { "$ref": "#/components/schemas/EntityInstanceQuerySortTargetRequest" } }, "additionalProperties": false, "description": "Runtime entity table-surface sort item resolved from configuration." }, "EntityTableSurfaceUnavailableTarget": { "type": "object", "properties": { "Key": { "type": "string", "description": "Stable configured target key.", "nullable": true }, "ReasonCode": { "type": "string", "description": "Safe reason code. Does not include hidden field names.", "nullable": true } }, "additionalProperties": false, "description": "Safe reason metadata for a configured table target that cannot be used by the current caller/runtime schema." }, "EntityTableTreeChildrenRequest": { "required": [ "ExpectedTableSurfaceId", "ExpectedTableSurfaceRowVersion", "ParentInstanceId", "Query" ], "type": "object", "properties": { "ParentInstanceId": { "minLength": 1, "type": "string", "description": "Parent instance whose direct children are requested." }, "ExpectedTableSurfaceId": { "minLength": 1, "type": "string", "description": "Table Surface identifier returned by bootstrap." }, "ExpectedTableSurfaceRowVersion": { "type": "string", "description": "Table Surface revision returned by bootstrap.", "format": "uuid" }, "Query": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" } }, "additionalProperties": false, "description": "Request for one lazy Parent Tree View child sibling page." }, "EntityTableTreeNode": { "type": "object", "properties": { "Instance": { "$ref": "#/components/schemas/EntityInstanceListItem" }, "ChildCount": { "type": "integer", "description": "Exact number of direct eligible children.", "format": "int32" }, "IsAncestorContext": { "type": "boolean", "description": "Whether this row is included only to preserve the branch to a matching descendant." }, "HierarchyIssue": { "$ref": "#/components/schemas/EntityInstanceHierarchyIssue" }, "CanConfirm": { "type": "boolean", "description": "Whether this direct seed row may be returned as the selected Reference value." } }, "additionalProperties": false, "description": "One real entity instance in a Parent Tree View sibling page." }, "EntityTableTreeNodePage": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableTreeNode" }, "description": "Real entity-instance tree nodes.", "nullable": true }, "TotalCount": { "type": "integer", "description": "Exact number of eligible records in this sibling set.", "format": "int32", "nullable": true }, "Page": { "type": "integer", "description": "One-based sibling page number.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Effective sibling page size.", "format": "int32" }, "HasNextPage": { "type": "boolean", "description": "Whether another sibling page is available." }, "Permissions": { "$ref": "#/components/schemas/EntityInstancePagePermissions" }, "ResponsibilityDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResponsibilityDefinition" }, "description": "Assignment relation metadata used by existing row actions.", "nullable": true }, "ReferenceCandidateState": { "$ref": "#/components/schemas/EntityReferenceRuntimeContextState" }, "ReferenceCandidateErrorCode": { "type": "string", "description": "Stable guidance code when Moltaro.Entity.Ui.Models.Table.EntityTableTreeNodePageModel.ReferenceCandidateState is not ready.", "nullable": true }, "RuntimeState": { "$ref": "#/components/schemas/EntityTableRuntimeState" }, "RuntimeRows": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableRuntimeRowState" }, "description": "Actor-shaped Manual Order projection flags for the returned sibling rows.", "nullable": true } }, "additionalProperties": false, "description": "One independently sorted and paged root or child sibling set." }, "EntityTableTreeNodePageResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityTableTreeNodePage" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityTableTreeView": { "type": "object", "properties": { "ParentFieldDefinitionId": { "type": "string", "description": "Stable parent self-reference field identifier.", "nullable": true }, "ParentFieldKey": { "type": "string", "description": "Stable parent self-reference field key.", "nullable": true }, "SortFieldDefinitionId": { "type": "string", "description": "Stable sibling sort field identifier, or null to sort siblings by Display name.", "nullable": true }, "SortFieldKey": { "type": "string", "description": "Stable sibling sort field key, or null when the Display name default applies.", "nullable": true }, "SortFieldDisplayName": { "type": "string", "description": "Actor-visible sibling sort field label, or null when the Display name default applies.", "nullable": true }, "SortSpecial": { "$ref": "#/components/schemas/EntityInstanceQuerySpecialField" }, "SortDirection": { "$ref": "#/components/schemas/EntityInstanceQuerySortDirection" } }, "additionalProperties": false, "description": "Resolved Parent Tree View configuration for a runtime table." }, "EntityTableUi": { "type": "object", "properties": { "Id": { "type": "string", "description": "Surface identifier. This is empty when the model is not resolved.", "nullable": true }, "Surface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "DefaultPageSize": { "type": "integer", "description": "Default page size.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Concurrency token for persisted overrides.", "format": "uuid" }, "Columns": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUiColumn" }, "description": "Effective columns.", "nullable": true }, "Actions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUiAction" }, "description": "Effective row actions.", "nullable": true }, "RuleEvaluationContext": { "$ref": "#/components/schemas/EntityRuleEvaluationContext" }, "AfterCreateNavigation": { "$ref": "#/components/schemas/EntityTablePostFormNavigation" }, "AfterUpdateNavigation": { "$ref": "#/components/schemas/EntityTablePostFormNavigation" }, "CreateFormSelector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "EditFormSelector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "DrawerSelector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "DetailsPageSelector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" }, "RowRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUiRowRule" }, "description": "Ordered row appearance rules for explicit surfaces.", "nullable": true }, "Filters": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUiFilter" }, "description": "Filter targets and their table-surface placement.", "nullable": true }, "Sorting": { "$ref": "#/components/schemas/EntityTableUiSorting" }, "TreeView": { "$ref": "#/components/schemas/EntityTableTreeView" }, "RuntimeState": { "$ref": "#/components/schemas/EntityTableRuntimeState" } }, "additionalProperties": false, "description": "Persisted table surface." }, "EntityTableUiAction": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable action identifier.", "nullable": true }, "Action": { "$ref": "#/components/schemas/EntityRowAction" }, "Placement": { "$ref": "#/components/schemas/ActionPlacement" }, "SortOrder": { "type": "integer", "description": "Explicit order within the placement bucket.", "format": "int32" }, "FormSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware form selectors used by edit actions in admin configuration.", "nullable": true }, "FormSelector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" } }, "additionalProperties": false, "description": "One table-row action configuration." }, "EntityTableUiColumn": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable column identifier.", "nullable": true }, "Binding": { "$ref": "#/components/schemas/EntityUiFieldBinding" }, "Label": { "type": "string", "description": "Column label.", "nullable": true }, "Hint": { "type": "string", "description": "Optional user hint.", "nullable": true }, "Renderer": { "$ref": "#/components/schemas/TableColumnRenderer" }, "Editor": { "$ref": "#/components/schemas/TableCellEditor" }, "Visible": { "type": "boolean", "description": "Whether the column should render." }, "Editable": { "type": "boolean", "description": "Whether inline editing is enabled for the column." }, "Width": { "type": "integer", "description": "Preferred width in pixels.", "format": "int32" }, "SortOrder": { "type": "integer", "description": "Display order.", "format": "int32" }, "Projection": { "$ref": "#/components/schemas/EntityUiRelatedFieldProjection" }, "ReferenceInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "ReferenceRendererType": { "$ref": "#/components/schemas/ReferenceRendererType" }, "ReferenceLookupRenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Reference path configured for breadcrumb rendering.", "nullable": true }, "ReferenceOpenTarget": { "$ref": "#/components/schemas/EntityUiReferenceOpenTarget" }, "ReferenceOpenTargetSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware selectors retained until runtime shaping resolves Moltaro.Entity.Ui.Models.Table.EntityTableUiColumnModel.ReferenceOpenTarget.", "nullable": true } }, "additionalProperties": false, "description": "One persisted table column." }, "EntityTableUiFilter": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Label": { "type": "string", "nullable": true }, "Reference": { "$ref": "#/components/schemas/EntityInstanceQueryFieldReferenceRequest" }, "Placement": { "$ref": "#/components/schemas/EntityTableFilterPlacement" }, "FilterTarget": { "$ref": "#/components/schemas/EntityInstanceQueryConditionTargetRequest" }, "ReferenceEligibility": { "$ref": "#/components/schemas/EntityTableReferenceEligibilityRuntimeDescriptor" } }, "additionalProperties": false, "description": "One table-surface filter target exposed to the web client." }, "EntityTableUiRowRule": { "type": "object", "properties": { "StatementId": { "type": "string", "description": "Statement identifier used against instance predicates.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Stable evaluation order; the first matching rule wins.", "format": "int32" }, "FontColor": { "type": "string", "description": "Optional CSS font color applied to the whole row.", "nullable": true }, "BackgroundColor": { "type": "string", "description": "Optional CSS background color applied to the whole row.", "nullable": true } }, "additionalProperties": false, "description": "Runtime table row appearance rule." }, "EntityTableUiSortableTarget": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable sort target key.", "nullable": true }, "Label": { "type": "string", "description": "User-facing sort target label.", "nullable": true }, "Reference": { "$ref": "#/components/schemas/EntityInstanceQueryFieldReferenceRequest" }, "Target": { "$ref": "#/components/schemas/EntityInstanceQuerySortTargetRequest" } }, "additionalProperties": false, "description": "One table-surface sort target exposed to the web client." }, "EntityTableUiSorting": { "type": "object", "properties": { "AllowMultiSort": { "type": "boolean" }, "SortableTargets": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUiSortableTarget" }, "nullable": true }, "DefaultSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Table-surface sorting capabilities exposed to the web client." }, "EntityTableUserGridColumnLayoutPatchRequest": { "type": "object", "properties": { "Columns": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUserGridColumnStatePatchRequest" }, "description": "Column layout entries captured from the grid.", "nullable": true }, "ColumnOrder": { "type": "array", "items": { "type": "string" }, "description": "Column order captured from the grid.", "nullable": true } }, "additionalProperties": false, "description": "Column layout member of a grid-settings patch." }, "EntityTableUserGridColumnState": { "type": "object", "properties": { "ColId": { "type": "string", "description": "Runtime table column identifier.", "nullable": true }, "Width": { "type": "integer", "description": "Column width in pixels.", "format": "int32", "nullable": true }, "Pinned": { "type": "string", "description": "Pinned side: left, right, or null.", "nullable": true }, "Hide": { "type": "boolean", "description": "Whether the column is hidden." } }, "additionalProperties": false, "description": "One persisted runtime grid column layout entry." }, "EntityTableUserGridColumnStatePatchRequest": { "type": "object", "properties": { "ColId": { "type": "string", "description": "Runtime table column identifier.", "nullable": true }, "Width": { "type": "integer", "description": "Column width in pixels.", "format": "int32", "nullable": true }, "Pinned": { "type": "string", "description": "Pinned side: left, right, or null.", "nullable": true }, "Hide": { "type": "boolean", "description": "Whether the column is hidden." } }, "additionalProperties": false, "description": "Patch value for one runtime grid column." }, "EntityTableUserGridSettings": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "TableSurfaceId": { "type": "string", "description": "Resolved table surface identifier.", "nullable": true }, "HasSettings": { "type": "boolean", "description": "Whether a user-specific layout row exists." }, "RowVersion": { "type": "string", "description": "Persisted settings row version, or System.Guid.Empty when absent.", "format": "uuid" }, "Columns": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUserGridColumnState" }, "description": "Persisted column layout entries.", "nullable": true }, "ColumnOrder": { "type": "array", "items": { "type": "string" }, "description": "Persisted column order.", "nullable": true }, "SortOverride": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Explicit per-user sort override, or null when normal defaults apply.", "nullable": true } }, "additionalProperties": false, "description": "Per-user runtime grid settings for one resolved table surface." }, "EntityTableUserGridSettingsPatchField": { "enum": [ 0, 1 ], "type": "integer", "description": "Independently patchable members of per-user table settings.", "format": "int32", "x-enum-varnames": [ "ColumnLayout", "Sort" ], "x-enum-descriptions": { "0": "Column state and column order", "1": "Explicit runtime sort override" } }, "EntityTableUserGridSettingsResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityTableUserGridSettings" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityUiActionToolbarPresentation": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Primary", "Overflow" ], "x-enum-descriptions": { "0": "Show the action as a directly visible button in the toolbar", "1": "Tuck the action into the toolbar overflow menu" } }, "EntityUiDatePickerAnchorMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Today", "FixedYear", "RelativeYear" ], "x-enum-descriptions": { "0": "Open on the current workspace-local date", "1": "Open on a configured calendar year", "2": "Open on a year relative to the current workspace-local year" } }, "EntityUiFieldBinding": { "type": "object", "properties": { "RefKind": { "$ref": "#/components/schemas/EntityUiFieldRefKind" }, "FieldId": { "type": "string", "description": "Field identifier when the binding points to an entity field.", "nullable": true }, "FieldKey": { "type": "string", "description": "Runtime field key when the binding points to an entity field.", "nullable": true }, "SystemField": { "$ref": "#/components/schemas/EntitySystemField" }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "IsRequired": { "type": "boolean", "description": "Whether the bound field is always required." }, "VisibleWhen": { "type": "string", "description": "Visibility condition expression for draft-aware UI evaluation.", "nullable": true }, "RequiredWhen": { "type": "string", "description": "Requiredness condition expression for draft-aware UI evaluation.", "nullable": true }, "EditableWhen": { "type": "string", "description": "Editability condition expression for draft-aware UI evaluation.", "nullable": true }, "VisibleWhenPlan": { "$ref": "#/components/schemas/EntityRulePlan" }, "RequiredWhenPlan": { "$ref": "#/components/schemas/EntityRulePlan" }, "EditableWhenPlan": { "$ref": "#/components/schemas/EntityRulePlan" }, "AllowMultiple": { "type": "boolean", "description": "Whether the bound field allows multiple values." }, "DecimalPrecision": { "type": "integer", "description": "Decimal precision when applicable.", "format": "int32", "nullable": true }, "DecimalScale": { "type": "integer", "description": "Decimal scale when applicable.", "format": "int32", "nullable": true }, "StringMaxLength": { "type": "integer", "description": "String max length when applicable.", "format": "int32", "nullable": true }, "ReferenceToEntityDefinitionId": { "type": "string", "description": "Target entity definition identifier for reference-style fields.", "nullable": true }, "PairedReferenceFieldId": { "type": "string", "description": "Paired reference field identifier for inverse reference fields.", "nullable": true }, "AllowSort": { "type": "boolean", "description": "Whether root-list sorting by linked display value is allowed." }, "ReferenceDeleteBehavior": { "$ref": "#/components/schemas/ReferenceDeleteBehavior" }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldOption" }, "description": "Select options when applicable.", "nullable": true }, "TableFields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableField" }, "description": "Access-shaped child-table fields when the binding targets a table field.", "nullable": true }, "HasAccessibleChildFields": { "type": "boolean", "description": "Whether the caller can access at least one child-table field." }, "HasNestedAccessibleTableFields": { "type": "boolean", "description": "Whether the caller can access nested table child fields." }, "VisibleWhenOperationMode": { "$ref": "#/components/schemas/EntityEditOperationMode" }, "RequiredWhenOperationMode": { "$ref": "#/components/schemas/EntityEditOperationMode" }, "EditableWhenOperationMode": { "$ref": "#/components/schemas/EntityEditOperationMode" }, "BaseCurrencyCode": { "type": "string", "description": "Base currency code for Money fields.", "nullable": true }, "DefaultValue": { "$ref": "#/components/schemas/EntityFieldDefaultValue" }, "ResponsibilityKey": { "type": "string", "description": "Stable key when the binding targets a unified responsibility.", "nullable": true }, "ResponsibilityDisplayName": { "type": "string", "description": "Display name when the binding targets a unified responsibility.", "nullable": true }, "DisplayFieldId": { "type": "string", "description": "Display field identifier when the binding targets a display-only computed field.", "nullable": true }, "DisplayFieldKey": { "type": "string", "description": "Display field key when the binding targets a display-only computed field.", "nullable": true }, "DisplayFieldDisplayName": { "type": "string", "description": "Display field display name when the binding targets a display-only computed field.", "nullable": true }, "ObjectContextFactId": { "type": "string", "description": "Object-context fact configuration id when the binding targets a contextual fact.", "nullable": true }, "ObjectContextFactProviderKey": { "type": "string", "description": "Provider key that owns the object-context fact payload.", "nullable": true }, "ObjectContextFactTarget": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "AddressCoordinatesRequired": { "type": "boolean", "description": "Whether an address field must be captured through a coordinate-aware editor." }, "ClassifierCatalogDefinitionId": { "type": "string", "description": "Bound Classifier Catalog Definition identifier.", "nullable": true }, "ClassifierCatalogKey": { "type": "string", "description": "Bound Classifier Catalog Definition key.", "nullable": true }, "ClassifierCatalogDisplayName": { "type": "string", "description": "Bound Classifier Catalog Definition display name.", "nullable": true }, "SemanticRole": { "$ref": "#/components/schemas/EntityFieldSemanticRole" }, "EntityDefinitionId": { "type": "string", "description": "Owning entity definition identifier used by destination-scoped field capabilities.", "nullable": true }, "EntityDefinitionTableId": { "type": "string", "description": "Owning entity definition table identifier used by destination-scoped field capabilities.", "nullable": true } }, "additionalProperties": false, "description": "Resolved binding metadata for one UI field reference." }, "EntityUiFieldRefKind": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "EntityField", "SystemField", "Responsibility", "DisplayField", "ObjectContextFact" ], "x-enum-descriptions": { "0": "Bind to a field defined on the entity", "1": "Bind to a built-in Moltaro system field", "2": "Bind to an active unified responsibility by stable key", "3": "Bind to a configured display field of the entity", "4": "Bind to a module-provided context fact about the record" } }, "EntityUiHostLayoutBindingPath": { "type": "object", "properties": { "RootEntityDefinitionId": { "type": "string", "nullable": true }, "TargetEntityDefinitionId": { "type": "string", "nullable": true }, "Label": { "type": "string", "nullable": true }, "Steps": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiHostLayoutBindingPathStep" }, "nullable": true } }, "additionalProperties": false, "description": "Structured binding path for special host-layout blocks." }, "EntityUiHostLayoutBindingPathStep": { "type": "object", "properties": { "Direction": { "$ref": "#/components/schemas/EntityUiRelatedDataPathDirection" }, "SourceEntityDefinitionId": { "type": "string", "nullable": true }, "SourceReferenceFieldId": { "type": "string", "nullable": true }, "SourceReferenceFieldKey": { "type": "string", "nullable": true }, "TargetEntityDefinitionId": { "type": "string", "nullable": true }, "SourceEntityDisplayNamePlural": { "type": "string", "nullable": true }, "SourceReferenceFieldDisplayName": { "type": "string", "nullable": true }, "TargetEntityDisplayNameSingular": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One reverse-reference hop used by a special host-layout block." }, "EntityUiHostLayoutBlockBootstrap": { "type": "object", "properties": { "BlockId": { "type": "string", "nullable": true }, "BlockKind": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockKind" }, "State": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockRuntimeState" }, "BindingPath": { "$ref": "#/components/schemas/EntityUiHostLayoutBindingPath" }, "Table": { "$ref": "#/components/schemas/EntityTableUi" }, "Page": { "allOf": [ { "$ref": "#/components/schemas/EntityInstancePage" } ], "nullable": true }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" }, "MissingSurface": { "$ref": "#/components/schemas/EntityUiMissingSurface" }, "ErrorCode": { "type": "string", "nullable": true }, "CreateAction": { "$ref": "#/components/schemas/EntityRelatedCreateAction" }, "ExtensionKey": { "type": "string", "nullable": true }, "ExtensionPayload": { "type": "object", "nullable": true }, "TreePage": { "allOf": [ { "$ref": "#/components/schemas/EntityTableTreeNodePage" } ], "nullable": true }, "RuntimeRows": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableRuntimeRowState" }, "description": "Actor-shaped Manual Order projection flags for the returned Flat rows.", "nullable": true }, "RuntimeSortItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceRuntimeSortItem" }, "description": "Runtime sort targets available to this related Table Surface host.", "nullable": true }, "RuntimeUnavailableSortItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableSurfaceUnavailableTarget" }, "description": "Configured sort targets unavailable in the current related host context.", "nullable": true }, "RuntimeDefaultSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Resolved configured default used when the user clears the host-neutral Sort override.", "nullable": true }, "ContextRevision": { "type": "string", "description": "Opaque revision of the server-owned related binding context used by lazy child requests.", "nullable": true }, "DisplayMode": { "$ref": "#/components/schemas/EntityUiRelatedDataDisplayMode" }, "Card": { "$ref": "#/components/schemas/EntityCardUi" }, "CardInstance": { "$ref": "#/components/schemas/EntityInstanceDetail" } }, "additionalProperties": false, "description": "Runtime payload for a custom host-layout block." }, "EntityUiHostLayoutBlockBootstrapResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockBootstrap" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EntityUiHostLayoutBlockKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Standard", "RelatedData", "ModuleExtension" ], "x-enum-descriptions": { "0": "Built-in product block such as the data record or comments", "1": "Related records resolved through a configured binding path", "2": "Module-owned extension resolved by its stable extension key" } }, "EntityUiHostLayoutBlockRequest": { "type": "object", "properties": { "LayoutItemId": { "type": "string", "description": "Stable identifier of the server-owned layout section to load.", "nullable": true }, "Page": { "type": "integer", "description": "One-based page number for paged block data.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Requested page size, or zero to use the authored setting.", "format": "int32" }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" } }, "additionalProperties": false, "description": "Request payload for lazy loading one object-hosted layout block on a details page or drawer.\r\nMoltaro.Entity.Ui.Requests.EntityUiHostLayoutBlockRequest.LayoutItemId is a lookup key only: the server rebuilds the layout for the\r\nrequested surface and re-derives the binding path, settings, display mode and table surface\r\nfrom its own item, so a forged id can never carry a binding path or settings." }, "EntityUiHostLayoutBlockRuntimeState": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Ready", "BindingError", "ModuleDisabled", "AccessDenied", "ReferenceNotFound" ], "x-enum-descriptions": { "0": "Block resolved successfully and can load its content", "1": "Block binding path is invalid or cannot be resolved", "2": "Module that owns the block is disabled in the workspace", "3": "Caller may read the host record but not the entity the block reads from", "4": "A reference binding points to a record that no longer exists" } }, "EntityUiHostLayoutMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Default", "Custom" ], "x-enum-descriptions": { "0": "Render the built-in default host layout", "1": "Render the admin-configured custom layout override" } }, "EntityUiItemType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Field", "Alert", "TextBlock", "RelatedTable" ], "x-enum-descriptions": { "0": "Bound field rendered through an editor or renderer", "1": "Static alert banner with configured tone and text", "2": "Static text block with a configured typography style", "3": "Embedded table of child entities connected through a direct inverse reference" } }, "EntityUiMeta": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "Name": { "type": "string", "description": "Internal entity key used by runtime routes.", "nullable": true }, "DisplayNameSingular": { "type": "string", "description": "User-facing singular name.", "nullable": true }, "DisplayNamePlural": { "type": "string", "description": "User-facing plural name.", "nullable": true }, "CommentsEnabled": { "type": "boolean", "description": "Whether entity comments are enabled." }, "AttachmentsEnabled": { "type": "boolean", "description": "Whether entity attachments are enabled." }, "TagsEnabled": { "type": "boolean", "description": "Whether entity tags are enabled." }, "FullTextSearchAvailable": { "type": "boolean", "description": "Whether runtime configured search is available for the definition." }, "Statements": { "type": "array", "items": { "$ref": "#/components/schemas/EntityStatementDescriptor" }, "description": "Runtime-exposed statements for this entity.", "nullable": true }, "RuleEvaluationContext": { "$ref": "#/components/schemas/EntityRuleEvaluationContext" }, "IsProjection": { "type": "boolean", "description": "Whether the entity is an enabled Projection Entity." } }, "additionalProperties": false, "description": "Minimal runtime entity metadata used by explicit UI surfaces." }, "EntityUiMissingSurface": { "type": "object", "properties": { "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "Reason": { "$ref": "#/components/schemas/EntityUiMissingSurfaceReason" }, "Selector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" } }, "additionalProperties": false, "description": "Machine-readable state for a reusable UI surface that is intentionally missing." }, "EntityUiMissingSurfaceReason": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "DefaultMissing", "SelectionMissing" ], "x-enum-descriptions": { "0": "No default surface is configured for the requested surface type", "1": "The explicitly selected surface no longer exists" } }, "EntityUiReferenceHierarchyConfigurationAdmin": { "type": "object", "properties": { "SourceKind": { "$ref": "#/components/schemas/EntityReferenceHierarchySourceKind" }, "ParentFieldDefinitionId": { "type": "string", "description": "Recursive parent field identifier, or null for explicit-path mode.", "nullable": true }, "ParentFieldKey": { "type": "string", "description": "Recursive parent stable field key used by portable configuration.", "nullable": true } }, "additionalProperties": false, "description": "Saved relationship shape for one hierarchy reference input." }, "EntityUiReferenceOpenTarget": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/EntityUiReferenceOpenTargetValue" }, "SurfaceSelector": { "$ref": "#/components/schemas/EntityUiSurfaceSelector" } }, "additionalProperties": false, "description": "Role-resolved Drawer or Details surface target for opening an entity instance." }, "EntityUiReferenceOpenTargetAdmin": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/EntityUiReferenceOpenTargetValue" }, "SurfaceSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware target-surface selectors.", "nullable": true } }, "additionalProperties": false, "description": "Configured reference open target and role-aware target-surface selectors." }, "EntityUiReferenceOpenTargetValue": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Drawer", "DetailsPage" ], "x-enum-descriptions": { "0": "Open the referenced entity instance in a drawer surface", "1": "Open the referenced entity instance on a details-page surface" } }, "EntityUiRelatedDataDisplayMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Table", "Card" ], "x-enum-descriptions": { "0": "Present related instances as rows in a related-data table", "1": "Present each related instance as a card built from the resolved card surface" } }, "EntityUiRelatedDataPathDirection": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Reference", "InverseReference" ], "x-enum-descriptions": { "0": "Follow a reference field from the base record to its target record", "1": "Collect source records whose reference field points at the base record" } }, "EntityUiRelatedFieldProjection": { "type": "object", "properties": { "Path": { "type": "array", "items": { "type": "string" }, "description": "Runtime field-key path from the root entity to the projected terminal field.", "nullable": true }, "IncludePath": { "type": "array", "items": { "type": "string" }, "description": "Runtime reference path required for materialization.", "nullable": true }, "RootEntityFieldDefinitionId": { "type": "string", "description": "First primary-table reference field identifier.", "nullable": true }, "PathEntityFieldDefinitionId2": { "type": "string", "description": "Second reference field identifier inside the first target definition when configured.", "nullable": true }, "PathEntityFieldDefinitionId3": { "type": "string", "description": "Third reference field identifier inside the second target definition when configured.", "nullable": true }, "TerminalEntityFieldDefinitionId": { "type": "string", "description": "Projected terminal field identifier inside the final target definition.", "nullable": true } }, "additionalProperties": false, "description": "Read-only field projection backed by a materialized related-field path." }, "EntityUiStandardBlockKind": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "DataRecord", "Comments", "Attachments", "Stats", "Assignments" ], "x-enum-descriptions": { "0": "Render the base record through the selected hosted card surface", "1": "Render the shared comments panel for the record", "2": "Render the shared attachments panel for the record", "3": "Render the shared stats panel for the record", "4": "Render the shared assignments panel for the record" } }, "EntityUiSurfaceSelector": { "type": "object", "properties": { "Mode": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorMode" }, "SurfaceKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Selector for resolving an entity UI surface by default pointer or custom key." }, "EntityUiSurfaceSelectorAdmin": { "type": "object", "properties": { "Id": { "type": "string", "description": "Persisted selector row id. New client rows may send null.", "nullable": true }, "Priority": { "type": "integer", "description": "Higher values are evaluated first.", "format": "int32" }, "Mode": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorMode" }, "SurfaceKey": { "type": "string", "description": "Custom surface key when Moltaro.Entity.Ui.Models.EntityUiSurfaceSelectorAdminModel.Mode is custom key.", "nullable": true }, "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Workspace role ids that may use the selector; empty means all roles.", "nullable": true } }, "additionalProperties": false, "description": "Role-aware selector row used by hosted surfaces and lookup inputs." }, "EntityUiSurfaceSelectorMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Default", "CustomKey" ], "x-enum-descriptions": { "0": "Resolve the default compatible surface chosen by Moltaro", "1": "Resolve an explicitly selected surface by its key" } }, "EntityUiTab": { "type": "object", "properties": { "Id": { "type": "string", "description": "Tab identifier.", "nullable": true }, "Key": { "type": "string", "description": "Stable tab key.", "nullable": true }, "Title": { "type": "string", "description": "Visible tab title.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order.", "format": "int32" } }, "additionalProperties": false, "description": "Reusable tab metadata for card surfaces." }, "EntityUiTableField": { "type": "object", "properties": { "Id": { "type": "string", "description": "Child field identifier.", "nullable": true }, "Label": { "type": "string", "description": "Display label for the child field.", "nullable": true }, "Binding": { "$ref": "#/components/schemas/EntityUiFieldBinding" }, "Editor": { "$ref": "#/components/schemas/FormFieldEditor" }, "Editable": { "type": "boolean", "description": "Whether the caller may edit this child field." }, "ReferenceInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "ReferenceRendererType": { "$ref": "#/components/schemas/ReferenceRendererType" }, "ReferenceLookupRenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Reference path configured for breadcrumb rendering.", "nullable": true } }, "additionalProperties": false, "description": "One access-shaped child-table field for runtime UI rendering." }, "EntityUpdateCommandRequest": { "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "EntityDefinitionKey": { "type": "string", "nullable": true }, "EntityInstanceId": { "type": "string", "nullable": true }, "Patch": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "EntityUsageType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Data", "Part", "Association" ], "x-enum-descriptions": { "0": "Normal standalone record type visible in administration, Data Explorer, and generic APIs", "1": "Record type owned by another aggregate and hidden from standalone navigation and generic APIs", "2": "Standalone many-to-many intersect record type linking two Data entity records" } }, "EntityValidationRule": { "type": "object", "properties": { "Id": { "type": "string", "description": "Validation rule identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Owning entity definition identifier.", "nullable": true }, "Name": { "type": "string", "description": "Stable technical validation rule key.", "nullable": true }, "DisplayName": { "type": "string", "description": "User-facing validation rule label.", "nullable": true }, "Expression": { "type": "string", "description": "Validation expression.", "nullable": true }, "Message": { "type": "string", "description": "User-facing validation failure message.", "nullable": true }, "MessageTranslations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional localized validation failure message templates keyed by locale.", "nullable": true }, "Enabled": { "type": "boolean", "description": "Whether this validation rule is active." }, "SortOrder": { "type": "integer", "description": "Validation rule ordering inside the entity definition.", "format": "int32" }, "IsDeleted": { "type": "boolean", "description": "Whether the validation rule is soft-deleted." }, "DeletedAt": { "type": "string", "description": "Soft-delete timestamp when deleted.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "SchemaSource": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable Moltaro id when package-owned.", "nullable": true } }, "additionalProperties": false, "description": "Administrative entity validation rule definition." }, "EvaluateEntityInstanceFormRequest": { "type": "object", "properties": { "Mode": { "$ref": "#/components/schemas/EntityEditOperationMode" }, "DraftFields": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true }, "ChangedFields": { "type": "array", "items": { "type": "string" }, "nullable": true }, "FieldOrigins": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EntityInstanceFieldValueOrigin" }, "nullable": true } }, "additionalProperties": false, "description": "Request payload for debounced entity form mutation-effect evaluation." }, "ExportEntityInstancesRequest": { "type": "object", "properties": { "ProfileId": { "type": "string", "description": "Data transfer profile identifier.", "nullable": true }, "Query": { "$ref": "#/components/schemas/EntityInstanceListQueryRequest" }, "SelectedInstanceIds": { "type": "array", "items": { "type": "string" }, "description": "Optional explicit selected-row scope for export. When supplied, the server exports only those accessible ids inside the query context.", "nullable": true } }, "additionalProperties": false, "description": "Request payload for exporting entity instances through one data transfer profile." }, "ExternalIdentityDiagnosticCode": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "InvalidConfiguration", "CredentialsRejected", "InsufficientScope", "ProtocolValidationFailed", "ProviderUnavailable", "RateLimited", "WorkerOverdue", "ProfileEmailConflict", "RunInterrupted", "SubjectMissing", "LocalUserUnavailable", "ConnectionDisabled" ], "x-enum-descriptions": { "0": "No external identity diagnostic condition is present", "1": "External identity configuration is missing or invalid", "2": "External identity provider rejected the configured credentials", "3": "External identity provider credentials lack the required permissions or scope", "4": "External identity provider response failed protocol validation", "5": "External identity provider is unavailable", "6": "External identity provider temporarily rejected the request because of rate limiting", "7": "External identity synchronization worker has not completed within the expected interval", "8": "External profile email conflicts with another workspace user", "9": "External identity synchronization run was interrupted before completion", "10": "External identity provider response did not contain the required subject identifier", "11": "Linked workspace user is missing, deleted, or unavailable", "12": "External identity connection is disabled" } }, "ExternalIdentityLinkStatus": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Active", "ProviderDisabled", "ProviderDeleted", "ConnectionDisabled", "Archived" ], "x-enum-descriptions": { "1": "External identity link is active", "2": "External identity link is inactive because the provider account is disabled", "3": "External identity link is inactive because the provider account was deleted", "4": "External identity link is inactive because the provider connection is disabled", "5": "External identity link is archived" } }, "ExternalIdentityProfile": { "type": "object", "properties": { "Email": { "type": "string", "nullable": true }, "GivenName": { "type": "string", "nullable": true }, "FamilyName": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Provider-owned profile metadata. It is never an authorization input." }, "ExternalIdentityProviderKind": { "enum": [ 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "MoltaroIdentity", "GoogleWorkspace" ], "x-enum-descriptions": { "1": "Moltaro Identity is the external identity provider", "2": "Google Workspace is the external identity provider" } }, "FileBodyStorage": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Unspecified", "Database", "AzureBlobStorage", "AmazonS3", "GoogleCloudStorage", "LocalFileSystem" ], "x-enum-descriptions": { "0": "No file body storage provider has been selected", "1": "Store file bodies in the workspace database", "2": "Store file bodies in Azure Blob Storage", "3": "Store file bodies in Amazon S3-compatible storage", "4": "Store file bodies in Google Cloud Storage", "5": "Store file bodies in the local file system" } }, "FileContentAvailabilityState": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "LegacyUninspected", "PendingInspection", "Available", "Quarantined", "Rejected" ], "x-enum-descriptions": { "0": "Legacy content has not been inspected under the current policy", "1": "Content is waiting for inspection", "2": "Content passed inspection and is available", "3": "Content is isolated while its safety is unresolved", "4": "Content was rejected and is unavailable" } }, "FileDescriptor": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "FileName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "MimeType": { "type": "string", "nullable": true }, "StorageType": { "$ref": "#/components/schemas/FileBodyStorage" }, "AvailabilityState": { "$ref": "#/components/schemas/FileContentAvailabilityState" }, "DetectedMimeType": { "type": "string", "nullable": true }, "ImageWidth": { "type": "integer", "format": "int32", "nullable": true }, "ImageHeight": { "type": "integer", "format": "int32", "nullable": true }, "ContentGeneration": { "type": "integer", "format": "int64" }, "InspectedChecksumSha256": { "type": "string", "nullable": true }, "InspectedContentGeneration": { "type": "integer", "format": "int64", "nullable": true }, "SizeBytes": { "type": "integer", "format": "int64" }, "ChecksumSha256": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" }, "ModifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "CreatedByUserId": { "type": "string", "nullable": true }, "CreatedByUserName": { "type": "string", "nullable": true }, "ModifiedByUserId": { "type": "string", "nullable": true }, "ModifiedByUserName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileDownloadResult": { "type": "object", "properties": { "Descriptor": { "$ref": "#/components/schemas/FileDescriptor" }, "Content": { "type": "string", "format": "binary", "nullable": true }, "RedirectUrl": { "type": "string", "format": "uri", "nullable": true }, "RedirectExpiresAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FileDownloadResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/FileDownloadResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FileReference": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "FolderId": { "type": "string", "nullable": true }, "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "Relations": { "type": "array", "items": { "$ref": "#/components/schemas/MoltaroResourceRelation" }, "nullable": true }, "Origin": { "$ref": "#/components/schemas/MoltaroResourceOrigin" }, "IsDeleted": { "type": "boolean" }, "EditDeadline": { "type": "string", "format": "date-time" }, "RowVersion": { "type": "string", "format": "uuid" }, "Descriptor": { "$ref": "#/components/schemas/FileDescriptor" } }, "additionalProperties": false }, "FileReferenceResourceContext": { "type": "object", "properties": { "Identity": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "DisplayName": { "type": "string", "nullable": true }, "SafeLabel": { "type": "string", "nullable": true }, "OpenTarget": { "$ref": "#/components/schemas/ResourceOpenTarget" }, "CanOpen": { "type": "boolean" } }, "additionalProperties": false }, "FileReferenceResourceItem": { "type": "object", "properties": { "Placement": { "$ref": "#/components/schemas/FileReferenceResourcePlacement" }, "File": { "$ref": "#/components/schemas/FileReference" }, "Owner": { "$ref": "#/components/schemas/FileReferenceResourceContext" }, "RelatedTarget": { "$ref": "#/components/schemas/FileReferenceResourceContext" }, "Source": { "$ref": "#/components/schemas/FileReferenceResourceContext" }, "RelationId": { "type": "string", "nullable": true }, "RelationKind": { "$ref": "#/components/schemas/MoltaroResourceRelationKind" }, "PolicyCode": { "type": "string", "nullable": true }, "CorrelationId": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" }, "Permissions": { "$ref": "#/components/schemas/FileReferenceResourcePermissions" } }, "additionalProperties": false }, "FileReferenceResourceListRequest": { "type": "object", "properties": { "Resource": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "Scope": { "$ref": "#/components/schemas/FileReferenceResourceScope" }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FileReferenceResourcePage": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/FileReferenceResourceItem" }, "nullable": true }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" }, "TotalCount": { "type": "integer", "format": "int32" }, "HasMore": { "type": "boolean" } }, "additionalProperties": false }, "FileReferenceResourcePageResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/FileReferenceResourcePage" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FileReferenceResourcePermissions": { "type": "object", "properties": { "CanView": { "type": "boolean" }, "CanRename": { "type": "boolean" }, "CanDelete": { "type": "boolean" }, "CanDownload": { "type": "boolean" } }, "additionalProperties": false }, "FileReferenceResourcePlacement": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Owned", "Related" ], "x-enum-descriptions": { "0": "The attachment is uploaded directly to the resource that owns the section", "1": "The attachment is surfaced from a related resource through a resource relation" } }, "FileReferenceResourceScope": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "All", "Owned", "Related" ], "x-enum-descriptions": { "0": "Return both attachments owned by the resource and attachments surfaced from related resources", "1": "Return only attachments uploaded directly to the resource", "2": "Return only attachments surfaced from related resources through resource relations" } }, "FileReferenceResourceSummary": { "type": "object", "properties": { "Count": { "type": "integer", "format": "int32" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/FileReferenceResourceItem" }, "nullable": true } }, "additionalProperties": false }, "FileReferenceResourceSummaryRequest": { "type": "object", "properties": { "Resource": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "Scope": { "$ref": "#/components/schemas/FileReferenceResourceScope" }, "Limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FileReferenceResourceSummaryResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/FileReferenceResourceSummary" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FileReferenceResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/FileReference" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FileUploadResult": { "type": "object", "properties": { "FileReferenceId": { "type": "string", "nullable": true }, "DescriptorId": { "type": "string", "nullable": true }, "ChecksumSha256": { "type": "string", "nullable": true }, "SizeBytes": { "type": "integer", "format": "int64" }, "MimeType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileUploadResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/FileUploadResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FileUploadSessionStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Created", "Uploading", "Completing", "PendingVerification", "Publishing", "PublishBlocked", "Available", "Aborting", "Aborted", "Expired", "Rejected", "Failed" ], "x-enum-descriptions": { "0": "The upload session was created and has not received content", "1": "Content is currently being uploaded", "2": "The client has requested upload completion", "3": "Uploaded content is waiting for verification", "4": "Verified content is being published", "5": "Publication is blocked until a recoverable condition is resolved", "6": "The uploaded content is published and available", "7": "The upload session is being aborted", "8": "The upload session was aborted", "9": "The upload session expired before completion", "10": "The uploaded content was rejected by validation or inspection", "11": "The upload session failed" } }, "FormFieldEditor": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ReadOnly", "Default", "Text", "TextArea", "Numeric", "Date", "Time", "Checkbox", "Switch", "Select", "DateTime" ], "x-enum-descriptions": { "0": "Show the value without editing controls", "1": "Use the editor inferred from the field type", "2": "Edit the value with a single-line text input", "3": "Edit the value with a multi-line text input", "4": "Edit the value with a numeric input", "5": "Edit the value with a date input", "6": "Edit the value with a time input", "7": "Edit the Boolean value with a checkbox", "8": "Edit the Boolean value with a switch", "9": "Edit the value with a select input", "10": "Edit an exact instant with one date and time input in the workspace time zone" } }, "GrantEntitlementPreview": { "type": "object", "properties": { "PlanId": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "ModelType": { "$ref": "#/components/schemas/EntitlementModelType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "DuplicateActiveOrPendingCount": { "type": "integer", "format": "int32" }, "PlanResourceCount": { "type": "integer", "format": "int32" }, "SelectedBeneficiaryCount": { "type": "integer", "format": "int32" }, "MaxCoveredPartyCount": { "type": "integer", "format": "int32", "nullable": true }, "RequiresExplicitBeneficiaries": { "type": "boolean" }, "CoveredResourceCount": { "type": "integer", "format": "int32" }, "CoveredResources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementEntityReference" }, "nullable": true } }, "additionalProperties": false, "description": "Grant preview response used by the WebApp grant dialog." }, "GrantEntitlementPreviewRequest": { "type": "object", "properties": { "PlanId": { "type": "string", "description": "Plan to issue.", "nullable": true }, "OwnerEntityInstanceId": { "type": "string", "description": "Selected owner party instance.", "nullable": true }, "BeneficiaryEntityInstanceIds": { "type": "array", "items": { "type": "string" }, "description": "Explicit delegated beneficiaries when the model requires them.", "nullable": true }, "StartsAtDate": { "type": "string", "description": "Optional workspace-local grant start date. Must be supplied with StartsAtTime.", "format": "date", "nullable": true }, "StartsAtTime": { "type": "string", "description": "Optional workspace-local grant start time. Must be supplied with StartsAtDate.", "format": "time", "nullable": true }, "CoveredResources": { "type": "array", "items": { "$ref": "#/components/schemas/GrantEntitlementResourceReferenceRequest" }, "description": "Covered resources selected at grant time for grant-selected resource models.", "nullable": true }, "IssuedTermsText": { "type": "string", "description": "Issued terms text captured with the grant when the plan requires or allows it.", "nullable": true } }, "additionalProperties": false, "description": "Preview a grant before creating a runtime entitlement." }, "GrantEntitlementPreviewResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/GrantEntitlementPreview" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "GrantEntitlementRequest": { "type": "object", "properties": { "PlanId": { "type": "string", "description": "Plan to issue.", "nullable": true }, "OwnerEntityInstanceId": { "type": "string", "description": "Selected owner party instance.", "nullable": true }, "BeneficiaryEntityInstanceIds": { "type": "array", "items": { "type": "string" }, "description": "Explicit delegated beneficiaries when the model requires them.", "nullable": true }, "StartsAtDate": { "type": "string", "description": "Optional workspace-local grant start date. Must be supplied with StartsAtTime.", "format": "date", "nullable": true }, "StartsAtTime": { "type": "string", "description": "Optional workspace-local grant start time. Must be supplied with StartsAtDate.", "format": "time", "nullable": true }, "IdempotencyKey": { "type": "string", "description": "Optional key that prevents repeating the same grant command.", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "description": "Nullable JSON or text metadata for the source command.", "nullable": true }, "CoveredResources": { "type": "array", "items": { "$ref": "#/components/schemas/GrantEntitlementResourceReferenceRequest" }, "description": "Covered resources selected at grant time for grant-selected resource models.", "nullable": true }, "IssuedTermsText": { "type": "string", "description": "Issued terms text captured with the grant when the plan requires or allows it.", "nullable": true } }, "additionalProperties": false, "description": "Create a runtime entitlement from one plan." }, "GrantEntitlementResourceReferenceRequest": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "description": "Entity definition of the covered resource.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Entity instance id of the covered resource.", "nullable": true } }, "additionalProperties": false, "description": "Grant-time covered resource reference." }, "IResponsibilityMutationResult": { "type": "object", "properties": { "Kind": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Marks a responsibility mutation result." }, "IResponsibilityMutationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/IResponsibilityMutationResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ImportPlanAction": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Create", "Update", "Skip", "Delete" ], "x-enum-descriptions": { "0": "Item will be created because no existing match was found", "1": "Item will update the matched existing record or metadata item", "2": "Item is left unchanged by this import run", "3": "Existing metadata item will be removed because the incoming payload no longer contains it" } }, "ImportPlanStatus": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "OK", "Warning", "Error" ], "x-enum-descriptions": { "0": "Can be applied without any detected issues", "1": "Can be applied but has issues the user should review first", "2": "Cannot be applied until blocking problems are fixed" } }, "InvokeBusinessFunctionActionRequest": { "type": "object", "properties": { "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "EntityInstanceId": { "type": "string", "nullable": true }, "SelectedEntityInstanceIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Input": { "type": "object", "nullable": true }, "CorrelationId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public runtime request to validate or enqueue an action from a UI surface." }, "InvokeBusinessFunctionCommandRequest": { "type": "object", "properties": { "Args": { "type": "object", "description": "Optional JSON arguments deserialized into the command argument type.", "nullable": true }, "CorrelationId": { "type": "string", "description": "Optional correlation identifier propagated to the function run.", "nullable": true } }, "additionalProperties": false, "description": "Request payload for synchronous command function invocation." }, "ListTagSuggestionsRequest": { "type": "object", "properties": { "ModuleKey": { "type": "string", "description": "Resource module key.", "nullable": true }, "ResourceKind": { "type": "string", "description": "Resource kind inside the module.", "nullable": true }, "ContextResourceId": { "type": "string", "description": "Resource context id, such as an entity definition id, board id, entitlement plan id, or workspace.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to list distinct tag suggestions for one resource family." }, "ListTagsByResourceRequest": { "type": "object", "properties": { "Resource": { "$ref": "#/components/schemas/MoltaroResourceIdentity" } }, "additionalProperties": false, "description": "Request payload to list tags owned by a resource." }, "LoginRequest": { "type": "object", "properties": { "UserNameOrEmail": { "type": "string", "description": "Workspace user name or email address.", "nullable": true }, "Password": { "type": "string", "description": "Account password.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to authenticate a workspace user." }, "LoginResponse": { "required": [ "AccessToken", "Avatar", "DateFormat", "DateTimeFormat", "DisplayName", "Locale", "Modules", "OnboardingStatus", "Permissions", "Roles", "TimeFormat", "TimeZone", "UserId", "UserName", "UserType", "WorkspaceName" ], "type": "object", "properties": { "AccessToken": { "type": "string", "description": "Access token for the workspace session.", "nullable": true }, "UserId": { "type": "string", "description": "Workspace user identifier.", "nullable": true }, "UserName": { "type": "string", "description": "User login name.", "nullable": true }, "Email": { "type": "string", "description": "User email address.", "nullable": true }, "FirstName": { "type": "string", "description": "User first name.", "nullable": true }, "LastName": { "type": "string", "description": "User last name.", "nullable": true }, "DisplayName": { "type": "string", "description": "Canonical effective display name.", "nullable": true }, "Avatar": { "$ref": "#/components/schemas/UserAvatar" }, "UserType": { "$ref": "#/components/schemas/UserType" }, "WorkspaceName": { "type": "string", "description": "Workspace slug identifier.", "nullable": true }, "Locale": { "type": "string", "description": "Workspace locale code.", "nullable": true }, "TimeZone": { "type": "string", "description": "Workspace time zone identifier.", "nullable": true }, "DateTimeFormat": { "type": "string", "description": "Workspace date-time format pattern.", "nullable": true }, "DateFormat": { "type": "string", "description": "Workspace date format pattern.", "nullable": true }, "TimeFormat": { "type": "string", "description": "Workspace time format pattern.", "nullable": true }, "RegionCode": { "type": "string", "description": "Workspace routing region code.", "nullable": true }, "OnboardingStatus": { "$ref": "#/components/schemas/WorkspaceOnboardingStatus" }, "Roles": { "type": "array", "items": { "type": "string" }, "description": "Role names assigned to the user.", "nullable": true }, "Permissions": { "type": "array", "items": { "type": "string" }, "description": "Permission keys assigned to the user.", "nullable": true }, "Modules": { "$ref": "#/components/schemas/WorkspaceModuleState" } }, "additionalProperties": false, "description": "Workspace authentication response with access token and user profile." }, "LoginResponseEnvelope": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/LoginResponse" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ManagedFileAuthorizedPart": { "type": "object", "properties": { "PartNumber": { "type": "integer", "format": "int32" }, "UploadUrl": { "type": "string", "nullable": true }, "ExpectedSizeBytes": { "type": "integer", "format": "int64" }, "RequiredHeaders": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "ExpiresAtUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "One exact short-lived browser upload operation." }, "ManagedFilePartAuthorizationResponse": { "type": "object", "properties": { "UploadSessionId": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" }, "UploadSessionExpiresAtUtc": { "type": "string", "format": "date-time" }, "Parts": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedFileAuthorizedPart" }, "nullable": true } }, "additionalProperties": false, "description": "Short-lived authorizations for exact multipart part uploads." }, "ManagedFilePartAuthorizationResponseEnvelope": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ManagedFilePartAuthorizationResponse" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ManagedFileTypeRule": { "type": "object", "properties": { "Extensions": { "type": "array", "items": { "type": "string" }, "description": "Normalized lower-case extensions, including the leading dot.", "nullable": true }, "MimeTypes": { "type": "array", "items": { "type": "string" }, "description": "Normalized lower-case MIME types without parameters.", "nullable": true } }, "additionalProperties": false, "description": "One extension-aware managed upload rule." }, "ManagedFileUploadAdministrationItem": { "type": "object", "properties": { "UploadSessionId": { "type": "string", "nullable": true }, "CreatedByUserId": { "type": "string", "nullable": true }, "SourceOperation": { "type": "string", "nullable": true }, "SourceFunctionRunId": { "type": "string", "nullable": true }, "SourceJobId": { "type": "string", "nullable": true }, "SourceRunStatus": { "type": "string", "nullable": true }, "SourceJobStatus": { "type": "string", "nullable": true }, "Status": { "$ref": "#/components/schemas/FileUploadSessionStatus" }, "ReservedBytes": { "type": "integer", "format": "int64" }, "CreatedAtUtc": { "type": "string", "format": "date-time" }, "LastActivityAtUtc": { "type": "string", "format": "date-time" }, "ExpiresAtUtc": { "type": "string", "format": "date-time" }, "IsExpired": { "type": "boolean" }, "IsOrphaned": { "type": "boolean" }, "RecoveryReasonCode": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Safe administrator diagnostics for one active upload reservation." }, "ManagedFileUploadAdministrationItemListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedFileUploadAdministrationItem" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ManagedFileUploadAdministrativeAbort": { "type": "object", "properties": { "UploadSessionId": { "type": "string", "nullable": true }, "Status": { "$ref": "#/components/schemas/FileUploadSessionStatus" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Result of a workspace-administrator upload cleanup operation." }, "ManagedFileUploadAdministrativeAbortResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ManagedFileUploadAdministrativeAbort" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ManagedFileUploadCapabilities": { "type": "object", "properties": { "StorageType": { "$ref": "#/components/schemas/FileBodyStorage" }, "ManagedMultipartEnabled": { "type": "boolean", "description": "Whether managed multipart transfer is available." }, "LegacyStreamEnabled": { "type": "boolean", "description": "Whether the legacy stream path is available." }, "MaximumFileSizeBytes": { "type": "integer", "description": "Effective maximum file size.", "format": "int64" }, "PartSizeBytes": { "type": "integer", "description": "Required bounded part size.", "format": "int32" }, "MaximumParallelParts": { "type": "integer", "description": "Maximum supported parallel part count.", "format": "int32" }, "ClientChecksumAlgorithm": { "type": "string", "description": "Supported client checksum algorithm.", "nullable": true }, "ClientChecksumRequired": { "type": "boolean", "description": "Whether the client must declare a checksum." }, "AllowedMimeTypes": { "type": "array", "items": { "type": "string" }, "description": "Deprecated MIME-only compatibility projection. Use Moltaro.API.Common.Controllers.Workspace.FileSystem.ManagedFileUploadCapabilitiesModel.FileTypeRules.", "nullable": true }, "FileTypeRules": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedFileTypeRule" }, "description": "Authoritative extension-aware upload rules.", "nullable": true }, "FileTypePolicyVersion": { "type": "integer", "description": "Version of the authoritative extension-aware upload policy.", "format": "int32" }, "FileTypePolicyHash": { "type": "string", "description": "SHA-256 fingerprint of the authoritative extension-aware upload policy.", "nullable": true }, "ActiveSessionLimit": { "type": "integer", "description": "Maximum simultaneously active upload sessions for the current actor.", "format": "int32" }, "ActiveSessionCount": { "type": "integer", "description": "Current simultaneously active upload sessions for the current actor.", "format": "int32" }, "ActiveReservedBytesLimit": { "type": "integer", "description": "Maximum active reserved bytes for the current actor.", "format": "int64" }, "ActiveReservedBytes": { "type": "integer", "description": "Current active reserved bytes for the current actor.", "format": "int64" }, "RetryAfterSeconds": { "type": "integer", "description": "Retry delay when the actor currently has no upload capacity.", "format": "int32", "nullable": true }, "InactivityTimeoutSeconds": { "type": "integer", "description": "Sliding inactivity lease in seconds.", "format": "int32" }, "AbsoluteSessionLifetimeSeconds": { "type": "integer", "description": "Absolute active-session lifetime in seconds.", "format": "int32" } }, "additionalProperties": false, "description": "Effective non-secret upload policy derived from trusted workspace configuration." }, "ManagedFileUploadCapabilitiesResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ManagedFileUploadCapabilities" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ManagedFileUploadRecovery": { "type": "object", "properties": { "ExaminedCount": { "type": "integer", "format": "int32" }, "EligibleCount": { "type": "integer", "format": "int32" }, "ReleasedCount": { "type": "integer", "format": "int32" }, "ReleasedUploadSessionIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "SkippedUploadSessionIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Summary of a bounded expired/orphaned upload recovery pass." }, "ManagedFileUploadRecoveryResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ManagedFileUploadRecovery" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ManagedFileUploadSession": { "type": "object", "properties": { "UploadSessionId": { "type": "string", "nullable": true }, "FileBodyGenerationId": { "type": "string", "nullable": true }, "TargetFolderId": { "type": "string", "nullable": true }, "RequestedFileName": { "type": "string", "nullable": true }, "DeclaredMimeType": { "type": "string", "nullable": true }, "DeclaredSizeBytes": { "type": "integer", "format": "int64" }, "ClientDeclaredSha256": { "type": "string", "nullable": true }, "PartSizeBytes": { "type": "integer", "format": "int32" }, "MaximumParallelParts": { "type": "integer", "format": "int32" }, "ExpiresAtUtc": { "type": "string", "format": "date-time" }, "ClientChecksumAlgorithm": { "type": "string", "nullable": true }, "ClientChecksumRequired": { "type": "boolean" }, "Status": { "$ref": "#/components/schemas/FileUploadSessionStatus" }, "RowVersion": { "type": "string", "format": "uuid" }, "AlreadyUploadedParts": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedFileUploadedPart" }, "nullable": true }, "FailureCode": { "type": "string", "nullable": true }, "PublishedFileReferenceId": { "type": "string", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true } }, "additionalProperties": false, "description": "Public state of a resumable managed file upload.\r\nPublishedFileReferenceId is non-null only once the session reaches Available." }, "ManagedFileUploadSessionResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ManagedFileUploadSession" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ManagedFileUploadedPart": { "type": "object", "properties": { "PartNumber": { "type": "integer", "format": "int32" }, "SizeBytes": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "description": "One provider-confirmed uploaded part safe to expose for resume." }, "ManagedFileUploadedPartListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedFileUploadedPart" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MarkdownPlainTextPreview": { "type": "object", "properties": { "Text": { "type": "string", "description": "Visible text when available.", "nullable": true }, "IsTruncated": { "type": "boolean", "description": "Whether the visible text was shortened for compact presentation." }, "State": { "$ref": "#/components/schemas/MarkdownPlainTextPreviewState" } }, "additionalProperties": false, "description": "Safe compact visible-text representation of a Markdown value." }, "MarkdownPlainTextPreviewState": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Available", "Empty", "Unavailable", "LegacyOverLimit" ], "x-enum-descriptions": { "0": "A safe plain-text preview is available", "1": "The Markdown value is empty", "2": "A safe plain-text preview cannot be produced", "3": "The legacy Markdown value exceeds the supported preview limit" } }, "MeResponse": { "required": [ "Avatar", "DateFormat", "DateTimeFormat", "DisplayName", "Locale", "Modules", "OnboardingStatus", "Permissions", "Roles", "TimeFormat", "TimeZone", "UserId", "UserName", "UserType", "WorkspaceName" ], "type": "object", "properties": { "UserId": { "type": "string", "description": "Workspace user identifier.", "nullable": true }, "UserName": { "type": "string", "description": "User login name.", "nullable": true }, "Email": { "type": "string", "description": "User email address.", "nullable": true }, "FirstName": { "type": "string", "description": "User first name.", "nullable": true }, "LastName": { "type": "string", "description": "User last name.", "nullable": true }, "DisplayName": { "type": "string", "description": "Canonical effective display name.", "nullable": true }, "Avatar": { "$ref": "#/components/schemas/UserAvatar" }, "UserType": { "$ref": "#/components/schemas/UserType" }, "WorkspaceName": { "type": "string", "description": "Workspace slug identifier.", "nullable": true }, "Locale": { "type": "string", "description": "Workspace locale code.", "nullable": true }, "TimeZone": { "type": "string", "description": "Workspace time zone identifier.", "nullable": true }, "DateTimeFormat": { "type": "string", "description": "Workspace date-time format pattern.", "nullable": true }, "DateFormat": { "type": "string", "description": "Workspace date format pattern.", "nullable": true }, "TimeFormat": { "type": "string", "description": "Workspace time format pattern.", "nullable": true }, "RegionCode": { "type": "string", "description": "Workspace routing region code.", "nullable": true }, "OnboardingStatus": { "$ref": "#/components/schemas/WorkspaceOnboardingStatus" }, "Roles": { "type": "array", "items": { "type": "string" }, "description": "Role names assigned to the user.", "nullable": true }, "Permissions": { "type": "array", "items": { "type": "string" }, "description": "Permission keys assigned to the user.", "nullable": true }, "Modules": { "$ref": "#/components/schemas/WorkspaceModuleState" } }, "additionalProperties": false, "description": "Workspace user profile response." }, "MeResponseEnvelope": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MeResponse" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ModuleEntityDefinitionRole": { "type": "object", "properties": { "ModuleKey": { "type": "string", "nullable": true }, "RoleKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public module-role identity projected with Entity Definition metadata." }, "MoltaroResourceIdentity": { "type": "object", "properties": { "ModuleKey": { "type": "string", "nullable": true }, "ResourceKind": { "type": "string", "nullable": true }, "ContextResourceId": { "type": "string", "nullable": true }, "ResourceObjectId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MoltaroResourceOrigin": { "type": "object", "properties": { "Source": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "PolicyCode": { "type": "string", "nullable": true }, "CorrelationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MoltaroResourceOriginRequest": { "type": "object", "properties": { "Source": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "PolicyCode": { "type": "string", "nullable": true }, "CorrelationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MoltaroResourceRelation": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Target": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "RelationKind": { "$ref": "#/components/schemas/MoltaroResourceRelationKind" }, "Source": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "PolicyCode": { "type": "string", "nullable": true }, "CorrelationId": { "type": "string", "nullable": true }, "CreatedByUserId": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" }, "DeletedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "MoltaroResourceRelationKind": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Related" ], "x-enum-descriptions": { "0": "Marks a generic association between the content and the target resource" } }, "MoltaroResourceRelationRequest": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "RelationKind": { "$ref": "#/components/schemas/MoltaroResourceRelationKind" }, "Source": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "PolicyCode": { "type": "string", "nullable": true }, "CorrelationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MoveBoardItemRequest": { "type": "object", "properties": { "ToBoardStatusId": { "type": "string", "nullable": true }, "Position": { "$ref": "#/components/schemas/BoardItemPositionRequest" }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true }, "LinkPrerequisiteSelections": { "type": "array", "items": { "$ref": "#/components/schemas/BoardMoveLinkPrerequisiteSelectionRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Request to move an open board item." }, "ObjectInvariant": { "type": "object", "properties": { "Resource": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "BusinessInvariants": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessInvariantObjectState" }, "description": "Current safe state of every applicable enabled Business Invariant.", "nullable": true }, "Operations": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ObjectOperationDecision" }, "description": "Explicit decision for every applicable and discoverable Object Operation Catalog entry on the current surface.", "nullable": true } }, "additionalProperties": false, "description": "Resource-neutral current invariant state and complete object-operation decision set." }, "ObjectOperationDecision": { "type": "object", "properties": { "OperationKey": { "type": "string", "description": "Stable Object Operation Catalog key.", "nullable": true }, "IsAllowed": { "type": "boolean", "description": "Whether all independent authorities allow the operation." }, "Denials": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectOperationDenial" }, "description": "Deterministically ordered safe denial details.", "nullable": true } }, "additionalProperties": false, "description": "Composed current decision for one applicable object operation." }, "ObjectOperationDecisionSource": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Identifies the independent authority that denied an object operation.", "format": "int32", "x-enum-varnames": [ "Security", "Domain", "BusinessInvariant", "RuntimeFailure" ], "x-enum-descriptions": { "0": "Platform authorization denied the operation", "1": "The owning domain denied the operation", "2": "A Business Invariant denied the operation", "3": "Safe fail-closed runtime handling denied the operation" } }, "ObjectOperationDenial": { "type": "object", "properties": { "Source": { "$ref": "#/components/schemas/ObjectOperationDecisionSource" }, "SourceKey": { "type": "string", "description": "Stable source identity, such as an invariant key or domain policy key.", "nullable": true }, "ReasonCode": { "type": "string", "description": "Stable machine-readable reason code.", "nullable": true }, "SafeMessage": { "type": "string", "description": "Non-empty localized safe message.", "nullable": true } }, "additionalProperties": false, "description": "One safe denial contributing to a composed object-operation decision." }, "ObjectResponse": { "type": "object", "properties": { "Data": { "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PagedEligibleResponsibilityTargetResult": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EligibleResponsibilityTarget" }, "nullable": true }, "NextCursor": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Returns one page of eligible responsibility targets." }, "PagedEligibleResponsibilityTargetResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/PagedEligibleResponsibilityTargetResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PatchEntityTableUserGridSettingsRequest": { "required": [ "ExpectedRowVersion", "Fields" ], "type": "object", "properties": { "ExpectedRowVersion": { "type": "string", "description": "Last row version returned by the server. Use System.Guid.Empty when no settings row exists.", "format": "uuid" }, "ExpectedContainerSurfaceId": { "type": "string", "description": "Optional Entity List Page identity captured by the grid-settings preflight. Hosted writes\r\nfail closed when the route now resolves to a different container.", "nullable": true }, "ExpectedTableSurfaceId": { "type": "string", "description": "Optional Table Surface identity captured by the grid-settings preflight. Writes fail closed\r\nwhen the current host, picker, or Lookup resolves to a different table.", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUserGridSettingsPatchField" }, "description": "Members changed by this patch. Members outside this mask remain unchanged.", "nullable": true }, "ColumnLayout": { "$ref": "#/components/schemas/EntityTableUserGridColumnLayoutPatchRequest" }, "Sort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityInstanceQuerySortRequest" }, "description": "Explicit sort when Moltaro.Entity.Ui.Requests.EntityTableUserGridSettingsPatchFieldEnum.Sort is masked,\r\nor `null`/empty to clear only the explicit sort override.", "nullable": true } }, "additionalProperties": false, "description": "Field-masked patch for the current user's host-neutral table settings." }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ReadAttachmentPolicy": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "BoardOnly", "BoardAndTarget", "TargetOnly" ], "x-enum-descriptions": { "0": "Listing returns only attachments owned by the board item", "1": "Listing returns board item-owned attachments plus attachments owned by or related to the target resource", "2": "Listing returns only attachments owned by or related to the target resource" } }, "ReadCommentPolicy": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "BoardOnly", "BoardAndTarget", "TargetOnly" ], "x-enum-descriptions": { "0": "Listing returns only comments owned by the board item", "1": "Listing returns board item-owned comments plus comments owned by or related to the target resource", "2": "Listing returns only comments owned by or related to the target resource" } }, "RecordMatchingActionMode": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ReviewOnly" ], "x-enum-descriptions": { "0": "Present matches for review without automatically changing records" } }, "RecordMatchingCandidate": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Subtitle": { "type": "string", "nullable": true }, "IsArchived": { "type": "boolean" }, "OpenTarget": { "$ref": "#/components/schemas/ResourceOpenTarget" } }, "additionalProperties": false, "description": "Visible record candidate returned by the matching engine." }, "RecordMatchingCandidateGroup": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable group identifier derived from its canonical candidate set.", "nullable": true }, "Score": { "type": "integer", "description": "Highest effective exact or fuzzy rule score contributing to the group.", "format": "int32" }, "ConfidenceBand": { "$ref": "#/components/schemas/RecordMatchingConfidenceBand" }, "MatchedRules": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingMatchedRule" }, "description": "Rules that produced the exact set or canonical fuzzy pair.", "nullable": true }, "Reasons": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingReason" }, "description": "Readable matching-field reasons for the group.", "nullable": true }, "Candidates": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingCandidate" }, "description": "Candidates materialized in the current bounded response page.", "nullable": true }, "TotalCandidateCount": { "type": "integer", "description": "Complete candidate count when candidates are paged; otherwise null.", "format": "int32", "nullable": true }, "GroupKind": { "$ref": "#/components/schemas/RecordMatchingGroupKind" } }, "additionalProperties": false, "description": "One exact set or honest fuzzy pair produced by matching rules." }, "RecordMatchingConfidenceBand": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Low", "Medium", "High" ], "x-enum-descriptions": { "0": "Classify the match as low confidence", "1": "Classify the match as medium confidence", "2": "Classify the match as high confidence" } }, "RecordMatchingDiacriticMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Preserve", "Ignore" ], "x-enum-descriptions": { "0": "Preserve diacritic marks during normalization", "1": "Ignore diacritic marks during normalization" } }, "RecordMatchingFieldComparisonMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Exact", "Fuzzy" ], "x-enum-descriptions": { "0": "Compare field values for exact equality", "1": "Compare field values using a fuzzy algorithm" } }, "RecordMatchingFullScanGroupCandidatesPage": { "type": "object", "properties": { "GroupId": { "type": "string", "description": "Stable saved group identifier.", "nullable": true }, "Page": { "type": "integer", "description": "One-based candidate page.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Applied bounded candidate page size.", "format": "int32" }, "TotalCandidateCount": { "type": "integer", "description": "Complete candidate count for the group.", "format": "int32" }, "Candidates": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingCandidate" }, "description": "Current actor-readable candidate summaries in this page.", "nullable": true } }, "additionalProperties": false, "description": "One bounded candidate page for a persisted full-scan group." }, "RecordMatchingFullScanGroupCandidatesPageResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RecordMatchingFullScanGroupCandidatesPage" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "RecordMatchingFullScanJob": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable persisted job identifier.", "nullable": true }, "Status": { "$ref": "#/components/schemas/RecordMatchingFullScanJobStatus" }, "Phase": { "$ref": "#/components/schemas/RecordMatchingFullScanPhase" }, "Profile": { "$ref": "#/components/schemas/RecordMatchingProfileSummary" }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" }, "TotalVisibleRecords": { "type": "integer", "description": "Complete actor-visible count after the Worker has counted the scope.", "format": "int32", "nullable": true }, "ScannedRecords": { "type": "integer", "description": "Records streamed through the complete scan.", "format": "int32" }, "GroupCount": { "type": "integer", "description": "Complete persisted group count after success.", "format": "int32" }, "ResultCandidateCount": { "type": "integer", "description": "Distinct persisted candidate count after success.", "format": "int32" }, "AttemptCount": { "type": "integer", "description": "Number of fenced Worker attempts.", "format": "int32" }, "CanCancel": { "type": "boolean", "description": "Whether the current actor may request cancellation." }, "CanRetry": { "type": "boolean", "description": "Whether the current actor may enqueue a retry." }, "ErrorCode": { "type": "string", "description": "Stable localized error code for a terminal failure.", "nullable": true }, "ErrorMessage": { "type": "string", "description": "Localized terminal failure message.", "nullable": true }, "CreatedAtUtc": { "type": "string", "description": "Job creation time.", "format": "date-time" }, "StartedAtUtc": { "type": "string", "description": "First processing time, when claimed.", "format": "date-time", "nullable": true }, "FinishedAtUtc": { "type": "string", "description": "Terminal completion time.", "format": "date-time", "nullable": true }, "CapturedAtUtc": { "type": "string", "description": "Time at which the currently published result snapshot was captured.", "format": "date-time", "nullable": true }, "FailureRetryable": { "type": "boolean", "description": "Whether the terminal failure was classified as transient for automatic retry diagnostics." }, "Result": { "$ref": "#/components/schemas/RecordMatchingFullScanResultPage" } }, "additionalProperties": false, "description": "Status and actor-owned progress of one durable full target-wide matching scan." }, "RecordMatchingFullScanJobResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RecordMatchingFullScanJob" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "RecordMatchingFullScanJobStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Queued", "Processing", "Succeeded", "Failed", "Cancelled" ], "x-enum-descriptions": { "0": "The full scan is waiting to start", "1": "The full scan is currently processing", "2": "The full scan completed successfully", "3": "The full scan failed", "4": "The full scan was cancelled" } }, "RecordMatchingFullScanPhase": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Queued", "Counting", "Matching", "Persisting", "Completed" ], "x-enum-descriptions": { "0": "The full scan is waiting to start", "1": "The full scan is counting candidate records", "2": "The full scan is evaluating record matches", "3": "The full scan is persisting its results", "4": "The full scan has completed" } }, "RecordMatchingFullScanRequest": { "type": "object", "properties": { "ProfileId": { "type": "string", "description": "Enabled Table Page profile to pin for the scan.", "nullable": true }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" }, "IdempotencyKey": { "type": "string", "description": "Caller-generated key used to deduplicate equivalent enqueue attempts.", "nullable": true } }, "additionalProperties": false, "description": "Request payload for one durable Worker-owned complete target-wide scan." }, "RecordMatchingFullScanResultPage": { "type": "object", "properties": { "Run": { "$ref": "#/components/schemas/RecordMatchingRunResult" }, "Page": { "type": "integer", "description": "One-based group page.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Applied bounded group page size.", "format": "int32" }, "TotalGroupCount": { "type": "integer", "description": "Complete group count in the saved result.", "format": "int32" } }, "additionalProperties": false, "description": "One bounded page over the complete persisted groups of a successful full scan." }, "RecordMatchingFuzzyAlgorithm": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "DamerauLevenshtein" ], "x-enum-descriptions": { "0": "Measure edit distance using the Damerau-Levenshtein algorithm" } }, "RecordMatchingGroupKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ExactSet", "FuzzyPair" ], "x-enum-descriptions": { "0": "Treat the group as an exact set of matching rules", "1": "Treat the group as a pair of fuzzy matching rules" } }, "RecordMatchingLaunchOptions": { "type": "object", "properties": { "Surface": { "$ref": "#/components/schemas/RecordMatchingLaunchSurface" }, "Profiles": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingProfileSummary" }, "nullable": true } }, "additionalProperties": false, "description": "Runtime launch options for one entity surface." }, "RecordMatchingLaunchOptionsResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RecordMatchingLaunchOptions" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "RecordMatchingLaunchSurface": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Constructor", "TablePage", "DetailsPage" ], "x-enum-descriptions": { "0": "Launch record matching from a record creation workflow", "1": "Launch record matching from an Entity table page", "2": "Launch record matching from an Entity details page" } }, "RecordMatchingMatchedRule": { "type": "object", "properties": { "RuleId": { "type": "string", "description": "Stable matching-rule identifier.", "nullable": true }, "RuleKey": { "type": "string", "description": "Portable technical rule key.", "nullable": true }, "RuleName": { "type": "string", "description": "Current rule label.", "nullable": true }, "Score": { "type": "integer", "description": "Effective score after fuzzy similarity is applied.", "format": "int32" }, "ConfiguredScore": { "type": "integer", "description": "Configured rule score before fuzzy similarity; null for legacy exact results.", "format": "int32", "nullable": true }, "SimilarityBasisPoints": { "type": "integer", "description": "Weighted similarity from zero through ten thousand basis points.", "format": "int32" } }, "additionalProperties": false, "description": "Configured rule that contributed to a candidate group. Score is the effective\r\nscore; ConfiguredScore preserves the profile score before fuzzy similarity." }, "RecordMatchingNormalizer": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Email", "Phone", "TextKey", "Date" ], "x-enum-descriptions": { "0": "Normalize the value as an email address", "1": "Normalize the value as a phone number", "2": "Normalize the value as a text key", "3": "Normalize the value as a date" } }, "RecordMatchingProfileSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "TargetKind": { "$ref": "#/components/schemas/RecordMatchingTargetKind" }, "TargetEntityDefinitionId": { "type": "string", "nullable": true }, "TargetEntityName": { "type": "string", "nullable": true }, "TargetEntityDisplayName": { "type": "string", "nullable": true }, "ShowOnTablePage": { "type": "boolean" }, "ShowOnDetailsPage": { "type": "boolean" }, "ActionMode": { "$ref": "#/components/schemas/RecordMatchingActionMode" }, "MinimumScore": { "type": "integer", "format": "int32" }, "MediumConfidenceThreshold": { "type": "integer", "format": "int32" }, "HighConfidenceThreshold": { "type": "integer", "format": "int32" }, "RuleCount": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Compact record-matching profile used by lists and launch options." }, "RecordMatchingReason": { "type": "object", "properties": { "RuleId": { "type": "string", "description": "Stable matching-rule identifier.", "nullable": true }, "RuleKey": { "type": "string", "description": "Portable technical rule key.", "nullable": true }, "RuleName": { "type": "string", "description": "Current rule label.", "nullable": true }, "FieldId": { "type": "string", "description": "Stable matching field identifier.", "nullable": true }, "FieldKey": { "type": "string", "description": "Portable technical entity-field key.", "nullable": true }, "FieldDisplayName": { "type": "string", "description": "Current actor-readable field label.", "nullable": true }, "Normalizer": { "$ref": "#/components/schemas/RecordMatchingNormalizer" }, "DiagnosticValue": { "type": "string", "description": "Actor-safe exact diagnostic; empty for fuzzy evidence.", "nullable": true }, "ComparisonMode": { "$ref": "#/components/schemas/RecordMatchingFieldComparisonMode" }, "FuzzyAlgorithm": { "$ref": "#/components/schemas/RecordMatchingFuzzyAlgorithm" }, "Distance": { "type": "integer", "description": "Unicode-rune edit distance, or null for exact evidence.", "format": "int32", "nullable": true }, "MaxDistance": { "type": "integer", "description": "Configured inclusive fuzzy threshold, or null for exact evidence.", "format": "int32", "nullable": true }, "SimilarityBasisPoints": { "type": "integer", "description": "Field similarity from zero through ten thousand basis points.", "format": "int32", "nullable": true }, "Weight": { "type": "integer", "description": "Configured fuzzy field weight, or null for exact evidence.", "format": "int32", "nullable": true }, "DiacriticMode": { "$ref": "#/components/schemas/RecordMatchingDiacriticMode" }, "TokenOrderMode": { "$ref": "#/components/schemas/RecordMatchingTokenOrderMode" } }, "additionalProperties": false, "description": "Actor-safe field evidence for an exact-normalized match or fuzzy comparison. Fuzzy evidence exposes\r\ndistance and settings but never raw or normalized matching values." }, "RecordMatchingRunRequest": { "type": "object", "properties": { "ProfileId": { "type": "string", "description": "Optional matching profile identifier.", "nullable": true }, "ArchiveMode": { "$ref": "#/components/schemas/ArchiveMode" }, "Limit": { "type": "integer", "description": "Target-wide scan limit. Ignored by Details Page anchored matching.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Request payload for a transient record-matching run. Limit bounds only target-wide\r\nand constructor scans; Details Page anchored matching ignores it and either returns the complete\r\nactor-visible exact/fuzzy result or a bounded error." }, "RecordMatchingRunResult": { "type": "object", "properties": { "Surface": { "$ref": "#/components/schemas/RecordMatchingLaunchSurface" }, "Profile": { "$ref": "#/components/schemas/RecordMatchingProfileSummary" }, "Anchor": { "$ref": "#/components/schemas/RecordMatchingCandidate" }, "TotalVisibleRecords": { "type": "integer", "description": "Complete actor-visible record count in the selected archive scope.", "format": "int32" }, "TotalScannedRecords": { "type": "integer", "description": "Records covered by the matching run.", "format": "int32" }, "ScanLimitReached": { "type": "boolean", "description": "Whether a target-wide scan stopped at its request limit." }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingCandidateGroup" }, "description": "Complete groups for anchored runs, or groups from the bounded target-wide scan.", "nullable": true } }, "additionalProperties": false, "description": "Transient result of a record-matching run. For Details Page anchored matching,\r\nTotalScannedRecords equals TotalVisibleRecords and\r\nScanLimitReached is false; target-wide scans remain bounded and may be partial." }, "RecordMatchingRunResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RecordMatchingRunResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "RecordMatchingTargetKind": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "EntityDefinition" ], "x-enum-descriptions": { "0": "Match records within an Entity Definition" } }, "RecordMatchingTokenOrderMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Ordered", "AnyOrder" ], "x-enum-descriptions": { "0": "Compare tokens in their original order", "1": "Compare tokens without requiring their original order" } }, "RecoverManagedFileUploadsRequest": { "type": "object", "properties": { "UploadSessionIds": { "type": "array", "items": { "type": "string" }, "description": "Optional exact session ids. Omit to scan the bounded active set.", "nullable": true }, "Limit": { "type": "integer", "description": "Maximum active sessions examined in this request.", "format": "int32" } }, "additionalProperties": false, "description": "Request a bounded recovery pass for expired or orphaned upload sessions." }, "ReferenceArchiveBehavior": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "Cascade" ], "x-enum-descriptions": { "0": "Archiving the referenced record leaves records holding this reference untouched", "1": "Archiving the referenced record also archives the records holding this reference" } }, "ReferenceAuditRollupBehavior": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "RollupToReferencedRecord" ], "x-enum-descriptions": { "0": "Changes on the referencing record stay out of the referenced record's audit trail", "1": "Changes on the referencing record are also surfaced in the referenced record's audit trail" } }, "ReferenceDeleteBehavior": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "Cascade", "Restrict" ], "x-enum-descriptions": { "0": "Deleting the referenced record leaves records holding this reference untouched", "1": "Deleting the referenced record also deletes the records holding this reference", "2": "Deleting the referenced record is blocked while another record holds this reference" } }, "ReferenceInputType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "List", "LongList", "Lookup", "Hierarchy" ], "x-enum-descriptions": { "0": "Pick the referenced record from a compact list input", "1": "Pick the referenced record from a list input optimized for large option sets", "2": "Pick the referenced record through a lookup backed by a table surface", "3": "Pick the referenced record through a server-derived hierarchy" } }, "ReferenceLookupRenderType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Text", "Breadcrumbs" ], "x-enum-descriptions": { "0": "Render lookup results as plain text", "1": "Render lookup results as hierarchy breadcrumbs when available" } }, "ReferenceRendererType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "SimpleReference", "Breadcrumbs" ], "x-enum-descriptions": { "0": "Render the referenced record presentation value", "1": "Render the reference hierarchy as breadcrumbs when available" } }, "RemoveBoardItemLinkRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request to remove an active board item link." }, "RemoveBoardItemRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid", "nullable": true }, "RemoveReason": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Request to remove an open board item from the board without deleting its target object." }, "RenameBoardProcessAttachmentRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Rename a process attachment through board runtime policy." }, "RenameFileRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "OperationKey": { "type": "string", "format": "uuid" }, "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "RenewEntitlementRequest": { "type": "object", "properties": { "StartsAtDate": { "type": "string", "description": "Optional workspace-local renewal start date. Must be supplied with StartsAtTime.", "format": "date", "nullable": true }, "StartsAtTime": { "type": "string", "description": "Optional workspace-local renewal start time. Must be supplied with StartsAtDate.", "format": "time", "nullable": true }, "IdempotencyKey": { "type": "string", "description": "Optional key that prevents repeating the same renewal command.", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "description": "Nullable JSON or text metadata for the source command.", "nullable": true }, "ExternalReference": { "type": "string", "description": "Optional external payment or integration reference.", "nullable": true } }, "additionalProperties": false, "description": "Renew an existing runtime entitlement by creating its next period." }, "ReplaceRuntimeResponsibilitiesRequest": { "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "ExpectedResourceRowVersion": { "type": "string", "format": "uuid" }, "Subjects": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilityAssignmentSubject" }, "nullable": true }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Replaces one resource responsibility set." }, "ResolvedRuntimeMenu": { "type": "object", "properties": { "Id": { "type": "string", "description": "Menu identifier.", "nullable": true }, "Name": { "type": "string", "description": "Menu display name.", "nullable": true }, "Priority": { "type": "integer", "description": "Resolution priority.", "format": "int32" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ResolvedRuntimeMenuNode" }, "description": "Resolved visible nodes.", "nullable": true } }, "additionalProperties": false, "description": "Resolved user menu block to prepend in the runtime navigation." }, "ResolvedRuntimeMenuNode": { "type": "object", "properties": { "Kind": { "$ref": "#/components/schemas/RuntimeMenuItemKind" }, "SortOrder": { "type": "integer", "description": "Sibling sort order.", "format": "int32" }, "Label": { "type": "string", "description": "Display label.", "nullable": true }, "Icon": { "type": "string", "description": "MDI icon name.", "nullable": true }, "LeafType": { "$ref": "#/components/schemas/RuntimeMenuLeafType" }, "EntityDefinitionId": { "type": "string", "description": "Target entity definition identifier.", "nullable": true }, "Href": { "type": "string", "description": "Absolute HTTP(S) URL or app-relative path for external-link leaves.", "nullable": true }, "PageCode": { "type": "string", "description": "Registered stable page code for module-page leaves.", "nullable": true }, "WorkspaceUiPageKey": { "type": "string", "description": "Workspace UI page key for workspace-page leaves.", "nullable": true }, "CatalogDefinitionId": { "type": "string", "description": "Runtime Catalog Definition identifier for Catalog leaves.", "nullable": true }, "Children": { "type": "array", "items": { "$ref": "#/components/schemas/ResolvedRuntimeMenuNode" }, "description": "Resolved child nodes.", "nullable": true }, "ModulePageRouteName": { "type": "string", "description": "Backend-owned WebApp named route for an available module-page leaf.", "nullable": true }, "EntityListPageSurfaceKey": { "type": "string", "description": "Explicit entity-list page key, or null for the current default.", "nullable": true } }, "additionalProperties": false, "description": "One resolved runtime-menu node for the runtime navigation." }, "ResolvedRuntimeMenuResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ResolvedRuntimeMenu" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ResourceIdentity": { "type": "object", "properties": { "ResourceModule": { "type": "string", "nullable": true }, "ResourceKind": { "type": "string", "nullable": true }, "ContextResourceId": { "type": "string", "nullable": true }, "ResourceObjectId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResourceOpenTarget": { "type": "object", "properties": { "TargetCode": { "type": "string", "nullable": true }, "Parameters": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ResponsibilityAssignmentActions": { "type": "object", "properties": { "CanAdd": { "type": "boolean" }, "CanReplace": { "type": "boolean" }, "CanClose": { "type": "boolean" } }, "additionalProperties": false, "description": "Server-computed responsibility assignment actions for the caller." }, "ResponsibilityAssignmentHistoryItem": { "type": "object", "properties": { "ChangeSetId": { "type": "string", "nullable": true }, "ChangedAt": { "type": "string", "format": "date-time" }, "ActorUserId": { "type": "string", "nullable": true }, "Reason": { "type": "string", "nullable": true }, "Before": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilityAssignmentSubject" }, "nullable": true }, "After": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilityAssignmentSubject" }, "nullable": true } }, "additionalProperties": false, "description": "Describes one responsibility assignment history item." }, "ResponsibilityAssignmentHistoryResult": { "type": "object", "properties": { "Resource": { "$ref": "#/components/schemas/SecurityResourceSelector" }, "ResponsibilityKey": { "type": "string", "nullable": true }, "Changes": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilityAssignmentHistoryItem" }, "nullable": true }, "NextCursor": { "type": "string", "nullable": true }, "SubjectDisplays": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Server-resolved subject display names keyed by SubjectType:SubjectId.", "nullable": true } }, "additionalProperties": false, "description": "Returns responsibility history." }, "ResponsibilityAssignmentHistoryResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ResponsibilityAssignmentHistoryResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ResponsibilityAssignmentSet": { "type": "object", "properties": { "Resource": { "$ref": "#/components/schemas/SecurityResourceSelector" }, "ResponsibilityKey": { "type": "string", "nullable": true }, "Subjects": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilityAssignmentSubject" }, "nullable": true }, "ResourceRowVersion": { "type": "string", "format": "uuid" }, "SubjectDisplays": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Server-resolved subject display names keyed by SubjectType:SubjectId.", "nullable": true }, "Actions": { "$ref": "#/components/schemas/ResponsibilityAssignmentActions" } }, "additionalProperties": false, "description": "Returns the current responsibility assignments." }, "ResponsibilityAssignmentSetResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ResponsibilityAssignmentSet" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ResponsibilityAssignmentSubject": { "type": "object", "properties": { "SubjectType": { "type": "string", "nullable": true }, "SubjectId": { "type": "string", "nullable": true }, "EffectiveFrom": { "type": "string", "format": "date-time" }, "EffectiveTo": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Describes one assigned responsibility subject." }, "ResponsibilityCandidatePayload": { "required": [ "ResponsibilityKey", "Subjects" ], "type": "object", "properties": { "ResponsibilityKey": { "type": "string" }, "Subjects": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilitySubjectPayload" } } }, "additionalProperties": false }, "ResponsibilityGroupAvatar": { "type": "object", "properties": { "Initials": { "type": "string", "description": "Avatar initials.", "nullable": true }, "BackgroundColor": { "type": "string", "description": "Avatar background color.", "nullable": true }, "TextColor": { "type": "string", "description": "Avatar text color.", "nullable": true } }, "additionalProperties": false, "description": "Avatar presentation for a responsibility-group member." }, "ResponsibilityGroupDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Group identifier.", "nullable": true }, "Code": { "type": "string", "description": "Optional code-facing identifier.", "nullable": true }, "Name": { "type": "string", "description": "Display name.", "nullable": true }, "Type": { "$ref": "#/components/schemas/ResponsibilityGroupType" }, "Description": { "type": "string", "description": "Optional description.", "nullable": true }, "Users": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilityGroupMember" }, "description": "Assigned users.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-secret integration metadata.", "nullable": true } }, "additionalProperties": false, "description": "Full responsibility-group detail." }, "ResponsibilityGroupDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ResponsibilityGroupDetail" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ResponsibilityGroupMember": { "type": "object", "properties": { "Id": { "type": "string", "description": "User identifier.", "nullable": true }, "UserName": { "type": "string", "description": "Login user name.", "nullable": true }, "Email": { "type": "string", "description": "Optional email address.", "nullable": true }, "FirstName": { "type": "string", "description": "First name.", "nullable": true }, "LastName": { "type": "string", "description": "Optional last name.", "nullable": true }, "DisplayName": { "type": "string", "description": "Canonical effective display name.", "nullable": true }, "UserType": { "$ref": "#/components/schemas/UserType" }, "IsBlocked": { "type": "boolean", "description": "Whether the user is blocked." }, "Avatar": { "$ref": "#/components/schemas/ResponsibilityGroupAvatar" } }, "additionalProperties": false, "description": "Member assigned to a responsibility group." }, "ResponsibilityGroupSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Group identifier.", "nullable": true }, "Code": { "type": "string", "description": "Optional code-facing identifier.", "nullable": true }, "Name": { "type": "string", "description": "Display name.", "nullable": true }, "Type": { "$ref": "#/components/schemas/ResponsibilityGroupType" }, "Description": { "type": "string", "description": "Optional description.", "nullable": true }, "UserCount": { "type": "integer", "description": "Assigned member count.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-secret integration metadata.", "nullable": true } }, "additionalProperties": false, "description": "Summary projection for one responsibility group." }, "ResponsibilityGroupSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilityGroupSummary" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ResponsibilityGroupType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Team", "Committee", "Department", "Region", "ProjectTeam", "Other" ], "x-enum-descriptions": { "0": "Standing team of people working together", "1": "Deliberative group convened for decisions or oversight", "2": "Formal organizational unit", "3": "Group scoped to a geographic area", "4": "Temporary group formed around a specific project", "5": "Group that does not fit the predefined classifications" } }, "ResponsibilityMutationResult": { "type": "object", "additionalProperties": false }, "ResponsibilityMutationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ResponsibilityMutationResult" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ResponsibilityStatePayload": { "type": "object", "properties": { "Resource": { "$ref": "#/components/schemas/SecurityResourceSelector" }, "ResponsibilityKey": { "type": "string", "nullable": true }, "Subjects": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsibilityAssignmentSubject" }, "nullable": true }, "ChangeSetId": { "type": "string", "nullable": true }, "ResourceRowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Returns authorized responsibility state." }, "ResponsibilitySubjectPayload": { "required": [ "EffectiveFrom", "SubjectId", "SubjectType" ], "type": "object", "properties": { "SubjectType": { "type": "string" }, "SubjectId": { "type": "string" }, "EffectiveFrom": { "type": "string", "format": "date-time" }, "EffectiveTo": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ReverseEntitlementQuantityRequest": { "type": "object", "properties": { "ConsumeLedgerEntryId": { "type": "string", "description": "Prior consume ledger entry being reversed.", "nullable": true }, "Quantity": { "type": "number", "description": "Positive amount to reverse.", "format": "double" }, "RowVersion": { "type": "string", "description": "Optional concurrency token from the latest entitlement limit detail.", "format": "uuid", "nullable": true }, "ReasonCode": { "type": "string", "description": "Optional structured reason for support and audit review.", "nullable": true }, "ReasonText": { "type": "string", "description": "Optional free-form reason for support and audit review.", "nullable": true }, "IdempotencyKey": { "type": "string", "description": "Optional key that prevents repeating the same reverse command.", "nullable": true }, "SourceType": { "$ref": "#/components/schemas/EntitlementSourceType" }, "SourceData": { "type": "string", "description": "Nullable JSON or text metadata for the source command.", "nullable": true } }, "additionalProperties": false, "description": "Reverse a positive quantity from one prior consume ledger row." }, "RoleSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Role identifier.", "nullable": true }, "Name": { "type": "string", "description": "Role display name.", "nullable": true }, "Description": { "type": "string", "description": "Role description.", "nullable": true }, "AutoAssign": { "type": "boolean", "description": "Whether the role is auto-assigned to new users." }, "IsSystem": { "type": "boolean", "description": "Whether the role is a protected system role." }, "UserCount": { "type": "integer", "description": "Number of users assigned to this role.", "format": "int32" }, "PermissionCount": { "type": "integer", "description": "Number of permissions assigned to this role.", "format": "int32" }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "Tag names assigned to the role.", "nullable": true }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-secret integration metadata.", "nullable": true } }, "additionalProperties": false, "description": "Summary of a workspace role." }, "RoleSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RoleSummary" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "RuntimeMenuItemKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Leaf", "Section", "Submenu" ], "x-enum-descriptions": { "0": "Navigable entry that opens the concrete target resolved from its leaf type", "1": "Groups its child leaves under a titled section in the navigation", "2": "Groups its child leaves under a nested expandable submenu" } }, "RuntimeMenuLeafType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "DataExplorer", "ExternalLink", "FileSystem", "ModulePage", "WorkspaceUiPage", "Catalog" ], "x-enum-descriptions": { "0": "Opens the Data Explorer list for the configured entity definition", "1": "Opens the external URL configured in the item's href", "2": "Opens the workspace file system browser", "3": "Opens a module-provided page resolved by the configured page code", "4": "Opens a workspace UI project page resolved by the configured page key", "5": "Opens the configured classifier catalog" } }, "SecurityResourceSelector": { "type": "object", "properties": { "ResourceModule": { "type": "string", "nullable": true }, "ResourceKind": { "type": "string", "nullable": true }, "ContextResourceId": { "type": "string", "nullable": true }, "ResourceObjectId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Identifies one runtime resource." }, "StringResponse": { "type": "object", "properties": { "Data": { "type": "string", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TableCellEditor": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "Default", "Text", "TextArea", "Numeric", "Date", "Time", "BoolCheckbox", "BoolSwitch", "Select", "DateTime" ], "x-enum-descriptions": { "0": "Disable inline editing for the cell", "1": "Use the editor inferred from the field type", "2": "Edit the cell with a single-line text input", "3": "Edit the cell with a multi-line text input", "4": "Edit the cell with a numeric input", "5": "Edit the cell with a date input", "6": "Edit the cell with a time input", "7": "Edit the Boolean cell with a checkbox", "8": "Edit the Boolean cell with a switch", "9": "Edit the cell with a select input", "10": "Edit an exact instant with one date and time input in the workspace time zone" } }, "TableColumnRenderer": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Default", "Text", "LongText", "Numeric", "Date", "DateTime", "Time", "BoolIcon", "BoolCheckbox", "BoolSwitch", "SelectChip", "SelectText", "Reference", "Tags", "CommentSummary", "Assignments", "Address", "File", "ObjectContextFact" ], "x-enum-descriptions": { "0": "Use the renderer inferred from the field type", "1": "Render the value as short single-line text", "2": "Render the value as multi-line long text", "3": "Render the value as a formatted number", "4": "Render the value as a date without time", "5": "Render the value as a date with time", "6": "Render the value as a time of day", "7": "Render the Boolean value as an icon", "8": "Render the Boolean value as a checkbox", "9": "Render the Boolean value as a switch", "10": "Render the select option as a chip", "11": "Render the select option as plain text", "12": "Render the referenced record presentation value", "13": "Render the runtime tags attached to the record", "14": "Render a summary of the latest comment on the record", "15": "Render the assignment subjects for the record", "16": "Render the structured address value", "17": "Render the attached file value", "18": "Render a module-provided context fact about the record" } }, "Tag": { "type": "object", "properties": { "Id": { "type": "string", "description": "Tag identifier.", "nullable": true }, "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" }, "TagName": { "type": "string", "description": "Tag name.", "nullable": true }, "Color": { "type": "string", "description": "Optional color value.", "nullable": true }, "Category": { "type": "string", "description": "Optional category.", "nullable": true }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "CreatedByUserId": { "type": "string", "description": "Creator identifier, or null for legacy rows without attribution.", "nullable": true }, "CreatedByUserName": { "type": "string", "description": "Creator display name.", "nullable": true } }, "additionalProperties": false, "description": "Tag details." }, "TagListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TagResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Tag" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TagSuggestion": { "type": "object", "properties": { "Id": { "type": "string", "description": "Representative tag identifier used by query filters.", "nullable": true }, "TagName": { "type": "string", "description": "Tag name.", "nullable": true }, "Color": { "type": "string", "description": "Optional color value.", "nullable": true }, "Category": { "type": "string", "description": "Optional category.", "nullable": true } }, "additionalProperties": false, "description": "A resource-safe tag suggestion." }, "TagSuggestionListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/TagSuggestion" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TextBlockStyle": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "H1", "H2", "H3", "H4", "H5", "H6", "Overline", "Subtitle", "Body" ], "x-enum-descriptions": { "0": "Render the text as a first-level heading", "1": "Render the text as a second-level heading", "2": "Render the text as a third-level heading", "3": "Render the text as a fourth-level heading", "4": "Render the text as a fifth-level heading", "5": "Render the text as a sixth-level heading", "6": "Render the text in the small uppercase overline style", "7": "Render the text in the subtitle style", "8": "Render the text in the regular body style" } }, "TransitionManagedFileUploadRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Optimistic transition request for complete or abort." }, "UpdateBoardItemCycleRequest": { "type": "object", "properties": { "BoardCycleId": { "type": "string", "nullable": true }, "ChangeReason": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request to assign one board item to a board cycle." }, "UpdateBoardItemDataRequest": { "type": "object", "properties": { "Subject": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true }, "Fields": { "type": "object", "additionalProperties": { "type": "object", "nullable": true }, "nullable": true }, "MarkdownAttachmentDraftSessionId": { "type": "string", "nullable": true }, "MutationIdempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Request to update board-owned data on one board item." }, "UpdateBoardItemDueDateRequest": { "type": "object", "properties": { "DueDate": { "type": "string", "format": "date", "nullable": true }, "DueTime": { "type": "string", "format": "time", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request to update one board item due date." }, "UpdateBoardRuntimeCycleRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Cycle name.", "nullable": true }, "Description": { "type": "string", "description": "Optional cycle description.", "nullable": true }, "StartDate": { "type": "string", "description": "Inclusive workspace-local start date.", "format": "date", "nullable": true }, "EndDate": { "type": "string", "description": "Inclusive workspace-local end date.", "format": "date", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order inside the board.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Optional optimistic concurrency token.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Update an eligible runtime board cycle." }, "UpdateBoardRuntimeSavedFilterRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Filter": { "$ref": "#/components/schemas/BoardRuntimeItemsSearchRequest" }, "IsFavorite": { "type": "boolean", "nullable": true }, "IsDefault": { "type": "boolean", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Update a personal runtime saved filter." }, "UpdateCommentRequest": { "type": "object", "properties": { "CommentText": { "type": "string", "description": "Updated comment text.", "nullable": true }, "OperationKey": { "type": "string", "description": "Caller-owned idempotency key. Required for Core Entity mutations.", "format": "uuid" }, "RowVersion": { "type": "string", "description": "Expected comment row version. Required for Core Entity mutations.", "format": "uuid" }, "Owner": { "$ref": "#/components/schemas/MoltaroResourceIdentity" } }, "additionalProperties": false, "description": "Request payload to update a comment." }, "UpdateTagRequest": { "type": "object", "properties": { "TagName": { "type": "string", "description": "Updated tag name.", "nullable": true }, "Color": { "type": "string", "description": "Updated color value.", "nullable": true }, "Category": { "type": "string", "description": "Updated category.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update a tag." }, "UpdateWorkspaceAccountProfileRequest": { "type": "object", "properties": { "UserName": { "type": "string", "description": "Exact Unicode login name. Lookup uniqueness uses trim, NFC, and invariant uppercase.", "nullable": true }, "Email": { "type": "string", "description": "Optional email address.", "nullable": true }, "FirstName": { "type": "string", "description": "First name. Omit together with LastName when names are managed by an associated Worker.", "nullable": true }, "LastName": { "type": "string", "description": "Last name. Omit together with FirstName when names are managed by an associated Worker.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update the authenticated workspace account profile." }, "UserAvatar": { "type": "object", "properties": { "Initials": { "type": "string", "description": "Initials derived from the user name.", "nullable": true }, "BackgroundColor": { "type": "string", "description": "Hex color for the avatar background.", "nullable": true }, "TextColor": { "type": "string", "description": "Hex color for the avatar text.", "nullable": true } }, "additionalProperties": false, "description": "Avatar presentation values for a workspace user." }, "UserExternalIdentityProjection": { "type": "object", "properties": { "LinkId": { "type": "string", "nullable": true }, "ProviderKind": { "$ref": "#/components/schemas/ExternalIdentityProviderKind" }, "ProviderDisplayName": { "type": "string", "nullable": true }, "Status": { "$ref": "#/components/schemas/ExternalIdentityLinkStatus" }, "Profile": { "$ref": "#/components/schemas/ExternalIdentityProfile" }, "DiagnosticCode": { "$ref": "#/components/schemas/ExternalIdentityDiagnosticCode" }, "LastSynchronizedAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Safe current external identity state attached to a local user projection." }, "UserSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "User identifier.", "nullable": true }, "UserName": { "type": "string", "description": "Exact stored Unicode login name.", "nullable": true }, "Email": { "type": "string", "description": "Optional email address.", "nullable": true }, "FirstName": { "type": "string", "description": "First name.", "nullable": true }, "LastName": { "type": "string", "description": "Last name.", "nullable": true }, "UserType": { "$ref": "#/components/schemas/UserType" }, "IsBlocked": { "type": "boolean", "description": "Whether the user is blocked from signing in." }, "IsDeleted": { "type": "boolean", "description": "Whether the user is soft deleted." }, "Avatar": { "$ref": "#/components/schemas/UserAvatar" }, "Roles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleSummary" }, "description": "Roles assigned to this user.", "nullable": true }, "HasLocalPassword": { "type": "boolean", "description": "Whether local password authentication is available." }, "ExternalIdentity": { "$ref": "#/components/schemas/UserExternalIdentityProjection" }, "EmailConfirmed": { "type": "boolean", "description": "Whether the optional email address has been confirmed." }, "RowVersion": { "type": "string", "description": "Opaque concurrency token.", "nullable": true }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-secret integration metadata.", "nullable": true }, "DisplayName": { "type": "string", "description": "Canonical display name.", "nullable": true }, "WorkerAssociation": { "$ref": "#/components/schemas/UserWorkerAssociation" } }, "additionalProperties": false, "description": "Summary projection for a workspace user." }, "UserSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UserType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Owner", "WorkspaceUser", "Service" ], "x-enum-descriptions": { "0": "Owns the workspace and bypasses role-based permission checks", "1": "Human user who signs in with email and password credentials", "2": "Non-human account used by API integrations or AI agents acting as a user" } }, "UserWorkerAssociation": { "type": "object", "properties": { "Worker": { "$ref": "#/components/schemas/UserWorkerReference" }, "Availability": { "type": "string", "nullable": true }, "AssociationVersion": { "type": "string", "nullable": true }, "NamesManagedByWorker": { "type": "boolean" }, "CanRead": { "type": "boolean" }, "CanManage": { "type": "boolean" } }, "additionalProperties": false, "description": "Current Work Schedule association projected into a user read model." }, "UserWorkerReference": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "nullable": true }, "Id": { "type": "string", "nullable": true }, "Number": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Field-safe reference to the Worker associated with a workspace user." }, "WorkspaceAccountProfileResponse": { "type": "object", "properties": { "UserId": { "type": "string", "description": "Workspace user identifier.", "nullable": true }, "UserName": { "type": "string", "description": "Exact stored Unicode login name.", "nullable": true }, "Email": { "type": "string", "description": "Optional email address.", "nullable": true }, "FirstName": { "type": "string", "description": "First name.", "nullable": true }, "LastName": { "type": "string", "description": "Last name.", "nullable": true }, "DisplayName": { "type": "string", "description": "Canonical effective display name.", "nullable": true }, "UserType": { "$ref": "#/components/schemas/UserType" }, "Avatar": { "$ref": "#/components/schemas/UserAvatar" } }, "additionalProperties": false, "description": "Profile fields for the authenticated workspace account." }, "WorkspaceAccountProfileResponseEnvelope": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceAccountProfileResponse" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "WorkspaceContextResponse": { "type": "object", "properties": { "DisplayName": { "type": "string", "description": "Workspace display name.", "nullable": true }, "Locale": { "type": "string", "description": "Workspace locale code.", "nullable": true }, "TimeZone": { "type": "string", "description": "Workspace time zone identifier.", "nullable": true }, "RegionCode": { "type": "string", "description": "Workspace routing region code.", "nullable": true }, "EnabledFeatures": { "type": "array", "items": { "type": "string" }, "description": "Enabled deployment features.", "nullable": true }, "GoogleMapsApiKey": { "type": "string", "description": "Optional Google Maps browser API key (can be null when maps are not supported).", "nullable": true }, "BusinessLogicAuthoringMode": { "type": "string", "description": "Effective workspace business-logic authoring mode.", "nullable": true } }, "additionalProperties": false, "description": "Workspace settings available before authentication." }, "WorkspaceContextResponseEnvelope": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceContextResponse" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Success": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "WorkspaceModuleAvailability": { "type": "object", "properties": { "Enabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Availability state for one workspace module in the authenticated user context." }, "WorkspaceModuleState": { "type": "object", "properties": { "Boards": { "$ref": "#/components/schemas/WorkspaceModuleAvailability" }, "Booking": { "$ref": "#/components/schemas/WorkspaceModuleAvailability" }, "CurrencyRates": { "$ref": "#/components/schemas/WorkspaceModuleAvailability" }, "EntitlementOperations": { "$ref": "#/components/schemas/WorkspaceModuleAvailability" }, "FileProtection": { "$ref": "#/components/schemas/WorkspaceModuleAvailability" }, "WorkInbox": { "$ref": "#/components/schemas/WorkspaceModuleAvailability" }, "WorkSchedule": { "$ref": "#/components/schemas/WorkspaceModuleAvailability" } }, "additionalProperties": false, "description": "Typed module availability snapshot included in the authenticated user context." }, "WorkspaceOnboardingStatus": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "InProgress", "Completed" ], "x-enum-descriptions": { "0": "No workspace onboarding is running or required.", "1": "Workspace onboarding is currently running.", "2": "Workspace onboarding has completed." } } }, "securitySchemes": { "WorkspaceBearer": { "type": "http", "description": "Workspace bearer token or service API key. Example: `Bearer {token}`", "scheme": "bearer", "bearerFormat": "Bearer" } } }, "tags": [ { "name": "Account", "description": "Manage the authenticated workspace account." }, { "name": "Activity Feed", "description": "Return resource-aware activity feed items for Moltaro resources." }, { "name": "Attachments", "description": "Manage generic attachments for workspace entities." }, { "name": "Auth", "description": "Authenticate and manage workspace user access." }, { "name": "Boards Runtime", "description": "Reads and mutates named Board responsibilities through Unified Security." }, { "name": "Commands", "description": "Invoke published command functions synchronously by callable key." }, { "name": "Comments", "description": "Manage generic comments for workspace entities." }, { "name": "Context", "description": "Provides workspace settings for unauthenticated clients." }, { "name": "Entitlement Operations Entitlements", "description": "Runtime entitlement operations for issuing and viewing entitlements." }, { "name": "Entitlement Operations Ledger", "description": "Operational ledger APIs for entitlement lifecycle, renewal, and usage rows." }, { "name": "Entitlement Operations Renewal", "description": "Renewal policy and workflow operation APIs for Moltaro Entitlement Operations." }, { "name": "Entity Data Transfer", "description": "Runtime data transfer API for entity instances." }, { "name": "Entity Definitions", "description": "Read entity definition metadata in Moltaro." }, { "name": "Entity Instances", "description": "Exposes the frozen Entity responsibility-mutation route through Unified Security." }, { "name": "Entity UI", "description": "Runtime UI metadata endpoints for entity surfaces." }, { "name": "File System", "description": "Manage resumable large-file upload sessions." }, { "name": "Function Actions", "description": "Invoke published action functions from supported Moltaro runtime surfaces." }, { "name": "Function API Jobs", "description": "Enqueue published global functions through the functions API and observe their jobs." }, { "name": "Record Matching", "description": "Runtime record-matching and duplicate-detection endpoints for entity records." }, { "name": "Responsibility Groups", "description": "Read responsibility groups in Moltaro." }, { "name": "Roles", "description": "Read workspace roles." }, { "name": "Tags", "description": "Manage generic tags for workspace resources." }, { "name": "User Menu", "description": "Resolve the effective user menu block." }, { "name": "Users", "description": "Read workspace users." } ] }