{ "openapi": "3.0.4", "info": { "title": "Moltaro Configuration API", "description": "Curated configuration 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 configured Moltaro installation.\r\n- For actual development, prefer the OpenAPI document served by that installation at `/openapi/moltaro-config-v1.json`; it matches the installed release.\r\n- A human administrator first deploys or registers the workspace Web Application, creates a service user and key, and supplies the workspace API base URL. The Web Application and API URLs may differ.\r\n\r\nScope\r\n- This reference covers core entity definition management: definitions, schema fields, Reference Eligibility validation/impact/disabled metadata, unique constraints, indexes, configurable search targets, projection entities, display fields, object context facts, validation rules, mutation effects, direct current Entity Security configuration through Security Statements, Permission Assignments and Responsibilities, data transfer profiles, strict Entity YAML v8 portability, geo location sources, and expression validation for the Moltaro expression language (DSL).\r\n- It also covers the entity UI surface library (table, card, and form surfaces, list page, details and drawer host layouts, field UI preferences), user menus and their built-in module-page registry, Boards configuration (module lifecycle, localized board defaults, boards, statuses, transitions, Responsibilities, Security Statements, Permission Assignments, target definitions, and the board-owned data model), and Entitlement Operations configuration (module lifecycle, entitlement models, model security, plans, plan families, and renewal policies).\r\n- It also covers business-logic authoring and operations: the function catalog, function schedules, run and job operations, API function publications (commands and enqueue), HTTP endpoint function governance, managed secrets for trusted C# runtimes, entity UI action design, and the Net Operation Project source, build, and lifecycle endpoints.\r\n- Workspace file-system settings include the extension-aware declared MIME policy used by browser, API, Boards, and Package SDK uploads.\r\n- It also covers the Workspace UI Project: frontend source and revisions, source templates and page generators, ZIP download and upload, checks and builds, artifacts, compatibility, and the activation lifecycle. These endpoints gate on the Workspace UI Project permissions (View, Manage source, Build, Publish) in addition to role checks.\r\n- Workspace principal administration covers ordinary CRUD for users, roles, role permissions, and responsibility groups. Create accepts caller-supplied stable string ids and create/update expose bounded non-secret ExtendedData; there are no separate synchronization endpoints. User create may include an initial local Password only for a WorkspaceUser. Omit Password for deliberate passwordless provisioning and Service users. Subsequent password, invitation, external-identity, avatar, token, and API-key lifecycle endpoints are intentionally excluded.\r\n- Other administration areas (packages, general workspace settings, and business-function runtime settings) are intentionally excluded from this version. Entitlement renewal-operation workflow endpoints and business-function invocation endpoints belong to the Runtime API.\r\n\r\nAuthorization\r\n- Use `Authorization: Bearer ` with a workspace access token or a service API key.\r\n- Core entity-definition operations require the Admin or Configurator role.\r\n- Geo Location Sources operations may also authorize resource-context managers, such as a board manager with the ManageConfiguration permission for that board.\r\n- Service accounts pass the same role and resource-context permission gates as human users.\r\n\r\nSchema changes\r\n- Destructive schema changes (field type changes, deletions, base updates) offer `schema-change-plan` endpoints that preview data loss before the change is applied.\r\n\r\nExpressions\r\n- Validation rules, field behavior conditions, presentation rules, statements, and calculated fields use the Moltaro expression language: https://moltaro.com/docs/dsl/\r\n- Calculated fields are stored values. Current calculation targets are Integer, Decimal, and Money; Display Fields are a separate read-time text contract.\r\n- Validate a field calculation without saving through `POST /api/workspace/admin/entity-fields/{fieldId}/calculation/validate`, then persist it with the current `RowVersion` through `PUT /api/workspace/admin/entity-fields/{fieldId}/calculation`: https://moltaro.com/docs/dsl/calculated-fields/\r\n- Validate other expressions without saving through the rule-expressions and validation-rules validation endpoints.\r\n- Reference Eligibility compares `Current` source values with `Candidate` target values. This API currently validates, impact-checks, and stores disabled rules; `Enabled = true` remains unavailable until runtime candidate and mutation consumers are released: https://moltaro.com/docs/configuration/reference-eligibility/\r\n\r\nResponses\r\n- Endpoints return `ApiResponse` with `Success`, `Data`, `Errors`, and `Warnings`.", "contact": { "name": "Moltaro", "url": "https://moltaro.com" }, "version": "moltaro-config-v1" }, "paths": { "/api/workspace/admin/record-matching": { "get": { "tags": [ "Admin Record Matching" ], "summary": "List configured record-matching profiles.", "operationId": "admin-record-matching-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/RecordMatchingProfileSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Admin Record Matching" ], "summary": "Create one record-matching profile.", "operationId": "admin-record-matching-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/CreateRecordMatchingProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRecordMatchingProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateRecordMatchingProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingProfileDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingProfileDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingProfileDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/record-matching/{profileId}": { "get": { "tags": [ "Admin Record Matching" ], "summary": "Return one record-matching profile.", "operationId": "admin-record-matching-get", "parameters": [ { "name": "profileId", "in": "path", "description": "Record-matching profile 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/RecordMatchingProfileDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingProfileDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Admin Record Matching" ], "summary": "Replace one record-matching profile.", "operationId": "admin-record-matching-update", "parameters": [ { "name": "profileId", "in": "path", "description": "Record-matching profile 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": "Complete replacement profile configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRecordMatchingProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateRecordMatchingProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateRecordMatchingProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingProfileDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingProfileDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingProfileDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordMatchingProfileDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Admin Record Matching" ], "summary": "Delete one record-matching profile.", "operationId": "admin-record-matching-delete", "parameters": [ { "name": "profileId", "in": "path", "description": "Record-matching profile 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/BooleanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/record-matching/target-options": { "get": { "tags": [ "Admin Record Matching" ], "summary": "Return entity definitions and compatible fields for profile configuration.", "operationId": "admin-record-matching-get-target-options", "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/RecordMatchingTargetOptionsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/record-matching/{profileId}/run": { "post": { "tags": [ "Admin Record Matching" ], "summary": "Run a bounded exact or fuzzy record-matching profile from Constructor.", "operationId": "admin-record-matching-run", "parameters": [ { "name": "profileId", "in": "path", "description": "Record-matching profile 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": "Archive scope and bounded compatibility 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/admin/responsibility-groups": { "post": { "tags": [ "Admin Responsibility Groups" ], "summary": "Create one responsibility group.", "operationId": "admin-responsibility-groups-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/CreateResponsibilityGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateResponsibilityGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateResponsibilityGroupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/responsibility-groups/{responsibilityGroupId}": { "put": { "tags": [ "Admin Responsibility Groups" ], "summary": "Update one responsibility group.", "operationId": "admin-responsibility-groups-update", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponsibilityGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateResponsibilityGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateResponsibilityGroupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Admin Responsibility Groups" ], "summary": "Delete one responsibility group.", "operationId": "admin-responsibility-groups-delete", "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/BooleanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/responsibility-groups/{responsibilityGroupId}/users": { "put": { "tags": [ "Admin Responsibility Groups" ], "summary": "Replace users assigned to one responsibility group.", "operationId": "admin-responsibility-groups-update-users", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponsibilityGroupUsersRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateResponsibilityGroupUsersRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateResponsibilityGroupUsersRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsibilityGroupDetailResponse" } } } }, "400": { "description": "Bad Request", "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/{roleId}": { "get": { "tags": [ "Admin Roles" ], "summary": "Return details for a workspace role.", "operationId": "admin-roles-get-role", "parameters": [ { "name": "roleId", "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/RoleDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Admin Roles" ], "summary": "Update a workspace role.", "operationId": "admin-roles-update-role", "parameters": [ { "name": "roleId", "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/UpdateRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateRoleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Admin Roles" ], "summary": "Delete a workspace role.", "operationId": "admin-roles-delete-role", "parameters": [ { "name": "roleId", "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/RoleDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/roles": { "post": { "tags": [ "Admin Roles" ], "summary": "Create a new workspace role.", "operationId": "admin-roles-create-role", "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/CreateRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateRoleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "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/roles/{roleId}/users": { "put": { "tags": [ "Admin Roles" ], "summary": "Update role membership.", "operationId": "admin-roles-update-role-users", "parameters": [ { "name": "roleId", "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/UpdateRoleUsersRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateRoleUsersRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateRoleUsersRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/roles/permissions": { "get": { "tags": [ "Admin Roles" ], "summary": "Return available permissions for roles.", "operationId": "admin-roles-get-permissions", "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/PermissionDescListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/roles/{roleId}/permissions": { "get": { "tags": [ "Admin Roles" ], "summary": "Return permissions assigned to a role.", "operationId": "admin-roles-get-role-permissions", "parameters": [ { "name": "roleId", "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/StringListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Admin Roles" ], "summary": "Update permissions assigned to a role.", "operationId": "admin-roles-update-role-permissions", "parameters": [ { "name": "roleId", "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/UpdateRolePermissionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateRolePermissionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateRolePermissionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/users/{userId}": { "get": { "tags": [ "Admin Users" ], "summary": "Return details for a workspace user.", "operationId": "admin-users-get-user", "parameters": [ { "name": "userId", "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/UserDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Admin Users" ], "summary": "Update a workspace user profile.", "operationId": "admin-users-update-user", "parameters": [ { "name": "userId", "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/UpdateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Admin Users" ], "summary": "Soft delete a workspace user.", "operationId": "admin-users-delete-user", "parameters": [ { "name": "userId", "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/UserDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/users/{userId}/worker/options": { "get": { "tags": [ "Admin Users" ], "summary": "Lists every active Worker available to an administrator linking a user.\r\nWorker Entity Security does not filter this administrative lookup.", "operationId": "admin-users-list-worker-options", "parameters": [ { "name": "userId", "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/UserWorkerOptionListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWorkerOptionListResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWorkerOptionListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/users": { "post": { "tags": [ "Admin Users" ], "summary": "Create a workspace or service user, optionally setting an initial local password\r\nfor a workspace user.", "operationId": "admin-users-create-user", "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/CreateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "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": [ { } ] } }, "/api/workspace/users/{userId}/roles": { "put": { "tags": [ "Admin Users" ], "summary": "Update role assignments for a user.", "operationId": "admin-users-update-user-roles", "parameters": [ { "name": "userId", "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/UpdateUserRolesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRolesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserRolesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/users/{userId}/block": { "post": { "tags": [ "Admin Users" ], "summary": "Block a workspace user and revoke active tokens.", "operationId": "admin-users-block-user", "parameters": [ { "name": "userId", "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/UserDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/users/{userId}/unblock": { "post": { "tags": [ "Admin Users" ], "summary": "Unblock a workspace user.", "operationId": "admin-users-unblock-user", "parameters": [ { "name": "userId", "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/UserDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/agent-integration": { "get": { "tags": [ "Agent Integration" ], "summary": "Return agent integration facts for this installation. This endpoint does not discover an unknown workspace host.", "operationId": "admin-agent-integration-get", "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/AgentIntegrationManifestResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/agent-integration/agents-md": { "get": { "tags": [ "Agent Integration" ], "summary": "Download the workspace-specific guide after installation bootstrap. The same response may be saved as AGENTS.md or CLAUDE.md.", "operationId": "admin-agent-integration-download-agents-markdown", "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" }, "403": { "description": "Forbidden", "content": { "text/markdown": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/agent-integration/access-kit": { "post": { "tags": [ "Agent Integration" ], "summary": "Create a trusted Service user with Admin and Configurator roles and download its\r\none-time, 90-day agent access kit as a ZIP archive.", "operationId": "admin-agent-integration-create-access-kit", "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" }, "400": { "description": "Bad Request", "content": { "application/zip": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/api-functions": { "get": { "tags": [ "API Functions" ], "summary": "List discovered command and API enqueue publications.", "operationId": "admin-business-function-api-publications-admin-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/BusinessFunctionApiPublicationListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/api-functions/{publicationId}": { "get": { "tags": [ "API Functions" ], "summary": "Get one publication.", "operationId": "admin-business-function-api-publications-admin-get", "parameters": [ { "name": "publicationId", "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/BusinessFunctionApiPublicationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiPublicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/api-functions/{publicationId}/settings": { "put": { "tags": [ "API Functions" ], "summary": "Update admin-owned publication settings.", "operationId": "admin-business-function-api-publications-admin-update-settings", "parameters": [ { "name": "publicationId", "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/UpdateBusinessFunctionApiPublicationSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBusinessFunctionApiPublicationSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBusinessFunctionApiPublicationSettingsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiPublicationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiPublicationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiPublicationResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionApiPublicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return current Boards module summary and configured boards.", "operationId": "admin-boards-administration-get", "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/BoardsAdministrationDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/setup": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return Boards administration setup data.", "operationId": "admin-boards-administration-setup", "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/BoardsAdministrationSetupResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/permissions": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return role assignments for Boards global module permissions.", "operationId": "admin-boards-administration-permissions", "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/ScopedRolePermissionsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Boards Configuration" ], "summary": "Replace role assignments for Boards global module permissions.", "operationId": "admin-boards-administration-update-permissions", "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/ReplaceScopedRolePermissionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceScopedRolePermissionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceScopedRolePermissionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopedRolePermissionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopedRolePermissionsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return board summaries.", "operationId": "admin-boards-administration-boards", "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/BoardSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Boards Configuration" ], "summary": "Create a board configuration.", "operationId": "admin-boards-administration-create-board", "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/CreateBoardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return one board configuration.", "operationId": "admin-boards-administration-board", "parameters": [ { "name": "boardId", "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/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "patch": { "tags": [ "Boards Configuration" ], "summary": "Update board identity fields.", "operationId": "admin-boards-administration-update-board", "parameters": [ { "name": "boardId", "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/UpdateBoardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Configuration" ], "summary": "Delete a board that has no runtime board items.", "operationId": "admin-boards-administration-delete-board", "parameters": [ { "name": "boardId", "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/DeleteBoardRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteBoardRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteBoardRequest" } } } }, "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/admin/boards/boards/{boardId}/data-model": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return the board-owned Part entity definition used for board data.", "operationId": "admin-boards-administration-board-data-model", "parameters": [ { "name": "boardId", "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" } } } }, "400": { "description": "Bad Request", "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/admin/boards/boards/{boardId}/data-model/fields": { "post": { "tags": [ "Boards Configuration" ], "summary": "Create a primary field in the board-owned Part entity definition.", "operationId": "admin-boards-administration-create-board-data-field", "parameters": [ { "name": "boardId", "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/CreateEntityFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityFieldRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/data-model/fields/{fieldId}": { "put": { "tags": [ "Boards Configuration" ], "summary": "Update a primary field in the board-owned Part entity definition.", "operationId": "admin-boards-administration-update-board-data-field", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/UpdateEntityFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityFieldRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "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": [ { } ] }, "delete": { "tags": [ "Boards Configuration" ], "summary": "Delete a primary field from the board-owned Part entity definition.", "operationId": "admin-boards-administration-delete-board-data-field", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "schemaChangeConfirmationToken", "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/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "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/admin/boards/boards/{boardId}/data-model/fields/{fieldId}/schema-change-plan": { "post": { "tags": [ "Boards Configuration" ], "summary": "Plan a primary field update in the board-owned Part entity definition.", "operationId": "admin-boards-administration-plan-board-data-field-update", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/UpdateEntityFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityFieldRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/data-model/fields/{fieldId}/type": { "put": { "tags": [ "Boards Configuration" ], "summary": "Change a primary field type in the board-owned Part entity definition.", "operationId": "admin-boards-administration-change-board-data-field-type", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/ChangeEntityFieldTypeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeEntityFieldTypeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeEntityFieldTypeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "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/admin/boards/boards/{boardId}/data-model/fields/{fieldId}/type/schema-change-plan": { "post": { "tags": [ "Boards Configuration" ], "summary": "Plan a primary field type change in the board-owned Part entity definition.", "operationId": "admin-boards-administration-plan-board-data-field-type-change", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/ChangeEntityFieldTypeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeEntityFieldTypeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeEntityFieldTypeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/data-model/fields/{fieldId}/delete/schema-change-plan": { "post": { "tags": [ "Boards Configuration" ], "summary": "Plan a primary field delete in the board-owned Part entity definition.", "operationId": "admin-boards-administration-plan-board-data-field-delete", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/SchemaChangePlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/data-model/fields/order": { "put": { "tags": [ "Boards Configuration" ], "summary": "Reorder primary fields in the board-owned Part entity definition.", "operationId": "admin-boards-administration-reorder-board-data-fields", "parameters": [ { "name": "boardId", "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/ReorderEntityFieldsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderEntityFieldsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderEntityFieldsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "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/admin/boards/boards/{boardId}/data-model/fields/{fieldId}/ui-preference": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return reference UI preference for a board data field.", "operationId": "admin-boards-administration-get-board-data-field-preference", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/EntityUiFieldPreferenceAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Boards Configuration" ], "summary": "Upsert reference UI preference for a board data field.", "operationId": "admin-boards-administration-upsert-board-data-field-preference", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/UpsertEntityUiFieldPreferenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertEntityUiFieldPreferenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertEntityUiFieldPreferenceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Configuration" ], "summary": "Delete reference UI preference for a board data field.", "operationId": "admin-boards-administration-delete-board-data-field-preference", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/DeleteEntityUiFieldPreferenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteEntityUiFieldPreferenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteEntityUiFieldPreferenceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/data-model/fields/{fieldId}/metadata": { "put": { "tags": [ "Boards Configuration" ], "summary": "Upsert board-owned visibility metadata for a board data field.", "operationId": "admin-boards-administration-upsert-board-data-field-metadata", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/UpdateBoardDataFieldMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardDataFieldMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardDataFieldMetadataRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "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/admin/boards/enable": { "post": { "tags": [ "Boards Configuration" ], "summary": "Enable the Boards module lifecycle.", "operationId": "admin-boards-administration-enable", "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/EnableBoardsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnableBoardsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EnableBoardsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardsAdministrationDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardsAdministrationDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardsAdministrationDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/disable": { "post": { "tags": [ "Boards Configuration" ], "summary": "Disable the Boards module lifecycle.", "operationId": "admin-boards-administration-disable", "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/DisableBoardsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DisableBoardsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DisableBoardsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardsAdministrationDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardsAdministrationDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardsAdministrationDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/due-date-policy": { "put": { "tags": [ "Boards Configuration" ], "summary": "Replace a board due-date process policy.", "operationId": "admin-boards-administration-replace-due-date-policy", "parameters": [ { "name": "boardId", "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/ReplaceBoardDueDatePolicyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceBoardDueDatePolicyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceBoardDueDatePolicyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/attention-signal-policy": { "put": { "tags": [ "Boards Configuration" ], "summary": "Replace a board AttentionSignal projection and delivery policy.", "operationId": "admin-boards-administration-replace-attention-signal-policy", "parameters": [ { "name": "boardId", "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/ReplaceBoardAttentionSignalPolicyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceBoardAttentionSignalPolicyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceBoardAttentionSignalPolicyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/activate": { "post": { "tags": [ "Boards Configuration" ], "summary": "Activate a board for runtime process use.", "operationId": "admin-boards-administration-activate-board", "parameters": [ { "name": "boardId", "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/BoardLifecycleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardLifecycleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardLifecycleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/deactivate": { "post": { "tags": [ "Boards Configuration" ], "summary": "Deactivate a board without deleting configuration.", "operationId": "admin-boards-administration-deactivate-board", "parameters": [ { "name": "boardId", "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/BoardLifecycleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardLifecycleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoardLifecycleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/statements": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return Board Statements configured for one board.", "operationId": "admin-boards-administration-board-statements", "parameters": [ { "name": "boardId", "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/BoardStatementListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Boards Configuration" ], "summary": "Create a reusable Board Statement.", "operationId": "admin-boards-administration-create-board-statement", "parameters": [ { "name": "boardId", "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/CreateBoardStatementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardStatementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardStatementRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/statements/{boardStatementId}": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return one Board Statement.", "operationId": "admin-boards-administration-board-statement", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardStatementId", "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/BoardStatementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Boards Configuration" ], "summary": "Update a reusable Board Statement.", "operationId": "admin-boards-administration-update-board-statement", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardStatementId", "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/UpdateBoardStatementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardStatementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardStatementRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Configuration" ], "summary": "Delete an unreferenced Board Statement.", "operationId": "admin-boards-administration-delete-board-statement", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardStatementId", "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/DeleteBoardStatementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteBoardStatementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteBoardStatementRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/statements/authoring": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return the server-owned Board Statement DSL authoring schema.", "operationId": "admin-boards-administration-board-statement-authoring", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardTargetDefinitionId", "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/BoardStatementAuthoringResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementAuthoringResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/statements/validate": { "post": { "tags": [ "Boards Configuration" ], "summary": "Validate and bind a Board Statement expression without persisting it.", "operationId": "admin-boards-administration-validate-board-statement", "parameters": [ { "name": "boardId", "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/ValidateBoardStatementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateBoardStatementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateBoardStatementRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementValidationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementValidationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/statements/preview": { "post": { "tags": [ "Boards Configuration" ], "summary": "Evaluate a Board Statement against an explicit proposed context.", "operationId": "admin-boards-administration-preview-board-statement", "parameters": [ { "name": "boardId", "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/PreviewBoardStatementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviewBoardStatementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PreviewBoardStatementRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementPreviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementPreviewResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/statements/reorder": { "post": { "tags": [ "Boards Configuration" ], "summary": "Reorder Board Statements.", "operationId": "admin-boards-administration-reorder-board-statements", "parameters": [ { "name": "boardId", "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/ReorderBoardStatementsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderBoardStatementsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderBoardStatementsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatementListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/constraints": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return Board Constraints configured for one board.", "operationId": "admin-boards-administration-board-constraints", "parameters": [ { "name": "boardId", "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/BoardConstraintListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Boards Configuration" ], "summary": "Create a draft Board Constraint.", "operationId": "admin-boards-administration-create-board-constraint", "parameters": [ { "name": "boardId", "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/CreateBoardConstraintRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardConstraintRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardConstraintRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/constraints/{boardConstraintId}": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return one Board Constraint with activation health.", "operationId": "admin-boards-administration-board-constraint", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardConstraintId", "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/BoardConstraintResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Boards Configuration" ], "summary": "Update a Board Constraint.", "operationId": "admin-boards-administration-update-board-constraint", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardConstraintId", "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/UpdateBoardConstraintRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardConstraintRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardConstraintRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Configuration" ], "summary": "Delete a Board Constraint and its bindings.", "operationId": "admin-boards-administration-delete-board-constraint", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardConstraintId", "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/DeleteBoardConstraintRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteBoardConstraintRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteBoardConstraintRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/constraints/bindings/validate": { "post": { "tags": [ "Boards Configuration" ], "summary": "Validate a Board Constraint Binding without persisting it.", "operationId": "admin-boards-administration-validate-board-constraint-binding", "parameters": [ { "name": "boardId", "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/ValidateBoardConstraintBindingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateBoardConstraintBindingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateBoardConstraintBindingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintBindingHealthResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintBindingHealthResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/constraints/reorder": { "post": { "tags": [ "Boards Configuration" ], "summary": "Reorder Board Constraints.", "operationId": "admin-boards-administration-reorder-board-constraints", "parameters": [ { "name": "boardId", "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/ReorderBoardConstraintsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderBoardConstraintsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderBoardConstraintsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/constraints/{boardConstraintId}/bindings": { "post": { "tags": [ "Boards Configuration" ], "summary": "Create one draft Board Constraint Binding.", "operationId": "admin-boards-administration-create-board-constraint-binding", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardConstraintId", "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/CreateBoardConstraintBindingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardConstraintBindingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardConstraintBindingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/constraints/{boardConstraintId}/bindings/{boardConstraintBindingId}": { "put": { "tags": [ "Boards Configuration" ], "summary": "Update one Board Constraint Binding.", "operationId": "admin-boards-administration-update-board-constraint-binding", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardConstraintId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardConstraintBindingId", "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/UpdateBoardConstraintBindingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardConstraintBindingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardConstraintBindingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Configuration" ], "summary": "Delete one Board Constraint Binding.", "operationId": "admin-boards-administration-delete-board-constraint-binding", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardConstraintId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardConstraintBindingId", "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/DeleteBoardConstraintBindingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteBoardConstraintBindingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteBoardConstraintBindingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/constraints/{boardConstraintId}/bindings/reorder": { "post": { "tags": [ "Boards Configuration" ], "summary": "Reorder bindings inside one Board Constraint.", "operationId": "admin-boards-administration-reorder-board-constraint-bindings", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardConstraintId", "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/ReorderBoardConstraintBindingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderBoardConstraintBindingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderBoardConstraintBindingsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardConstraintResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/statuses": { "post": { "tags": [ "Boards Configuration" ], "summary": "Create a board status.", "operationId": "admin-boards-administration-create-status", "parameters": [ { "name": "boardId", "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/CreateBoardStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardStatusRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/statuses/{statusId}": { "put": { "tags": [ "Boards Configuration" ], "summary": "Update a board status.", "operationId": "admin-boards-administration-update-status", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statusId", "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/UpdateBoardStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardStatusRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/statuses/reorder": { "post": { "tags": [ "Boards Configuration" ], "summary": "Reorder board statuses.", "operationId": "admin-boards-administration-reorder-statuses", "parameters": [ { "name": "boardId", "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/ReorderBoardStatusesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderBoardStatusesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderBoardStatusesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/statuses/{statusId}/delete": { "post": { "tags": [ "Boards Configuration" ], "summary": "Delete a board status and optionally move current items to another status.", "operationId": "admin-boards-administration-delete-status", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statusId", "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/DeleteBoardStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteBoardStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteBoardStatusRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/transitions": { "post": { "tags": [ "Boards Configuration" ], "summary": "Create a board transition.", "operationId": "admin-boards-administration-create-transition", "parameters": [ { "name": "boardId", "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/CreateBoardTransitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardTransitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardTransitionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/transitions/{transitionId}": { "put": { "tags": [ "Boards Configuration" ], "summary": "Update a board transition.", "operationId": "admin-boards-administration-update-transition", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transitionId", "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/UpdateBoardTransitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardTransitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardTransitionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Configuration" ], "summary": "Delete or deactivate a board transition.", "operationId": "admin-boards-administration-delete-transition", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transitionId", "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/DeleteBoardTransitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteBoardTransitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteBoardTransitionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/transitions/reorder": { "post": { "tags": [ "Boards Configuration" ], "summary": "Reorder board transitions.", "operationId": "admin-boards-administration-reorder-transitions", "parameters": [ { "name": "boardId", "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/ReorderBoardTransitionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderBoardTransitionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderBoardTransitionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/target-definitions": { "post": { "tags": [ "Boards Configuration" ], "summary": "Create a canonical board target definition.", "operationId": "admin-boards-administration-create-target-definition", "parameters": [ { "name": "boardId", "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/CreateBoardTargetDefinitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBoardTargetDefinitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBoardTargetDefinitionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/target-definitions/{boardTargetDefinitionId}": { "put": { "tags": [ "Boards Configuration" ], "summary": "Update a canonical board target definition.", "operationId": "admin-boards-administration-update-target-definition", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardTargetDefinitionId", "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/UpdateBoardTargetDefinitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardTargetDefinitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBoardTargetDefinitionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Configuration" ], "summary": "Delete a canonical board target definition.", "operationId": "admin-boards-administration-delete-target-definition", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardTargetDefinitionId", "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/DeleteBoardTargetDefinitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteBoardTargetDefinitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteBoardTargetDefinitionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/target-definitions/{boardTargetDefinitionId}/card-fields/catalog": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return provider-declared card field catalog for a canonical board target definition.", "operationId": "admin-boards-administration-target-definition-card-field-catalog", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardTargetDefinitionId", "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/BoardTargetCardFieldCatalogListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetCardFieldCatalogListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/target-definitions/{boardTargetDefinitionId}/card-fields": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return configured card fields for a canonical board target definition.", "operationId": "admin-boards-administration-target-definition-card-fields", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardTargetDefinitionId", "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/BoardTargetDefinitionCardFieldsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetDefinitionCardFieldsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Boards Configuration" ], "summary": "Replace configured card fields for a canonical board target definition.", "operationId": "admin-boards-administration-replace-target-definition-card-fields", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardTargetDefinitionId", "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/ReplaceBoardTargetDefinitionCardFieldsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceBoardTargetDefinitionCardFieldsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceBoardTargetDefinitionCardFieldsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetDefinitionCardFieldsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetDefinitionCardFieldsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetDefinitionCardFieldsResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetDefinitionCardFieldsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/target-definitions/{boardTargetDefinitionId}/initial-field-mappings/catalog": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return compatible initial field mapping catalog for a canonical board target definition.", "operationId": "admin-boards-administration-target-definition-initial-field-mapping-catalog", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardTargetDefinitionId", "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/BoardTargetInitialFieldMappingCatalogResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetInitialFieldMappingCatalogResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/target-definitions/{boardTargetDefinitionId}/initial-field-mappings": { "get": { "tags": [ "Boards Configuration" ], "summary": "Return configured initial field mappings for a canonical board target definition.", "operationId": "admin-boards-administration-target-definition-initial-field-mappings", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardTargetDefinitionId", "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/BoardTargetDefinitionInitialFieldMappingsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetDefinitionInitialFieldMappingsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Boards Configuration" ], "summary": "Replace configured initial field mappings for a canonical board target definition.", "operationId": "admin-boards-administration-replace-target-definition-initial-field-mappings", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boardTargetDefinitionId", "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/ReplaceBoardTargetDefinitionInitialFieldMappingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceBoardTargetDefinitionInitialFieldMappingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceBoardTargetDefinitionInitialFieldMappingsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetDefinitionInitialFieldMappingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetDefinitionInitialFieldMappingsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetDefinitionInitialFieldMappingsResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTargetDefinitionInitialFieldMappingsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security": { "get": { "tags": [ "Boards Security" ], "summary": "Returns both Board Security profile groups with their shared row version.", "operationId": "admin-board-security-administration-get-configuration", "parameters": [ { "name": "boardId", "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": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSecurityConfigurationResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security/authoring-options": { "get": { "tags": [ "Boards Security" ], "summary": "Returns stable authoring options shared by both Board Security profiles.", "operationId": "admin-board-security-administration-get-authoring-options", "parameters": [ { "name": "boardId", "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": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAuthoringOptionsResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/permissions": { "get": { "tags": [ "Boards Security" ], "summary": "Returns the exact permission catalog for one Board resource kind.", "operationId": "admin-board-security-administration-get-permissions", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionCatalogResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/access-policies": { "get": { "tags": [ "Boards Security" ], "summary": "Returns Access Policies, capability groups, exact Permissions, and health for one Board profile.", "operationId": "admin-board-security-administration-get-access-policies", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAccessPolicyAdministrationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAccessPolicyAdministrationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAccessPolicyAdministrationResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/access-policies/plan": { "post": { "tags": [ "Boards Security" ], "summary": "Plans one atomic Board Access Policy change.", "operationId": "admin-board-security-administration-plan-access-policy", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/PlanSecurityAccessPolicyChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanSecurityAccessPolicyChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlanSecurityAccessPolicyChangeRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/access-policies/apply": { "post": { "tags": [ "Boards Security" ], "summary": "Applies one unchanged Board Access Policy plan atomically.", "operationId": "admin-board-security-administration-apply-access-policy", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/ApplySecurityAccessPolicyChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplySecurityAccessPolicyChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplySecurityAccessPolicyChangeRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/permission-bindings/plan": { "post": { "tags": [ "Boards Security" ], "summary": "Plans an atomic partial replacement of exact Board Permission bindings.", "operationId": "admin-board-security-administration-plan-permission-bindings", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/PlanSecurityPermissionBindingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanSecurityPermissionBindingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlanSecurityPermissionBindingsRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/permission-bindings/apply": { "post": { "tags": [ "Boards Security" ], "summary": "Applies one unchanged exact Board Permission binding plan atomically.", "operationId": "admin-board-security-administration-apply-permission-bindings", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/ApplySecurityPermissionBindingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplySecurityPermissionBindingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplySecurityPermissionBindingsRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/normalization/plan": { "post": { "tags": [ "Boards Security" ], "summary": "Plans explicit removal of structurally redundant Board Data field refinements.", "operationId": "admin-board-security-administration-plan-field-normalization", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/PlanSecurityFieldNormalizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanSecurityFieldNormalizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlanSecurityFieldNormalizationRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/normalization/apply": { "post": { "tags": [ "Boards Security" ], "summary": "Applies one unchanged redundant Board Data field normalization plan atomically.", "operationId": "admin-board-security-administration-apply-field-normalization", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/ApplySecurityFieldNormalizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplySecurityFieldNormalizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplySecurityFieldNormalizationRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/statements": { "post": { "tags": [ "Boards Security" ], "summary": "Creates one immediately effective Security Statement.", "operationId": "admin-board-security-administration-create-statement", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/EntitySecurityStatementWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementWriteRequest" } } } }, "responses": { "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/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/statements/{statementKey}": { "put": { "tags": [ "Boards Security" ], "summary": "Updates one immediately effective Security Statement.", "operationId": "admin-board-security-administration-update-statement", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statementKey", "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/EntitySecurityStatementWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementWriteRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Security" ], "summary": "Deletes one unused Security Statement.", "operationId": "admin-board-security-administration-delete-statement", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statementKey", "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/EntitySecurityArtifactDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } } } }, "responses": { "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/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/permission-assignments": { "post": { "tags": [ "Boards Security" ], "summary": "Creates one Permission Assignment.", "operationId": "admin-board-security-administration-create-permission-assignment", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/EntitySecurityPermissionAssignmentWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignmentWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignmentWriteRequest" } } } }, "responses": { "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/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/permission-assignments/{assignmentKey}": { "delete": { "tags": [ "Boards Security" ], "summary": "Deletes one Permission Assignment.", "operationId": "admin-board-security-administration-delete-permission-assignment", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assignmentKey", "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/EntitySecurityArtifactDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } } } }, "responses": { "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/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/responsibilities": { "post": { "tags": [ "Boards Security" ], "summary": "Creates one named Responsibility Definition.", "operationId": "admin-board-security-administration-create-responsibility", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/EntitySecurityResponsibilityWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityWriteRequest" } } } }, "responses": { "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/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/responsibilities/{responsibilityKey}": { "put": { "tags": [ "Boards Security" ], "summary": "Updates one named Responsibility Definition.", "operationId": "admin-board-security-administration-update-responsibility", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/EntitySecurityResponsibilityWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityWriteRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Security" ], "summary": "Deletes one unused named Responsibility Definition.", "operationId": "admin-board-security-administration-delete-responsibility", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/EntitySecurityArtifactDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } } } }, "responses": { "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/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/initial-assignment-rules": { "post": { "tags": [ "Boards Security" ], "summary": "Creates one initial responsibility assignment rule.", "operationId": "admin-board-security-administration-create-initial-rule", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/EntitySecurityInitialAssignmentRuleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleWriteRequest" } } } }, "responses": { "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/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/initial-assignment-rules/{ruleKey}": { "put": { "tags": [ "Boards Security" ], "summary": "Updates one initial responsibility assignment rule.", "operationId": "admin-board-security-administration-update-initial-rule", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleKey", "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/EntitySecurityInitialAssignmentRuleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleWriteRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Security" ], "summary": "Deletes one initial responsibility assignment rule.", "operationId": "admin-board-security-administration-delete-initial-rule", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleKey", "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/EntitySecurityArtifactDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } } } }, "responses": { "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/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/assignment-rules": { "post": { "tags": [ "Boards Security" ], "summary": "Creates one responsibility assignment rule.", "operationId": "admin-board-security-administration-create-assignment-rule", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/EntitySecurityAssignmentRuleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleWriteRequest" } } } }, "responses": { "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/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/assignment-rules/apply": { "post": { "tags": [ "Boards Security" ], "summary": "Atomically creates or replaces one Assignment Rule per selected assignment actor.", "operationId": "admin-board-security-administration-apply-assignment-rule-set", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "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/EntitySecurityAssignmentRuleSetWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleSetWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleSetWriteRequest" } } } }, "responses": { "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/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/assignment-rules/{ruleKey}": { "put": { "tags": [ "Boards Security" ], "summary": "Updates one responsibility assignment rule.", "operationId": "admin-board-security-administration-update-assignment-rule", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleKey", "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/EntitySecurityAssignmentRuleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleWriteRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Boards Security" ], "summary": "Deletes one responsibility assignment rule.", "operationId": "admin-board-security-administration-delete-assignment-rule", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceKind", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleKey", "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/EntitySecurityArtifactDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } } } }, "responses": { "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/admin/entitlement-operations": { "get": { "tags": [ "Entitlement Operations" ], "summary": "Return current module configuration summary and entitlement models.", "operationId": "admin-entitlement-operations-get", "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/EntitlementOperationsDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/permissions": { "get": { "tags": [ "Entitlement Operations" ], "summary": "Return role assignments for Entitlement Operations global module permissions.", "operationId": "admin-entitlement-operations-permissions", "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/ScopedRolePermissionsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations" ], "summary": "Replace role assignments for Entitlement Operations global module permissions.", "operationId": "admin-entitlement-operations-update-permissions", "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/ReplaceScopedRolePermissionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceScopedRolePermissionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceScopedRolePermissionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopedRolePermissionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopedRolePermissionsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/setup": { "get": { "tags": [ "Entitlement Operations" ], "summary": "Return model editor bootstrap data.", "operationId": "admin-entitlement-operations-setup", "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/EntitlementOperationsSetupResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/setup/relationship-paths": { "get": { "tags": [ "Entitlement Operations" ], "summary": "Return selectable relationship paths for one root record type.", "operationId": "admin-entitlement-operations-relationship-paths", "parameters": [ { "name": "rootEntityDefinitionId", "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/EntitlementOperationsRelationshipPathListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsRelationshipPathListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/setup-plan": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Validate setup input without writing changes.", "operationId": "admin-entitlement-operations-setup-plan", "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/EntitlementOperationsSetupPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsSetupPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsSetupPlanRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsSetupPlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsSetupPlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/enable": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Enable the module lifecycle without creating an entitlement model.", "operationId": "admin-entitlement-operations-enable", "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/EnableEntitlementOperationsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnableEntitlementOperationsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EnableEntitlementOperationsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/software-license": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Create a software license entitlement model.", "operationId": "admin-entitlement-operations-create-software-license-model", "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/SoftwareLicenseEntitlementModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementModelRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/membership": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Create a membership entitlement model.", "operationId": "admin-entitlement-operations-create-membership-model", "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/MembershipEntitlementModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementModelRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/information-service-access": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Create an information service access entitlement model.", "operationId": "admin-entitlement-operations-create-information-service-access-model", "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/InformationServiceAccessEntitlementModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementModelRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/warranty": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Create a warranty entitlement model.", "operationId": "admin-entitlement-operations-create-warranty-model", "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/WarrantyEntitlementModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementModelRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/software-license/{modelId}": { "get": { "tags": [ "Entitlement Operations" ], "summary": "Return one software license entitlement model.", "operationId": "admin-entitlement-operations-get-software-license-model", "parameters": [ { "name": "modelId", "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/SoftwareLicenseEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations" ], "summary": "Update a software license entitlement model.", "operationId": "admin-entitlement-operations-update-software-license-model", "parameters": [ { "name": "modelId", "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/SoftwareLicenseEntitlementModelUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementModelUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementModelUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entitlement Operations" ], "summary": "Delete a software license entitlement model.", "operationId": "admin-entitlement-operations-delete-software-license-model", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rowVersion", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "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" } } } }, "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/admin/entitlement-operations/models/membership/{modelId}": { "get": { "tags": [ "Entitlement Operations" ], "summary": "Return one membership entitlement model.", "operationId": "admin-entitlement-operations-get-membership-model", "parameters": [ { "name": "modelId", "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/MembershipEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations" ], "summary": "Update a membership entitlement model.", "operationId": "admin-entitlement-operations-update-membership-model", "parameters": [ { "name": "modelId", "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/MembershipEntitlementModelUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementModelUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementModelUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entitlement Operations" ], "summary": "Delete a membership entitlement model.", "operationId": "admin-entitlement-operations-delete-membership-model", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rowVersion", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "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" } } } }, "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/admin/entitlement-operations/models/information-service-access/{modelId}": { "get": { "tags": [ "Entitlement Operations" ], "summary": "Return one information service access entitlement model.", "operationId": "admin-entitlement-operations-get-information-service-access-model", "parameters": [ { "name": "modelId", "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/InformationServiceAccessEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations" ], "summary": "Update an information service access entitlement model.", "operationId": "admin-entitlement-operations-update-information-service-access-model", "parameters": [ { "name": "modelId", "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/InformationServiceAccessEntitlementModelUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementModelUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementModelUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entitlement Operations" ], "summary": "Delete an information service access entitlement model.", "operationId": "admin-entitlement-operations-delete-information-service-access-model", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rowVersion", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "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" } } } }, "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/admin/entitlement-operations/models/warranty/{modelId}": { "get": { "tags": [ "Entitlement Operations" ], "summary": "Return one warranty entitlement model.", "operationId": "admin-entitlement-operations-get-warranty-model", "parameters": [ { "name": "modelId", "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/WarrantyEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations" ], "summary": "Update a warranty entitlement model.", "operationId": "admin-entitlement-operations-update-warranty-model", "parameters": [ { "name": "modelId", "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/WarrantyEntitlementModelUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementModelUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementModelUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entitlement Operations" ], "summary": "Delete a warranty entitlement model.", "operationId": "admin-entitlement-operations-delete-warranty-model", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rowVersion", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "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" } } } }, "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/admin/entitlement-operations/models/{modelId}/security": { "get": { "tags": [ "Entitlement Operations" ], "summary": "Return model-bound security grants for one entitlement model.", "operationId": "admin-entitlement-operations-get-model-security", "parameters": [ { "name": "modelId", "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/EntitlementOperationsModelSecurityResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsModelSecurityResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations" ], "summary": "Replace model-bound security grants for one entitlement model.", "operationId": "admin-entitlement-operations-update-model-security", "parameters": [ { "name": "modelId", "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/UpdateEntitlementOperationsModelSecurityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntitlementOperationsModelSecurityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntitlementOperationsModelSecurityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsModelSecurityResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsModelSecurityResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsModelSecurityResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/software-license/{modelId}/deactivate": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Deactivate a software license entitlement model without deleting it.", "operationId": "admin-entitlement-operations-deactivate-software-license-model", "parameters": [ { "name": "modelId", "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/DeactivateEntitlementOperationsModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementOperationsModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementOperationsModelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/membership/{modelId}/deactivate": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Deactivate a membership entitlement model without deleting it.", "operationId": "admin-entitlement-operations-deactivate-membership-model", "parameters": [ { "name": "modelId", "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/DeactivateEntitlementOperationsModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementOperationsModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementOperationsModelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/information-service-access/{modelId}/deactivate": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Deactivate an information service access entitlement model without deleting it.", "operationId": "admin-entitlement-operations-deactivate-information-service-access-model", "parameters": [ { "name": "modelId", "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/DeactivateEntitlementOperationsModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementOperationsModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementOperationsModelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/warranty/{modelId}/deactivate": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Deactivate a warranty entitlement model without deleting it.", "operationId": "admin-entitlement-operations-deactivate-warranty-model", "parameters": [ { "name": "modelId", "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/DeactivateEntitlementOperationsModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementOperationsModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementOperationsModelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/software-license/{modelId}/reactivate": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Reactivate a software license entitlement model without changing its shape.", "operationId": "admin-entitlement-operations-reactivate-software-license-model", "parameters": [ { "name": "modelId", "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/ReactivateEntitlementOperationsModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReactivateEntitlementOperationsModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReactivateEntitlementOperationsModelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicenseEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/membership/{modelId}/reactivate": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Reactivate a membership entitlement model without changing its shape.", "operationId": "admin-entitlement-operations-reactivate-membership-model", "parameters": [ { "name": "modelId", "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/ReactivateEntitlementOperationsModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReactivateEntitlementOperationsModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReactivateEntitlementOperationsModelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/information-service-access/{modelId}/reactivate": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Reactivate an information service access entitlement model without changing its shape.", "operationId": "admin-entitlement-operations-reactivate-information-service-access-model", "parameters": [ { "name": "modelId", "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/ReactivateEntitlementOperationsModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReactivateEntitlementOperationsModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReactivateEntitlementOperationsModelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/models/warranty/{modelId}/reactivate": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Reactivate a warranty entitlement model without changing its shape.", "operationId": "admin-entitlement-operations-reactivate-warranty-model", "parameters": [ { "name": "modelId", "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/ReactivateEntitlementOperationsModelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReactivateEntitlementOperationsModelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReactivateEntitlementOperationsModelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyEntitlementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entitlement-operations/disable": { "post": { "tags": [ "Entitlement Operations" ], "summary": "Disable the module while preserving its entitlement models.", "operationId": "admin-entitlement-operations-disable", "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/DisableEntitlementOperationsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DisableEntitlementOperationsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DisableEntitlementOperationsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementOperationsDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return active entitlement models available to runtime plan pages.", "operationId": "entitlement-operations-plans-list-models", "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/EntitlementOperationsRuntimeModelListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/{modelType}/{modelId}/plan-families": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return plan families owned by the selected entitlement model.", "operationId": "entitlement-operations-plans-list-plan-families", "parameters": [ { "name": "modelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "IncludeInactive", "in": "query", "description": "Whether inactive families should be included.", "schema": { "type": "boolean" } }, { "name": "Search", "in": "query", "description": "Optional search text matched against family key and display name.", "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/EntitlementPlanFamilyListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entitlement Operations Plans" ], "summary": "Create one plan family.", "operationId": "entitlement-operations-plans-create-plan-family", "parameters": [ { "name": "modelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelId", "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/EntitlementPlanFamilyCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/{modelType}/{modelId}/plan-families/{planFamilyId}": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return one plan family.", "operationId": "entitlement-operations-plans-get-plan-family", "parameters": [ { "name": "modelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planFamilyId", "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/EntitlementPlanFamilyDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations Plans" ], "summary": "Update one plan family.", "operationId": "entitlement-operations-plans-update-plan-family", "parameters": [ { "name": "modelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planFamilyId", "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/EntitlementPlanFamilyUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entitlement Operations Plans" ], "summary": "Delete one unused plan family.", "operationId": "entitlement-operations-plans-delete-plan-family", "parameters": [ { "name": "modelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planFamilyId", "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/EntitlementPlanFamilyDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanFamilyDeleteRequest" } } }, "required": true }, "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/entitlement-operations/models/software-license/{modelId}/plans/bootstrap": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return software license plan editor bootstrap metadata.", "operationId": "entitlement-operations-plans-software-license-bootstrap", "parameters": [ { "name": "modelId", "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/EntitlementPlanBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/software-license/{modelId}/plans": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return software license plans owned by the selected entitlement model.", "operationId": "entitlement-operations-plans-list-software-license-plans", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Search", "in": "query", "description": "Optional search text matched against plan key and display name.", "schema": { "type": "string" } }, { "name": "IncludeInactive", "in": "query", "description": "Whether inactive plans should be included.", "schema": { "type": "boolean" } }, { "name": "PlanFamilyIds", "in": "query", "description": "Optional model-scoped plan family ids that at least one assigned family must match.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ConditionFamily", "in": "query", "description": "Optional active plan condition family filter.", "schema": { "$ref": "#/components/schemas/EntitlementLimitFamily" } }, { "name": "TermKind", "in": "query", "description": "Optional derived active plan term shape filter.", "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 id currently assigned to the plan.", "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/SoftwareLicensePlanListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entitlement Operations Plans" ], "summary": "Create a software license plan.", "operationId": "entitlement-operations-plans-create-software-license-plan", "parameters": [ { "name": "modelId", "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/SoftwareLicensePlanCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/software-license/{modelId}/plans/{planId}": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return one software license plan.", "operationId": "entitlement-operations-plans-get-software-license-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/SoftwareLicensePlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations Plans" ], "summary": "Update a software license plan.", "operationId": "entitlement-operations-plans-update-software-license-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/SoftwareLicensePlanUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entitlement Operations Plans" ], "summary": "Delete an unused software license plan.", "operationId": "entitlement-operations-plans-delete-software-license-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/DeleteEntitlementPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteEntitlementPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteEntitlementPlanRequest" } } }, "required": true }, "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/entitlement-operations/models/software-license/{modelId}/plans/{planId}/resource-tree": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return the full resource hierarchy available to a software license plan.", "operationId": "entitlement-operations-plans-software-license-resource-tree", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/EntitlementPlanResourceTreeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanResourceTreeResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/software-license/{modelId}/plans/order": { "put": { "tags": [ "Entitlement Operations Plans" ], "summary": "Persist explicit software license plan ordering.", "operationId": "entitlement-operations-plans-reorder-software-license-plans", "parameters": [ { "name": "modelId", "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/ReorderEntitlementPlansRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderEntitlementPlansRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderEntitlementPlansRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareLicensePlanListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/membership/{modelId}/plans/bootstrap": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return membership plan editor bootstrap metadata.", "operationId": "entitlement-operations-plans-membership-bootstrap", "parameters": [ { "name": "modelId", "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/EntitlementPlanBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/membership/{modelId}/plans": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return membership plans owned by the selected entitlement model.", "operationId": "entitlement-operations-plans-list-membership-plans", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Search", "in": "query", "description": "Optional search text matched against plan key and display name.", "schema": { "type": "string" } }, { "name": "IncludeInactive", "in": "query", "description": "Whether inactive plans should be included.", "schema": { "type": "boolean" } }, { "name": "PlanFamilyIds", "in": "query", "description": "Optional model-scoped plan family ids that at least one assigned family must match.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ConditionFamily", "in": "query", "description": "Optional active plan condition family filter.", "schema": { "$ref": "#/components/schemas/EntitlementLimitFamily" } }, { "name": "TermKind", "in": "query", "description": "Optional derived active plan term shape filter.", "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 id currently assigned to the plan.", "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/MembershipPlanListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entitlement Operations Plans" ], "summary": "Create a membership plan.", "operationId": "entitlement-operations-plans-create-membership-plan", "parameters": [ { "name": "modelId", "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/MembershipPlanCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MembershipPlanCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/membership/{modelId}/plans/{planId}": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return one membership plan.", "operationId": "entitlement-operations-plans-get-membership-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/MembershipPlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations Plans" ], "summary": "Update a membership plan.", "operationId": "entitlement-operations-plans-update-membership-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/MembershipPlanUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MembershipPlanUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entitlement Operations Plans" ], "summary": "Delete an unused membership plan.", "operationId": "entitlement-operations-plans-delete-membership-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/DeleteEntitlementPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteEntitlementPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteEntitlementPlanRequest" } } }, "required": true }, "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/entitlement-operations/models/membership/{modelId}/plans/{planId}/resource-tree": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return the full resource hierarchy available to a membership plan.", "operationId": "entitlement-operations-plans-membership-resource-tree", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/EntitlementPlanResourceTreeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanResourceTreeResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/membership/{modelId}/plans/order": { "put": { "tags": [ "Entitlement Operations Plans" ], "summary": "Persist explicit membership plan ordering.", "operationId": "entitlement-operations-plans-reorder-membership-plans", "parameters": [ { "name": "modelId", "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/ReorderEntitlementPlansRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderEntitlementPlansRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderEntitlementPlansRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPlanListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/information-service-access/{modelId}/plans/bootstrap": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return information service access plan editor bootstrap metadata.", "operationId": "entitlement-operations-plans-information-service-access-bootstrap", "parameters": [ { "name": "modelId", "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/EntitlementPlanBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/information-service-access/{modelId}/plans": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return information service access plans owned by the selected entitlement model.", "operationId": "entitlement-operations-plans-list-information-service-access-plans", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Search", "in": "query", "description": "Optional search text matched against plan key and display name.", "schema": { "type": "string" } }, { "name": "IncludeInactive", "in": "query", "description": "Whether inactive plans should be included.", "schema": { "type": "boolean" } }, { "name": "PlanFamilyIds", "in": "query", "description": "Optional model-scoped plan family ids that at least one assigned family must match.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ConditionFamily", "in": "query", "description": "Optional active plan condition family filter.", "schema": { "$ref": "#/components/schemas/EntitlementLimitFamily" } }, { "name": "TermKind", "in": "query", "description": "Optional derived active plan term shape filter.", "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 id currently assigned to the plan.", "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/InformationServiceAccessPlanListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entitlement Operations Plans" ], "summary": "Create an information service access plan.", "operationId": "entitlement-operations-plans-create-information-service-access-plan", "parameters": [ { "name": "modelId", "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/InformationServiceAccessPlanCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/information-service-access/{modelId}/plans/{planId}": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return one information service access plan.", "operationId": "entitlement-operations-plans-get-information-service-access-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/InformationServiceAccessPlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations Plans" ], "summary": "Update an information service access plan.", "operationId": "entitlement-operations-plans-update-information-service-access-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/InformationServiceAccessPlanUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entitlement Operations Plans" ], "summary": "Delete an unused information service access plan.", "operationId": "entitlement-operations-plans-delete-information-service-access-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/DeleteEntitlementPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteEntitlementPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteEntitlementPlanRequest" } } }, "required": true }, "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/entitlement-operations/models/information-service-access/{modelId}/plans/{planId}/resource-tree": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return the full resource hierarchy available to an information service access plan.", "operationId": "entitlement-operations-plans-information-service-access-resource-tree", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/EntitlementPlanResourceTreeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanResourceTreeResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/information-service-access/{modelId}/plans/order": { "put": { "tags": [ "Entitlement Operations Plans" ], "summary": "Persist explicit information service access plan ordering.", "operationId": "entitlement-operations-plans-reorder-information-service-access-plans", "parameters": [ { "name": "modelId", "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/ReorderEntitlementPlansRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderEntitlementPlansRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderEntitlementPlansRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationServiceAccessPlanListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/warranty/{modelId}/plans/bootstrap": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return warranty plan editor bootstrap metadata.", "operationId": "entitlement-operations-plans-warranty-bootstrap", "parameters": [ { "name": "modelId", "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/EntitlementPlanBootstrapResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementPlanBootstrapResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/warranty/{modelId}/plans": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return warranty plans owned by the selected entitlement model.", "operationId": "entitlement-operations-plans-list-warranty-plans", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Search", "in": "query", "description": "Optional search text matched against plan key and display name.", "schema": { "type": "string" } }, { "name": "IncludeInactive", "in": "query", "description": "Whether inactive plans should be included.", "schema": { "type": "boolean" } }, { "name": "PlanFamilyIds", "in": "query", "description": "Optional model-scoped plan family ids that at least one assigned family must match.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ConditionFamily", "in": "query", "description": "Optional active plan condition family filter.", "schema": { "$ref": "#/components/schemas/EntitlementLimitFamily" } }, { "name": "TermKind", "in": "query", "description": "Optional derived active plan term shape filter.", "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 id currently assigned to the plan.", "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/WarrantyPlanListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entitlement Operations Plans" ], "summary": "Create a warranty plan.", "operationId": "entitlement-operations-plans-create-warranty-plan", "parameters": [ { "name": "modelId", "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/WarrantyPlanCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/warranty/{modelId}/plans/{planId}": { "get": { "tags": [ "Entitlement Operations Plans" ], "summary": "Return one warranty plan.", "operationId": "entitlement-operations-plans-get-warranty-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/WarrantyPlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations Plans" ], "summary": "Update a warranty plan.", "operationId": "entitlement-operations-plans-update-warranty-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/WarrantyPlanUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entitlement Operations Plans" ], "summary": "Delete an unused warranty plan.", "operationId": "entitlement-operations-plans-delete-warranty-plan", "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "planId", "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/DeleteEntitlementPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteEntitlementPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteEntitlementPlanRequest" } } }, "required": true }, "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/entitlement-operations/models/warranty/{modelId}/plans/order": { "put": { "tags": [ "Entitlement Operations Plans" ], "summary": "Persist explicit warranty plan ordering.", "operationId": "entitlement-operations-plans-reorder-warranty-plans", "parameters": [ { "name": "modelId", "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/ReorderEntitlementPlansRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderEntitlementPlansRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderEntitlementPlansRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarrantyPlanListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/{modelType}/{modelId}/renewal-policies": { "get": { "tags": [ "Entitlement Operations Renewal" ], "summary": "Return renewal policies owned by one entitlement model.", "operationId": "entitlement-operations-renewal-list-policies", "parameters": [ { "name": "modelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "IncludeInactive", "in": "query", "description": "Whether inactive policies should be included.", "schema": { "type": "boolean" } }, { "name": "Search", "in": "query", "description": "Optional search text matched against policy key and display name.", "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/EntitlementRenewalPolicyListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entitlement Operations Renewal" ], "summary": "Create one renewal policy.", "operationId": "entitlement-operations-renewal-create-policy", "parameters": [ { "name": "modelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelId", "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/EntitlementRenewalPolicyCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/entitlement-operations/models/{modelType}/{modelId}/renewal-policies/{renewalPolicyId}": { "get": { "tags": [ "Entitlement Operations Renewal" ], "summary": "Return one renewal policy.", "operationId": "entitlement-operations-renewal-get-policy", "parameters": [ { "name": "modelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "renewalPolicyId", "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/EntitlementRenewalPolicyDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entitlement Operations Renewal" ], "summary": "Update one renewal policy.", "operationId": "entitlement-operations-renewal-update-policy", "parameters": [ { "name": "modelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "renewalPolicyId", "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/EntitlementRenewalPolicyUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entitlement Operations Renewal" ], "summary": "Delete one unused renewal policy.", "operationId": "entitlement-operations-renewal-delete-policy", "parameters": [ { "name": "modelType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "renewalPolicyId", "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/EntitlementRenewalPolicyDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDeleteRequest" } } }, "required": true }, "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/admin/entity-definitions/{entityDefinitionId}/data-transfer-profiles": { "get": { "tags": [ "Entity Data Transfer Profiles" ], "summary": "List data transfer profiles for one entity definition.", "operationId": "admin-entity-data-transfer-profiles-list", "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/EntityDataTransferProfileSummaryListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entity Data Transfer Profiles" ], "summary": "Create one data transfer profile for an entity definition.", "operationId": "admin-entity-data-transfer-profiles-create", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityDataTransferProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityDataTransferProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityDataTransferProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-data-transfer-profiles/{profileId}": { "get": { "tags": [ "Entity Data Transfer Profiles" ], "summary": "Return one data transfer profile.", "operationId": "admin-entity-data-transfer-profiles-get", "parameters": [ { "name": "profileId", "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/EntityDataTransferProfileDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Data Transfer Profiles" ], "summary": "Soft-delete one data transfer profile.", "operationId": "admin-entity-data-transfer-profiles-delete", "parameters": [ { "name": "profileId", "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/DeleteEntityDataTransferProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteEntityDataTransferProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteEntityDataTransferProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "400": { "description": "Bad Request", "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/admin/entity-definitions/{entityDefinitionId}/data-transfer-profiles/json-export": { "post": { "tags": [ "Entity Data Transfer Profiles" ], "summary": "Create one JSON export profile for the Sprint 2 export editor.", "operationId": "admin-entity-data-transfer-profiles-create-json-export", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityJsonExportProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityJsonExportProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityJsonExportProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-data-transfer-profiles/{profileId}/base": { "put": { "tags": [ "Entity Data Transfer Profiles" ], "summary": "Update base metadata for one data transfer profile.", "operationId": "admin-entity-data-transfer-profiles-update-base", "parameters": [ { "name": "profileId", "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/UpdateEntityDataTransferProfileBaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDataTransferProfileBaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDataTransferProfileBaseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-data-transfer-profiles/{profileId}/json-export": { "put": { "tags": [ "Entity Data Transfer Profiles" ], "summary": "Update one JSON export profile slice for the Sprint 2 export editor.", "operationId": "admin-entity-data-transfer-profiles-update-json-export", "parameters": [ { "name": "profileId", "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/UpdateEntityJsonExportProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityJsonExportProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityJsonExportProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-data-transfer-profiles/{profileId}/fields": { "put": { "tags": [ "Entity Data Transfer Profiles" ], "summary": "Replace all configured profile fields.", "operationId": "admin-entity-data-transfer-profiles-update-fields", "parameters": [ { "name": "profileId", "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/UpdateEntityDataTransferProfileFieldsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDataTransferProfileFieldsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDataTransferProfileFieldsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-data-transfer-profiles/{profileId}/reference-resolvers": { "put": { "tags": [ "Entity Data Transfer Profiles" ], "summary": "Replace all configured profile reference resolvers.", "operationId": "admin-entity-data-transfer-profiles-update-reference-resolvers", "parameters": [ { "name": "profileId", "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/UpdateEntityDataTransferProfileReferenceResolversRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDataTransferProfileReferenceResolversRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDataTransferProfileReferenceResolversRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDataTransferProfileDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/export": { "get": { "tags": [ "Entity Definition Portability" ], "summary": "Export an entity definition as a YAML document.", "operationId": "admin-entity-definition-portability-export", "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": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/import/plan": { "post": { "tags": [ "Entity Definition Portability" ], "summary": "Generate an import plan from a YAML document.", "operationId": "admin-entity-definition-portability-generate-import-plan", "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/GenerateImportPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenerateImportPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateImportPlanRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionImportPlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/import/apply": { "post": { "tags": [ "Entity Definition Portability" ], "summary": "Apply an approved import plan.", "operationId": "admin-entity-definition-portability-apply-import-plan", "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/ApplyImportPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplyImportPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplyImportPlanRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions": { "get": { "tags": [ "Entity Definitions" ], "summary": "List configured entity definitions.", "operationId": "admin-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": [ { } ] }, "post": { "tags": [ "Entity Definitions" ], "summary": "Create a new entity definition and its physical tables.", "description": "The response includes the created tables; use the primary table id to add fields.\r\nConcepts: [entity definitions](https://moltaro.com/docs/user/data-structure/entity-definitions/).", "operationId": "admin-entity-definitions-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/CreateEntityDefinitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityDefinitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityDefinitionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}": { "get": { "tags": [ "Entity Definitions" ], "summary": "Return one entity definition with its business schema and current Security configuration references.", "operationId": "admin-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": [ { } ] }, "delete": { "tags": [ "Entity Definitions" ], "summary": "Delete one entity definition immediately or schedule deferred deletion.", "description": "Preview the impact first with the delete schema-change-plan endpoint; destructive deletes\r\nrequire the confirmation token it returns.", "operationId": "admin-entity-definitions-delete", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "schemaChangeConfirmationToken", "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/EntityDefinitionDeleteResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDeleteResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDeleteResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/dictionaries": { "post": { "tags": [ "Entity Definitions" ], "summary": "Create a new data entity definition configured as a simple dictionary.", "operationId": "admin-entity-definitions-create-dictionary", "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/CreateDictionaryEntityDefinitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDictionaryEntityDefinitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDictionaryEntityDefinitionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/associations": { "post": { "tags": [ "Entity Definitions" ], "summary": "Create a new association entity definition with locked endpoint and inverse fields.", "operationId": "admin-entity-definitions-create-association", "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/CreateAssociationEntityDefinitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAssociationEntityDefinitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAssociationEntityDefinitionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/base": { "put": { "tags": [ "Entity Definitions" ], "summary": "Update core entity definition naming metadata.", "operationId": "admin-entity-definitions-update-base", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionBaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionBaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionBaseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/base/schema-change-plan": { "post": { "tags": [ "Entity Definitions" ], "summary": "Plan a base entity definition update and return schema-impacting warnings.", "description": "Call this with the intended update payload first; when the plan requires confirmation,\r\nrepeat the update with the returned confirmation token.", "operationId": "admin-entity-definitions-plan-update-base-schema-change", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionBaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionBaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionBaseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/features": { "put": { "tags": [ "Entity Definitions" ], "summary": "Update entity feature toggles.", "operationId": "admin-entity-definitions-update-features", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionFeaturesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionFeaturesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionFeaturesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/search-targets": { "put": { "tags": [ "Entity Definitions" ], "summary": "Replace the configured PostgreSQL search paths for an entity definition.", "operationId": "admin-entity-definitions-update-search-targets", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionSearchTargetsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionSearchTargetsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionSearchTargetsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/audit-settings": { "put": { "tags": [ "Entity Definitions" ], "summary": "Update audit trail settings for an entity definition.", "operationId": "admin-entity-definitions-update-audit-settings", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionAuditSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionAuditSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionAuditSettingsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/display-settings": { "put": { "tags": [ "Entity Definitions" ], "summary": "Update numbering and display settings for an entity definition.", "operationId": "admin-entity-definitions-update-display-settings", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionDisplaySettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionDisplaySettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionDisplaySettingsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/display-fields": { "put": { "tags": [ "Entity Definitions" ], "summary": "Replace read-time display fields for an entity definition.", "operationId": "admin-entity-definitions-update-display-fields", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionDisplayFieldsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionDisplayFieldsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionDisplayFieldsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/object-context-facts": { "put": { "tags": [ "Entity Definitions" ], "summary": "Replace object-context facts for an entity definition.", "operationId": "admin-entity-definitions-update-object-context-facts", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionObjectContextFactsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionObjectContextFactsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityDefinitionObjectContextFactsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/projection": { "get": { "tags": [ "Entity Definitions" ], "summary": "Return projection-entity configuration for one entity definition.", "description": "Concepts, member field rules, and mapping semantics:\r\n[projection](https://moltaro.com/docs/user/data-structure/entity-definitions/projection/).", "operationId": "admin-entity-definitions-get-projection", "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/EntityProjectionDefinitionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityProjectionDefinitionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity Definitions" ], "summary": "Replace projection-entity configuration for one entity definition.", "description": "Replaces the full member and mapping configuration in one call. Requires at least two\r\nsingle-value reference members; enabling runs a preflight scan over existing rows. Concepts:\r\n[projection](https://moltaro.com/docs/user/data-structure/entity-definitions/projection/).", "operationId": "admin-entity-definitions-update-projection", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityProjectionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityProjectionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityProjectionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/projection/synchronization": { "get": { "tags": [ "Entity Definitions" ], "summary": "Return live row consistency counters for one enabled projection entity definition.", "description": "Reports missing, stale, and duplicated projection rows against the source entities. The caller\r\nmust have unconditional View and ReadArchive access to the projection and every enabled source.\r\nUse the rebuild operation to reconcile.", "operationId": "admin-entity-definitions-get-projection-synchronization", "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/EntityProjectionSynchronizationStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityProjectionSynchronizationStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityProjectionSynchronizationStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/projection/rebuild": { "post": { "tags": [ "Entity Definitions" ], "summary": "Rebuild materialized projection rows for one enabled projection entity definition.", "description": "Reconciles projection rows with the source entities: creates missing rows, refreshes stale\r\nvalues, and removes duplicates. The caller must retain definition-management authority,\r\nunconditional View and ReadArchive over every row, plus the exact projection Create, Update,\r\nDelete, CreateWrite, and Write permissions required by each batch. Safe to run repeatedly.", "operationId": "admin-entity-definitions-rebuild-projection", "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/EntityProjectionRebuildResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityProjectionRebuildResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityProjectionRebuildResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/rule-expressions/validate": { "post": { "tags": [ "Entity Definitions" ], "summary": "Validate one rule or template expression before saving metadata.", "description": "Checks field behavior, presentation, and statement expressions without saving anything and\r\nreturns structured errors with token positions. Expression syntax:\r\n[expression language reference](https://moltaro.com/docs/dsl/).", "operationId": "admin-entity-definitions-validate-rule-expression", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateEntityRuleExpressionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateEntityRuleExpressionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateEntityRuleExpressionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRuleExpressionValidationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRuleExpressionValidationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRuleExpressionValidationResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/calculated-field-recalculation-jobs": { "get": { "tags": [ "Entity Definitions" ], "summary": "Return recent calculated-field recalculation jobs for an entity definition.", "operationId": "admin-entity-definitions-list-calculated-field-recalculation-jobs", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJobStatus" } }, { "name": "limit", "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/EntityCalculatedFieldRecalculationJobListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJobListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJobListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/calculated-field-recalculation-jobs/reconcile": { "post": { "tags": [ "Entity Definitions" ], "summary": "Manually queue a full calculated-field recalculation for an entity definition.", "operationId": "admin-entity-definitions-reconcile-calculated-fields", "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/EntityCalculatedFieldRecalculationJobResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJobResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJobResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/calculated-field-recalculation-jobs/{jobId}/retry": { "post": { "tags": [ "Entity Definitions" ], "summary": "Requeue a failed or cancelled calculated-field recalculation job.", "operationId": "admin-entity-definitions-retry-calculated-field-recalculation-job", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "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/EntityCalculatedFieldRecalculationJobResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJobResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJobResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/delete/schema-change-plan": { "post": { "tags": [ "Entity Definitions" ], "summary": "Plan an entity definition delete and return schema-impacting warnings.", "operationId": "admin-entity-definitions-plan-delete-schema-change", "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/SchemaChangePlanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/cancel-deletion": { "post": { "tags": [ "Entity Definitions" ], "summary": "Cancel a pending entity definition deletion.", "operationId": "admin-entity-definitions-cancel-deletion", "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" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/unique-constraints": { "get": { "tags": [ "Entity Definitions" ], "summary": "List unique constraints for one entity definition.", "operationId": "admin-entity-definitions-list-unique-constraints", "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/EntityDefinitionUniqueConstraintListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionUniqueConstraintListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entity Definitions" ], "summary": "Create a unique constraint for one entity definition.", "operationId": "admin-entity-definitions-create-unique-constraint", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityDefinitionUniqueConstraintRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityDefinitionUniqueConstraintRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityDefinitionUniqueConstraintRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionUniqueConstraintResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionUniqueConstraintResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionUniqueConstraintResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionUniqueConstraintResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/unique-constraints/{constraintId}": { "delete": { "tags": [ "Entity Definitions" ], "summary": "Delete a unique constraint from one entity definition.", "operationId": "admin-entity-definitions-delete-unique-constraint", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "constraintId", "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/admin/entity-definitions/{entityDefinitionId}/indexes": { "get": { "tags": [ "Entity Definitions" ], "summary": "List non-unique indexes for one entity definition.", "operationId": "admin-entity-definitions-list-indexes", "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/EntityDefinitionIndexListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionIndexListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entity Definitions" ], "summary": "Create a non-unique index for one entity definition.", "operationId": "admin-entity-definitions-create-index", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityDefinitionIndexRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityDefinitionIndexRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityDefinitionIndexRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionIndexResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionIndexResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionIndexResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDefinitionIndexResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/indexes/{indexId}": { "delete": { "tags": [ "Entity Definitions" ], "summary": "Delete a non-unique index from one entity definition.", "operationId": "admin-entity-definitions-delete-index", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "indexId", "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/admin/entity-definition-tables/{entityDefinitionTableId}/fields": { "get": { "tags": [ "Entity Fields" ], "summary": "List field metadata for one entity definition table.", "operationId": "admin-entity-fields-list", "parameters": [ { "name": "entityDefinitionTableId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeDeleted", "in": "query", "schema": { "type": "boolean", "default": false } }, { "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/EntityFieldDefinitionListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entity Fields" ], "summary": "Create a field inside one entity definition table.", "description": "Field type semantics and per-type settings:\r\n[fields and schema](https://moltaro.com/docs/user/data-structure/entity-definitions/fields-and-schema/).\r\nBehavior conditions (`VisibleWhen`, `RequiredWhen`, `EditableWhen`) use the\r\n[expression language](https://moltaro.com/docs/dsl/rule-expressions/).", "operationId": "admin-entity-fields-create", "parameters": [ { "name": "entityDefinitionTableId", "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/CreateEntityFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityFieldRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-fields/{fieldId}": { "get": { "tags": [ "Entity Fields" ], "summary": "Return one field metadata record.", "operationId": "admin-entity-fields-get", "parameters": [ { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeDeleted", "in": "query", "schema": { "type": "boolean", "default": false } }, { "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/EntityFieldDefinitionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity Fields" ], "summary": "Update field metadata without changing the field type.", "operationId": "admin-entity-fields-update", "parameters": [ { "name": "fieldId", "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/UpdateEntityFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityFieldRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Fields" ], "summary": "Permanently delete a field and drop its physical storage.", "operationId": "admin-entity-fields-delete", "parameters": [ { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "schemaChangeConfirmationToken", "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/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/admin/entity-fields/{fieldId}/reference-eligibility": { "get": { "tags": [ "Entity Fields" ], "summary": "Return Reference Eligibility metadata owned by one dependent Reference field.", "operationId": "admin-entity-fields-get-reference-eligibility", "parameters": [ { "name": "fieldId", "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/EntityReferenceEligibilityResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity Fields" ], "summary": "Create or replace disabled Reference Eligibility metadata for one Reference field.", "operationId": "admin-entity-fields-put-reference-eligibility", "parameters": [ { "name": "fieldId", "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/UpsertEntityReferenceEligibilityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertEntityReferenceEligibilityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertEntityReferenceEligibilityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Fields" ], "summary": "Delete disabled Reference Eligibility metadata using optimistic concurrency.", "operationId": "admin-entity-fields-delete-reference-eligibility", "parameters": [ { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rowVersion", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "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" } } } }, "400": { "description": "Bad Request", "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" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-fields/{fieldId}/reference-eligibility/validate": { "post": { "tags": [ "Entity Fields" ], "summary": "Validate a Reference Eligibility expression without saving it.", "operationId": "admin-entity-fields-validate-reference-eligibility", "parameters": [ { "name": "fieldId", "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/ValidateEntityReferenceEligibilityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateEntityReferenceEligibilityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateEntityReferenceEligibilityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityValidationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityValidationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityValidationResultResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityValidationResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-fields/{fieldId}/reference-eligibility/impact": { "post": { "tags": [ "Entity Fields" ], "summary": "Preview active and archived data plus saved-surface impact for a proposed expression.", "operationId": "admin-entity-fields-preview-reference-eligibility-impact", "parameters": [ { "name": "fieldId", "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/PreviewEntityReferenceEligibilityImpactRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviewEntityReferenceEligibilityImpactRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PreviewEntityReferenceEligibilityImpactRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityImpactResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityImpactResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityImpactResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityReferenceEligibilityImpactResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-fields/{fieldId}/calculation": { "put": { "tags": [ "Entity Fields" ], "summary": "Update a field calculation expression.", "description": "Local and aggregate expression syntax, money semantics, and evaluation order:\r\n[calculated field expressions](https://moltaro.com/docs/dsl/calculated-fields/).", "operationId": "admin-entity-fields-update-calculation", "parameters": [ { "name": "fieldId", "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/UpdateEntityFieldCalculationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityFieldCalculationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityFieldCalculationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-fields/{fieldId}/calculation/validate": { "post": { "tags": [ "Entity Fields" ], "summary": "Validate a calculation expression for one field without saving it.", "description": "Dry-run: binds the expression against the field's schema and target type and returns\r\nstructured errors plus the inferred calculation kind, without persisting anything.\r\nExpression syntax:\r\n[calculated field expressions](https://moltaro.com/docs/dsl/calculated-fields/).", "operationId": "admin-entity-fields-validate-calculation", "parameters": [ { "name": "fieldId", "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/ValidateEntityFieldCalculationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateEntityFieldCalculationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateEntityFieldCalculationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldCalculationExpressionValidationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldCalculationExpressionValidationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldCalculationExpressionValidationResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-fields/{fieldId}/schema-change-plan": { "post": { "tags": [ "Entity Fields" ], "summary": "Plan a field metadata update and return schema-impacting warnings.", "operationId": "admin-entity-fields-plan-update-schema-change", "parameters": [ { "name": "fieldId", "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/UpdateEntityFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityFieldRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-fields/{fieldId}/type": { "put": { "tags": [ "Entity Fields" ], "summary": "Change field type and rebuild physical storage.", "description": "Preview data loss first with the type schema-change-plan endpoint; destructive changes\r\nrequire the confirmation token it returns.", "operationId": "admin-entity-fields-change-type", "parameters": [ { "name": "fieldId", "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/ChangeEntityFieldTypeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeEntityFieldTypeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeEntityFieldTypeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityFieldDefinitionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-fields/{fieldId}/type/schema-change-plan": { "post": { "tags": [ "Entity Fields" ], "summary": "Plan a field type change and return schema-impacting warnings.", "operationId": "admin-entity-fields-plan-change-type-schema-change", "parameters": [ { "name": "fieldId", "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/ChangeEntityFieldTypeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeEntityFieldTypeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeEntityFieldTypeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-fields/{fieldId}/delete/schema-change-plan": { "post": { "tags": [ "Entity Fields" ], "summary": "Plan a field delete and return schema-impacting warnings.", "operationId": "admin-entity-fields-plan-delete-schema-change", "parameters": [ { "name": "fieldId", "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/SchemaChangePlanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaChangePlanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definition-tables/{entityDefinitionTableId}/fields/order": { "put": { "tags": [ "Entity Fields" ], "summary": "Reorder fields inside one entity definition table.", "operationId": "admin-entity-fields-reorder", "parameters": [ { "name": "entityDefinitionTableId", "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/ReorderEntityFieldsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderEntityFieldsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderEntityFieldsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/mutation-effects": { "get": { "tags": [ "Entity Mutation Effects" ], "summary": "List mutation effects for one entity definition.", "operationId": "admin-entity-mutation-effects-list", "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/EntityMutationEffectListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationEffectListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entity Mutation Effects" ], "summary": "Create one mutation effect for an entity definition.", "operationId": "admin-entity-mutation-effects-create", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityMutationEffectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityMutationEffectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityMutationEffectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationEffectResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationEffectResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationEffectResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationEffectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-mutation-effects/{mutationEffectId}": { "get": { "tags": [ "Entity Mutation Effects" ], "summary": "Return one mutation effect.", "operationId": "admin-entity-mutation-effects-get", "parameters": [ { "name": "mutationEffectId", "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/EntityMutationEffectResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationEffectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity Mutation Effects" ], "summary": "Update one mutation effect.", "operationId": "admin-entity-mutation-effects-update", "parameters": [ { "name": "mutationEffectId", "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/UpdateEntityMutationEffectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityMutationEffectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityMutationEffectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationEffectResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationEffectResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationEffectResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityMutationEffectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Mutation Effects" ], "summary": "Delete one mutation effect.", "operationId": "admin-entity-mutation-effects-delete", "parameters": [ { "name": "mutationEffectId", "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/admin/entity-definitions/{entityDefinitionId}/security": { "get": { "tags": [ "Entity Security" ], "summary": "Returns the current Entity Security configuration.", "operationId": "entity-security-administration-get-configuration", "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": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityConfigurationResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/permissions": { "get": { "tags": [ "Entity Security" ], "summary": "Returns the canonical permissions that can be assigned to Security Statements.", "operationId": "entity-security-administration-get-permissions", "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": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionCatalogResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionCatalogResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionCatalogResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/authoring-options": { "get": { "tags": [ "Entity Security" ], "summary": "Returns roles and other stable authoring options for Security Statements.", "operationId": "entity-security-administration-get-authoring-options", "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": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAuthoringOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAuthoringOptionsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAuthoringOptionsResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/access-policies": { "get": { "tags": [ "Entity Security" ], "summary": "Returns Access Policies, exact capability groups, Permissions, and configuration health.", "operationId": "entity-security-administration-get-access-policies", "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": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAccessPolicyAdministrationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAccessPolicyAdministrationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAccessPolicyAdministrationResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/access-policies/plan": { "post": { "tags": [ "Entity Security" ], "summary": "Plans one atomic Access Policy change without mutating live configuration.", "operationId": "entity-security-administration-plan-access-policy", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanSecurityAccessPolicyChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanSecurityAccessPolicyChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlanSecurityAccessPolicyChangeRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/access-policies/apply": { "post": { "tags": [ "Entity Security" ], "summary": "Applies one unchanged Access Policy plan atomically.", "operationId": "entity-security-administration-apply-access-policy", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplySecurityAccessPolicyChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplySecurityAccessPolicyChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplySecurityAccessPolicyChangeRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/permission-bindings/plan": { "post": { "tags": [ "Entity Security" ], "summary": "Plans an atomic partial replacement of exact Permission bindings.", "operationId": "entity-security-administration-plan-permission-bindings", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanSecurityPermissionBindingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanSecurityPermissionBindingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlanSecurityPermissionBindingsRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/permission-bindings/apply": { "post": { "tags": [ "Entity Security" ], "summary": "Applies one unchanged exact Permission binding plan atomically.", "operationId": "entity-security-administration-apply-permission-bindings", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplySecurityPermissionBindingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplySecurityPermissionBindingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplySecurityPermissionBindingsRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/normalization/plan": { "post": { "tags": [ "Entity Security" ], "summary": "Plans explicit removal of exact redundant field refinements.", "operationId": "entity-security-administration-plan-field-normalization", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanSecurityFieldNormalizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanSecurityFieldNormalizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlanSecurityFieldNormalizationRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationPlanResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/normalization/apply": { "post": { "tags": [ "Entity Security" ], "summary": "Applies one unchanged redundant-field normalization plan atomically.", "operationId": "entity-security-administration-apply-field-normalization", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplySecurityFieldNormalizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplySecurityFieldNormalizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplySecurityFieldNormalizationRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdministrationApplyResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/statements": { "post": { "tags": [ "Entity Security" ], "summary": "Creates one immediately effective Security Statement.", "operationId": "entity-security-administration-create-statement", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementWriteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/statements/{statementKey}": { "put": { "tags": [ "Entity Security" ], "summary": "Updates one immediately effective Security Statement.", "operationId": "entity-security-administration-update-statement", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statementKey", "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/EntitySecurityStatementWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementWriteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityStatementResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Security" ], "summary": "Deletes an unused Security Statement.", "operationId": "entity-security-administration-delete-statement", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statementKey", "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/EntitySecurityArtifactDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/permission-assignments": { "post": { "tags": [ "Entity Security" ], "summary": "Assigns one canonical permission to one Security Statement.", "operationId": "entity-security-administration-create-permission-assignment", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignmentWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignmentWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignmentWriteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignmentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignmentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignmentResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignmentResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/permission-assignments/{assignmentKey}": { "delete": { "tags": [ "Entity Security" ], "summary": "Deletes one Permission Assignment.", "operationId": "entity-security-administration-delete-permission-assignment", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assignmentKey", "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/EntitySecurityArtifactDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/responsibilities": { "post": { "tags": [ "Entity Security" ], "summary": "Creates one immediately effective Responsibility Definition.", "operationId": "entity-security-administration-create-responsibility", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityWriteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/responsibilities/{responsibilityKey}": { "put": { "tags": [ "Entity Security" ], "summary": "Updates one immediately effective Responsibility Definition.", "operationId": "entity-security-administration-update-responsibility", "parameters": [ { "name": "entityDefinitionId", "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/EntitySecurityResponsibilityWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityWriteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityResponsibilityResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Security" ], "summary": "Deletes an unused Responsibility Definition.", "operationId": "entity-security-administration-delete-responsibility", "parameters": [ { "name": "entityDefinitionId", "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/EntitySecurityArtifactDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/initial-assignment-rules": { "post": { "tags": [ "Entity Security" ], "summary": "Creates one immediately effective Initial Assignment Rule.", "operationId": "entity-security-administration-create-initial-rule", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleWriteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/initial-assignment-rules/{ruleKey}": { "put": { "tags": [ "Entity Security" ], "summary": "Updates one immediately effective Initial Assignment Rule.", "operationId": "entity-security-administration-update-initial-rule", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleKey", "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/EntitySecurityInitialAssignmentRuleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleWriteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRuleResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Security" ], "summary": "Deletes one Initial Assignment Rule.", "operationId": "entity-security-administration-delete-initial-rule", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleKey", "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/EntitySecurityArtifactDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/assignment-rules": { "post": { "tags": [ "Entity Security" ], "summary": "Creates one immediately effective responsibility Assignment Rule.", "operationId": "entity-security-administration-create-assignment-rule", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleWriteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/assignment-rules/apply": { "post": { "tags": [ "Entity Security" ], "summary": "Atomically creates or replaces one Assignment Rule per selected assignment actor.", "operationId": "entity-security-administration-apply-assignment-rule-set", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleSetWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleSetWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleSetWriteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/assignment-rules/{ruleKey}": { "put": { "tags": [ "Entity Security" ], "summary": "Updates one immediately effective responsibility Assignment Rule.", "operationId": "entity-security-administration-update-assignment-rule", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleKey", "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/EntitySecurityAssignmentRuleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleWriteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleResponse" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Security" ], "summary": "Deletes one responsibility Assignment Rule.", "operationId": "entity-security-administration-delete-assignment-rule", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleKey", "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/EntitySecurityArtifactDeleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntitySecurityArtifactDeleteRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySecurityMutationResultResponse" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/statements": { "get": { "tags": [ "Entity Statements" ], "summary": "List statements for one entity definition.", "operationId": "admin-entity-statements-list", "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/EntityStatementListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityStatementListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entity Statements" ], "summary": "Create one statement for an entity definition.", "operationId": "admin-entity-statements-create", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityStatementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityStatementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityStatementRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityStatementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityStatementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityStatementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityStatementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-statements/{statementId}": { "get": { "tags": [ "Entity Statements" ], "summary": "Return one statement.", "operationId": "admin-entity-statements-get", "parameters": [ { "name": "statementId", "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/EntityStatementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityStatementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity Statements" ], "summary": "Update one statement.", "operationId": "admin-entity-statements-update", "parameters": [ { "name": "statementId", "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/UpdateEntityStatementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityStatementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityStatementRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityStatementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityStatementResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityStatementResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityStatementResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Statements" ], "summary": "Soft-delete one statement.", "operationId": "admin-entity-statements-delete", "parameters": [ { "name": "statementId", "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/admin/entity-definitions/{entityDefinitionId}/ui/actions/designer-model": { "get": { "tags": [ "Entity UI Actions" ], "summary": "Return designer data for configuring function-backed UI actions.", "operationId": "admin-business-function-action-designer-get-designer-model", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Surface", "in": "query", "schema": { "$ref": "#/components/schemas/EntitySurfaceType" } }, { "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/BusinessFunctionActionDesignerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionDesignerResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/actions": { "get": { "tags": [ "Entity UI Actions" ], "summary": "List function-backed UI actions for an entity definition.", "operationId": "admin-business-function-action-designer-list", "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/BusinessFunctionActionBindingListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entity UI Actions" ], "summary": "Create a function-backed UI action.", "operationId": "admin-business-function-action-designer-create", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBusinessFunctionActionBindingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBusinessFunctionActionBindingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBusinessFunctionActionBindingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionBindingResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionBindingResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/actions/{actionId}": { "put": { "tags": [ "Entity UI Actions" ], "summary": "Update a function-backed UI action.", "operationId": "admin-business-function-action-designer-update", "parameters": [ { "name": "entityDefinitionId", "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/UpdateBusinessFunctionActionBindingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBusinessFunctionActionBindingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBusinessFunctionActionBindingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionBindingResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionBindingResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionBindingResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionActionBindingResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Actions" ], "summary": "Delete a function-backed UI action.", "operationId": "admin-business-function-action-designer-delete", "parameters": [ { "name": "actionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "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/BooleanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/fields/{fieldId}/ui": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return the effective field UI preferences for one field.", "operationId": "admin-entity-field-ui-get", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/EntityUiFieldPreferenceAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Create or update explicit field UI preferences for one field.", "operationId": "admin-entity-field-ui-put", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/UpsertEntityUiFieldPreferenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertEntityUiFieldPreferenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertEntityUiFieldPreferenceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete the explicit field UI preferences row and fall back to platform defaults.", "operationId": "admin-entity-field-ui-delete", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldId", "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/DeleteEntityUiFieldPreferenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteEntityUiFieldPreferenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteEntityUiFieldPreferenceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/catalog": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return the read-only surface catalog for one surface type.", "operationId": "admin-entity-ui-get-catalog", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceType", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/selector-dependencies": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return resolved selector dependencies connected to this entity definition's UI surfaces.", "operationId": "admin-entity-ui-get-selector-dependencies", "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/EntityUiSurfaceDependencyGraphAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceDependencyGraphAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/host-surfaces/{surfaceType}": { "post": { "tags": [ "Entity UI Surfaces" ], "summary": "Create a custom entity-list, details-page, or drawer host surface.", "operationId": "admin-entity-ui-post-host-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntitySurfaceType" } }, { "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/CreateEntityUiHostSurfaceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiHostSurfaceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiHostSurfaceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/host-surfaces/{surfaceType}/{surfaceKey}/clone": { "post": { "tags": [ "Entity UI Surfaces" ], "summary": "Clone an entity-list, details-page, or drawer host surface.", "operationId": "admin-entity-ui-clone-host-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntitySurfaceType" } }, { "name": "surfaceKey", "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/CloneEntityUiHostSurfaceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloneEntityUiHostSurfaceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloneEntityUiHostSurfaceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/host-surfaces/{surfaceType}/{surfaceKey}/default": { "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Set an entity-list, details-page, or drawer host surface as its family's default.", "operationId": "admin-entity-ui-put-default-host-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntitySurfaceType" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/host-surfaces/{surfaceType}/{surfaceKey}": { "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete a custom entity-list, details-page, or drawer host surface.", "operationId": "admin-entity-ui-delete-host-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/EntitySurfaceType" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/table-surfaces": { "post": { "tags": [ "Entity UI Surfaces" ], "summary": "Create a custom table surface for this entity definition.", "operationId": "admin-entity-ui-post-table-surface", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiTableSurfaceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiTableSurfaceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiTableSurfaceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/table-surfaces/{surfaceKey}/clone": { "post": { "tags": [ "Entity UI Surfaces" ], "summary": "Clone a custom table surface for this entity definition.", "operationId": "admin-entity-ui-clone-table-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/CloneEntityUiTableSurfaceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloneEntityUiTableSurfaceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloneEntityUiTableSurfaceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/table-surfaces/{surfaceKey}/default": { "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Set a table surface as the default table for this entity definition.", "operationId": "admin-entity-ui-put-default-table-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Unset a table surface as the default table for this entity definition.", "operationId": "admin-entity-ui-delete-default-table-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/table-surfaces/{surfaceKey}": { "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete a custom table surface for this entity definition.", "operationId": "admin-entity-ui-delete-table-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/table-surfaces/{surfaceKey}/configuration": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return the explicit table surface configuration for one table surface.", "operationId": "admin-entity-ui-get-table-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiTableSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Replace the explicit table surface configuration for one table surface.", "operationId": "admin-entity-ui-put-table-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/ReplaceEntityUiTableSurfaceConfigurationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiTableSurfaceConfigurationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiTableSurfaceConfigurationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete the explicit table surface configuration for one table surface.", "operationId": "admin-entity-ui-delete-table-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiTableSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/table-surfaces/configuration/options": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return visual editor options for table surface configuration.", "operationId": "admin-entity-ui-get-table-surface-configuration-options", "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/EntityUiTableSurfaceConfigurationOptionsAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfigurationOptionsAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfigurationOptionsAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/card-surfaces": { "post": { "tags": [ "Entity UI Surfaces" ], "summary": "Create a custom card surface for this entity definition.", "operationId": "admin-entity-ui-post-card-surface", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiCardSurfaceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiCardSurfaceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiCardSurfaceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/card-surfaces/{surfaceKey}/default": { "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Set a card surface as the default card for this entity definition.", "operationId": "admin-entity-ui-put-default-card-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Unset a card surface as the default card for this entity definition.", "operationId": "admin-entity-ui-delete-default-card-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/card-surfaces/{surfaceKey}/clone": { "post": { "tags": [ "Entity UI Surfaces" ], "summary": "Clone a custom card surface for this entity definition.", "operationId": "admin-entity-ui-clone-card-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/CloneEntityUiCardSurfaceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloneEntityUiCardSurfaceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloneEntityUiCardSurfaceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/card-surfaces/{surfaceKey}": { "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete a custom card surface for this entity definition.", "operationId": "admin-entity-ui-delete-card-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/card-surfaces/{surfaceKey}/configuration": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return the explicit card surface configuration for one card surface.", "operationId": "admin-entity-ui-get-card-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiCardSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Replace the explicit card surface configuration for one card surface.", "operationId": "admin-entity-ui-put-card-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/ReplaceEntityUiCardSurfaceConfigurationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiCardSurfaceConfigurationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiCardSurfaceConfigurationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete the explicit card surface configuration for one card surface.", "operationId": "admin-entity-ui-delete-card-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiCardSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/card-surfaces/configuration/options": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return visual editor options for card surface configuration.", "operationId": "admin-entity-ui-get-card-surface-configuration-options", "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/EntityUiCardSurfaceConfigurationOptionsAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfigurationOptionsAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfigurationOptionsAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/form-surfaces": { "post": { "tags": [ "Entity UI Surfaces" ], "summary": "Create a custom form surface for this entity definition.", "operationId": "admin-entity-ui-post-form-surface", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiFormSurfaceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiFormSurfaceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityUiFormSurfaceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/form-surfaces/{surfaceKey}/default": { "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Set a form surface as the default form for this entity definition.", "operationId": "admin-entity-ui-put-default-form-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Unset a form surface as the default form for this entity definition.", "operationId": "admin-entity-ui-delete-default-form-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/form-surfaces/{surfaceKey}/clone": { "post": { "tags": [ "Entity UI Surfaces" ], "summary": "Clone a custom form surface for this entity definition.", "operationId": "admin-entity-ui-clone-form-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/CloneEntityUiFormSurfaceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloneEntityUiFormSurfaceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloneEntityUiFormSurfaceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/form-surfaces/{surfaceKey}": { "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete a custom form surface for this entity definition.", "operationId": "admin-entity-ui-delete-form-surface", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiSurfaceCatalogAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/form-surfaces/{surfaceKey}/configuration": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return the explicit form surface configuration for one form surface.", "operationId": "admin-entity-ui-get-form-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiFormSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Replace the explicit form surface configuration for one form surface.", "operationId": "admin-entity-ui-put-form-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/ReplaceEntityUiFormSurfaceConfigurationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiFormSurfaceConfigurationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiFormSurfaceConfigurationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete the explicit form surface configuration for one form surface.", "operationId": "admin-entity-ui-delete-form-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "surfaceKey", "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/EntityUiFormSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/form-surfaces/configuration/options": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return visual editor options for form surface configuration.", "operationId": "admin-entity-ui-get-form-surface-configuration-options", "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/EntityUiFormSurfaceConfigurationOptionsAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfigurationOptionsAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfigurationOptionsAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/entity-list-page/configuration": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return the explicit entity list-page configuration.", "operationId": "admin-entity-ui-get-entity-list-page-configuration", "parameters": [ { "name": "entityDefinitionId", "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/EntityUiEntityListPageConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiEntityListPageConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiEntityListPageConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Replace the explicit entity list-page configuration.", "operationId": "admin-entity-ui-put-entity-list-page-configuration", "parameters": [ { "name": "entityDefinitionId", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiEntityListPageConfigurationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiEntityListPageConfigurationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiEntityListPageConfigurationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiEntityListPageConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiEntityListPageConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiEntityListPageConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete the explicit entity list-page configuration.", "operationId": "admin-entity-ui-delete-entity-list-page-configuration", "parameters": [ { "name": "entityDefinitionId", "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/EntityUiEntityListPageConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiEntityListPageConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiEntityListPageConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/details-surface/configuration": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return the explicit entity details host-surface configuration.", "operationId": "admin-entity-ui-get-details-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "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/EntityUiDetailsSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiDetailsSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiDetailsSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Replace the explicit entity details host-surface configuration.", "operationId": "admin-entity-ui-put-details-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiDetailsSurfaceConfigurationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiDetailsSurfaceConfigurationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiDetailsSurfaceConfigurationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiDetailsSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiDetailsSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiDetailsSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/details-surface/object-hosted-layout": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return the details page object-hosted navigation and section layout.", "operationId": "admin-entity-ui-get-details-surface-object-hosted-layout", "parameters": [ { "name": "entityDefinitionId", "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/EntityObjectHostedLayoutAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Replace the details page object-hosted navigation and section layout.", "operationId": "admin-entity-ui-put-details-surface-object-hosted-layout", "parameters": [ { "name": "entityDefinitionId", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityObjectHostedLayoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityObjectHostedLayoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityObjectHostedLayoutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete the custom details page object-hosted layout and return to automatic generation.", "operationId": "admin-entity-ui-delete-details-surface-object-hosted-layout", "parameters": [ { "name": "entityDefinitionId", "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/EntityObjectHostedLayoutAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/drawer-surface/configuration": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return the explicit drawer host-surface configuration.", "operationId": "admin-entity-ui-get-drawer-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "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/EntityUiDrawerSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiDrawerSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiDrawerSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Replace the explicit drawer host-surface configuration.", "operationId": "admin-entity-ui-put-drawer-surface-configuration", "parameters": [ { "name": "entityDefinitionId", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiDrawerSurfaceConfigurationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiDrawerSurfaceConfigurationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityUiDrawerSurfaceConfigurationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiDrawerSurfaceConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiDrawerSurfaceConfigurationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityUiDrawerSurfaceConfigurationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/drawer-surface/object-hosted-layout": { "get": { "tags": [ "Entity UI Surfaces" ], "summary": "Return the drawer object-hosted section layout.", "operationId": "admin-entity-ui-get-drawer-surface-object-hosted-layout", "parameters": [ { "name": "entityDefinitionId", "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/EntityObjectHostedLayoutAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity UI Surfaces" ], "summary": "Replace the drawer object-hosted section layout.", "operationId": "admin-entity-ui-put-drawer-surface-object-hosted-layout", "parameters": [ { "name": "entityDefinitionId", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityObjectHostedLayoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityObjectHostedLayoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplaceEntityObjectHostedLayoutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity UI Surfaces" ], "summary": "Delete the custom drawer object-hosted layout and return to the default renderer.", "operationId": "admin-entity-ui-delete-drawer-surface-object-hosted-layout", "parameters": [ { "name": "entityDefinitionId", "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/EntityObjectHostedLayoutAdminResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdminResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/validation-rules": { "get": { "tags": [ "Entity Validation Rules" ], "summary": "List validation rules for one entity definition.", "operationId": "admin-entity-validation-rules-list", "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/EntityValidationRuleListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Entity Validation Rules" ], "summary": "Create one validation rule for an entity definition.", "operationId": "admin-entity-validation-rules-create", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityValidationRuleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEntityValidationRuleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEntityValidationRuleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-validation-rules/{validationRuleId}": { "get": { "tags": [ "Entity Validation Rules" ], "summary": "Return one validation rule.", "operationId": "admin-entity-validation-rules-get", "parameters": [ { "name": "validationRuleId", "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/EntityValidationRuleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Entity Validation Rules" ], "summary": "Update one validation rule.", "operationId": "admin-entity-validation-rules-update", "parameters": [ { "name": "validationRuleId", "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/UpdateEntityValidationRuleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityValidationRuleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEntityValidationRuleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Entity Validation Rules" ], "summary": "Soft-delete one validation rule.", "operationId": "admin-entity-validation-rules-delete", "parameters": [ { "name": "validationRuleId", "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/admin/entity-definitions/{entityDefinitionId}/validation-rules/order": { "put": { "tags": [ "Entity Validation Rules" ], "summary": "Replace validation rule order for one entity definition.", "operationId": "admin-entity-validation-rules-reorder", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderEntityValidationRulesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderEntityValidationRulesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderEntityValidationRulesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleListResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/entity-definitions/{entityDefinitionId}/validation-rules/validate-expression": { "post": { "tags": [ "Entity Validation Rules" ], "summary": "Validate one validation-rule expression before saving metadata.", "description": "Returns structured errors with token positions without saving anything. Expression syntax:\r\n[validation rule expressions](https://moltaro.com/docs/dsl/validation-rules/).", "operationId": "admin-entity-validation-rules-validate-expression", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateEntityValidationRuleExpressionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateEntityValidationRuleExpressionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateEntityValidationRuleExpressionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleExpressionValidationResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleExpressionValidationResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValidationRuleExpressionValidationResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/filesystem/settings": { "get": { "tags": [ "File System" ], "summary": "Return file system settings.", "operationId": "file-system-settings-get-settings", "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/FileSystemSettingsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSystemSettingsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "File System" ], "summary": "Update file system settings.", "operationId": "file-system-settings-update-settings", "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/UpdateFileSystemSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFileSystemSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFileSystemSettingsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSystemSettingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSystemSettingsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSystemSettingsResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSystemSettingsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-catalog": { "get": { "tags": [ "Function Catalog" ], "summary": "List business functions from the synchronized runtime catalog.", "operationId": "business-function-catalog-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/BusinessFunctionSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-catalog/{functionId}": { "get": { "tags": [ "Function Catalog" ], "summary": "Return one business function from the synchronized runtime catalog.", "operationId": "business-function-catalog-get", "parameters": [ { "name": "functionId", "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/BusinessFunctionDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-catalog/{functionId}/versions": { "get": { "tags": [ "Function Catalog" ], "summary": "List immutable versions for one business function.", "operationId": "business-function-catalog-list-versions", "parameters": [ { "name": "functionId", "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/BusinessFunctionVersionListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionVersionListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-catalog/{functionId}/test-invocations": { "post": { "tags": [ "Function Catalog" ], "summary": "Run a published business function with supplied test context.", "operationId": "business-function-catalog-run-test-invocation", "parameters": [ { "name": "functionId", "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/TestBusinessFunctionInvocationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TestBusinessFunctionInvocationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TestBusinessFunctionInvocationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionExecutionResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionExecutionResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionExecutionResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-catalog/bindings": { "get": { "tags": [ "Function Catalog" ], "summary": "List function bindings for one entity definition.", "operationId": "business-function-catalog-list-bindings", "parameters": [ { "name": "entityDefinitionId", "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/BusinessFunctionBindingListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-catalog/binding-summaries": { "get": { "tags": [ "Function Catalog" ], "summary": "List function binding summaries across entity definitions.", "operationId": "business-function-catalog-list-binding-summaries", "parameters": [ { "name": "Source", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessFunctionBindingSource" } }, { "name": "EntityDefinitionId", "in": "query", "schema": { "type": "string" } }, { "name": "Operation", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessFunctionBindingOperation" } }, { "name": "BusinessFunctionId", "in": "query", "schema": { "type": "string" } }, { "name": "IsEnabled", "in": "query", "schema": { "type": "boolean" } }, { "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/BusinessFunctionBindingSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-operations/overview": { "get": { "tags": [ "Function Operations" ], "summary": "Return queue counts, recent runs, and failed or retrying queued runs.", "operationId": "business-function-operations-overview", "parameters": [ { "name": "Limit", "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/BusinessFunctionOperationsOverviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionOperationsOverviewResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-operations/runs": { "get": { "tags": [ "Function Operations" ], "summary": "List persisted business-function runs.", "operationId": "business-function-operations-list-runs", "parameters": [ { "name": "FunctionId", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessFunctionRunStatus" } }, { "name": "Source", "in": "query", "schema": { "type": "string" } }, { "name": "TriggerBindingId", "in": "query", "schema": { "type": "string" } }, { "name": "ScheduleId", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "timeFrom", "in": "query", "schema": { "type": "string", "format": "time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "timeTo", "in": "query", "schema": { "type": "string", "format": "time" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ActionId", "in": "query", "schema": { "type": "string" } }, { "name": "ActionTargetScope", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" } }, { "name": "EntityDefinitionId", "in": "query", "schema": { "type": "string" } }, { "name": "EntityInstanceId", "in": "query", "schema": { "type": "string" } }, { "name": "BusinessFunctionVersionId", "in": "query", "schema": { "type": "string" } }, { "name": "ActorUserId", "in": "query", "schema": { "type": "string" } }, { "name": "OriginalUserId", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "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/BusinessFunctionRunOperationalSummaryListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionRunOperationalSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-operations/runs/page": { "get": { "tags": [ "Function Operations" ], "summary": "List persisted business-function runs as a page.", "operationId": "business-function-operations-list-runs-page", "parameters": [ { "name": "FunctionId", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessFunctionRunStatus" } }, { "name": "Source", "in": "query", "schema": { "type": "string" } }, { "name": "TriggerBindingId", "in": "query", "schema": { "type": "string" } }, { "name": "ScheduleId", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "timeFrom", "in": "query", "schema": { "type": "string", "format": "time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "timeTo", "in": "query", "schema": { "type": "string", "format": "time" } }, { "name": "ActionId", "in": "query", "schema": { "type": "string" } }, { "name": "ActionTargetScope", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" } }, { "name": "EntityDefinitionId", "in": "query", "schema": { "type": "string" } }, { "name": "EntityInstanceId", "in": "query", "schema": { "type": "string" } }, { "name": "BusinessFunctionVersionId", "in": "query", "schema": { "type": "string" } }, { "name": "ActorUserId", "in": "query", "schema": { "type": "string" } }, { "name": "OriginalUserId", "in": "query", "schema": { "type": "string" } }, { "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": "SortField", "in": "query", "description": "Sortable fields for persisted business-function run pages.", "schema": { "$ref": "#/components/schemas/BusinessFunctionRunSortField" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction for business-function operation pages.", "schema": { "$ref": "#/components/schemas/BusinessFunctionOperationSortDirection" } }, { "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/BusinessFunctionRunOperationsPageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionRunOperationsPageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-operations/runs/{runId}": { "get": { "tags": [ "Function Operations" ], "summary": "Return one persisted business-function run.", "operationId": "business-function-operations-get-run", "parameters": [ { "name": "runId", "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/BusinessFunctionRunDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionRunDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-operations/jobs/{jobId}": { "get": { "tags": [ "Function Operations" ], "summary": "Return one queued function run.", "operationId": "business-function-operations-get-job", "parameters": [ { "name": "jobId", "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/BusinessFunctionJobDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionJobDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-operations/jobs": { "get": { "tags": [ "Function Operations" ], "summary": "List queued function runs.", "operationId": "business-function-operations-list-jobs", "parameters": [ { "name": "FunctionId", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" } }, { "name": "Source", "in": "query", "schema": { "type": "string" } }, { "name": "TriggerBindingId", "in": "query", "schema": { "type": "string" } }, { "name": "ScheduleId", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "timeFrom", "in": "query", "schema": { "type": "string", "format": "time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "timeTo", "in": "query", "schema": { "type": "string", "format": "time" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ActionId", "in": "query", "schema": { "type": "string" } }, { "name": "ActionTargetScope", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" } }, { "name": "EntityDefinitionId", "in": "query", "schema": { "type": "string" } }, { "name": "EntityInstanceId", "in": "query", "schema": { "type": "string" } }, { "name": "BusinessFunctionVersionId", "in": "query", "schema": { "type": "string" } }, { "name": "ActorUserId", "in": "query", "schema": { "type": "string" } }, { "name": "OriginalUserId", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Retrying", "in": "query", "schema": { "type": "boolean" } }, { "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/BusinessFunctionJobOperationalSummaryListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionJobOperationalSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-operations/jobs/page": { "get": { "tags": [ "Function Operations" ], "summary": "List queued function runs as a page.", "operationId": "business-function-operations-list-jobs-page", "parameters": [ { "name": "FunctionId", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" } }, { "name": "Source", "in": "query", "schema": { "type": "string" } }, { "name": "TriggerBindingId", "in": "query", "schema": { "type": "string" } }, { "name": "ScheduleId", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "timeFrom", "in": "query", "schema": { "type": "string", "format": "time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "timeTo", "in": "query", "schema": { "type": "string", "format": "time" } }, { "name": "ActionId", "in": "query", "schema": { "type": "string" } }, { "name": "ActionTargetScope", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" } }, { "name": "EntityDefinitionId", "in": "query", "schema": { "type": "string" } }, { "name": "EntityInstanceId", "in": "query", "schema": { "type": "string" } }, { "name": "BusinessFunctionVersionId", "in": "query", "schema": { "type": "string" } }, { "name": "ActorUserId", "in": "query", "schema": { "type": "string" } }, { "name": "OriginalUserId", "in": "query", "schema": { "type": "string" } }, { "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": "SortField", "in": "query", "description": "Sortable fields for queued business-function job pages.", "schema": { "$ref": "#/components/schemas/BusinessFunctionJobSortField" } }, { "name": "SortDirection", "in": "query", "description": "Sort direction for business-function operation pages.", "schema": { "$ref": "#/components/schemas/BusinessFunctionOperationSortDirection" } }, { "name": "Retrying", "in": "query", "schema": { "type": "boolean" } }, { "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/BusinessFunctionJobOperationsPageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionJobOperationsPageResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-operations/jobs/{jobId}/cancel": { "post": { "tags": [ "Function Operations" ], "summary": "Cancel a queued run or request cancellation for a running function.", "operationId": "business-function-operations-cancel-job", "parameters": [ { "name": "jobId", "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/BusinessFunctionJobResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionJobResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionJobResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-operations/jobs/{jobId}/stop-retries": { "post": { "tags": [ "Function Operations" ], "summary": "Stop the complete retry chain for an active queued job. Queued or expired work is cancelled\r\nimmediately; a leased attempt receives cooperative cancellation and can never be retried.", "operationId": "business-function-operations-stop-job-retries", "parameters": [ { "name": "jobId", "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/StopBusinessFunctionJobRetriesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StopBusinessFunctionJobRetriesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StopBusinessFunctionJobRetriesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionJobRetryStopResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionJobRetryStopResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionJobRetryStopResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-operations/runs/{runId}/cancel": { "post": { "tags": [ "Function Operations" ], "summary": "Cancel a running function run when it supports manual cancellation.", "operationId": "business-function-operations-cancel-run", "parameters": [ { "name": "runId", "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/BusinessFunctionJobResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionJobResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionJobResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-schedules": { "get": { "tags": [ "Function Schedules" ], "summary": "List configured business-function schedules.", "description": "Schedule occurrences never overlap active queued or running work for their target function.\r\nAn overlapping occurrence is exposed as `Skipped` in run history.", "operationId": "business-function-schedules-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/BusinessFunctionScheduleListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Function Schedules" ], "summary": "Create a business-function schedule.", "description": "Schedule occurrences never overlap active queued or running work for their target function.\r\nAn overlapping occurrence is recorded as `Skipped` instead of creating a parallel job.", "operationId": "business-function-schedules-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/CreateBusinessFunctionScheduleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBusinessFunctionScheduleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBusinessFunctionScheduleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionScheduleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionScheduleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/function-schedules/{scheduleId}": { "get": { "tags": [ "Function Schedules" ], "summary": "Return one business-function schedule.", "description": "The response exposes any currently queued or leased job. Later due occurrences are recorded\r\nas `Skipped` while that work remains active.", "operationId": "business-function-schedules-get", "parameters": [ { "name": "scheduleId", "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/BusinessFunctionScheduleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionScheduleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Function Schedules" ], "summary": "Update one business-function schedule.", "description": "Schedule occurrences never overlap active queued or running work for their target function.\r\nAn overlapping occurrence is recorded as `Skipped` instead of creating a parallel job.", "operationId": "business-function-schedules-update", "parameters": [ { "name": "scheduleId", "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/UpdateBusinessFunctionScheduleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBusinessFunctionScheduleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBusinessFunctionScheduleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionScheduleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionScheduleResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionScheduleResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionScheduleResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Function Schedules" ], "summary": "Delete one business-function schedule.", "operationId": "business-function-schedules-delete", "parameters": [ { "name": "scheduleId", "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" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/geo/location-sources": { "get": { "tags": [ "Geo Location Sources" ], "summary": "Return Location source configurations for one Resource Catalog context.", "operationId": "admin-geo-location-sources-get", "parameters": [ { "name": "moduleKey", "in": "query", "schema": { "type": "string" } }, { "name": "resourceKind", "in": "query", "schema": { "type": "string" } }, { "name": "contextResourceId", "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/GeoResourceLocationSourceDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResourceLocationSourceDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "Geo Location Sources" ], "summary": "Create or replace one named Location source for one Resource Catalog context.", "operationId": "admin-geo-location-sources-upsert", "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/UpsertGeoResourceLocationSourceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertGeoResourceLocationSourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertGeoResourceLocationSourceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResourceLocationSourceMutationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResourceLocationSourceMutationResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResourceLocationSourceMutationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/geo/location-sources/candidates": { "get": { "tags": [ "Geo Location Sources" ], "summary": "Return valid source modes and address-field candidates for one Resource Catalog context.", "operationId": "admin-geo-location-sources-candidates", "parameters": [ { "name": "moduleKey", "in": "query", "schema": { "type": "string" } }, { "name": "resourceKind", "in": "query", "schema": { "type": "string" } }, { "name": "contextResourceId", "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/GeoResourceLocationCandidatesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResourceLocationCandidatesResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/geo/location-sources/disable": { "post": { "tags": [ "Geo Location Sources" ], "summary": "Disable one named Location source for one Resource Catalog context.", "operationId": "admin-geo-location-sources-disable", "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/DisableGeoResourceLocationSourceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DisableGeoResourceLocationSourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DisableGeoResourceLocationSourceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResourceLocationSourceMutationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResourceLocationSourceMutationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResourceLocationSourceMutationResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResourceLocationSourceMutationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/http-endpoints": { "get": { "tags": [ "HTTP Endpoint Functions" ], "summary": "List discovered inbound HTTP endpoint functions.", "operationId": "admin-business-function-http-endpoints-admin-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/BusinessFunctionHttpEndpointSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/http-endpoints/{endpointId}": { "get": { "tags": [ "HTTP Endpoint Functions" ], "summary": "Get HTTP endpoint function settings and secret metadata.", "operationId": "admin-business-function-http-endpoints-admin-get", "parameters": [ { "name": "endpointId", "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/BusinessFunctionHttpEndpointDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/http-endpoints/{endpointId}/settings": { "put": { "tags": [ "HTTP Endpoint Functions" ], "summary": "Update admin-owned HTTP endpoint function settings.", "operationId": "admin-business-function-http-endpoints-admin-update-settings", "parameters": [ { "name": "endpointId", "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/UpdateBusinessFunctionHttpEndpointSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBusinessFunctionHttpEndpointSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBusinessFunctionHttpEndpointSettingsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/http-endpoints/{endpointId}/secrets": { "post": { "tags": [ "HTTP Endpoint Functions" ], "summary": "Create or rotate a managed HTTP endpoint secret. Plaintext is returned only once.", "operationId": "admin-business-function-http-endpoints-admin-create-secret", "parameters": [ { "name": "endpointId", "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/CreateBusinessFunctionHttpEndpointSecretRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBusinessFunctionHttpEndpointSecretRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBusinessFunctionHttpEndpointSecretRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointSecretCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointSecretCreatedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointSecretCreatedResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointSecretCreatedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/secrets": { "get": { "tags": [ "Managed Secrets" ], "summary": "List managed-secret metadata for an owner or administrator. Values are never returned.", "operationId": "admin-managed-secrets-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/ManagedSecretListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Managed Secrets" ], "summary": "Create an enabled managed secret at value version 1. The submitted value is never returned.", "operationId": "admin-managed-secrets-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/CreateManagedSecretRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateManagedSecretRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateManagedSecretRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/secrets/{id}": { "get": { "tags": [ "Managed Secrets" ], "summary": "Get managed-secret metadata for an owner or administrator. The value is never returned.", "operationId": "admin-managed-secrets-get", "parameters": [ { "name": "id", "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/ManagedSecretResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/secrets/{id}/rotate": { "post": { "tags": [ "Managed Secrets" ], "summary": "Rotate an active or disabled secret, replacing its value and incrementing its value version.", "operationId": "admin-managed-secrets-rotate", "parameters": [ { "name": "id", "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/RotateManagedSecretRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RotateManagedSecretRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RotateManagedSecretRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/secrets/{id}/disable": { "post": { "tags": [ "Managed Secrets" ], "summary": "Disable trusted C# resolution without changing the value version.", "operationId": "admin-managed-secrets-disable", "parameters": [ { "name": "id", "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/ChangeManagedSecretStateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeManagedSecretStateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeManagedSecretStateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/secrets/{id}/enable": { "post": { "tags": [ "Managed Secrets" ], "summary": "Re-enable trusted C# resolution without changing the value version.", "operationId": "admin-managed-secrets-enable", "parameters": [ { "name": "id", "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/ChangeManagedSecretStateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeManagedSecretStateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeManagedSecretStateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/secrets/{id}/retire": { "post": { "tags": [ "Managed Secrets" ], "summary": "Permanently retire a managed secret, increment its version, and erase its ciphertext.", "operationId": "admin-managed-secrets-retire", "parameters": [ { "name": "id", "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/ChangeManagedSecretStateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeManagedSecretStateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeManagedSecretStateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSecretResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/status": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return current Net Operation Project status, creating the starter revision if needed.", "operationId": "admin-net-operation-project-get-status", "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/NetOperationProjectStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/revisions": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return immutable Net Operation Project source revisions ordered newest first.", "operationId": "admin-net-operation-project-list-revisions", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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/NetOperationProjectRevisionListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectRevisionListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/builds": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return Net Operation Project build/check history ordered newest first.", "operationId": "admin-net-operation-project-list-builds", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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/NetOperationProjectBuildListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectBuildListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Net Operation Project" ], "summary": "Queue a Net Operation Project build or check for the working revision.", "operationId": "admin-net-operation-project-queue-build", "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/QueueNetOperationProjectBuildRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueueNetOperationProjectBuildRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QueueNetOperationProjectBuildRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectBuildResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectBuildResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/builds/{buildId}": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return one Net Operation Project build/check record.", "operationId": "admin-net-operation-project-get-build", "parameters": [ { "name": "buildId", "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/NetOperationProjectBuildResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectBuildResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectBuildResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/revisions/{revisionId}/files": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return stored files for one Net Operation Project source revision.", "operationId": "admin-net-operation-project-list-revision-files", "parameters": [ { "name": "revisionId", "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/NetOperationProjectFileListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectFileListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectFileListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-tree": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return source tree metadata for the current working or requested Net Operation Project revision.", "operationId": "admin-net-operation-project-get-source-tree", "parameters": [ { "name": "revisionId", "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/NetOperationProjectSourceTreeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceTreeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceTreeResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-files": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return one source file from the current working or requested Net Operation Project revision.", "operationId": "admin-net-operation-project-get-source-file", "parameters": [ { "name": "revisionId", "in": "query", "schema": { "type": "string" } }, { "name": "path", "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/NetOperationProjectFileResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectFileResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectFileResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-revisions/manual-edit": { "post": { "tags": [ "Net Operation Project" ], "summary": "Create a manual Net Operation Project source revision from file changes.", "operationId": "admin-net-operation-project-create-manual-edit-revision", "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/CreateNetOperationProjectManualEditRevisionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateNetOperationProjectManualEditRevisionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateNetOperationProjectManualEditRevisionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectManualEditResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectManualEditResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectManualEditResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectManualEditResultResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectManualEditResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-package-references": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return package references for the current working or requested Net Operation Project revision.", "operationId": "admin-net-operation-project-get-package-references", "parameters": [ { "name": "revisionId", "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/NetOperationProjectPackageReferencesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectPackageReferencesResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectPackageReferencesResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-package-references/manual-edit": { "post": { "tags": [ "Net Operation Project" ], "summary": "Create a manual Net Operation Project source revision from package reference changes.", "operationId": "admin-net-operation-project-update-package-references", "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/UpdateNetOperationProjectPackageReferencesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateNetOperationProjectPackageReferencesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateNetOperationProjectPackageReferencesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectPackageReferencesEditResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectPackageReferencesEditResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectPackageReferencesEditResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectPackageReferencesEditResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-templates": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return the available server-generated Net Operation Project source templates and their input requirements.", "operationId": "admin-net-operation-project-list-source-templates", "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/NetOperationProjectSourceTemplateListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceTemplateListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/developer-surface": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return the supported Net Operation Project assemblies, generated-contract behavior, and injectable services.", "operationId": "admin-net-operation-project-get-developer-surface", "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/NetOperationProjectDeveloperSurfaceResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-templates/preview": { "post": { "tags": [ "Net Operation Project" ], "summary": "Preview a server-generated Net Operation Project source template without creating a revision.", "operationId": "admin-net-operation-project-preview-source-template", "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/NetOperationProjectSourceTemplatePreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceTemplatePreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceTemplatePreviewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceTemplatePreviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceTemplatePreviewResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceTemplatePreviewResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/nuget-packages/search": { "get": { "tags": [ "Net Operation Project" ], "summary": "Search public NuGet.org packages for Net Operation Project package management.", "operationId": "admin-net-operation-project-search-nu-get-packages", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includePrerelease", "in": "query", "schema": { "type": "boolean", "default": false } }, { "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/NuGetPackageSearchResultListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NuGetPackageSearchResultListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/nuget-packages/versions": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return public NuGet.org versions for one package.", "operationId": "admin-net-operation-project-list-nu-get-package-versions", "parameters": [ { "name": "packageId", "in": "query", "schema": { "type": "string" } }, { "name": "includePrerelease", "in": "query", "schema": { "type": "boolean", "default": false } }, { "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/NuGetPackageVersionListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NuGetPackageVersionListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-language/completions": { "post": { "tags": [ "Net Operation Project" ], "summary": "Return C# completion items for the current Net Operation Project source buffer.", "operationId": "admin-net-operation-project-get-source-language-completions", "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/NetOperationProjectSourceLanguageCompletionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageCompletionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageCompletionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageCompletionResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageCompletionResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageCompletionResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageCompletionResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-language/diagnostics": { "post": { "tags": [ "Net Operation Project" ], "summary": "Return C# diagnostics for the current Net Operation Project source buffer.", "operationId": "admin-net-operation-project-get-source-language-diagnostics", "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/NetOperationProjectSourceLanguageDiagnosticsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnosticsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnosticsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnosticsResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnosticsResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnosticsResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnosticsResultResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnosticsResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-language/hover": { "post": { "tags": [ "Net Operation Project" ], "summary": "Return C# hover information for the current Net Operation Project source buffer.", "operationId": "admin-net-operation-project-get-source-language-hover", "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/NetOperationProjectSourceLanguageHoverRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageHoverRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageHoverRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageHoverResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageHoverResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageHoverResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageHoverResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-language/signature-help": { "post": { "tags": [ "Net Operation Project" ], "summary": "Return C# signature help for the current Net Operation Project source buffer.", "operationId": "admin-net-operation-project-get-source-language-signature-help", "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/NetOperationProjectSourceLanguageSignatureHelpRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageSignatureHelpRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageSignatureHelpRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageSignatureHelpResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageSignatureHelpResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageSignatureHelpResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageSignatureHelpResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/source-language/source-index": { "get": { "tags": [ "Net Operation Project" ], "summary": "Return the read-only Studio source index for the current or requested Net Operation Project revision.", "operationId": "admin-net-operation-project-get-source-language-source-index", "parameters": [ { "name": "revisionId", "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/NetOperationProjectSourceIndexResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceIndexResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectSourceIndexResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/revisions/{revisionId}": { "delete": { "tags": [ "Net Operation Project" ], "summary": "Delete a non-current Net Operation Project source revision that has not produced an artifact.", "operationId": "admin-net-operation-project-delete-revision", "parameters": [ { "name": "revisionId", "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/NetOperationProjectStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/download": { "get": { "tags": [ "Net Operation Project" ], "summary": "Download a ZIP archive for the current or requested Net Operation Project revision.", "operationId": "admin-net-operation-project-download", "parameters": [ { "name": "revisionId", "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": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/net-operation-project/upload": { "post": { "tags": [ "Net Operation Project" ], "summary": "Upload a full project ZIP archive and create a new immutable source revision.", "operationId": "admin-net-operation-project-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", "description": "Uploaded ZIP archive.", "format": "binary" }, "Comment": { "type": "string", "description": "Optional revision comment." } } }, "encoding": { "File": { "style": "form" }, "Comment": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectUploadResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetOperationProjectUploadResultResponse" } } } }, "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/admin/runtime-menus": { "get": { "tags": [ "User Menus" ], "summary": "List configured user menus.", "operationId": "admin-runtime-menus-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/RuntimeMenuSummaryListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "User Menus" ], "summary": "Create one user menu.", "operationId": "admin-runtime-menus-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/CreateRuntimeMenuRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRuntimeMenuRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateRuntimeMenuRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeMenuDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeMenuDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeMenuDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/runtime-menus/module-pages": { "get": { "tags": [ "User Menus" ], "summary": "List registered built-in module pages for user-menu configuration.", "description": "Known pages remain in the catalog while their owning module is disabled. Such pages may be saved but are unavailable at runtime until the module is enabled.", "operationId": "admin-runtime-menus-list-module-pages", "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/RuntimeMenuModulePageCatalogListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/runtime-menus/{runtimeMenuId}": { "get": { "tags": [ "User Menus" ], "summary": "Return one configured user menu.", "operationId": "admin-runtime-menus-get", "parameters": [ { "name": "runtimeMenuId", "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/RuntimeMenuDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeMenuDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "put": { "tags": [ "User Menus" ], "summary": "Replace one user menu.", "operationId": "admin-runtime-menus-update", "parameters": [ { "name": "runtimeMenuId", "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/UpdateRuntimeMenuRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateRuntimeMenuRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateRuntimeMenuRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeMenuDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeMenuDetailResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeMenuDetailResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeMenuDetailResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "User Menus" ], "summary": "Delete one user menu.", "operationId": "admin-runtime-menus-delete", "parameters": [ { "name": "runtimeMenuId", "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" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/status": { "get": { "tags": [ "Workspace UI Project" ], "summary": "Return current Workspace UI project status, provisioning an empty source skeleton only for source-capable users.", "operationId": "admin-workspace-ui-project-get-status", "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/WorkspaceUiProjectStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/revisions": { "get": { "tags": [ "Workspace UI Project" ], "summary": "List immutable Workspace UI source revisions ordered newest first.", "operationId": "admin-workspace-ui-project-list-revisions", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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/WorkspaceUiProjectRevisionListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/revisions/{revisionId}": { "get": { "tags": [ "Workspace UI Project" ], "summary": "Return one immutable Workspace UI source revision.", "operationId": "admin-workspace-ui-project-get-revision", "parameters": [ { "name": "revisionId", "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/WorkspaceUiProjectRevisionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectRevisionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Workspace UI Project" ], "summary": "Delete a disposable source revision and its completed non-artifact build history.", "operationId": "admin-workspace-ui-project-delete-revision", "parameters": [ { "name": "revisionId", "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/WorkspaceUiProjectRevisionDeletionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectRevisionDeletionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectRevisionDeletionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectStatusResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/source-tree": { "get": { "tags": [ "Workspace UI Project" ], "summary": "Return source-tree metadata for one requested revision.", "operationId": "admin-workspace-ui-project-get-source-tree", "parameters": [ { "name": "revisionId", "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/WorkspaceUiProjectSourceTreeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTreeResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/source-files": { "get": { "tags": [ "Workspace UI Project" ], "summary": "Return one UTF-8 source file from a Workspace UI revision.", "operationId": "admin-workspace-ui-project-get-source-file", "parameters": [ { "name": "revisionId", "in": "query", "schema": { "type": "string" } }, { "name": "path", "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/WorkspaceUiProjectFileResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectFileResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/source-revisions/manual-edit": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Create one immutable manual-edit source revision.", "operationId": "admin-workspace-ui-project-create-manual-revision", "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/CreateWorkspaceUiProjectRevisionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWorkspaceUiProjectRevisionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWorkspaceUiProjectRevisionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectRevisionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectRevisionResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectRevisionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/source-templates": { "get": { "tags": [ "Workspace UI Project" ], "summary": "List deterministic Workspace UI source templates available to authoring clients.", "operationId": "admin-workspace-ui-project-list-source-templates", "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/WorkspaceUiProjectSourceTemplateListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/source-templates/preview": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Preview deterministic template changes without modifying Workspace UI source.", "operationId": "admin-workspace-ui-project-preview-source-template", "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/PreviewWorkspaceUiProjectSourceTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviewWorkspaceUiProjectSourceTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PreviewWorkspaceUiProjectSourceTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplatePreviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplatePreviewResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplatePreviewResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/source-templates/apply": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Atomically apply a deterministic template as one immutable Workspace UI source revision.", "operationId": "admin-workspace-ui-project-apply-source-template", "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/ApplyWorkspaceUiProjectSourceTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplyWorkspaceUiProjectSourceTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplyWorkspaceUiProjectSourceTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplateApplyResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplateApplyResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplateApplyResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/page-generators/catalog": { "get": { "tags": [ "Workspace UI Project" ], "summary": "Return typed page-generator, entity-field, working-page, and optional runtime-menu capabilities.", "operationId": "admin-workspace-ui-project-get-page-generator-catalog", "parameters": [ { "name": "revisionId", "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/WorkspaceUiPageGeneratorCatalogResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorCatalogResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/page-generators/preview": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Preview all deterministic source changes and optional root-leaf menu placement for one page.", "operationId": "admin-workspace-ui-project-preview-page-generator", "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/PreviewWorkspaceUiPageGeneratorRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviewWorkspaceUiPageGeneratorRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PreviewWorkspaceUiPageGeneratorRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorPreviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorPreviewResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorPreviewResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/page-generators/apply": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Re-plan and create one TemplateApply source revision, then independently attempt optional menu placement.", "operationId": "admin-workspace-ui-project-apply-page-generator", "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/ApplyWorkspaceUiPageGeneratorRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplyWorkspaceUiPageGeneratorRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplyWorkspaceUiPageGeneratorRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorApplyResultResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorApplyResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorApplyResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/download": { "get": { "tags": [ "Workspace UI Project" ], "summary": "Download a deterministic source and generated IDE-project ZIP.", "operationId": "admin-workspace-ui-project-download", "parameters": [ { "name": "revisionId", "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": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/upload": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Upload a ZIP and create one immutable source revision without automatically queuing a build.", "operationId": "admin-workspace-ui-project-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", "description": "Uploaded ZIP archive.", "format": "binary" }, "Comment": { "type": "string", "description": "Optional source revision comment." } } }, "encoding": { "File": { "style": "form" }, "Comment": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectRevisionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectRevisionResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/builds": { "get": { "tags": [ "Workspace UI Project" ], "summary": "List Workspace UI checks and builds ordered newest first.", "operationId": "admin-workspace-ui-project-list-builds", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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/WorkspaceUiProjectBuildListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] }, "post": { "tags": [ "Workspace UI Project" ], "summary": "Queue a Workspace UI Check or Build for one immutable revision.", "operationId": "admin-workspace-ui-project-queue-build", "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/CreateWorkspaceUiProjectBuildRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWorkspaceUiProjectBuildRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWorkspaceUiProjectBuildRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/builds/{buildId}": { "get": { "tags": [ "Workspace UI Project" ], "summary": "Return one Workspace UI check or build.", "operationId": "admin-workspace-ui-project-get-build", "parameters": [ { "name": "buildId", "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/WorkspaceUiProjectBuildResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/builds/{buildId}/cancel": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Request cancellation of one queued or running Workspace UI build.", "operationId": "admin-workspace-ui-project-cancel-build", "parameters": [ { "name": "buildId", "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/WorkspaceUiProjectBuildCancellationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildCancellationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildCancellationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/artifacts": { "get": { "tags": [ "Workspace UI Project" ], "summary": "List stored Workspace UI artifacts ordered newest first.", "operationId": "admin-workspace-ui-project-list-artifacts", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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/WorkspaceUiProjectArtifactListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/artifacts/{artifactId}": { "get": { "tags": [ "Workspace UI Project" ], "summary": "Return one stored Workspace UI artifact.", "operationId": "admin-workspace-ui-project-get-artifact", "parameters": [ { "name": "artifactId", "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/WorkspaceUiProjectArtifactResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/compatibility": { "get": { "tags": [ "Workspace UI Project" ], "summary": "Return safe build-toolchain, runtime-contract, and optional artifact compatibility.", "operationId": "admin-workspace-ui-project-get-compatibility", "parameters": [ { "name": "artifactId", "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/WorkspaceUiProjectCompatibilityResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectCompatibilityResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/artifacts/{artifactId}/activate": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Activate one compatible inactive Workspace UI artifact.", "operationId": "admin-workspace-ui-project-activate-artifact", "parameters": [ { "name": "artifactId", "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/WorkspaceUiProjectArtifactStateChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactStateChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactStateChangeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/artifacts/{artifactId}/deactivate": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Deactivate the currently active Workspace UI artifact.", "operationId": "admin-workspace-ui-project-deactivate-artifact", "parameters": [ { "name": "artifactId", "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/WorkspaceUiProjectArtifactStateChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactStateChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactStateChangeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/artifacts/{artifactId}/rollback": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Roll back to one compatible previously published Workspace UI artifact.", "operationId": "admin-workspace-ui-project-rollback-artifact", "parameters": [ { "name": "artifactId", "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/WorkspaceUiProjectArtifactStateChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactStateChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactStateChangeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { } ] } }, "/api/workspace/admin/ui-project/artifacts/{artifactId}/purge": { "post": { "tags": [ "Workspace UI Project" ], "summary": "Purge bytes from one inactive Workspace UI artifact while retaining history metadata.", "operationId": "admin-workspace-ui-project-purge-artifact", "parameters": [ { "name": "artifactId", "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/WorkspaceUiProjectArtifactPurgeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactPurgeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactPurgeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResultResponse" } } } }, "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" } }, "AgentIntegrationManifest": { "type": "object", "properties": { "WorkspaceDisplayName": { "type": "string", "description": "Workspace display name shown in the UI.", "nullable": true }, "PublicApiBaseUrl": { "type": "string", "description": "Resolved workspace API base URL. This is not the Moltaro public website or documentation URL.", "nullable": true }, "PublicOpenApiUrl": { "type": "string", "description": "Installation-local runtime OpenAPI document URL.", "nullable": true }, "ConfigurationOpenApiUrl": { "type": "string", "description": "Installation-local curated configuration OpenAPI document URL.", "nullable": true }, "DocsUrl": { "type": "string", "description": "Public product documentation URL for reference only; workspace API routes are not served from this origin.", "nullable": true }, "ManagedSecretsDocsUrl": { "type": "string", "description": "Canonical public guide for managed-secret administration and trusted C# usage.", "nullable": true }, "LlmsFullUrl": { "type": "string", "description": "Machine-readable full documentation URL for AI agents.", "nullable": true }, "ReleaseNotesUrl": { "type": "string", "description": "Versioned Moltaro release-note index that agents read before starting work.", "nullable": true } }, "additionalProperties": false, "description": "Agent integration facts for this Moltaro installation." }, "AgentIntegrationManifestResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AgentIntegrationManifest" }, "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 }, "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" } }, "ApplyImportPlanRequest": { "required": [ "Security", "Yaml" ], "type": "object", "properties": { "Yaml": { "type": "string", "description": "YAML document content (same as used for plan generation)." }, "TargetEntityDefinitionId": { "type": "string", "description": "Target entity definition for update mode; null for create mode.", "nullable": true }, "Refinements": { "type": "array", "items": { "$ref": "#/components/schemas/ImportReferenceRefinement" }, "description": "User-provided reference refinements.", "nullable": true }, "ConflictResolutions": { "type": "array", "items": { "$ref": "#/components/schemas/ImportConflictResolution" }, "description": "User-provided conflict resolutions for update mode.", "nullable": true }, "ApplyHeader": { "type": "boolean", "description": "Whether to apply entity-definition header changes." }, "SelectedItemIds": { "type": "array", "items": { "type": "string" }, "description": "Selected actionable plan item identifiers; null applies all actionable items.", "nullable": true }, "Security": { "$ref": "#/components/schemas/EntityDefinitionSecurityApplyRequest" } }, "additionalProperties": false, "description": "Request payload to apply an approved import plan." }, "ApplySecurityAccessPolicyChangeRequest": { "required": [ "AcknowledgedWarningCodes", "ChangeKind", "ExpectedRowVersion", "OperationKey", "PlanToken" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "ExpectedRowVersion": { "type": "string", "format": "uuid" }, "ChangeKind": { "$ref": "#/components/schemas/SecurityAccessPolicyChangeKind" }, "OriginalPolicyKey": { "type": "string", "nullable": true }, "Draft": { "$ref": "#/components/schemas/SecurityAccessPolicyDraft" }, "PlanToken": { "type": "string" }, "AcknowledgedWarningCodes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Applies one unchanged Access Policy plan." }, "ApplySecurityFieldNormalizationRequest": { "required": [ "AcknowledgedWarningCodes", "ExpectedRowVersion", "OperationKey", "PlanToken" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "ExpectedRowVersion": { "type": "string", "format": "uuid" }, "PlanToken": { "type": "string" }, "AcknowledgedWarningCodes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Applies one unchanged field-refinement normalization plan." }, "ApplySecurityPermissionBindingsRequest": { "required": [ "AcknowledgedWarningCodes", "Bindings", "ExpectedRowVersion", "OperationKey", "PlanToken" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "ExpectedRowVersion": { "type": "string", "format": "uuid" }, "Bindings": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityPermissionBindingPatch" } }, "PlanToken": { "type": "string" }, "AcknowledgedWarningCodes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Applies one unchanged Permission binding plan." }, "ApplyWorkspaceUiPageGeneratorRequest": { "type": "object", "properties": { "Page": { "$ref": "#/components/schemas/PreviewWorkspaceUiPageGeneratorRequest" }, "Comment": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Re-plan and apply one deterministic page as an immutable TemplateApply revision." }, "ApplyWorkspaceUiProjectSourceTemplateRequest": { "type": "object", "properties": { "Template": { "$ref": "#/components/schemas/PreviewWorkspaceUiProjectSourceTemplateRequest" }, "Comment": { "type": "string", "description": "Optional immutable revision comment.", "nullable": true } }, "additionalProperties": false, "description": "Atomically apply a deterministic Workspace UI source template." }, "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" } }, "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" } }, "BoardAllowedActions": { "type": "object", "properties": { "CanUpdate": { "type": "boolean", "description": "Whether board identity can be updated." }, "CanDelete": { "type": "boolean", "description": "Whether board can be deleted." }, "CanActivate": { "type": "boolean", "description": "Whether board can be activated." }, "CanDeactivate": { "type": "boolean", "description": "Whether board can be deactivated." }, "CanManageConfiguration": { "type": "boolean", "description": "Whether board configuration can be changed." } }, "additionalProperties": false, "description": "Allowed actions for one board." }, "BoardAttentionSignalAudienceSubject": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "SubjectType": { "$ref": "#/components/schemas/BoardAttentionSignalAudienceSubjectType" }, "SubjectKey": { "type": "string", "nullable": true }, "RoleId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "One configured audience subject for board AttentionSignals." }, "BoardAttentionSignalAudienceSubjectRequest": { "type": "object", "properties": { "SubjectType": { "$ref": "#/components/schemas/BoardAttentionSignalAudienceSubjectType" }, "RoleId": { "type": "string", "description": "Existing workspace role id. Required when SubjectType is Role; must be null for the dynamic responsible subject types.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Ordering of this audience subject inside the policy.", "format": "int32" } }, "additionalProperties": false, "description": "One audience subject configured for board AttentionSignals." }, "BoardAttentionSignalAudienceSubjectType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Role", "ItemResponsible", "StatusResponsible" ], "x-enum-descriptions": { "0": "Address the signal to a directly selected workspace role", "1": "Address the signal to the users currently responsible for the board item", "2": "Address the signal to the users currently responsible for the item's board status" } }, "BoardAttentionSignalPolicy": { "type": "object", "properties": { "Reasons": { "type": "array", "items": { "$ref": "#/components/schemas/BoardAttentionSignalPolicyReason" }, "nullable": true }, "Audience": { "type": "array", "items": { "$ref": "#/components/schemas/BoardAttentionSignalAudienceSubject" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Board AttentionSignal projection and delivery policy." }, "BoardAttentionSignalPolicyReason": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "AttentionSignalTypeKey": { "type": "string", "nullable": true }, "DefaultSeverity": { "$ref": "#/components/schemas/AttentionSignalSeverity" }, "SignalEnabled": { "type": "boolean" }, "NotificationDeliveryEnabled": { "type": "boolean" }, "SortOrder": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "One configured board AttentionSignal reason row." }, "BoardAttentionSignalPolicyReasonRequest": { "required": [ "AttentionSignalTypeKey" ], "type": "object", "properties": { "AttentionSignalTypeKey": { "type": "string", "description": "Required known board signal type key, such as \"boards.item.overdue\" or \"boards.item.blocked-by-child\". Unknown keys are rejected." }, "DefaultSeverity": { "$ref": "#/components/schemas/AttentionSignalSeverity" }, "SignalEnabled": { "type": "boolean", "description": "Whether signals of this type are projected for board items at all." }, "NotificationDeliveryEnabled": { "type": "boolean", "description": "Whether projected signals of this type also deliver notifications. Effective only while SignalEnabled is true; the stored value is forced to false when the signal is disabled." }, "SortOrder": { "type": "integer", "description": "Ordering of this reason row inside the policy.", "format": "int32" } }, "additionalProperties": false, "description": "One board AttentionSignal reason configuration row." }, "BoardCardFieldSourceKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ProviderField", "PrimaryEntityField" ], "x-enum-descriptions": { "0": "Read the card field value from the target provider's field catalog", "1": "Read the card field value from a field of the item's primary Entity Instance definition" } }, "BoardCardFieldValueType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Text", "Number", "DateTime", "Boolean", "Status", "Address" ], "x-enum-descriptions": { "0": "Render the card field value as plain text", "1": "Render the card field value as a numeric amount", "2": "Render the card field value as a date or date-time", "3": "Render the card field value as a yes/no flag", "4": "Render the card field value as a status-like enumerated label", "5": "Render the card field value as a structured address" } }, "BoardConstraint": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "BoardId": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "FailureMessage": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsEnabled": { "type": "boolean" }, "IsEnforcing": { "type": "boolean" }, "ActivationHealth": { "$ref": "#/components/schemas/BoardConstraintActivationHealth" }, "Bindings": { "type": "array", "items": { "$ref": "#/components/schemas/BoardConstraintBinding" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "One Board Constraint and its ordered applicability bindings." }, "BoardConstraintActivationHealth": { "type": "object", "properties": { "ConfigurationValid": { "type": "boolean" }, "RuntimeAvailable": { "type": "boolean" }, "CanEnable": { "type": "boolean" }, "Issues": { "type": "array", "items": { "$ref": "#/components/schemas/BoardConstraintConfigurationIssue" }, "nullable": true } }, "additionalProperties": false, "description": "Activation health aggregated for one Board Constraint." }, "BoardConstraintBinding": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "BoardConstraintId": { "type": "string", "nullable": true }, "TriggerType": { "$ref": "#/components/schemas/BoardConstraintTriggerType" }, "FromBoardStatusId": { "type": "string", "nullable": true }, "ToBoardStatusId": { "type": "string", "nullable": true }, "BoardStatusId": { "type": "string", "nullable": true }, "EvaluatorType": { "$ref": "#/components/schemas/BoardConstraintEvaluatorType" }, "LogicalOperator": { "$ref": "#/components/schemas/BoardConstraintLogicalOperator" }, "SortOrder": { "type": "integer", "format": "int32" }, "IsEnabled": { "type": "boolean" }, "IsEnforcing": { "type": "boolean" }, "ActivationHealth": { "$ref": "#/components/schemas/BoardConstraintBindingHealth" }, "Statements": { "type": "array", "items": { "$ref": "#/components/schemas/BoardConstraintBindingStatement" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "One Board Constraint trigger and Statement-set binding." }, "BoardConstraintBindingHealth": { "type": "object", "properties": { "ConfigurationValid": { "type": "boolean" }, "RuntimeAvailable": { "type": "boolean" }, "CanEnable": { "type": "boolean" }, "ReachableTargetDefinitionIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "UncoveredTargetDefinitionIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Issues": { "type": "array", "items": { "$ref": "#/components/schemas/BoardConstraintConfigurationIssue" }, "nullable": true } }, "additionalProperties": false, "description": "Activation health for one Board Constraint Binding." }, "BoardConstraintBindingHealthResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardConstraintBindingHealth" }, "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 }, "BoardConstraintBindingOrderRequest": { "type": "object", "properties": { "BoardConstraintBindingId": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "One Board Constraint Binding order row." }, "BoardConstraintBindingStatement": { "type": "object", "properties": { "BoardStatementId": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsEnabled": { "type": "boolean" }, "IsEventEligible": { "type": "boolean" }, "IsStatusInvariantEligible": { "type": "boolean" } }, "additionalProperties": false, "description": "One ordered Board Statement selected by a constraint binding." }, "BoardConstraintConfigurationIssue": { "type": "object", "properties": { "Code": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true }, "SubjectId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One safe localized Board Constraint configuration issue." }, "BoardConstraintEvaluatorType": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Statements" ], "x-enum-descriptions": { "0": "Evaluate an ordered non-empty set of reusable Board Statements" } }, "BoardConstraintListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BoardConstraint" }, "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 }, "BoardConstraintLogicalOperator": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "And", "Or" ], "x-enum-descriptions": { "0": "Require all applicable statements to pass", "1": "Require at least one applicable statement to pass" } }, "BoardConstraintOrderRequest": { "type": "object", "properties": { "BoardConstraintId": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "One Board Constraint order row." }, "BoardConstraintResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardConstraint" }, "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 }, "BoardConstraintTriggerType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Transition", "EnterStatus", "ExitStatus", "StatusInvariant" ], "x-enum-descriptions": { "0": "Evaluate one exact source-to-destination transition", "1": "Evaluate any mutation that enters one status", "2": "Evaluate any mutation that exits one status", "3": "Evaluate every governed mutation while an item is in one status" } }, "BoardCreateAttachmentPolicyOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/CreateAttachmentPolicy" }, "Name": { "type": "string", "description": "Enum name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable process attachment creation policy." }, "BoardCreateCommentPolicyOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/CreateCommentPolicy" }, "Name": { "type": "string", "description": "Enum name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable process comment creation policy." }, "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" } }, "BoardCycleActivationModeOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/BoardCycleActivationMode" }, "Name": { "type": "string", "description": "Enum name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable board cycle activation mode." }, "BoardDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Board id.", "nullable": true }, "Key": { "type": "string", "description": "Stable board key.", "nullable": true }, "DataEntityDefinitionId": { "type": "string", "description": "Owned Part EntityDefinition id used for board payload data.", "nullable": true }, "DisplayName": { "type": "string", "description": "Board display name.", "nullable": true }, "Description": { "type": "string", "description": "Board description.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether the board can be used for runtime process activity." }, "BoardType": { "$ref": "#/components/schemas/BoardType" }, "BoardCycleActivationMode": { "$ref": "#/components/schemas/BoardCycleActivationMode" }, "TagsEnabled": { "type": "boolean", "description": "Whether board item tags are enabled." }, "DueDatePolicy": { "$ref": "#/components/schemas/BoardDueDatePolicy" }, "AttentionSignalPolicy": { "$ref": "#/components/schemas/BoardAttentionSignalPolicy" }, "AllowedActions": { "$ref": "#/components/schemas/BoardAllowedActions" }, "TargetDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetDefinition" }, "description": "Canonical target definitions.", "nullable": true }, "Statuses": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatus" }, "description": "Board statuses.", "nullable": true }, "Transitions": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTransition" }, "description": "Board transition matrix rows.", "nullable": true }, "OpenItemCount": { "type": "integer", "description": "Number of open board items.", "format": "int32" }, "ItemCount": { "type": "integer", "description": "Total number of board items.", "format": "int32" }, "CycleCount": { "type": "integer", "description": "Total number of board cycles.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Board row version.", "format": "uuid" } }, "additionalProperties": false, "description": "Full board administration model." }, "BoardDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardDetail" }, "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 }, "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" } }, "BoardDueDatePolicy": { "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/BoardDueDateStatusExpectation" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Full board due-date administration policy." }, "BoardDueDateStatusExpectation": { "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" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Board due-date status expectation administration row." }, "BoardDueDateStatusExpectationRequest": { "required": [ "ExpectedBoardStatusId" ], "type": "object", "properties": { "ExpectedBoardStatusId": { "type": "string", "description": "Required id of an existing board status the item is expected to have reached. The expectation is satisfied when the item has reached this status by status sort order; otherwise the expectation severity may apply once the threshold is reached." }, "OffsetAmount": { "type": "integer", "description": "Non-negative amount of time before the item due date at which the expectation threshold is reached. Zero means the expectation applies at the due date itself.", "format": "int32" }, "OffsetUnit": { "$ref": "#/components/schemas/BoardDueDateOffsetUnit" }, "Severity": { "$ref": "#/components/schemas/AttentionSignalSeverity" }, "SortOrder": { "type": "integer", "description": "Ordering of this expectation row inside the due-date policy.", "format": "int32" } }, "additionalProperties": false, "description": "One due-date status expectation row." }, "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" } }, "BoardEntityTargetOption": { "type": "object", "properties": { "Id": { "type": "string", "description": "Entity definition id.", "nullable": true }, "Name": { "type": "string", "description": "Entity definition technical name.", "nullable": true }, "DisplayNameSingular": { "type": "string", "description": "Singular display name.", "nullable": true }, "DisplayNamePlural": { "type": "string", "description": "Plural display name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable entity definition for board setup." }, "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" } }, "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" } }, "BoardLifecycleRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Optional expected board row version.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Changes board active state." }, "BoardReadAttachmentPolicyOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/ReadAttachmentPolicy" }, "Name": { "type": "string", "description": "Enum name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable process attachment read policy." }, "BoardReadCommentPolicyOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/ReadCommentPolicy" }, "Name": { "type": "string", "description": "Enum name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable process comment read policy." }, "BoardResponsibilityGroupOption": { "type": "object", "properties": { "Id": { "type": "string", "description": "Group id.", "nullable": true }, "Name": { "type": "string", "description": "Group display name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable responsibility group for board setup." }, "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" } }, "BoardResponsibilitySubjectTypeOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/BoardResponsibilitySubjectType" }, "Name": { "type": "string", "description": "Enum name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable concrete responsibility subject type." }, "BoardRoleOption": { "type": "object", "properties": { "Id": { "type": "string", "description": "Role id.", "nullable": true }, "Name": { "type": "string", "description": "Role name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable workspace role for board setup." }, "BoardSecurityConfiguration": { "required": [ "Profiles", "RowVersion" ], "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid" }, "Profiles": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSecurityProfileConfiguration" } } }, "additionalProperties": false, "description": "Returns the complete Board Security configuration with one shared concurrency token." }, "BoardSecurityConfigurationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardSecurityConfiguration" }, "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 }, "BoardSecurityProfileConfiguration": { "required": [ "AssignmentRules", "InitialAssignmentRules", "PermissionAssignments", "ResourceKind", "Responsibilities", "SecurityStatements" ], "type": "object", "properties": { "ResourceKind": { "type": "string" }, "SecurityStatements": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityStatement" } }, "PermissionAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignment" } }, "Responsibilities": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityResponsibility" } }, "InitialAssignmentRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRule" } }, "AssignmentRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityAssignmentRule" } } }, "additionalProperties": false, "description": "Returns the current artifacts for one Board resource kind." }, "BoardStatement": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "BoardId": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "Expression": { "type": "string", "nullable": true }, "NormalizedExpression": { "type": "string", "nullable": true }, "EngineVersion": { "type": "string", "nullable": true }, "ProfileVersion": { "type": "integer", "format": "int32" }, "SchemaFingerprint": { "type": "string", "nullable": true }, "ProfileFingerprint": { "type": "string", "nullable": true }, "ExpressionFingerprint": { "type": "string", "nullable": true }, "ArtifactFingerprint": { "type": "string", "nullable": true }, "IsEventEligible": { "type": "boolean" }, "IsStatusInvariantEligible": { "type": "boolean" }, "SortOrder": { "type": "integer", "format": "int32" }, "IsEnabled": { "type": "boolean" }, "Dependencies": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatementDependency" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "One reusable Board Statement configured on a board." }, "BoardStatementAuthoring": { "type": "object", "properties": { "ProfileKey": { "type": "string", "nullable": true }, "ProfileVersion": { "type": "integer", "format": "int32" }, "EngineVersion": { "type": "string", "nullable": true }, "Roots": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatementAuthoringRoot" }, "nullable": true }, "Operators": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Variables": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Functions": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatementAuthoringFunction" }, "nullable": true }, "LiteralExamples": { "type": "array", "items": { "type": "string" }, "nullable": true }, "DiagnosticCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Examples": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Server-owned Board Statement authoring schema." }, "BoardStatementAuthoringCollection": { "type": "object", "properties": { "Path": { "type": "string", "nullable": true }, "ItemPaths": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatementAuthoringPath" }, "nullable": true }, "Description": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One collection available to EXISTS and COUNT." }, "BoardStatementAuthoringFunction": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "ArgumentFamilies": { "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "ResultFamilies": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Description": { "type": "string", "nullable": true }, "Example": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One function available in the Board Statement DSL profile." }, "BoardStatementAuthoringPath": { "type": "object", "properties": { "Path": { "type": "string", "nullable": true }, "ValueFamily": { "type": "string", "nullable": true }, "Nullable": { "type": "boolean" }, "Description": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One scalar Board Statement DSL path." }, "BoardStatementAuthoringResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardStatementAuthoring" }, "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 }, "BoardStatementAuthoringRoot": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Paths": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatementAuthoringPath" }, "nullable": true }, "Collections": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatementAuthoringCollection" }, "nullable": true } }, "additionalProperties": false, "description": "One root available in the Board Statement DSL profile." }, "BoardStatementComplexity": { "type": "object", "properties": { "NodeCount": { "type": "integer", "format": "int32" }, "MaximumDepth": { "type": "integer", "format": "int32" }, "MaximumPathSegments": { "type": "integer", "format": "int32" }, "MaximumCollectionItems": { "type": "integer", "format": "int32" }, "MaximumFunctionArguments": { "type": "integer", "format": "int32" }, "ExpressionUtf8Bytes": { "type": "integer", "format": "int32" }, "TokenCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Compiled Board Statement complexity metrics." }, "BoardStatementDependency": { "type": "object", "properties": { "Kind": { "type": "string", "nullable": true }, "DependencyId": { "type": "string", "nullable": true }, "Path": { "type": "string", "nullable": true }, "CollectionScope": { "type": "string", "nullable": true }, "IsStatusInvariantSafe": { "type": "boolean" } }, "additionalProperties": false, "description": "One bound Board Statement dependency." }, "BoardStatementDiagnostic": { "type": "object", "properties": { "Code": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true }, "Start": { "type": "integer", "format": "int32" }, "Length": { "type": "integer", "format": "int32" }, "Token": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One position-aware Board Statement DSL diagnostic." }, "BoardStatementListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatement" }, "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 }, "BoardStatementOrderRequest": { "type": "object", "properties": { "BoardStatementId": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "One Board Statement order row." }, "BoardStatementPreview": { "type": "object", "properties": { "Validation": { "$ref": "#/components/schemas/BoardStatementValidation" }, "Value": { "type": "boolean", "nullable": true }, "EvaluationErrorCode": { "type": "string", "nullable": true }, "EvaluationErrorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Result of evaluating a proposed Board Statement context." }, "BoardStatementPreviewResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardStatementPreview" }, "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 }, "BoardStatementResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardStatement" }, "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 }, "BoardStatementValidation": { "type": "object", "properties": { "Success": { "type": "boolean" }, "NormalizedExpression": { "type": "string", "nullable": true }, "EngineVersion": { "type": "string", "nullable": true }, "ProfileVersion": { "type": "integer", "format": "int32", "nullable": true }, "SchemaFingerprint": { "type": "string", "nullable": true }, "ProfileFingerprint": { "type": "string", "nullable": true }, "ExpressionFingerprint": { "type": "string", "nullable": true }, "ArtifactFingerprint": { "type": "string", "nullable": true }, "IsEventEligible": { "type": "boolean", "nullable": true }, "IsStatusInvariantEligible": { "type": "boolean", "nullable": true }, "Complexity": { "$ref": "#/components/schemas/BoardStatementComplexity" }, "Dependencies": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatementDependency" }, "nullable": true }, "Diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatementDiagnostic" }, "nullable": true } }, "additionalProperties": false, "description": "Result of validating and binding a Board Statement expression." }, "BoardStatementValidationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardStatementValidation" }, "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 }, "BoardStatus": { "type": "object", "properties": { "Id": { "type": "string", "description": "Status id.", "nullable": true }, "Key": { "type": "string", "description": "Optional stable status key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Status display name.", "nullable": true }, "Description": { "type": "string", "description": "Status description.", "nullable": true }, "Color": { "type": "string", "description": "Status visual color token.", "nullable": true }, "MetaType": { "$ref": "#/components/schemas/BoardStatusMetaType" }, "SortOrder": { "type": "integer", "description": "Display order.", "format": "int32" }, "IsActive": { "type": "boolean", "description": "Whether the status can receive board items." }, "IsDeleted": { "type": "boolean", "description": "Whether the status is retained only for history." }, "DeletedAtUtc": { "type": "string", "description": "Soft-delete timestamp.", "format": "date-time", "nullable": true }, "DeletedByUserId": { "type": "string", "description": "User id that soft-deleted the status.", "nullable": true }, "DeletedReason": { "type": "string", "description": "Soft-delete reason.", "nullable": true }, "CurrentItemCount": { "type": "integer", "description": "Current board items in this status.", "format": "int32" }, "HistoryReferenceCount": { "type": "integer", "description": "Movement history rows referencing this status.", "format": "int32" }, "AllowedActions": { "$ref": "#/components/schemas/BoardStatusAllowedActions" }, "RowVersion": { "type": "string", "description": "Status row version.", "format": "uuid" } }, "additionalProperties": false, "description": "Board status administration model." }, "BoardStatusAllowedActions": { "type": "object", "properties": { "CanUpdate": { "type": "boolean", "description": "Whether the status can be updated." }, "CanDelete": { "type": "boolean", "description": "Whether the status can be deleted." } }, "additionalProperties": false, "description": "Allowed actions for one board status." }, "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" } }, "BoardStatusMetaTypeOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/BoardStatusMetaType" }, "Name": { "type": "string", "description": "Enum name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable board status meta type." }, "BoardStatusOrderRequest": { "required": [ "StatusId" ], "type": "object", "properties": { "StatusId": { "type": "string", "description": "Status id." }, "SortOrder": { "type": "integer", "description": "New sort order.", "format": "int32" } }, "additionalProperties": false, "description": "One status order row." }, "BoardSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Board id.", "nullable": true }, "Key": { "type": "string", "description": "Stable board key.", "nullable": true }, "DataEntityDefinitionId": { "type": "string", "description": "Owned Part EntityDefinition id used for board payload data.", "nullable": true }, "DisplayName": { "type": "string", "description": "Board display name.", "nullable": true }, "Description": { "type": "string", "description": "Board description.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether the board can be used for runtime process activity." }, "BoardType": { "$ref": "#/components/schemas/BoardType" }, "BoardCycleActivationMode": { "$ref": "#/components/schemas/BoardCycleActivationMode" }, "TagsEnabled": { "type": "boolean", "description": "Whether board item tags are enabled." }, "DueDateEnabled": { "type": "boolean", "description": "Whether board due dates are enabled." }, "AllowedActions": { "$ref": "#/components/schemas/BoardAllowedActions" }, "TargetDefinitionCount": { "type": "integer", "description": "Number of attached target definitions.", "format": "int32" }, "StatusCount": { "type": "integer", "description": "Number of non-deleted statuses.", "format": "int32" }, "TransitionCount": { "type": "integer", "description": "Number of transitions.", "format": "int32" }, "OpenItemCount": { "type": "integer", "description": "Number of open board items.", "format": "int32" }, "ItemCount": { "type": "integer", "description": "Total number of board items.", "format": "int32" }, "CycleCount": { "type": "integer", "description": "Total number of board cycles.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Board row version.", "format": "uuid" } }, "additionalProperties": false, "description": "Board list item for administration screens." }, "BoardSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSummary" }, "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 }, "BoardTargetCardFieldCatalog": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "SourceKind": { "$ref": "#/components/schemas/BoardCardFieldSourceKind" }, "ValueType": { "$ref": "#/components/schemas/BoardCardFieldValueType" }, "Searchable": { "type": "boolean" } }, "additionalProperties": false, "description": "Provider-declared field that can be placed on compact board cards." }, "BoardTargetCardFieldCatalogListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetCardFieldCatalog" }, "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 }, "BoardTargetDefinition": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "TargetKind": { "$ref": "#/components/schemas/BoardTargetKind" }, "TargetModelId": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "RepeatPolicy": { "$ref": "#/components/schemas/BoardTargetRepeatPolicy" }, "CreateCommentPolicy": { "$ref": "#/components/schemas/CreateCommentPolicy" }, "ReadCommentPolicy": { "$ref": "#/components/schemas/ReadCommentPolicy" }, "CreateAttachmentPolicy": { "$ref": "#/components/schemas/CreateAttachmentPolicy" }, "ReadAttachmentPolicy": { "$ref": "#/components/schemas/ReadAttachmentPolicy" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Canonical board target definition." }, "BoardTargetDefinitionCardField": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "BoardStatusId": { "type": "string", "nullable": true }, "SourceKind": { "$ref": "#/components/schemas/BoardCardFieldSourceKind" }, "FieldKey": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "DisplayNameOverride": { "type": "string", "nullable": true }, "ValueType": { "$ref": "#/components/schemas/BoardCardFieldValueType" }, "SortOrder": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "One configured card field row." }, "BoardTargetDefinitionCardFieldRequest": { "required": [ "FieldKey", "SourceKind" ], "type": "object", "properties": { "BoardStatusId": { "type": "string", "description": "Optional board status scope. When set it must reference an existing status of the board and the field renders only for items in that status; null shows the field for all statuses.", "nullable": true }, "SourceKind": { "$ref": "#/components/schemas/BoardCardFieldSourceKind" }, "FieldKey": { "type": "string", "description": "Required key of the field for the chosen SourceKind. The SourceKind plus FieldKey pair must exist in the target definition's card field catalog." }, "DisplayNameOverride": { "type": "string", "description": "Optional display label override for the card field. Null keeps the catalog display name.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order of the field within its status scope.", "format": "int32" } }, "additionalProperties": false, "description": "One requested board target card field." }, "BoardTargetDefinitionCardFields": { "type": "object", "properties": { "BoardId": { "type": "string", "nullable": true }, "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetDefinitionCardField" }, "nullable": true } }, "additionalProperties": false, "description": "Configured card fields for one canonical board target definition." }, "BoardTargetDefinitionCardFieldsResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardTargetDefinitionCardFields" }, "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 }, "BoardTargetDefinitionInitialFieldMapping": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "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" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "One configured initial field mapping row." }, "BoardTargetDefinitionInitialFieldMappingRequest": { "required": [ "DestinationFieldKey", "SourceFieldKey" ], "type": "object", "properties": { "DestinationKind": { "$ref": "#/components/schemas/BoardInitialFieldMappingDestinationKind" }, "DestinationFieldKey": { "type": "string", "description": "Required key of the destination field. It must exist in the destination catalog for the DestinationKind; the due-date destination is available only while the board has a date-only due-date policy enabled." }, "SourceFieldKey": { "type": "string", "description": "Required key of a supported field on the primary table of the target Entity Definition. The source field type must be compatible with the destination field type." }, "SortOrder": { "type": "integer", "description": "Ordering of this mapping row within the target definition.", "format": "int32" } }, "additionalProperties": false, "description": "One requested initial field mapping." }, "BoardTargetDefinitionInitialFieldMappings": { "type": "object", "properties": { "BoardId": { "type": "string", "nullable": true }, "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" }, "Mappings": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetDefinitionInitialFieldMapping" }, "nullable": true } }, "additionalProperties": false, "description": "Configured initial field mappings for one canonical board target definition." }, "BoardTargetDefinitionInitialFieldMappingsResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardTargetDefinitionInitialFieldMappings" }, "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 }, "BoardTargetInitialFieldMappingCatalog": { "type": "object", "properties": { "BoardId": { "type": "string", "nullable": true }, "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "SourceFields": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetInitialFieldMappingSourceField" }, "nullable": true }, "DestinationFields": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetInitialFieldMappingDestinationField" }, "nullable": true } }, "additionalProperties": false, "description": "Catalog of fields that can participate in initial board target mappings." }, "BoardTargetInitialFieldMappingCatalogResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardTargetInitialFieldMappingCatalog" }, "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 }, "BoardTargetInitialFieldMappingDestinationField": { "type": "object", "properties": { "DestinationKind": { "$ref": "#/components/schemas/BoardInitialFieldMappingDestinationKind" }, "FieldKey": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" } }, "additionalProperties": false, "description": "Board-owned destination field available for initial board target mappings." }, "BoardTargetInitialFieldMappingSourceField": { "type": "object", "properties": { "FieldKey": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" } }, "additionalProperties": false, "description": "Source Entity Instance field available for initial board target mappings." }, "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" } }, "BoardTargetRepeatPolicy": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "AllowNewPass", "ReopenTerminalOnly", "DenyAfterTerminal" ], "x-enum-descriptions": { "0": "Permit reopening the latest terminal item or starting a new process pass", "1": "Permit only reopening the latest terminal item, never a new process pass", "2": "Block any further process pass once the latest item is terminal" } }, "BoardTargetRepeatPolicyOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/BoardTargetRepeatPolicy" }, "Name": { "type": "string", "description": "Enum name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable board target repeat policy." }, "BoardTransition": { "type": "object", "properties": { "Id": { "type": "string", "description": "Transition id.", "nullable": true }, "Key": { "type": "string", "description": "Optional stable transition key.", "nullable": true }, "FromBoardStatusId": { "type": "string", "description": "Source status id.", "nullable": true }, "ToBoardStatusId": { "type": "string", "description": "Target status id.", "nullable": true }, "DisplayName": { "type": "string", "description": "Transition display name.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order within the source status.", "format": "int32" }, "IsActive": { "type": "boolean", "description": "Whether the transition is available." }, "AllowedActions": { "$ref": "#/components/schemas/BoardTransitionAllowedActions" }, "RowVersion": { "type": "string", "description": "Transition row version.", "format": "uuid" }, "LinkPrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTransitionLinkPrerequisite" }, "description": "Required active-link scopes for this transition.", "nullable": true } }, "additionalProperties": false, "description": "Board transition administration model." }, "BoardTransitionAllowedActions": { "type": "object", "properties": { "CanUpdate": { "type": "boolean", "description": "Whether the transition can be updated." }, "CanDelete": { "type": "boolean", "description": "Whether the transition can be deleted." } }, "additionalProperties": false, "description": "Allowed actions for one board transition." }, "BoardTransitionLinkPrerequisite": { "type": "object", "properties": { "Id": { "type": "string", "description": "Prerequisite id.", "nullable": true }, "LinkType": { "$ref": "#/components/schemas/BoardItemLinkTypeSystemKind" }, "Direction": { "$ref": "#/components/schemas/BoardItemLinkDirection" }, "TargetBoardId": { "type": "string", "description": "Required target board id.", "nullable": true }, "TargetBoardTargetDefinitionId": { "type": "string", "description": "Required target definition id.", "nullable": true }, "MinimumCount": { "type": "integer", "description": "Minimum matching active-link count.", "format": "int32" }, "MaximumCount": { "type": "integer", "description": "Optional maximum matching active-link count.", "format": "int32", "nullable": true }, "RowVersion": { "type": "string", "description": "Prerequisite row version.", "format": "uuid" } }, "additionalProperties": false, "description": "One configured active-link prerequisite for a board transition." }, "BoardTransitionLinkPrerequisiteRequest": { "required": [ "TargetBoardId", "TargetBoardTargetDefinitionId" ], "type": "object", "properties": { "LinkType": { "$ref": "#/components/schemas/BoardItemLinkTypeSystemKind" }, "Direction": { "$ref": "#/components/schemas/BoardItemLinkDirection" }, "TargetBoardId": { "type": "string", "description": "Board that must own the item at the other end of the link." }, "TargetBoardTargetDefinitionId": { "type": "string", "description": "Target definition that must own the item at the other end of the link." }, "MinimumCount": { "type": "integer", "description": "Minimum matching active-link count. Must be at least one.", "format": "int32" }, "MaximumCount": { "type": "integer", "description": "Optional maximum matching active-link count.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "One active-link prerequisite for a board transition." }, "BoardTransitionOrderRequest": { "required": [ "TransitionId" ], "type": "object", "properties": { "TransitionId": { "type": "string", "description": "Transition id." }, "SortOrder": { "type": "integer", "description": "New sort order.", "format": "int32" } }, "additionalProperties": false, "description": "One transition order row." }, "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" } }, "BoardTypeOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/BoardType" }, "Name": { "type": "string", "description": "Enum name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable board runtime type." }, "BoardUserOption": { "type": "object", "properties": { "Id": { "type": "string", "description": "User id.", "nullable": true }, "Name": { "type": "string", "description": "User display name.", "nullable": true } }, "additionalProperties": false, "description": "Selectable workspace user for board setup." }, "BoardsAdministrationAllowedActions": { "type": "object", "properties": { "CanEnable": { "type": "boolean", "description": "Whether the module can be enabled." }, "CanDisable": { "type": "boolean", "description": "Whether the module can be disabled." }, "CanCreateBoard": { "type": "boolean", "description": "Whether a board can be created." } }, "additionalProperties": false, "description": "Allowed administration actions for the Boards module." }, "BoardsAdministrationDetail": { "type": "object", "properties": { "Summary": { "$ref": "#/components/schemas/BoardsAdministrationSummary" }, "Boards": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSummary" }, "description": "Configured boards.", "nullable": true } }, "additionalProperties": false, "description": "Administration detail for the Boards module." }, "BoardsAdministrationDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardsAdministrationDetail" }, "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 }, "BoardsAdministrationSetup": { "type": "object", "properties": { "EntityDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/BoardEntityTargetOption" }, "description": "Selectable entity definitions.", "nullable": true }, "Roles": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRoleOption" }, "description": "Selectable workspace roles.", "nullable": true }, "Users": { "type": "array", "items": { "$ref": "#/components/schemas/BoardUserOption" }, "description": "Selectable workspace users.", "nullable": true }, "ResponsibilityGroups": { "type": "array", "items": { "$ref": "#/components/schemas/BoardResponsibilityGroupOption" }, "description": "Selectable workspace responsibility groups.", "nullable": true }, "StatusMetaTypes": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatusMetaTypeOption" }, "description": "Supported status meta types.", "nullable": true }, "BoardTypes": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTypeOption" }, "description": "Supported board runtime types.", "nullable": true }, "BoardCycleActivationModes": { "type": "array", "items": { "$ref": "#/components/schemas/BoardCycleActivationModeOption" }, "description": "Supported cycle activation modes.", "nullable": true }, "ResponsibilitySubjectTypes": { "type": "array", "items": { "$ref": "#/components/schemas/BoardResponsibilitySubjectTypeOption" }, "description": "Supported responsibility assignment subject types.", "nullable": true }, "TargetRepeatPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetRepeatPolicyOption" }, "description": "Supported target repeat policies.", "nullable": true }, "CreateCommentPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/BoardCreateCommentPolicyOption" }, "description": "Supported process comment creation policies.", "nullable": true }, "ReadCommentPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/BoardReadCommentPolicyOption" }, "description": "Supported process comment read policies.", "nullable": true }, "CreateAttachmentPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/BoardCreateAttachmentPolicyOption" }, "description": "Supported process attachment creation policies.", "nullable": true }, "ReadAttachmentPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/BoardReadAttachmentPolicyOption" }, "description": "Supported process attachment read policies.", "nullable": true } }, "additionalProperties": false, "description": "Board administration setup model." }, "BoardsAdministrationSetupResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BoardsAdministrationSetup" }, "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 }, "BoardsAdministrationSummary": { "type": "object", "properties": { "ModuleKey": { "type": "string", "description": "Stable module key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Module display name.", "nullable": true }, "Description": { "type": "string", "description": "Module description.", "nullable": true }, "IsEnabled": { "type": "boolean", "description": "Whether the module is enabled." }, "EnabledAtUtc": { "type": "string", "description": "Timestamp when the module was enabled.", "format": "date-time", "nullable": true }, "DisabledAtUtc": { "type": "string", "description": "Timestamp when the module was disabled.", "format": "date-time", "nullable": true }, "DisabledReason": { "type": "string", "description": "Latest disable reason.", "nullable": true }, "RowVersion": { "type": "string", "description": "Module lifecycle row version.", "format": "uuid" }, "AllowedActions": { "$ref": "#/components/schemas/BoardsAdministrationAllowedActions" }, "BoardCount": { "type": "integer", "description": "Total configured board count.", "format": "int32" }, "ActiveBoardCount": { "type": "integer", "description": "Active board count.", "format": "int32" } }, "additionalProperties": false, "description": "Administration summary for the Boards module." }, "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 }, "BusinessFunctionActionBinding": { "type": "object", "properties": { "Id": { "type": "string", "description": "Action identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Bound business function identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier for entity-scoped action targets.", "nullable": true }, "EntityUiSurfaceModelId": { "type": "string", "description": "Entity UI surface model identifier when bound to a concrete surface.", "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", "description": "Action order within the placement.", "format": "int32" }, "IsEnabled": { "type": "boolean", "description": "Whether the binding is enabled." }, "Label": { "type": "string", "description": "Optional label override.", "nullable": true }, "Icon": { "type": "string", "description": "Optional icon override.", "nullable": true }, "Color": { "type": "string", "description": "Vuetify color token.", "nullable": true }, "Variant": { "type": "string", "description": "Vuetify variant token.", "nullable": true }, "PermissionKey": { "type": "string", "description": "Optional action-specific permission gate.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Designer-owned action connecting a business function to a compatible UI surface context." }, "BusinessFunctionActionBindingListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionActionBinding" }, "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 }, "BusinessFunctionActionBindingResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionActionBinding" }, "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 }, "BusinessFunctionActionDesigner": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "nullable": true }, "Surface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "Actions": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionActionBinding" }, "nullable": true }, "AvailableFunctions": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionSummary" }, "nullable": true }, "SupportedSurfaces": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySurfaceType" }, "nullable": true }, "SupportedTargetScopes": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "nullable": true }, "SupportedPlacements": { "type": "array", "items": { "$ref": "#/components/schemas/ActionPlacement" }, "nullable": true }, "SupportedToolbarPresentations": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiActionToolbarPresentation" }, "nullable": true }, "SupportedColors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "SupportedVariants": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Designer payload for configuring function-backed UI actions on one entity definition." }, "BusinessFunctionActionDesignerResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionActionDesigner" }, "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 }, "BusinessFunctionActionInputHistory": { "type": "object", "properties": { "HasInput": { "type": "boolean", "description": "Whether the action version accepts input fields." }, "MetadataValid": { "type": "boolean", "description": "Whether schema, card metadata, and input snapshot could be parsed." }, "Warnings": { "type": "array", "items": { "type": "string" }, "description": "Non-fatal warnings produced while materializing history.", "nullable": true }, "RedactedInputSnapshot": { "type": "string", "description": "Redacted input JSON snapshot.", "nullable": true }, "InputSchemaPayload": { "type": "string", "description": "Executed-version input schema JSON payload, including its versioned nullability and default metadata.", "nullable": true }, "InputCardPayload": { "type": "string", "description": "Executed-version input-history Card JSON payload.", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionActionInputHistoryField" }, "description": "Materialized field display values keyed by CLR property name.", "nullable": true } }, "additionalProperties": false, "description": "Versioned, redacted action input history prepared for operations UI rendering." }, "BusinessFunctionActionInputHistoryField": { "type": "object", "properties": { "PropertyName": { "type": "string", "description": "CLR property name used as the input JSON key.", "nullable": true }, "Key": { "type": "string", "description": "Stable field key from action input metadata.", "nullable": true }, "Label": { "type": "string", "description": "User-facing field label from executed-version metadata.", "nullable": true }, "FieldType": { "type": "string", "description": "Normalized action input field type name.", "nullable": true }, "Sensitive": { "type": "boolean", "description": "Whether the value is sensitive and redacted." }, "AllowMultiple": { "type": "boolean", "description": "Whether the value can contain multiple items." }, "RawValueJson": { "type": "string", "description": "Redacted raw JSON value for diagnostics.", "nullable": true }, "DisplayValue": { "type": "string", "description": "Resolved single display value.", "nullable": true }, "DisplayValues": { "type": "array", "items": { "type": "string" }, "description": "Resolved display values for multi-value fields.", "nullable": true } }, "additionalProperties": false, "description": "One materialized action input field value for history rendering." }, "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" } }, "BusinessFunctionApiPublication": { "type": "object", "properties": { "Id": { "type": "string", "description": "Publication row identifier.", "nullable": true }, "Kind": { "$ref": "#/components/schemas/BusinessFunctionApiPublicationKind" }, "Key": { "type": "string", "description": "Callable function key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Function display name.", "nullable": true }, "Description": { "type": "string", "description": "Function description.", "nullable": true }, "PermissionKey": { "type": "string", "description": "Permission key required to invoke the publication, when configured.", "nullable": true }, "AllowAnyAuthenticatedUser": { "type": "boolean", "description": "Whether every authenticated workspace user may invoke the publication." }, "TimeoutSeconds": { "type": "integer", "description": "Optional synchronous timeout override for command publications.", "format": "int32", "nullable": true }, "IsEnabled": { "type": "boolean", "description": "Admin-owned kill switch." }, "IsRetired": { "type": "boolean", "description": "Whether the source function disappeared from the active descriptors." }, "BusinessFunctionId": { "type": "string", "description": "Published function identifier.", "nullable": true }, "FunctionName": { "type": "string", "description": "Published function display name.", "nullable": true }, "CreatedAt": { "type": "string", "description": "Row creation timestamp.", "format": "date-time" }, "ModifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Optimistic concurrency token.", "format": "uuid" } }, "description": "Administration view of a command or API enqueue publication." }, "BusinessFunctionApiPublicationKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Command", "Enqueue" ], "x-enum-descriptions": { "0": "Publish the function as a synchronous API call that runs the function and returns its result in the response", "1": "Publish the function as an API call that enqueues a background job and returns without waiting for execution" } }, "BusinessFunctionApiPublicationListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionApiPublication" }, "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 }, "BusinessFunctionApiPublicationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionApiPublication" }, "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 }, "BusinessFunctionBinding": { "type": "object", "properties": { "Id": { "type": "string", "description": "Binding identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Bound function identifier.", "nullable": true }, "Source": { "$ref": "#/components/schemas/BusinessFunctionBindingSource" }, "Operation": { "$ref": "#/components/schemas/BusinessFunctionBindingOperation" }, "SortOrder": { "type": "integer", "description": "Execution order within the source and operation.", "format": "int32" }, "IsEnabled": { "type": "boolean", "description": "Whether the binding is enabled." }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "description": "Entity-bound business function binding." }, "BusinessFunctionBindingListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionBinding" }, "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 }, "BusinessFunctionBindingOperation": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Create", "Update", "Archive", "Restore", "Delete" ], "x-enum-descriptions": { "0": "Run the bound function when a new entity record is created", "1": "Run the bound function when an existing entity record is updated", "2": "Run the bound function when an entity record is archived", "3": "Run the bound function when an archived entity record is restored", "4": "Run the bound function when an entity record is deleted" } }, "BusinessFunctionBindingSource": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "EntitySave", "EntityTrigger" ], "x-enum-descriptions": { "0": "Binding comes from the entity save pipeline, running validation or before-save mutation while the record is persisted", "1": "Binding comes from a committed entity lifecycle trigger event, running the handler after the change is saved" } }, "BusinessFunctionBindingSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Binding identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "EntityName": { "type": "string", "description": "Stable entity definition name.", "nullable": true }, "EntityDisplayNameSingular": { "type": "string", "description": "Singular display name for the entity.", "nullable": true }, "EntityDisplayNamePlural": { "type": "string", "description": "Plural display name for the entity.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Bound function identifier.", "nullable": true }, "BusinessFunctionKey": { "type": "string", "description": "Stable function key.", "nullable": true }, "BusinessFunctionName": { "type": "string", "description": "User-facing function name.", "nullable": true }, "PublishedContract": { "$ref": "#/components/schemas/BusinessFunctionContract" }, "Source": { "$ref": "#/components/schemas/BusinessFunctionBindingSource" }, "Operation": { "$ref": "#/components/schemas/BusinessFunctionBindingOperation" }, "SortOrder": { "type": "integer", "description": "Execution order within the source and operation.", "format": "int32" }, "IsEnabled": { "type": "boolean", "description": "Whether the binding is enabled." }, "LastRunStatus": { "$ref": "#/components/schemas/BusinessFunctionRunStatus" }, "LastRunStartedAt": { "type": "string", "description": "Most recent run start timestamp associated with this binding.", "format": "date-time", "nullable": true }, "LastJobStatus": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" }, "LastJobCreatedAt": { "type": "string", "description": "Most recent queued job creation timestamp associated with this binding.", "format": "date-time", "nullable": true }, "LastJobNextRunAt": { "type": "string", "description": "Most recent queued job next-run timestamp associated with this binding.", "format": "date-time", "nullable": true }, "LastError": { "type": "string", "description": "Most recent run or job error summary associated with this binding.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "description": "Administrative summary for a configured business-function binding." }, "BusinessFunctionBindingSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionBindingSummary" }, "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 }, "BusinessFunctionCancellationKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "Queued", "IsolatedProcess" ], "x-enum-descriptions": { "0": "Cancellation is not available for the job in its current state", "1": "Cancel by removing the job from the queue before a worker leases it", "2": "Cancel a leased run by stopping its isolated worker process" } }, "BusinessFunctionContract": { "enum": [ 0, 1, 2, 3, 5, 6, 7 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Validation", "BeforeSaveMutation", "Action", "Job", "TriggerHandler", "HttpEndpoint", "Command" ], "x-enum-descriptions": { "0": "Checks a record before save and rejects the save when the data is invalid", "1": "Adjusts record field values before the save is persisted", "2": "Runs an operation explicitly invoked by a user", "3": "Runs as queued background work executed by a worker", "5": "Runs after a committed entity lifecycle event", "6": "Handles an inbound HTTP webhook request", "7": "Handles a synchronous request/response invocation through the workspace commands API" } }, "BusinessFunctionDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Function identifier.", "nullable": true }, "Key": { "type": "string", "description": "Stable function key.", "nullable": true }, "Name": { "type": "string", "description": "User-facing function name.", "nullable": true }, "Description": { "type": "string", "description": "Optional description.", "nullable": true }, "Kind": { "$ref": "#/components/schemas/BusinessFunctionKind" }, "EntityDefinitionId": { "type": "string", "description": "Owning entity definition for entity functions.", "nullable": true }, "IsEnabled": { "type": "boolean", "description": "Whether the function can be invoked by future runtime slices." }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "ModifiedAt": { "type": "string", "description": "Last metadata modification timestamp.", "format": "date-time", "nullable": true }, "ModifiedByUserId": { "type": "string", "description": "Last modifying user identifier.", "nullable": true }, "CurrentPublishedVersion": { "$ref": "#/components/schemas/BusinessFunctionVersion" }, "Versions": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionVersion" }, "description": "Function versions ordered by version number.", "nullable": true }, "Bindings": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionBinding" }, "description": "Entity bindings that reference this function.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "description": "Administrative business function detail." }, "BusinessFunctionDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionDetail" }, "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 }, "BusinessFunctionExecutionResult": { "type": "object", "properties": { "RunId": { "type": "string", "description": "Persisted run identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Function identifier.", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "description": "Executed function version identifier.", "nullable": true }, "Source": { "type": "string", "description": "Execution source.", "nullable": true }, "ActorUserId": { "type": "string", "description": "Actor user identifier.", "nullable": true }, "CorrelationId": { "type": "string", "description": "Correlation identifier.", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionRunStatus" }, "StartedAt": { "type": "string", "description": "Execution start timestamp.", "format": "date-time" }, "CompletedAt": { "type": "string", "description": "Execution completion timestamp.", "format": "date-time", "nullable": true }, "DurationMs": { "type": "integer", "description": "Execution 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 }, "LogSummary": { "type": "string", "description": "Bounded diagnostic log summary.", "nullable": true }, "ValidationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionValidationError" }, "description": "Structured validation errors produced by a Validation contract.", "nullable": true }, "MutationOutput": { "$ref": "#/components/schemas/BusinessFunctionMutationOutput" }, "FailureReasonCode": { "type": "string", "description": "Stable machine-readable reason code for a platform or runtime failure.", "nullable": true }, "SourceNetOperationProjectRevisionId": { "type": "string", "description": "Net Operation Project source revision captured for this execution.", "nullable": true }, "SourceNetOperationProjectBuildId": { "type": "string", "description": "Net Operation Project build captured for this execution.", "nullable": true }, "SourceNetOperationProjectArtifactId": { "type": "string", "description": "Net Operation Project artifact captured by the published function version.", "nullable": true }, "ResolvedNetOperationProjectArtifactId": { "type": "string", "description": "Net Operation Project artifact selected before runtime activation.", "nullable": true } }, "description": "Business function execution result." }, "BusinessFunctionExecutionResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionExecutionResult" }, "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 }, "BusinessFunctionHttpBodyMode": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Json", "Raw", "FormUrlEncoded", "Multipart" ], "x-enum-descriptions": { "0": "Parse the request body as JSON and expose it as a structured payload", "1": "Pass the raw request body bytes to the function without parsing", "2": "Parse the request body as form URL-encoded key/value pairs", "3": "Multipart request body handling reserved for future use and rejected in V1" } }, "BusinessFunctionHttpEndpointActorMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "AuthenticatedUser", "ConfiguredServiceUser" ], "x-enum-descriptions": { "0": "Execute the endpoint as the authenticated user resolved from the request", "1": "Execute the endpoint as the service user configured for the endpoint" } }, "BusinessFunctionHttpEndpointAuthMode": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "WorkspaceBearer", "Anonymous", "SharedSecretHeader", "HmacSignature" ], "x-enum-descriptions": { "0": "Require a workspace bearer token or API key on the incoming request", "1": "Accept unauthenticated requests and run as the configured service user when explicitly enabled", "2": "Require a configured shared secret value in a request header", "3": "Require an HMAC signature over the raw body validated within a timestamp tolerance" } }, "BusinessFunctionHttpEndpointDetail": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "RouteTemplate": { "type": "string", "nullable": true }, "AllowedMethods": { "type": "integer", "format": "int32" }, "BusinessFunctionId": { "type": "string", "nullable": true }, "BusinessFunctionKey": { "type": "string", "nullable": true }, "BusinessFunctionName": { "type": "string", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "nullable": true }, "VersionResolutionMode": { "$ref": "#/components/schemas/BusinessFunctionVersionResolutionMode" }, "IsEnabled": { "type": "boolean" }, "DescriptorBodyMode": { "$ref": "#/components/schemas/BusinessFunctionHttpBodyMode" }, "DescriptorAuthMode": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointAuthMode" }, "DescriptorActorMode": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointActorMode" }, "BodyMode": { "$ref": "#/components/schemas/BusinessFunctionHttpBodyMode" }, "AuthMode": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointAuthMode" }, "ActorMode": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointActorMode" }, "ActorUserId": { "type": "string", "nullable": true }, "SharedSecretHeaderName": { "type": "string", "nullable": true }, "HmacSignatureHeaderName": { "type": "string", "nullable": true }, "HmacTimestampHeaderName": { "type": "string", "nullable": true }, "HmacTimestampToleranceSeconds": { "type": "integer", "format": "int32" }, "MaxBodyBytes": { "type": "integer", "format": "int32" }, "MaxFormFieldCount": { "type": "integer", "format": "int32" }, "MaxFormKeyLength": { "type": "integer", "format": "int32" }, "MaxFormValueLength": { "type": "integer", "format": "int32" }, "Secrets": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointSecretSummary" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "description": "Detailed HTTP endpoint function configuration." }, "BusinessFunctionHttpEndpointDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointDetail" }, "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 }, "BusinessFunctionHttpEndpointSecretCreated": { "type": "object", "properties": { "Secret": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointSecretSummary" }, "PlaintextSecret": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Created or rotated HTTP endpoint secret. Plaintext is returned only once." }, "BusinessFunctionHttpEndpointSecretCreatedResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointSecretCreated" }, "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 }, "BusinessFunctionHttpEndpointSecretPurpose": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "SharedSecretHeader", "HmacSignature" ], "x-enum-descriptions": { "0": "Secret compared against the shared secret header on incoming requests", "1": "Secret used as the key for validating HMAC signatures of incoming requests" } }, "BusinessFunctionHttpEndpointSecretSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Purpose": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointSecretPurpose" }, "VersionNumber": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "RetiredAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Secret metadata for an HTTP endpoint function. The secret value is never included here." }, "BusinessFunctionHttpEndpointSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "RouteTemplate": { "type": "string", "nullable": true }, "AllowedMethods": { "type": "integer", "format": "int32" }, "BusinessFunctionId": { "type": "string", "nullable": true }, "BusinessFunctionKey": { "type": "string", "nullable": true }, "BusinessFunctionName": { "type": "string", "nullable": true }, "IsEnabled": { "type": "boolean" }, "BodyMode": { "$ref": "#/components/schemas/BusinessFunctionHttpBodyMode" }, "AuthMode": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointAuthMode" }, "ActorMode": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointActorMode" }, "ActorUserId": { "type": "string", "nullable": true }, "HasActiveSharedSecret": { "type": "boolean" }, "HasActiveHmacSecret": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Summary row for a discovered HTTP endpoint function." }, "BusinessFunctionHttpEndpointSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointSummary" }, "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 }, "BusinessFunctionHttpRunDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "HTTP run detail identifier.", "nullable": true }, "BusinessFunctionRunId": { "type": "string", "description": "Parent business-function run identifier.", "nullable": true }, "BusinessFunctionHttpEndpointId": { "type": "string", "description": "Configured HTTP endpoint identifier, when available.", "nullable": true }, "EndpointKey": { "type": "string", "description": "Inbound endpoint key.", "nullable": true }, "Method": { "type": "string", "description": "HTTP method.", "nullable": true }, "Path": { "type": "string", "description": "Path suffix after the endpoint key.", "nullable": true }, "ContentType": { "type": "string", "description": "Request content type, when supplied.", "nullable": true }, "ContentLength": { "type": "integer", "description": "Request content length, when supplied.", "format": "int64", "nullable": true }, "BodyMode": { "$ref": "#/components/schemas/BusinessFunctionHttpBodyMode" }, "AuthMode": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointAuthMode" }, "ActorMode": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointActorMode" }, "AuthResult": { "type": "string", "description": "Authentication outcome captured by the endpoint runtime.", "nullable": true }, "HttpStatusCode": { "type": "integer", "description": "HTTP status code returned to the caller.", "format": "int32", "nullable": true }, "ResponseContentType": { "type": "string", "description": "Response content type returned to the caller.", "nullable": true }, "ResponseBodyBytes": { "type": "integer", "description": "Response body size in bytes.", "format": "int32", "nullable": true }, "RedactedHeaders": { "type": "object", "description": "Redacted request headers.", "nullable": true }, "RedactedQuery": { "type": "object", "description": "Redacted request query values.", "nullable": true }, "FormSummary": { "type": "object", "description": "Redacted form-url-encoded request summary.", "nullable": true }, "PlatformFailureCode": { "type": "string", "description": "Platform-level failure code before handler execution, when any.", "nullable": true } }, "additionalProperties": false, "description": "HTTP-specific operational metadata captured for one endpoint run." }, "BusinessFunctionJob": { "type": "object", "properties": { "Id": { "type": "string", "description": "Queued run identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Queued function identifier.", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "description": "Captured function version identifier.", "nullable": true }, "VersionResolutionMode": { "$ref": "#/components/schemas/BusinessFunctionVersionResolutionMode" }, "Status": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" }, "Source": { "type": "string", "description": "Execution source.", "nullable": true }, "DeduplicationKey": { "type": "string", "description": "Optional deduplication key.", "nullable": true }, "Priority": { "type": "integer", "description": "Queue priority; lower numbers run first.", "format": "int32" }, "AttemptCount": { "type": "integer", "description": "Execution attempt count.", "format": "int32" }, "CreatedAt": { "type": "string", "description": "Timestamp when the run was queued.", "format": "date-time" }, "NextRunAt": { "type": "string", "description": "Next eligible run timestamp.", "format": "date-time" }, "ActorUserId": { "type": "string", "description": "Original actor user identifier, when any.", "nullable": true }, "OriginalUserId": { "type": "string", "description": "Source user identifier when the worker runs under a different actor.", "nullable": true }, "CorrelationId": { "type": "string", "description": "Correlation identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Related entity definition identifier.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Related entity instance identifier.", "nullable": true }, "EntityOperation": { "type": "string", "description": "Related entity operation.", "nullable": true }, "TriggerBindingId": { "type": "string", "description": "Trigger binding identifier, when this run came from a trigger.", "nullable": true }, "ScheduleId": { "type": "string", "description": "Schedule identifier, when this run came from a schedule.", "nullable": true }, "ActionId": { "type": "string", "description": "Action binding identifier, when this run came from an action.", "nullable": true }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "ActionInputSnapshot": { "type": "string", "description": "Action input JSON snapshot.", "nullable": true }, "ActionSelectedEntityIdsSnapshot": { "type": "string", "description": "Selected entity ids JSON snapshot for selection actions.", "nullable": true }, "LastError": { "type": "string", "description": "Last execution error summary.", "nullable": true }, "CancellationRequestedAt": { "type": "string", "description": "Timestamp when cancellation was requested.", "format": "date-time", "nullable": true }, "CancellationRequestedByUserId": { "type": "string", "description": "User that requested cancellation.", "nullable": true }, "CancellationObservedAt": { "type": "string", "description": "Timestamp when cancellation was observed by the worker.", "format": "date-time", "nullable": true }, "CanCancel": { "type": "boolean", "description": "Whether the queued run can be cancelled manually." }, "CancellationKind": { "$ref": "#/components/schemas/BusinessFunctionCancellationKind" }, "TimeoutSeconds": { "type": "integer", "description": "Optional source-owned timeout captured for schedule or API-enqueue runs.", "format": "int32", "nullable": true }, "LastFailureReasonCode": { "type": "string", "description": "Stable machine-readable reason code for the latest failed attempt.", "nullable": true }, "SourceNetOperationProjectRevisionId": { "type": "string", "description": "Net Operation Project source revision captured for this job.", "nullable": true }, "SourceNetOperationProjectBuildId": { "type": "string", "description": "Net Operation Project build captured for this job.", "nullable": true }, "SourceNetOperationProjectArtifactId": { "type": "string", "description": "Net Operation Project artifact captured for this job.", "nullable": true }, "EffectiveMaxAttempts": { "type": "integer", "description": "Maximum attempts captured when this job was enqueued.", "format": "int32", "nullable": true }, "RetryDelaySeconds": { "type": "integer", "description": "Retry delay captured when this job was enqueued.", "format": "int32", "nullable": true }, "RemainingAttempts": { "type": "integer", "description": "Attempts still available after the current attempt.", "format": "int32" }, "WillRetry": { "type": "boolean", "description": "Whether the persisted policy permits a later attempt." }, "CanStopRetries": { "type": "boolean", "description": "Whether the administrator can stop this retry chain." }, "RetryStopState": { "$ref": "#/components/schemas/BusinessFunctionRetryStopState" }, "CancellationReasonCode": { "type": "string", "description": "Stable reason for the accepted retry stop.", "nullable": true }, "CurrentAttempt": { "type": "integer", "description": "Current one-based execution attempt; zero means the initial attempt has not started.", "format": "int32", "readOnly": true } }, "description": "Queued function run summary." }, "BusinessFunctionJobDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Queued run identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Function identifier.", "nullable": true }, "BusinessFunctionKey": { "type": "string", "description": "Function key.", "nullable": true }, "BusinessFunctionName": { "type": "string", "description": "Function display name.", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "description": "Captured function version identifier.", "nullable": true }, "VersionNumber": { "type": "integer", "description": "Captured function version number.", "format": "int32", "nullable": true }, "VersionResolutionMode": { "$ref": "#/components/schemas/BusinessFunctionVersionResolutionMode" }, "Status": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" }, "Source": { "type": "string", "description": "Execution source.", "nullable": true }, "DeduplicationKey": { "type": "string", "description": "Optional deduplication key.", "nullable": true }, "TargetKey": { "type": "string", "description": "Computed action target key when available.", "nullable": true }, "AttemptCount": { "type": "integer", "description": "Execution attempt count.", "format": "int32" }, "Priority": { "type": "integer", "description": "Queue priority; lower numbers run first.", "format": "int32" }, "NextRunAt": { "type": "string", "description": "Next eligible run timestamp.", "format": "date-time" }, "LeaseExpiresAt": { "type": "string", "description": "Lease expiration timestamp, when leased.", "format": "date-time", "nullable": true }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "ModifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time", "nullable": true }, "LastError": { "type": "string", "description": "Last execution error summary.", "nullable": true }, "CorrelationId": { "type": "string", "description": "Correlation identifier.", "nullable": true }, "ActorUserId": { "type": "string", "description": "Effective actor user identifier, when any.", "nullable": true }, "OriginalUserId": { "type": "string", "description": "Original user identifier, when any.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Related entity definition identifier.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Related entity instance identifier.", "nullable": true }, "EntityOperation": { "type": "string", "description": "Related entity operation.", "nullable": true }, "TriggerBindingId": { "type": "string", "description": "Trigger binding identifier, when any.", "nullable": true }, "ScheduleId": { "type": "string", "description": "Schedule identifier, when any.", "nullable": true }, "TriggerBinding": { "$ref": "#/components/schemas/BusinessFunctionOperationTriggerBindingDisplay" }, "Schedule": { "$ref": "#/components/schemas/BusinessFunctionOperationScheduleDisplay" }, "ActionId": { "type": "string", "description": "Surface Action identifier, when any.", "nullable": true }, "ActionLabel": { "type": "string", "description": "Current Action label, when the source Action still exists.", "nullable": true }, "ActionSourceSurface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "ActionSelectedEntityIdsCount": { "type": "integer", "description": "Selected entity id count for selection actions.", "format": "int32" }, "ArgsPayload": { "type": "string", "description": "Persisted execution argument payload.", "nullable": true }, "ActionInputSnapshot": { "type": "string", "description": "Redacted action input JSON snapshot.", "nullable": true }, "ActionSelectedEntityIdsSnapshot": { "type": "string", "description": "Selected entity ids JSON snapshot for selection actions.", "nullable": true }, "ActionInputHistory": { "$ref": "#/components/schemas/BusinessFunctionActionInputHistory" }, "CancellationRequestedAt": { "type": "string", "description": "Timestamp when cancellation was requested.", "format": "date-time", "nullable": true }, "CancellationRequestedByUserId": { "type": "string", "description": "User that requested cancellation.", "nullable": true }, "CancellationObservedAt": { "type": "string", "description": "Timestamp when cancellation was observed by the worker.", "format": "date-time", "nullable": true }, "ActorUser": { "$ref": "#/components/schemas/BusinessFunctionOperationUserRef" }, "OriginalUser": { "$ref": "#/components/schemas/BusinessFunctionOperationUserRef" }, "EntityTarget": { "$ref": "#/components/schemas/BusinessFunctionOperationTarget" }, "CancellationRequestedByUser": { "$ref": "#/components/schemas/BusinessFunctionOperationUserRef" }, "CanCancel": { "type": "boolean", "description": "Whether the queued run can be cancelled manually." }, "CancellationKind": { "$ref": "#/components/schemas/BusinessFunctionCancellationKind" }, "LastFailureReasonCode": { "type": "string", "description": "Stable machine-readable reason code for the latest failed attempt.", "nullable": true }, "SourceNetOperationProjectRevisionId": { "type": "string", "description": "Net Operation Project source revision captured for this job.", "nullable": true }, "SourceNetOperationProjectBuildId": { "type": "string", "description": "Net Operation Project build captured for this job.", "nullable": true }, "SourceNetOperationProjectArtifactId": { "type": "string", "description": "Net Operation Project artifact captured for this job.", "nullable": true }, "EffectiveMaxAttempts": { "type": "integer", "description": "Maximum attempts durably captured for this job.", "format": "int32", "nullable": true }, "RemainingAttempts": { "type": "integer", "description": "Attempts still available after the current attempt.", "format": "int32" }, "RetryDelaySeconds": { "type": "integer", "description": "Retry delay durably captured for this job.", "format": "int32", "nullable": true }, "WillRetry": { "type": "boolean", "description": "Whether the persisted policy permits a later attempt." }, "CanStopRetries": { "type": "boolean", "description": "Whether an administrator can stop this retry chain." }, "RetryStopState": { "$ref": "#/components/schemas/BusinessFunctionRetryStopState" }, "CancellationReasonCode": { "type": "string", "description": "Stable retry-stop or cancellation reason.", "nullable": true }, "CurrentAttempt": { "type": "integer", "description": "Current one-based execution attempt; zero means no attempt has started.", "format": "int32", "readOnly": true } }, "description": "Operational detail for one queued function run." }, "BusinessFunctionJobDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionJobDetail" }, "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 }, "BusinessFunctionJobOperationalSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Queued run identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Function identifier.", "nullable": true }, "BusinessFunctionKey": { "type": "string", "description": "Function key.", "nullable": true }, "BusinessFunctionName": { "type": "string", "description": "Function display name.", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "description": "Captured function version identifier.", "nullable": true }, "VersionNumber": { "type": "integer", "description": "Captured function version number.", "format": "int32", "nullable": true }, "VersionResolutionMode": { "$ref": "#/components/schemas/BusinessFunctionVersionResolutionMode" }, "Status": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" }, "Source": { "type": "string", "description": "Execution source.", "nullable": true }, "DeduplicationKey": { "type": "string", "description": "Optional deduplication key.", "nullable": true }, "AttemptCount": { "type": "integer", "description": "Execution attempt count.", "format": "int32" }, "Priority": { "type": "integer", "description": "Queue priority; lower numbers run first.", "format": "int32" }, "NextRunAt": { "type": "string", "description": "Next eligible run timestamp.", "format": "date-time" }, "LeaseExpiresAt": { "type": "string", "description": "Lease expiration timestamp, when leased.", "format": "date-time", "nullable": true }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "ModifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time", "nullable": true }, "LastError": { "type": "string", "description": "Last execution error summary.", "nullable": true }, "CorrelationId": { "type": "string", "description": "Correlation identifier.", "nullable": true }, "ActorUserId": { "type": "string", "description": "Original actor user identifier, when any.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Related entity definition identifier.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Related entity instance identifier.", "nullable": true }, "EntityOperation": { "type": "string", "description": "Related entity operation.", "nullable": true }, "TriggerBindingId": { "type": "string", "description": "Trigger binding identifier, when any.", "nullable": true }, "ScheduleId": { "type": "string", "description": "Schedule identifier, when any.", "nullable": true }, "TriggerBinding": { "$ref": "#/components/schemas/BusinessFunctionOperationTriggerBindingDisplay" }, "Schedule": { "$ref": "#/components/schemas/BusinessFunctionOperationScheduleDisplay" }, "CancellationRequestedAt": { "type": "string", "description": "Timestamp when cancellation was requested.", "format": "date-time", "nullable": true }, "CancellationRequestedByUserId": { "type": "string", "description": "User that requested cancellation.", "nullable": true }, "CancellationObservedAt": { "type": "string", "description": "Timestamp when cancellation was observed by the worker.", "format": "date-time", "nullable": true }, "OriginalUserId": { "type": "string", "description": "Original user identifier, when any.", "nullable": true }, "ActionId": { "type": "string", "description": "Surface Action identifier, when any.", "nullable": true }, "ActionLabel": { "type": "string", "description": "Current Action label, when the source Action still exists.", "nullable": true }, "ActionSourceSurface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "TargetKey": { "type": "string", "description": "Computed action target key when available.", "nullable": true }, "ActionSelectedEntityIdsCount": { "type": "integer", "description": "Selected entity id count for selection actions.", "format": "int32" }, "ActorUser": { "$ref": "#/components/schemas/BusinessFunctionOperationUserRef" }, "OriginalUser": { "$ref": "#/components/schemas/BusinessFunctionOperationUserRef" }, "EntityTarget": { "$ref": "#/components/schemas/BusinessFunctionOperationTarget" }, "CanCancel": { "type": "boolean", "description": "Whether the queued run can be cancelled manually." }, "CancellationKind": { "$ref": "#/components/schemas/BusinessFunctionCancellationKind" }, "LastFailureReasonCode": { "type": "string", "description": "Stable machine-readable reason code for the latest failed attempt.", "nullable": true }, "SourceNetOperationProjectRevisionId": { "type": "string", "description": "Net Operation Project source revision captured for this job.", "nullable": true }, "SourceNetOperationProjectBuildId": { "type": "string", "description": "Net Operation Project build captured for this job.", "nullable": true }, "SourceNetOperationProjectArtifactId": { "type": "string", "description": "Net Operation Project artifact captured for this job.", "nullable": true }, "EffectiveMaxAttempts": { "type": "integer", "description": "Maximum attempts durably captured for this job.", "format": "int32", "nullable": true }, "RemainingAttempts": { "type": "integer", "description": "Attempts still available after the current attempt.", "format": "int32" }, "RetryDelaySeconds": { "type": "integer", "description": "Retry delay durably captured for this job.", "format": "int32", "nullable": true }, "WillRetry": { "type": "boolean", "description": "Whether the persisted policy permits a later attempt." }, "CanStopRetries": { "type": "boolean", "description": "Whether an administrator can stop this retry chain." }, "RetryStopState": { "$ref": "#/components/schemas/BusinessFunctionRetryStopState" }, "CancellationReasonCode": { "type": "string", "description": "Stable retry-stop or cancellation reason.", "nullable": true }, "CurrentAttempt": { "type": "integer", "description": "Current one-based execution attempt; zero means no attempt has started.", "format": "int32", "readOnly": true } }, "description": "Operational summary for one queued function run." }, "BusinessFunctionJobOperationalSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionJobOperationalSummary" }, "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 }, "BusinessFunctionJobOperationsPage": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionJobOperationalSummary" }, "description": "Queued runs in the requested page.", "nullable": true }, "TotalCount": { "type": "integer", "description": "Total number of queued runs matching the filters.", "format": "int32" }, "Page": { "type": "integer", "description": "One-based page number.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Requested page size.", "format": "int32" }, "FilterDisplays": { "$ref": "#/components/schemas/BusinessFunctionOperationFilterDisplays" } }, "additionalProperties": false, "description": "Paged operational result for queued business-function jobs." }, "BusinessFunctionJobOperationsPageResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionJobOperationsPage" }, "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 }, "BusinessFunctionJobResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionJob" }, "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 }, "BusinessFunctionJobRetryStopResult": { "type": "object", "properties": { "Job": { "$ref": "#/components/schemas/BusinessFunctionJob" }, "StateChanged": { "type": "boolean", "description": "Whether this command durably changed the job." } }, "additionalProperties": false, "description": "Result of stopping a queued job retry chain." }, "BusinessFunctionJobRetryStopResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionJobRetryStopResult" }, "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 }, "BusinessFunctionJobSortField": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "Sortable fields for queued business-function job pages.", "format": "int32", "x-enum-varnames": [ "NextRunAt", "CreatedAt", "Status", "AttemptCount", "Priority" ], "x-enum-descriptions": { "0": "Sort by the next eligible run timestamp", "1": "Sort by the queued job creation timestamp", "2": "Sort by the queued job status", "3": "Sort by the execution attempt count", "4": "Sort by the queue priority" } }, "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" } }, "BusinessFunctionKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Entity", "Global" ], "x-enum-descriptions": { "0": "Function is bound to one entity definition and runs with a record context", "1": "Function operates at workspace level without a bound entity or record context" } }, "BusinessFunctionMutationOutput": { "type": "object", "properties": { "Record": { "type": "object", "description": "Mutated save draft exposed as `ctx.record`.", "nullable": true } }, "additionalProperties": false, "description": "Output produced by a BeforeSaveMutation function." }, "BusinessFunctionOperationAuditEntry": { "type": "object", "properties": { "ChangeId": { "type": "string", "description": "Entity audit change identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "EntityDefinitionName": { "type": "string", "description": "Entity definition display name.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Changed entity instance identifier.", "nullable": true }, "Operation": { "$ref": "#/components/schemas/EntityInstanceChangeOperation" }, "ChangedAt": { "type": "string", "description": "Change timestamp.", "format": "date-time" }, "SourceLabel": { "type": "string", "description": "Source label captured in the audit payload.", "nullable": true }, "Summary": { "type": "string", "description": "Compact admin-facing summary.", "nullable": true } }, "additionalProperties": false, "description": "Bounded entity audit summary correlated to one business-function operation." }, "BusinessFunctionOperationFilterDisplay": { "type": "object", "properties": { "Id": { "type": "string", "description": "Raw identifier used by the filter.", "nullable": true }, "DisplayName": { "type": "string", "description": "Human-readable label or raw identifier fallback.", "nullable": true }, "Subtitle": { "type": "string", "description": "Optional secondary label.", "nullable": true } }, "additionalProperties": false, "description": "Human-readable display reference for an active business-function operation filter." }, "BusinessFunctionOperationFilterDisplays": { "type": "object", "properties": { "Function": { "$ref": "#/components/schemas/BusinessFunctionOperationFilterDisplay" }, "Action": { "$ref": "#/components/schemas/BusinessFunctionOperationFilterDisplay" }, "EntityDefinition": { "$ref": "#/components/schemas/BusinessFunctionOperationFilterDisplay" }, "ActorUser": { "$ref": "#/components/schemas/BusinessFunctionOperationFilterDisplay" }, "OriginalUser": { "$ref": "#/components/schemas/BusinessFunctionOperationFilterDisplay" }, "TriggerBinding": { "$ref": "#/components/schemas/BusinessFunctionOperationFilterDisplay" }, "Schedule": { "$ref": "#/components/schemas/BusinessFunctionOperationFilterDisplay" } }, "additionalProperties": false, "description": "Human-readable labels for active business-function operation filters." }, "BusinessFunctionOperationScheduleDisplay": { "type": "object", "properties": { "Id": { "type": "string", "description": "Schedule identifier.", "nullable": true }, "Name": { "type": "string", "description": "Schedule display name.", "nullable": true }, "CronExpression": { "type": "string", "description": "Saved CRON expression.", "nullable": true }, "TimeZone": { "type": "string", "description": "Schedule time zone override, when any.", "nullable": true } }, "additionalProperties": false, "description": "Human-readable schedule reference for a business-function operation." }, "BusinessFunctionOperationSortDirection": { "enum": [ 0, 1 ], "type": "integer", "description": "Sort direction for business-function operation pages.", "format": "int32", "x-enum-varnames": [ "Asc", "Desc" ], "x-enum-descriptions": { "0": "Ascending order", "1": "Descending order" } }, "BusinessFunctionOperationTarget": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier.", "nullable": true }, "EntityDefinitionName": { "type": "string", "description": "Entity definition display name.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Primary entity instance identifier when the operation targets one record.", "nullable": true }, "DisplayName": { "type": "string", "description": "Primary target label for the UI.", "nullable": true }, "Subtitle": { "type": "string", "description": "Secondary target label for the UI.", "nullable": true }, "SelectedCount": { "type": "integer", "description": "Number of selected entity instances.", "format": "int32" }, "SelectedRecords": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionOperationTargetRecord" }, "description": "Bounded sample of selected records.", "nullable": true } }, "additionalProperties": false, "description": "Display model for the entity target of a business-function operation." }, "BusinessFunctionOperationTargetRecord": { "type": "object", "properties": { "InstanceId": { "type": "string", "description": "Entity instance identifier.", "nullable": true }, "DisplayName": { "type": "string", "description": "Resolved record display name.", "nullable": true }, "Subtitle": { "type": "string", "description": "Resolved record subtitle when available.", "nullable": true } }, "additionalProperties": false, "description": "Display reference for one selected business-function target record." }, "BusinessFunctionOperationTriggerBindingDisplay": { "type": "object", "properties": { "Id": { "type": "string", "description": "Trigger binding identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Bound entity definition identifier.", "nullable": true }, "EntityDefinitionName": { "type": "string", "description": "Bound entity definition display name.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Bound function identifier.", "nullable": true }, "BusinessFunctionName": { "type": "string", "description": "Bound function display name.", "nullable": true }, "Source": { "$ref": "#/components/schemas/BusinessFunctionBindingSource" }, "Operation": { "$ref": "#/components/schemas/BusinessFunctionBindingOperation" } }, "additionalProperties": false, "description": "Human-readable trigger-binding reference for a business-function operation." }, "BusinessFunctionOperationUserRef": { "type": "object", "properties": { "Id": { "type": "string", "description": "User identifier or stable system actor identifier.", "nullable": true }, "DisplayName": { "type": "string", "description": "Resolved display name.", "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 user is deleted." }, "IsSystemActor": { "type": "boolean", "description": "Whether the reference is the built-in Moltaro automation actor." }, "IsMissing": { "type": "boolean", "description": "Whether the referenced user no longer exists in the workspace cache." } }, "additionalProperties": false, "description": "User display reference for business-function operations." }, "BusinessFunctionOperationsOverview": { "type": "object", "properties": { "QueueDepth": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionQueueDepth" }, "description": "Queue depth by queued-run status.", "nullable": true }, "QueuedCount": { "type": "integer", "description": "Number of queued runs.", "format": "int32" }, "LeasedCount": { "type": "integer", "description": "Number of leased queued runs.", "format": "int32" }, "RetryingCount": { "type": "integer", "description": "Number of queued runs that have already attempted execution.", "format": "int32" }, "FailedJobCount": { "type": "integer", "description": "Number of failed queued runs.", "format": "int32" }, "TimeoutRunCount24h": { "type": "integer", "description": "Number of timeout runs in the last 24 hours.", "format": "int32" }, "RuntimeFailureRunCount24h": { "type": "integer", "description": "Number of runtime exception runs in the last 24 hours.", "format": "int32" }, "SlowRunCount24h": { "type": "integer", "description": "Number of slow successful runs in the last 24 hours.", "format": "int32" }, "RecentRuns": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionRunOperationalSummary" }, "description": "Recent business-function runs.", "nullable": true }, "FailedJobs": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionJobOperationalSummary" }, "description": "Recent failed, leased, or retrying queued runs.", "nullable": true } }, "additionalProperties": false, "description": "Operational overview for Moltaro business-function execution." }, "BusinessFunctionOperationsOverviewResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionOperationsOverview" }, "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 }, "BusinessFunctionQueueDepth": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" }, "Count": { "type": "integer", "description": "Number of queued runs in that status.", "format": "int32" } }, "additionalProperties": false, "description": "Function queue depth for one status." }, "BusinessFunctionRetryStopState": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "Requested", "Applied" ], "x-enum-descriptions": { "0": "No retry stop was requested", "1": "A retry stop was requested and the current attempt is being cancelled", "2": "The retry stop was observed and no later attempt can run" } }, "BusinessFunctionRunDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Run identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Function identifier.", "nullable": true }, "BusinessFunctionKey": { "type": "string", "description": "Function key.", "nullable": true }, "BusinessFunctionName": { "type": "string", "description": "Function display name.", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "description": "Captured function version identifier.", "nullable": true }, "VersionNumber": { "type": "integer", "description": "Captured function version number.", "format": "int32" }, "Source": { "type": "string", "description": "Execution source.", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionRunStatus" }, "StartedAt": { "type": "string", "description": "Start timestamp.", "format": "date-time" }, "CompletedAt": { "type": "string", "description": "Completion timestamp.", "format": "date-time", "nullable": true }, "DurationMs": { "type": "integer", "description": "Duration in milliseconds.", "format": "int64", "nullable": true }, "CorrelationId": { "type": "string", "description": "Correlation identifier.", "nullable": true }, "ActorUserId": { "type": "string", "description": "Actor user identifier.", "nullable": true }, "OriginalUserId": { "type": "string", "description": "Original user identifier when the runtime used a service actor.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Related entity definition identifier.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Related entity instance identifier.", "nullable": true }, "EntityOperation": { "type": "string", "description": "Related entity operation.", "nullable": true }, "TriggerBindingId": { "type": "string", "description": "Trigger binding identifier, when any.", "nullable": true }, "ScheduleId": { "type": "string", "description": "Schedule identifier, when any.", "nullable": true }, "TriggerBinding": { "$ref": "#/components/schemas/BusinessFunctionOperationTriggerBindingDisplay" }, "Schedule": { "$ref": "#/components/schemas/BusinessFunctionOperationScheduleDisplay" }, "QueuedJobId": { "type": "string", "description": "Queued job identifier, when any.", "nullable": true }, "ActionId": { "type": "string", "description": "Action binding identifier, when any.", "nullable": true }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "TargetKey": { "type": "string", "description": "Computed action target key when available.", "nullable": true }, "ActionSelectedEntityIdsCount": { "type": "integer", "description": "Selected entity id count for selection actions.", "format": "int32" }, "ArgsSnapshot": { "type": "string", "description": "Persisted execution argument snapshot.", "nullable": true }, "ActionInputSnapshot": { "type": "string", "description": "Action input JSON snapshot.", "nullable": true }, "ActionSelectedEntityIdsSnapshot": { "type": "string", "description": "Selected entity ids JSON snapshot for selection actions.", "nullable": true }, "ResultSummary": { "type": "string", "description": "Compact result summary.", "nullable": true }, "ResultData": { "type": "object", "description": "Structured JSON result payload.", "nullable": true }, "ErrorSummary": { "type": "string", "description": "Compact error summary.", "nullable": true }, "LogSummary": { "type": "string", "description": "Persisted runtime log summary.", "nullable": true }, "ActionInputHistory": { "$ref": "#/components/schemas/BusinessFunctionActionInputHistory" }, "AuditEntries": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionOperationAuditEntry" }, "description": "Bounded entity audit entries correlated to the run.", "nullable": true }, "DevLogEntries": { "type": "array", "items": { "$ref": "#/components/schemas/DevLogEntrySummary" }, "description": "Bounded dev-log entries correlated to the run.", "nullable": true }, "ActorUser": { "$ref": "#/components/schemas/BusinessFunctionOperationUserRef" }, "OriginalUser": { "$ref": "#/components/schemas/BusinessFunctionOperationUserRef" }, "EntityTarget": { "$ref": "#/components/schemas/BusinessFunctionOperationTarget" }, "CanCancel": { "type": "boolean", "description": "Whether the run can be cancelled manually." }, "CancellationKind": { "$ref": "#/components/schemas/BusinessFunctionCancellationKind" }, "HttpEndpoint": { "$ref": "#/components/schemas/BusinessFunctionHttpRunDetail" }, "FailureReasonCode": { "type": "string", "description": "Stable machine-readable reason code for a platform or runtime failure.", "nullable": true }, "QueuedJobAttemptCount": { "type": "integer", "description": "Immutable queued-job attempt that caused this run, when any.", "format": "int32", "nullable": true }, "SourceNetOperationProjectRevisionId": { "type": "string", "description": "Net Operation Project source revision captured for this execution.", "nullable": true }, "SourceNetOperationProjectBuildId": { "type": "string", "description": "Net Operation Project build captured for this execution.", "nullable": true }, "SourceNetOperationProjectArtifactId": { "type": "string", "description": "Net Operation Project artifact captured by the published function version.", "nullable": true }, "ResolvedNetOperationProjectArtifactId": { "type": "string", "description": "Net Operation Project artifact selected before runtime activation.", "nullable": true } }, "description": "Operational detail for one Moltaro business-function run." }, "BusinessFunctionRunDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionRunDetail" }, "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 }, "BusinessFunctionRunOperationalSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Run identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Function identifier.", "nullable": true }, "BusinessFunctionKey": { "type": "string", "description": "Function key.", "nullable": true }, "BusinessFunctionName": { "type": "string", "description": "Function display name.", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "description": "Captured function version identifier.", "nullable": true }, "VersionNumber": { "type": "integer", "description": "Captured function version number.", "format": "int32" }, "Source": { "type": "string", "description": "Execution source.", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionRunStatus" }, "StartedAt": { "type": "string", "description": "Start timestamp.", "format": "date-time" }, "CompletedAt": { "type": "string", "description": "Completion timestamp.", "format": "date-time", "nullable": true }, "DurationMs": { "type": "integer", "description": "Duration in milliseconds.", "format": "int64", "nullable": true }, "CorrelationId": { "type": "string", "description": "Correlation identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Related entity definition identifier.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Related entity instance identifier.", "nullable": true }, "EntityOperation": { "type": "string", "description": "Related entity operation.", "nullable": true }, "TriggerBindingId": { "type": "string", "description": "Trigger binding identifier, when any.", "nullable": true }, "ScheduleId": { "type": "string", "description": "Schedule identifier, when any.", "nullable": true }, "TriggerBinding": { "$ref": "#/components/schemas/BusinessFunctionOperationTriggerBindingDisplay" }, "Schedule": { "$ref": "#/components/schemas/BusinessFunctionOperationScheduleDisplay" }, "QueuedJobId": { "type": "string", "description": "Queued job identifier, when any.", "nullable": true }, "ResultSummary": { "type": "string", "description": "Compact result summary.", "nullable": true }, "ResultData": { "type": "object", "description": "Structured JSON result payload.", "nullable": true }, "ErrorSummary": { "type": "string", "description": "Compact error summary.", "nullable": true }, "ActorUserId": { "type": "string", "description": "Effective actor user identifier, when any.", "nullable": true }, "OriginalUserId": { "type": "string", "description": "Original user identifier, when any.", "nullable": true }, "ActionId": { "type": "string", "description": "Surface Action identifier, when any.", "nullable": true }, "ActionLabel": { "type": "string", "description": "Current Action label, when the source Action still exists.", "nullable": true }, "ActionSourceSurface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "TargetKey": { "type": "string", "description": "Computed action target key when available.", "nullable": true }, "ActionSelectedEntityIdsCount": { "type": "integer", "description": "Selected entity id count for selection actions.", "format": "int32" }, "ActorUser": { "$ref": "#/components/schemas/BusinessFunctionOperationUserRef" }, "OriginalUser": { "$ref": "#/components/schemas/BusinessFunctionOperationUserRef" }, "EntityTarget": { "$ref": "#/components/schemas/BusinessFunctionOperationTarget" }, "CanCancel": { "type": "boolean", "description": "Whether the run can be cancelled manually." }, "CancellationKind": { "$ref": "#/components/schemas/BusinessFunctionCancellationKind" }, "HttpEndpoint": { "$ref": "#/components/schemas/BusinessFunctionHttpRunDetail" }, "FailureReasonCode": { "type": "string", "description": "Stable machine-readable reason code for a platform or runtime failure.", "nullable": true }, "QueuedJobAttemptCount": { "type": "integer", "description": "Immutable queued-job attempt that caused this run, when any.", "format": "int32", "nullable": true }, "SourceNetOperationProjectRevisionId": { "type": "string", "description": "Net Operation Project source revision captured for this execution.", "nullable": true }, "SourceNetOperationProjectBuildId": { "type": "string", "description": "Net Operation Project build captured for this execution.", "nullable": true }, "SourceNetOperationProjectArtifactId": { "type": "string", "description": "Net Operation Project artifact captured by the published function version.", "nullable": true }, "ResolvedNetOperationProjectArtifactId": { "type": "string", "description": "Net Operation Project artifact selected before runtime activation.", "nullable": true } }, "description": "Operational summary for one Moltaro business-function run." }, "BusinessFunctionRunOperationalSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionRunOperationalSummary" }, "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 }, "BusinessFunctionRunOperationsPage": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionRunOperationalSummary" }, "description": "Runs in the requested page.", "nullable": true }, "TotalCount": { "type": "integer", "description": "Total number of runs matching the filters.", "format": "int32" }, "Page": { "type": "integer", "description": "One-based page number.", "format": "int32" }, "PageSize": { "type": "integer", "description": "Requested page size.", "format": "int32" }, "FilterDisplays": { "$ref": "#/components/schemas/BusinessFunctionOperationFilterDisplays" } }, "additionalProperties": false, "description": "Paged operational result for persisted business-function runs." }, "BusinessFunctionRunOperationsPageResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionRunOperationsPage" }, "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 }, "BusinessFunctionRunSortField": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "Sortable fields for persisted business-function run pages.", "format": "int32", "x-enum-varnames": [ "StartedAt", "Status", "Function", "Duration", "Source" ], "x-enum-descriptions": { "0": "Sort by the run start timestamp", "1": "Sort by the run status", "2": "Sort by the function display name", "3": "Sort by the run duration", "4": "Sort by the execution source" } }, "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" } }, "BusinessFunctionSchedule": { "type": "object", "properties": { "Id": { "type": "string", "description": "Schedule identifier.", "nullable": true }, "Name": { "type": "string", "description": "Schedule name.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Published global function identifier.", "nullable": true }, "TimeZone": { "type": "string", "description": "Explicit schedule time zone identifier; `null` inherits the workspace time zone.", "nullable": true }, "CronExpression": { "type": "string", "description": "Cron expression.", "nullable": true }, "Args": { "type": "object", "description": "Optional JSON arguments exposed as `ctx.args`.", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionScheduleStatus" }, "NextRunAt": { "type": "string", "description": "Next eligible run timestamp.", "format": "date-time", "nullable": true }, "LastRunAt": { "type": "string", "description": "Last enqueue or execution activity timestamp.", "format": "date-time", "nullable": true }, "LastStatus": { "type": "string", "description": "Last enqueue, job, or run status.", "nullable": true }, "LastError": { "type": "string", "description": "Last enqueue, job, or run error summary.", "nullable": true }, "TargetState": { "$ref": "#/components/schemas/BusinessFunctionScheduleTargetState" }, "TargetError": { "type": "string", "description": "Target-resolution error for broken schedules.", "nullable": true }, "TargetBrokenAt": { "type": "string", "description": "Timestamp when target resolution broke.", "format": "date-time", "nullable": true }, "TimeoutSeconds": { "type": "integer", "description": "Maximum duration for one scheduled occurrence.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Optimistic concurrency token.", "format": "uuid" }, "ActiveJob": { "$ref": "#/components/schemas/BusinessFunctionScheduleActiveJob" } }, "additionalProperties": false, "description": "Business-function schedule configuration." }, "BusinessFunctionScheduleActiveJob": { "type": "object", "properties": { "Id": { "type": "string", "description": "Queued job identifier.", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionJobStatus" }, "ModifiedAt": { "type": "string", "description": "Concurrency token required by the stop-retries command.", "format": "date-time", "nullable": true }, "CurrentAttempt": { "type": "integer", "description": "Current persisted attempt number.", "format": "int32" }, "EffectiveMaxAttempts": { "type": "integer", "description": "Retry limit snapshotted for this job.", "format": "int32" }, "RemainingAttempts": { "type": "integer", "description": "Attempts still permitted by the snapshot.", "format": "int32" }, "RetryDelaySeconds": { "type": "integer", "description": "Delay before another attempt.", "format": "int32" }, "NextRunAt": { "type": "string", "description": "Next eligible attempt timestamp.", "format": "date-time", "nullable": true }, "WillRetry": { "type": "boolean", "description": "Whether the job is currently waiting for or executing an attempt that may retry." }, "CanStopRetries": { "type": "boolean", "description": "Whether an administrator can stop this retry chain." }, "RetryStopState": { "$ref": "#/components/schemas/BusinessFunctionRetryStopState" } }, "additionalProperties": false, "description": "Retry-control state for a schedule job that is still queued or leased." }, "BusinessFunctionScheduleListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionSchedule" }, "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 }, "BusinessFunctionScheduleResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BusinessFunctionSchedule" }, "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 }, "BusinessFunctionScheduleStatus": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Disabled", "Enabled" ], "x-enum-descriptions": { "0": "Schedule is turned off and does not enqueue new runs", "1": "Schedule is active and enqueues runs at its configured times" } }, "BusinessFunctionScheduleTargetState": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Ready", "Broken" ], "x-enum-descriptions": { "0": "Scheduled function target resolves to a runnable function", "1": "Scheduled function target no longer resolves to a runnable function and the schedule cannot execute" } }, "BusinessFunctionSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Function identifier.", "nullable": true }, "Key": { "type": "string", "description": "Stable function key.", "nullable": true }, "Name": { "type": "string", "description": "User-facing function name.", "nullable": true }, "Description": { "type": "string", "description": "Optional description.", "nullable": true }, "Kind": { "$ref": "#/components/schemas/BusinessFunctionKind" }, "EntityDefinitionId": { "type": "string", "description": "Owning entity definition for entity functions.", "nullable": true }, "IsEnabled": { "type": "boolean", "description": "Whether the function can be invoked by future runtime slices." }, "CurrentPublishedVersionId": { "type": "string", "description": "Current published version identifier.", "nullable": true }, "CurrentPublishedContract": { "$ref": "#/components/schemas/BusinessFunctionContract" }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "ModifiedAt": { "type": "string", "description": "Last metadata modification timestamp.", "format": "date-time", "nullable": true }, "ModifiedByUserId": { "type": "string", "description": "Last modifying user identifier.", "nullable": true }, "VersionCount": { "type": "integer", "description": "Number of stored immutable versions.", "format": "int32" }, "LatestVersionNumber": { "type": "integer", "description": "Latest stored version number.", "format": "int32", "nullable": true }, "LatestVersionPublishedAt": { "type": "string", "description": "Publication timestamp for the latest stored version.", "format": "date-time", "nullable": true }, "CurrentPublishedVersionNumber": { "type": "integer", "description": "Current published version number.", "format": "int32", "nullable": true }, "CurrentPublishedVersionPublishedAt": { "type": "string", "description": "Publication timestamp for the current published version.", "format": "date-time", "nullable": true }, "LastRunStatus": { "$ref": "#/components/schemas/BusinessFunctionRunStatus" }, "LastRunStartedAt": { "type": "string", "description": "Most recent persisted run start timestamp.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "description": "Administrative business function summary." }, "BusinessFunctionSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionSummary" }, "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 }, "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." }, "BusinessFunctionVersion": { "type": "object", "properties": { "Id": { "type": "string", "description": "Version identifier.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Owning function identifier.", "nullable": true }, "VersionNumber": { "type": "integer", "description": "Monotonic version number within the function.", "format": "int32" }, "Contract": { "$ref": "#/components/schemas/BusinessFunctionContract" }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "ActionInputClrTypeName": { "type": "string", "description": "Action input CLR type name.", "nullable": true }, "ActionInputSignatureHash": { "type": "string", "description": "Action input signature hash.", "nullable": true }, "ActionInputSchemaPayload": { "type": "string", "description": "Immutable action input schema JSON payload, including field nullability and typed Boolean or Select defaults when declared.", "nullable": true }, "ActionInputFormPayload": { "type": "string", "description": "Action input Form metadata JSON payload.", "nullable": true }, "ActionInputCardPayload": { "type": "string", "description": "Action input-history Card metadata JSON payload.", "nullable": true }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "CreatedByUserId": { "type": "string", "description": "User that created the version.", "nullable": true }, "PublishedAt": { "type": "string", "description": "Publication timestamp, when published.", "format": "date-time", "nullable": true }, "PublishedByUserId": { "type": "string", "description": "User that published the version.", "nullable": true } }, "description": "Immutable business function script version." }, "BusinessFunctionVersionListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessFunctionVersion" }, "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 }, "BusinessFunctionVersionResolutionMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "PinnedAtEnqueue", "LatestAtExecutionStart" ], "x-enum-descriptions": { "0": "Job runs the function version captured when the job was enqueued", "1": "Job resolves the latest available function version when execution starts" } }, "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" } }, "ChangeEntityFieldTypeRequest": { "required": [ "FieldType", "RowVersion" ], "type": "object", "properties": { "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "VisibleWhen": { "type": "string", "description": "Visibility condition expression after the change.", "nullable": true }, "RequiredWhen": { "type": "string", "description": "Requiredness condition expression after the change.", "nullable": true }, "EditableWhen": { "type": "string", "description": "Editability condition expression after the change.", "nullable": true }, "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" }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldOptionRequest" }, "description": "Select options when applicable.", "nullable": true }, "RowVersion": { "type": "string", "description": "Expected row version.", "format": "uuid" }, "AddressCoordinatesRequired": { "type": "boolean", "description": "Whether address values must carry latitude and longitude." }, "IsReadOnly": { "type": "boolean", "description": "Whether runtime writes should skip this field. Null preserves the current value.", "nullable": true }, "SchemaChangeConfirmationToken": { "type": "string", "description": "Confirmation token returned by the matching schema-change-plan endpoint; required when the planned change is destructive.", "nullable": true }, "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 }, "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": "Classifier Catalog Definition identifier for Classifier fields.", "nullable": true }, "DefaultValue": { "$ref": "#/components/schemas/EntityFieldDefaultValueRequest" } }, "additionalProperties": false, "description": "Request payload to change a field type." }, "ChangeManagedSecretStateRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Expected concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Disable, re-enable, or permanently retire a managed secret." }, "CloneEntityUiCardSurfaceRequest": { "required": [ "Key", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing card surface name for the clone." }, "Key": { "type": "string", "description": "Stable card surface key used by selectors and routes for the clone." } }, "additionalProperties": false, "description": "Request payload to clone an explicit custom card surface." }, "CloneEntityUiFormSurfaceRequest": { "required": [ "Key", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing form surface name for the clone." }, "Key": { "type": "string", "description": "Stable form surface key used by selectors and routes for the clone." } }, "additionalProperties": false, "description": "Request payload to clone an explicit custom form surface." }, "CloneEntityUiHostSurfaceRequest": { "required": [ "Key", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing host-surface name for the clone." }, "Key": { "type": "string", "description": "Stable host-surface key for the clone." }, "IsDefault": { "type": "boolean", "description": "Whether the cloned host surface should become its family's default." } }, "additionalProperties": false, "description": "Request payload to clone a custom entity-list, details-page, or drawer surface." }, "CloneEntityUiTableSurfaceRequest": { "required": [ "Key", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing table surface name for the clone." }, "Key": { "type": "string", "description": "Stable table surface key used by selectors and routes for the clone." } }, "additionalProperties": false, "description": "Request payload to clone a custom table surface." }, "CreateAssociationEndpointRequest": { "required": [ "FieldDisplayName", "FieldKey", "InverseFieldDisplayName", "InverseFieldKey", "TargetEntityDefinitionId" ], "type": "object", "properties": { "TargetEntityDefinitionId": { "type": "string", "description": "Normal data entity definition targeted by this endpoint." }, "FieldKey": { "type": "string", "description": "Required reference field key on the association entity." }, "FieldDisplayName": { "type": "string", "description": "Required reference field display name on the association entity." }, "InverseFieldKey": { "type": "string", "description": "Generated inverse reference field key on the target entity." }, "InverseFieldDisplayName": { "type": "string", "description": "Generated inverse reference field display name on the target entity." } }, "additionalProperties": false, "description": "Request payload for one endpoint of an association entity definition." }, "CreateAssociationEntityDefinitionRequest": { "required": [ "DisplayNamePlural", "DisplayNameSingular", "LeftEndpoint", "Name", "RightEndpoint" ], "type": "object", "properties": { "Name": { "type": "string", "description": "Internal association entity name." }, "DisplayNameSingular": { "type": "string", "description": "User-facing singular name." }, "DisplayNamePlural": { "type": "string", "description": "User-facing plural name." }, "Description": { "type": "string", "description": "Optional entity description.", "nullable": true }, "LeftEndpoint": { "$ref": "#/components/schemas/CreateAssociationEndpointRequest" }, "RightEndpoint": { "$ref": "#/components/schemas/CreateAssociationEndpointRequest" }, "IsReadOnly": { "type": "boolean", "description": "Whether runtime writes should be blocked for this association entity." }, "DisabledOperations": { "$ref": "#/components/schemas/EntityOperationPolicy" } }, "additionalProperties": false, "description": "Request payload to create an association entity definition." }, "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" } }, "CreateBoardConstraintBindingRequest": { "type": "object", "properties": { "TriggerType": { "$ref": "#/components/schemas/BoardConstraintTriggerType" }, "FromBoardStatusId": { "type": "string", "nullable": true }, "ToBoardStatusId": { "type": "string", "nullable": true }, "BoardStatusId": { "type": "string", "nullable": true }, "LogicalOperator": { "$ref": "#/components/schemas/BoardConstraintLogicalOperator" }, "BoardStatementIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "IsEnabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Create one draft binding on a Board Constraint." }, "CreateBoardConstraintRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "FailureMessage": { "type": "string", "nullable": true }, "IsEnabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Create a draft Board Constraint." }, "CreateBoardRequest": { "required": [ "DisplayName", "Key" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Required stable board key." }, "DisplayName": { "type": "string", "description": "Board display name." }, "Description": { "type": "string", "description": "Board description.", "nullable": true }, "CreateDefaultStatuses": { "type": "boolean", "description": "Whether Initial, Active, and Terminal statuses should be created." }, "TagsEnabled": { "type": "boolean", "description": "Whether board item tags are enabled." }, "BoardType": { "$ref": "#/components/schemas/BoardType" }, "BoardCycleActivationMode": { "$ref": "#/components/schemas/BoardCycleActivationMode" } }, "additionalProperties": false, "description": "Creates a board." }, "CreateBoardStatementRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "Expression": { "type": "string", "nullable": true }, "IsEnabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Create a reusable Board Statement." }, "CreateBoardStatusRequest": { "required": [ "DisplayName" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable status key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Status display name." }, "Description": { "type": "string", "description": "Status description.", "nullable": true }, "Color": { "type": "string", "description": "Optional status visual color token.", "nullable": true }, "MetaType": { "$ref": "#/components/schemas/BoardStatusMetaType" }, "SortOrder": { "type": "integer", "description": "Display order.", "format": "int32" }, "IsActive": { "type": "boolean", "description": "Whether the status can receive board items." } }, "additionalProperties": false, "description": "Creates a board status." }, "CreateBoardTargetDefinitionRequest": { "required": [ "TargetKind" ], "type": "object", "properties": { "TargetKind": { "$ref": "#/components/schemas/BoardTargetKind" }, "TargetModelId": { "type": "string", "description": "Target model id. Required and must reference an existing Entity Definition for EntityDefinition targets; optional for advanced Entitlement targets, where null accepts any Entitlement model; must be null for Itself targets.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order of the target definition inside the board target catalog.", "format": "int32" }, "IsActive": { "type": "boolean", "description": "Whether the target definition is active for board runtime use, such as adding target objects to the board." }, "RepeatPolicy": { "$ref": "#/components/schemas/BoardTargetRepeatPolicy" }, "CreateCommentPolicy": { "$ref": "#/components/schemas/CreateCommentPolicy" }, "ReadCommentPolicy": { "$ref": "#/components/schemas/ReadCommentPolicy" }, "CreateAttachmentPolicy": { "$ref": "#/components/schemas/CreateAttachmentPolicy" }, "ReadAttachmentPolicy": { "$ref": "#/components/schemas/ReadAttachmentPolicy" } }, "additionalProperties": false, "description": "Creates a canonical board target definition." }, "CreateBoardTransitionRequest": { "required": [ "FromBoardStatusId", "ToBoardStatusId" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable transition key.", "nullable": true }, "FromBoardStatusId": { "type": "string", "description": "Source status id." }, "ToBoardStatusId": { "type": "string", "description": "Target status id." }, "DisplayName": { "type": "string", "description": "Transition display name.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order inside the source status.", "format": "int32" }, "IsActive": { "type": "boolean", "description": "Whether transition is available." }, "LinkPrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTransitionLinkPrerequisiteRequest" }, "description": "Required active-link scopes for the transition.", "nullable": true } }, "additionalProperties": false, "description": "Creates a board transition." }, "CreateBusinessFunctionActionBindingRequest": { "type": "object", "properties": { "BusinessFunctionId": { "type": "string", "description": "Business function identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier for entity-scoped action targets.", "nullable": true }, "EntityUiSurfaceModelId": { "type": "string", "description": "Entity UI surface model identifier when binding to a concrete surface.", "nullable": true }, "Surface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "Placement": { "$ref": "#/components/schemas/ActionPlacement" }, "SortOrder": { "type": "integer", "description": "Action order within the placement.", "format": "int32" }, "IsEnabled": { "type": "boolean", "description": "Whether the binding is enabled." }, "Label": { "type": "string", "description": "Optional label override.", "nullable": true }, "Icon": { "type": "string", "description": "Optional icon override.", "nullable": true }, "PermissionKey": { "type": "string", "description": "Optional action-specific permission gate.", "nullable": true }, "ToolbarPresentation": { "$ref": "#/components/schemas/EntityUiActionToolbarPresentation" }, "Color": { "type": "string", "description": "Vuetify color token.", "nullable": true }, "Variant": { "type": "string", "description": "Vuetify variant token.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create a function-backed UI action." }, "CreateBusinessFunctionHttpEndpointSecretRequest": { "type": "object", "properties": { "Purpose": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointSecretPurpose" }, "Name": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Create or rotate a managed HTTP endpoint secret." }, "CreateBusinessFunctionScheduleRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Schedule name.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Published global function identifier.", "nullable": true }, "TimeZone": { "type": "string", "description": "Optional schedule time zone identifier; empty values inherit the workspace time zone.", "nullable": true }, "CronExpression": { "type": "string", "description": "Cron expression.", "nullable": true }, "Args": { "type": "object", "description": "Optional JSON arguments exposed as `ctx.args`.", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionScheduleStatus" }, "TimeoutSeconds": { "type": "integer", "description": "Maximum duration for one scheduled occurrence; defaults to 60 seconds.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create a business-function schedule." }, "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" } }, "CreateDictionaryEntityDefinitionRequest": { "required": [ "DisplayNamePlural", "DisplayNameSingular", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "Internal entity name." }, "DisplayNameSingular": { "type": "string", "description": "User-facing singular name." }, "DisplayNamePlural": { "type": "string", "description": "User-facing plural name." }, "Description": { "type": "string", "description": "Optional entity description.", "nullable": true }, "ReaderRoleIds": { "type": "array", "items": { "type": "string" }, "description": "Roles allowed to read dictionary records. Defaults to Everyone when omitted or empty.", "nullable": true }, "AdminRoleIds": { "type": "array", "items": { "type": "string" }, "description": "Roles allowed to manage dictionary records. Defaults to Admin when omitted or empty.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create a simple dictionary entity preset." }, "CreateEntityDataTransferProfileRequest": { "required": [ "Key", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing profile name." }, "Key": { "type": "string", "description": "Stable technical profile key." }, "Direction": { "$ref": "#/components/schemas/EntityDataTransferDirection" }, "Format": { "$ref": "#/components/schemas/EntityDataTransferFormat" }, "IdentityMode": { "$ref": "#/components/schemas/EntityDataTransferIdentityMode" }, "IdentityFieldId": { "type": "string", "description": "Optional identity field identifier.", "nullable": true }, "ImportMode": { "$ref": "#/components/schemas/EntityDataTransferImportMode" }, "Description": { "type": "string", "description": "Optional user-facing workflow description.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create an entity data transfer profile." }, "CreateEntityDefinitionIndexRequest": { "required": [ "FieldIds" ], "type": "object", "properties": { "FieldIds": { "type": "array", "items": { "type": "string" }, "description": "Ordered field identifiers that define the index columns." } }, "additionalProperties": false, "description": "Request payload to create a non-unique index on the primary entity table." }, "CreateEntityDefinitionRequest": { "required": [ "DisplayNamePlural", "DisplayNameSingular", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "Internal entity name." }, "DisplayNameSingular": { "type": "string", "description": "User-facing singular name." }, "DisplayNamePlural": { "type": "string", "description": "User-facing plural name." }, "Description": { "type": "string", "description": "Optional entity description.", "nullable": true }, "IsReadOnly": { "type": "boolean", "description": "Whether runtime writes should be blocked for this entity." }, "DisabledOperations": { "$ref": "#/components/schemas/EntityOperationPolicy" } }, "additionalProperties": false, "description": "Request payload to create an entity definition." }, "CreateEntityDefinitionUniqueConstraintRequest": { "required": [ "EntityDefinitionTableId", "FieldIds" ], "type": "object", "properties": { "EntityDefinitionTableId": { "type": "string", "description": "Owning entity definition table identifier." }, "FieldIds": { "type": "array", "items": { "type": "string" }, "description": "Ordered field identifiers participating in uniqueness." } }, "additionalProperties": false, "description": "Create one unique constraint for an entity definition table." }, "CreateEntityFieldRequest": { "required": [ "DisplayName", "FieldType", "Key" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Field key." }, "DisplayName": { "type": "string", "description": "Field display name." }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "VisibleWhen": { "type": "string", "description": "Visibility condition expression.", "nullable": true }, "RequiredWhen": { "type": "string", "description": "Requiredness condition expression.", "nullable": true }, "EditableWhen": { "type": "string", "description": "Editability condition expression.", "nullable": true }, "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" }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldOptionRequest" }, "description": "Select options when applicable.", "nullable": true }, "AddressCoordinatesRequired": { "type": "boolean", "description": "Whether address values must carry latitude and longitude." }, "IsReadOnly": { "type": "boolean", "description": "Whether runtime writes should skip this field." }, "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 }, "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": "Classifier Catalog Definition identifier for Classifier fields.", "nullable": true }, "DefaultValue": { "$ref": "#/components/schemas/EntityFieldDefaultValueRequest" } }, "additionalProperties": false, "description": "Request payload to create an entity field." }, "CreateEntityJsonExportProfileRequest": { "required": [ "Key", "Name", "ReferenceResolvers", "SelectedFieldIds" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing profile name." }, "Key": { "type": "string", "description": "Stable technical profile key." }, "IdentityMode": { "$ref": "#/components/schemas/EntityDataTransferIdentityMode" }, "IdentityFieldId": { "type": "string", "description": "Optional identity field identifier.", "nullable": true }, "SelectedFieldIds": { "type": "array", "items": { "type": "string" }, "description": "Ordered export-selected entity field identifiers." }, "ReferenceResolvers": { "type": "array", "items": { "$ref": "#/components/schemas/EntityJsonExportProfileResolverFieldRequest" }, "description": "Resolver configuration keyed by entity field definition identifier." }, "Description": { "type": "string", "description": "Optional user-facing workflow description.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create one JSON export profile slice." }, "CreateEntityMutationEffectRequest": { "required": [ "SourcePath", "TargetFieldId", "TriggerFieldIds" ], "type": "object", "properties": { "TargetFieldId": { "type": "string" }, "SourcePath": { "type": "string" }, "TriggerFieldIds": { "type": "array", "items": { "type": "string" } }, "ApplyOnMode": { "$ref": "#/components/schemas/EntityEditOperationMode" }, "AssignmentMode": { "$ref": "#/components/schemas/EntityMutationEffectAssignmentMode" }, "SortOrder": { "type": "integer", "format": "int32" }, "IsEnabled": { "type": "boolean" }, "ApplyWhen": { "type": "string", "description": "Optional typed condition that must evaluate to true before the effect may apply.\r\nBlank or null means always. The condition may use primary fields, one scalar reference hop,\r\nand `Operation.Mode`; its root fields become additional triggers.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create an entity mutation effect." }, "CreateEntityStatementRequest": { "required": [ "DisplayName", "Expression", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "Stable technical statement key." }, "DisplayName": { "type": "string", "description": "User-facing statement label." }, "Expression": { "type": "string", "description": "SQL-like statement expression." }, "ExposeInClient": { "type": "boolean", "description": "Whether runtime payloads expose this statement." } }, "additionalProperties": false, "description": "Create one entity statement." }, "CreateEntityUiCardSurfaceRequest": { "required": [ "Key", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing card surface name." }, "Key": { "type": "string", "description": "Stable card surface key used by selectors and routes." }, "IsDefault": { "type": "boolean", "description": "Whether the new card surface should become the default card immediately." } }, "additionalProperties": false, "description": "Request payload to create an explicit custom card surface." }, "CreateEntityUiFormSurfaceRequest": { "required": [ "Key", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing form surface name." }, "Key": { "type": "string", "description": "Stable form surface key used by selectors and routes." }, "IsDefault": { "type": "boolean", "description": "Whether the new form surface should become the default form immediately." } }, "additionalProperties": false, "description": "Request payload to create an explicit custom form surface." }, "CreateEntityUiHostSurfaceRequest": { "required": [ "Key", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing host-surface name." }, "Key": { "type": "string", "description": "Stable host-surface key used by selectors and routes." }, "IsDefault": { "type": "boolean", "description": "Whether the new host surface should become its family's default." } }, "additionalProperties": false, "description": "Request payload to create a custom entity-list, details-page, or drawer surface." }, "CreateEntityUiTableSurfaceRequest": { "required": [ "Key", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing table surface name." }, "Key": { "type": "string", "description": "Stable table surface key used by selectors and routes." }, "IsDefault": { "type": "boolean", "description": "Whether the new table surface should become the default table immediately." } }, "additionalProperties": false, "description": "Request payload to create a custom table surface." }, "CreateEntityValidationRuleRequest": { "required": [ "DisplayName", "Expression", "Message", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "Stable technical validation rule key." }, "DisplayName": { "type": "string", "description": "User-facing validation rule label." }, "Expression": { "type": "string", "description": "Boolean validation expression." }, "Message": { "type": "string", "description": "User-facing validation failure message." }, "Enabled": { "type": "boolean", "description": "Whether this validation rule is active." }, "MessageTranslations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional localized validation failure message templates keyed by locale.", "nullable": true } }, "additionalProperties": false, "description": "Create one entity validation rule." }, "CreateManagedSecretRequest": { "type": "object", "properties": { "Key": { "type": "string", "description": "Immutable, case-insensitive lookup key. Leading and trailing whitespace is invalid.", "nullable": true }, "Value": { "type": "string", "description": "Secret value, limited to 64 KiB in UTF-8. It is stored without transformation and never returned.", "nullable": true } }, "additionalProperties": false, "description": "Create an enabled write-only managed secret at value version 1." }, "CreateNetOperationProjectManualEditRevisionRequest": { "type": "object", "properties": { "BaseRevisionId": { "type": "string", "description": "Working revision the edit was based on.", "nullable": true }, "BaseSourceChecksum": { "type": "string", "description": "Source checksum of the base revision.", "nullable": true }, "Comment": { "type": "string", "description": "Optional revision comment.", "nullable": true }, "Changes": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectSourceChangeRequest" }, "description": "File changes to apply to the base revision.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create an immutable Net Operation Project source revision from manual file edits." }, "CreateRecordMatchingProfileRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "TargetKind": { "$ref": "#/components/schemas/RecordMatchingTargetKind" }, "TargetEntityDefinitionId": { "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" }, "Rules": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingRuleRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Request payload for creating a record-matching profile." }, "CreateResponsibilityGroupRequest": { "type": "object", "properties": { "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 }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional non-secret integration metadata.", "nullable": true }, "ResponsibilityGroupId": { "type": "string", "description": "Optional caller-supplied stable group identifier.", "nullable": true } }, "additionalProperties": false, "description": "Create one responsibility group." }, "CreateRoleRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Role display name.", "nullable": true }, "Description": { "type": "string", "description": "Role description.", "nullable": true }, "AutoAssign": { "type": "boolean", "description": "Whether to auto-assign the role to new users." }, "RoleId": { "type": "string", "description": "Optional caller-supplied stable role identifier.", "nullable": true }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional non-secret integration metadata.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create a workspace role." }, "CreateRuntimeMenuRequest": { "required": [ "Items", "Name", "Priority" ], "type": "object", "properties": { "Name": { "type": "string", "description": "Menu display name." }, "Description": { "type": "string", "description": "Optional free-form description.", "nullable": true }, "Priority": { "type": "integer", "description": "Resolution priority.", "format": "int32" }, "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Optional role scope; empty means all users.", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/RuntimeMenuNodeRequest" }, "description": "Whole menu tree." } }, "additionalProperties": false, "description": "Create one user menu." }, "CreateUserRequest": { "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 (required).", "nullable": true }, "LastName": { "type": "string", "description": "Last name.", "nullable": true }, "UserType": { "$ref": "#/components/schemas/UserType" }, "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Optional role identifiers to assign.", "nullable": true }, "UserId": { "type": "string", "description": "Optional caller-supplied stable user identifier.", "nullable": true }, "EmailConfirmed": { "type": "boolean", "description": "Whether the optional email is confirmed." }, "IsBlocked": { "type": "boolean", "description": "Whether the created user is blocked." }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional non-secret integration metadata.", "nullable": true }, "Password": { "type": "string", "description": "Optional initial local password. Supported only for workspace users; omit it for\r\npasswordless provisioning and service users.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create a workspace user." }, "CreateWorkspaceUiProjectBuildRequest": { "type": "object", "properties": { "RevisionId": { "type": "string", "description": "Source revision identifier.", "nullable": true }, "Kind": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildKind" } }, "additionalProperties": false, "description": "Create a queued Workspace UI check or build record." }, "CreateWorkspaceUiProjectRevisionRequest": { "type": "object", "properties": { "BaseRevisionId": { "type": "string", "description": "Working revision on which the edit is based.", "nullable": true }, "BaseSourceChecksum": { "type": "string", "description": "Expected checksum of the base revision.", "nullable": true }, "Comment": { "type": "string", "description": "Optional revision comment.", "nullable": true }, "Changes": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiProjectFileChangeRequest" }, "description": "Source-file changes to apply to the base revision.", "nullable": true } }, "additionalProperties": false, "description": "Create an immutable manual-edit Workspace UI source revision." }, "DeactivateEntitlementOperationsModelRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "Reason": { "type": "string", "description": "Optional administrator reason.", "nullable": true }, "RowVersion": { "type": "string", "description": "Required concurrency token from the current model.", "format": "uuid" } }, "additionalProperties": false, "description": "Request used to deactivate a model without deleting it." }, "DeleteBoardConstraintBindingRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Delete one Board Constraint Binding." }, "DeleteBoardConstraintRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Delete a Board Constraint." }, "DeleteBoardRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Optional expected board row version.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Deletes a board." }, "DeleteBoardStatementRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Delete a Board Statement." }, "DeleteBoardStatusRequest": { "type": "object", "properties": { "TargetStatusId": { "type": "string", "description": "Target status for current board items.", "nullable": true }, "Reason": { "type": "string", "description": "Optional administrator reason.", "nullable": true }, "RowVersion": { "type": "string", "description": "Optional expected status row version.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Deletes a board status." }, "DeleteBoardTargetDefinitionRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Optional expected target definition row version for optimistic concurrency. When supplied it must match the current row version or the request fails with a conflict.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Deletes a canonical board target definition." }, "DeleteBoardTransitionRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Optional expected transition row version.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Deletes a board transition." }, "DeleteEntitlementPlanRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Required concurrency token from the current plan.", "format": "uuid" } }, "additionalProperties": false, "description": "Delete an unused entitlement plan." }, "DeleteEntityDataTransferProfileRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Expected profile row version.", "format": "uuid" } }, "additionalProperties": false, "description": "Request payload to soft-delete an entity data transfer profile." }, "DeleteEntityUiFieldPreferenceRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Expected explicit row version when deleting an existing override.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request payload to delete explicit field UI preferences." }, "DevLogEntrySummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Log entry identifier.", "nullable": true }, "CreatedAt": { "type": "string", "description": "Entry creation timestamp in UTC.", "format": "date-time" }, "Level": { "$ref": "#/components/schemas/DevLogLevel" }, "Source": { "type": "string", "description": "Runtime or module source.", "nullable": true }, "Category": { "type": "string", "description": "Optional caller category.", "nullable": true }, "Message": { "type": "string", "description": "Diagnostic message.", "nullable": true }, "CorrelationId": { "type": "string", "description": "Correlation identifier.", "nullable": true }, "ExecutionTraceId": { "type": "string", "description": "Execution trace identifier.", "nullable": true }, "OperationId": { "type": "string", "description": "Operation identifier.", "nullable": true }, "ParentOperationId": { "type": "string", "description": "Parent operation identifier.", "nullable": true }, "ActorUserId": { "type": "string", "description": "Effective actor user identifier.", "nullable": true }, "OriginalUserId": { "type": "string", "description": "Original user identifier when the effective actor is system-owned.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Related business-function identifier.", "nullable": true }, "BusinessFunctionVersionId": { "type": "string", "description": "Related business-function version identifier.", "nullable": true }, "BusinessFunctionRunId": { "type": "string", "description": "Related business-function run identifier.", "nullable": true }, "QueuedJobId": { "type": "string", "description": "Related queued job identifier.", "nullable": true }, "TriggerBindingId": { "type": "string", "description": "Related trigger binding identifier.", "nullable": true }, "ScheduleId": { "type": "string", "description": "Related schedule identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Related entity definition identifier.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Related entity instance identifier.", "nullable": true }, "EntityOperation": { "type": "string", "description": "Related entity operation.", "nullable": true }, "IgnoredTransaction": { "type": "boolean", "description": "Whether the entry intentionally bypassed the caller transaction." }, "HasException": { "type": "boolean", "description": "Whether exception details are present." }, "ActorUser": { "$ref": "#/components/schemas/DevLogRelatedDisplay" }, "OriginalUser": { "$ref": "#/components/schemas/DevLogRelatedDisplay" }, "BusinessFunction": { "$ref": "#/components/schemas/DevLogRelatedDisplay" }, "BusinessFunctionVersion": { "$ref": "#/components/schemas/DevLogRelatedDisplay" }, "BusinessFunctionRun": { "$ref": "#/components/schemas/DevLogRelatedDisplay" }, "QueuedJob": { "$ref": "#/components/schemas/DevLogRelatedDisplay" }, "TriggerBinding": { "$ref": "#/components/schemas/DevLogRelatedDisplay" }, "Schedule": { "$ref": "#/components/schemas/DevLogRelatedDisplay" }, "EntityDefinition": { "$ref": "#/components/schemas/DevLogRelatedDisplay" }, "EntityInstance": { "$ref": "#/components/schemas/DevLogRelatedDisplay" } }, "additionalProperties": false, "description": "Summary row for the Moltaro developer log." }, "DevLogLevel": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Trace", "Debug", "Information", "Warning", "Error", "Critical" ], "x-enum-descriptions": { "0": "Fine-grained trace output for deep diagnostics", "1": "Diagnostic detail useful while developing functions", "2": "Normal informational events", "3": "Unexpected situations that did not stop execution", "4": "Failures that stopped an operation", "5": "Severe failures that require immediate attention" } }, "DevLogRelatedDisplay": { "type": "object", "properties": { "Id": { "type": "string", "description": "Referenced object identifier.", "nullable": true }, "Label": { "type": "string", "description": "Primary display label.", "nullable": true }, "Subtitle": { "type": "string", "description": "Optional secondary display text.", "nullable": true }, "Kind": { "type": "string", "description": "Referenced object kind.", "nullable": true } }, "additionalProperties": false, "description": "Human-readable display data for an object referenced by a developer-log entry." }, "DisableBoardsRequest": { "required": [ "Reason" ], "type": "object", "properties": { "Reason": { "type": "string", "description": "Administrator reason." }, "RowVersion": { "type": "string", "description": "Optional expected module row version.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Disables the Boards module lifecycle." }, "DisableEntitlementOperationsRequest": { "required": [ "Reason" ], "type": "object", "properties": { "Reason": { "type": "string", "description": "Disable reason." }, "RowVersion": { "type": "string", "description": "Optional module-state row version for concurrency checks.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request used to disable Moltaro Entitlement Operations without deleting its configuration." }, "DisableGeoResourceLocationSourceRequest": { "required": [ "ContextResourceId", "LocationSourceKey", "ModuleKey", "ResourceKind" ], "type": "object", "properties": { "ModuleKey": { "type": "string" }, "ResourceKind": { "type": "string" }, "ContextResourceId": { "type": "string" }, "LocationSourceKey": { "type": "string" }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request for disabling a Location source configuration." }, "EnableBoardsRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Optional expected module row version.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Enables the Boards module lifecycle." }, "EnableEntitlementOperationsRequest": { "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Optional module-state row version for concurrency checks.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request used to enable Moltaro Entitlement Operations." }, "EntitlementIssuedTermsRequirement": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "Optional", "Required" ], "x-enum-descriptions": { "0": "Do not capture issued terms for entitlements granted from this plan", "1": "Accept issued terms as optional input when the entitlement is granted", "2": "Reject grants that do not supply issued terms" } }, "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" } }, "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" } }, "EntitlementModelPartyRoleKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Owner", "Delegate" ], "x-enum-descriptions": { "0": "Root party role whose instances own issued entitlements and are selected at grant time", "1": "Party role whose instances receive access from the owner through the configured delegation path" } }, "EntitlementModelResourceRoleKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Root", "Related" ], "x-enum-descriptions": { "0": "Resource role for the directly granted root resource definition", "1": "Resource role for child resources reached through the model's resource hierarchy path" } }, "EntitlementModelSecurityCapability": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ManagePlans", "ManageEntitlements", "ReadEntitlements" ], "x-enum-descriptions": { "0": "Allow creating, updating, deleting, and ordering the model's plans", "1": "Allow assigning, revoking, and changing entitlements owned by the model", "2": "Allow reading runtime entitlements owned by the model" } }, "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" } }, "EntitlementOperationsAllowedActions": { "type": "object", "properties": { "CanStartSetup": { "type": "boolean" }, "CanEnable": { "type": "boolean" }, "CanUpdateSettings": { "type": "boolean" }, "CanDisable": { "type": "boolean" } }, "additionalProperties": false, "description": "Available admin actions for the current module state." }, "EntitlementOperationsDetail": { "type": "object", "properties": { "Summary": { "$ref": "#/components/schemas/EntitlementOperationsSummary" }, "EntitlementModels": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsEntitlementModel" }, "nullable": true } }, "additionalProperties": false, "description": "Full Moltaro Entitlement Operations configuration detail." }, "EntitlementOperationsDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementOperationsDetail" }, "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 }, "EntitlementOperationsEntitlementModel": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "ModelType": { "$ref": "#/components/schemas/EntitlementModelType" }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRole" }, "DelegateParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRole" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRole" }, "RelatedResource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRole" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPath" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPath" }, "Plans": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsPlanPreview" }, "nullable": true }, "AllowedActions": { "$ref": "#/components/schemas/EntitlementOperationsEntitlementModelAllowedActions" }, "IsActive": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Configured entitlement model aggregate." }, "EntitlementOperationsEntitlementModelAllowedActions": { "type": "object", "properties": { "CanEditIdentity": { "type": "boolean" }, "CanEditParty": { "type": "boolean" }, "CanEditResource": { "type": "boolean" }, "CanCreatePlan": { "type": "boolean" }, "CanDelete": { "type": "boolean" }, "CanDeactivate": { "type": "boolean" }, "CanReactivate": { "type": "boolean" } }, "additionalProperties": false, "description": "Server-computed actions allowed for one entitlement model." }, "EntitlementOperationsEntitlementModelRequest": { "required": [ "DisplayName", "OwnerParty", "Resource" ], "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string" }, "Description": { "type": "string", "nullable": true }, "ModelType": { "$ref": "#/components/schemas/EntitlementModelType" }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRoleRequest" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPathRequest" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRoleRequest" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPathRequest" }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Entitlement model aggregate submitted by setup planning and settings screens." }, "EntitlementOperationsEntityDefinitionOption": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "DisplayNameSingular": { "type": "string", "nullable": true }, "DisplayNamePlural": { "type": "string", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsEntityFieldOption" }, "nullable": true }, "TableSurfaces": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsTableSurfaceOption" }, "nullable": true } }, "additionalProperties": false, "description": "EntityDefinition option shown in setup and settings screens." }, "EntitlementOperationsEntityFieldOption": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "ReferenceToEntityDefinitionId": { "type": "string", "nullable": true }, "IsDisplayNameCompatible": { "type": "boolean" }, "IsReferenceCompatible": { "type": "boolean" } }, "additionalProperties": false, "description": "Field option shown in setup and settings screens." }, "EntitlementOperationsModelSecurity": { "type": "object", "properties": { "EntitlementModelId": { "type": "string", "nullable": true }, "Grants": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsModelSecurityGrant" }, "nullable": true } }, "additionalProperties": false, "description": "Security settings for one entitlement model." }, "EntitlementOperationsModelSecurityGrant": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "RoleId": { "type": "string", "nullable": true }, "RoleName": { "type": "string", "nullable": true }, "Capability": { "$ref": "#/components/schemas/EntitlementModelSecurityCapability" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Role grant materialized for one entitlement model security screen." }, "EntitlementOperationsModelSecurityGrantRequest": { "required": [ "RoleId" ], "type": "object", "properties": { "RoleId": { "type": "string" }, "Capability": { "$ref": "#/components/schemas/EntitlementModelSecurityCapability" } }, "additionalProperties": false, "description": "Security grant submitted by the model security screen." }, "EntitlementOperationsModelSecurityResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementOperationsModelSecurity" }, "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 }, "EntitlementOperationsModelTypeOption": { "type": "object", "properties": { "ModelType": { "$ref": "#/components/schemas/EntitlementModelType" }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "AllowsResourceHierarchy": { "type": "boolean" }, "PartyTypes": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPartyType" }, "nullable": true }, "LimitFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementLimitFamily" }, "nullable": true } }, "additionalProperties": false, "description": "One supported typed entitlement model option exposed by the server." }, "EntitlementOperationsPartyDelegationPath": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "PathKey": { "type": "string", "nullable": true }, "OwnerPartyRoleId": { "type": "string", "nullable": true }, "DelegatePartyRoleId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "LeafEntityDefinitionId": { "type": "string", "nullable": true }, "LeafEntityDisplayName": { "type": "string", "nullable": true }, "Steps": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsRelationshipPathStep" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Delegation path owned by an entitlement model." }, "EntitlementOperationsPartyDelegationPathRequest": { "required": [ "PathKey" ], "type": "object", "properties": { "PathKey": { "type": "string" } }, "additionalProperties": false, "description": "Delegation path submitted for a delegated entitlement model." }, "EntitlementOperationsPartyRole": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "RoleKind": { "$ref": "#/components/schemas/EntitlementModelPartyRoleKind" }, "DisplayName": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityDisplayName": { "type": "string", "nullable": true }, "InstancePickerInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "InstanceLookupTableSelectorMode": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorMode" }, "InstanceLookupTableSurfaceKey": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Party role owned by an entitlement model." }, "EntitlementOperationsPartyRoleRequest": { "required": [ "DisplayName", "EntityDefinitionId" ], "type": "object", "properties": { "DisplayName": { "type": "string" }, "EntityDefinitionId": { "type": "string" }, "InstancePickerInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "InstanceLookupTableSelectorMode": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorMode" }, "InstanceLookupTableSurfaceKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Party role submitted as part of an entitlement model." }, "EntitlementOperationsPlanPreview": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PriceAmount": { "type": "number", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "ResourceCount": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Small plan preview used only by the module overview model list." }, "EntitlementOperationsRelationshipPathList": { "type": "object", "properties": { "RootEntityDefinitionId": { "type": "string", "nullable": true }, "Paths": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsRelationshipPathOption" }, "nullable": true } }, "additionalProperties": false, "description": "Relationship path options returned for a selected root EntityDefinition." }, "EntitlementOperationsRelationshipPathListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementOperationsRelationshipPathList" }, "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 }, "EntitlementOperationsRelationshipPathOption": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "RootEntityDefinitionId": { "type": "string", "nullable": true }, "RootEntityDisplayName": { "type": "string", "nullable": true }, "LeafEntityDefinitionId": { "type": "string", "nullable": true }, "LeafEntityDisplayName": { "type": "string", "nullable": true }, "Depth": { "type": "integer", "format": "int32" }, "Steps": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsRelationshipPathStep" }, "nullable": true } }, "additionalProperties": false, "description": "Relationship path option that can be selected by an entitlement model." }, "EntitlementOperationsRelationshipPathStep": { "type": "object", "properties": { "SortOrder": { "type": "integer", "format": "int32" }, "FromEntityDefinitionId": { "type": "string", "nullable": true }, "FromEntityDisplayName": { "type": "string", "nullable": true }, "ToEntityDefinitionId": { "type": "string", "nullable": true }, "ToEntityDisplayName": { "type": "string", "nullable": true }, "FieldId": { "type": "string", "nullable": true }, "FieldDisplayName": { "type": "string", "nullable": true }, "Direction": { "$ref": "#/components/schemas/EntitlementRelationshipPathStepDirection" } }, "additionalProperties": false, "description": "One resolved step inside a relationship path option." }, "EntitlementOperationsResourceHierarchyPath": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "PathKey": { "type": "string", "nullable": true }, "ParentResourceRoleId": { "type": "string", "nullable": true }, "ChildResourceRoleId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "LeafEntityDefinitionId": { "type": "string", "nullable": true }, "LeafEntityDisplayName": { "type": "string", "nullable": true }, "Steps": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsRelationshipPathStep" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Resource hierarchy path owned by an entitlement model." }, "EntitlementOperationsResourceHierarchyPathRequest": { "required": [ "PathKey" ], "type": "object", "properties": { "PathKey": { "type": "string" } }, "additionalProperties": false, "description": "Resource hierarchy path submitted when a model includes related resources." }, "EntitlementOperationsResourceRole": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "RoleKind": { "$ref": "#/components/schemas/EntitlementModelResourceRoleKind" }, "DisplayName": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityDisplayName": { "type": "string", "nullable": true }, "ResourcePickerInputType": { "$ref": "#/components/schemas/EntitlementResourcePickerInputType" }, "ResourceLookupTableSelectorMode": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorMode" }, "ResourceLookupTableSurfaceKey": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Resource role owned by an entitlement model." }, "EntitlementOperationsResourceRoleRequest": { "required": [ "DisplayName", "EntityDefinitionId" ], "type": "object", "properties": { "DisplayName": { "type": "string" }, "EntityDefinitionId": { "type": "string" }, "ResourcePickerInputType": { "$ref": "#/components/schemas/EntitlementResourcePickerInputType" }, "ResourceLookupTableSelectorMode": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorMode" }, "ResourceLookupTableSurfaceKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Resource role submitted as part of an entitlement model." }, "EntitlementOperationsRuntimeModelActions": { "type": "object", "properties": { "CanManagePlans": { "type": "boolean" }, "CanManageEntitlements": { "type": "boolean" }, "CanReadEntitlements": { "type": "boolean" } }, "additionalProperties": false, "description": "Server-computed runtime actions for one entitlement model." }, "EntitlementOperationsRuntimeModelList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsRuntimeModelSummary" }, "nullable": true } }, "additionalProperties": false, "description": "Runtime model list for Entitlement Operations." }, "EntitlementOperationsRuntimeModelListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementOperationsRuntimeModelList" }, "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 }, "EntitlementOperationsRuntimeModelSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "ModelType": { "$ref": "#/components/schemas/EntitlementModelType" }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsRuntimePartyRole" }, "DelegateParty": { "$ref": "#/components/schemas/EntitlementOperationsRuntimePartyRole" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "ResourceBindingMode": { "$ref": "#/components/schemas/EntitlementResourceBindingMode" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsRuntimeResourceRole" }, "AllowedActions": { "$ref": "#/components/schemas/EntitlementOperationsRuntimeModelActions" } }, "additionalProperties": false, "description": "Runtime entitlement model summary exposed to operational pages." }, "EntitlementOperationsRuntimePartyRole": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityDisplayName": { "type": "string", "nullable": true }, "InstancePickerInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "InstanceLookupTableSelectorMode": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorMode" }, "InstanceLookupTableSurfaceKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Runtime selector metadata for a party role." }, "EntitlementOperationsRuntimeResourceRole": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityDisplayName": { "type": "string", "nullable": true }, "ResourcePickerInputType": { "$ref": "#/components/schemas/EntitlementResourcePickerInputType" }, "ResourceLookupTableSelectorMode": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorMode" }, "ResourceLookupTableSurfaceKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Runtime selector metadata for a root resource role." }, "EntitlementOperationsSetup": { "type": "object", "properties": { "ModelTypes": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsModelTypeOption" }, "description": "Supported typed entitlement model descriptors.", "nullable": true }, "EntityDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsEntityDefinitionOption" }, "description": "Eligible EntityDefinitions and compatible fields.", "nullable": true } }, "additionalProperties": false, "description": "Bootstrap data for the Moltaro Entitlement Operations model editor." }, "EntitlementOperationsSetupPlan": { "type": "object", "properties": { "IsValid": { "type": "boolean" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true }, "PartyRoleCount": { "type": "integer", "format": "int32" }, "ResourceRoleCount": { "type": "integer", "format": "int32" }, "HasPartyDelegationPath": { "type": "boolean" }, "HasResourceHierarchyPath": { "type": "boolean" } }, "additionalProperties": false, "description": "Validation plan returned by setup-plan without mutating configuration." }, "EntitlementOperationsSetupPlanRequest": { "required": [ "EntitlementModel" ], "type": "object", "properties": { "EntitlementModel": { "$ref": "#/components/schemas/EntitlementOperationsEntitlementModelRequest" } }, "additionalProperties": false, "description": "Request used to validate a Moltaro Entitlement Operations setup without writing changes." }, "EntitlementOperationsSetupPlanResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementOperationsSetupPlan" }, "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 }, "EntitlementOperationsSetupResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementOperationsSetup" }, "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 }, "EntitlementOperationsSummary": { "type": "object", "properties": { "ModuleKey": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "IsEnabled": { "type": "boolean" }, "ConfigurationState": { "$ref": "#/components/schemas/ModuleConfigurationState" }, "IsConfigurationComplete": { "type": "boolean" }, "EnabledAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "DisabledAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "DisabledReason": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" }, "AllowedActions": { "$ref": "#/components/schemas/EntitlementOperationsAllowedActions" }, "EntitlementModelCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Moltaro Entitlement Operations module summary for the Modules hub." }, "EntitlementOperationsTableSurfaceOption": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "IsDefault": { "type": "boolean" } }, "additionalProperties": false, "description": "Table surface option shown for runtime lookup selection." }, "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" } }, "EntitlementPlanBootstrap": { "type": "object", "properties": { "EntitlementModel": { "$ref": "#/components/schemas/EntitlementPlanModelOption" }, "PlanFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanFamilyReference" }, "nullable": true }, "LimitFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanLimitFamilyOption" }, "nullable": true }, "TimeUnits": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanTimeUnitOption" }, "nullable": true }, "WindowAnchors": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanWindowAnchorOption" }, "nullable": true } }, "additionalProperties": false, "description": "Bootstrap data for plan administration under one entitlement model." }, "EntitlementPlanBootstrapResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementPlanBootstrap" }, "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 }, "EntitlementPlanFamilyCreateRequest": { "required": [ "DisplayName" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable family key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Family display name." }, "Description": { "type": "string", "description": "Optional family description.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Optional display order. The server appends when omitted.", "format": "int32", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this family can be assigned to plans." } }, "additionalProperties": false, "description": "Create a plan family for one entitlement model." }, "EntitlementPlanFamilyDeleteRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Required concurrency token from the current family.", "format": "uuid" } }, "additionalProperties": false, "description": "Delete an unused plan family." }, "EntitlementPlanFamilyDetail": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "PlanCount": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Plan family detail." }, "EntitlementPlanFamilyDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementPlanFamilyDetail" }, "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 }, "EntitlementPlanFamilyList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanFamilySummary" }, "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Paginated plan family list response." }, "EntitlementPlanFamilyListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementPlanFamilyList" }, "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 }, "EntitlementPlanFamilyReference": { "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 attached to a plan or exposed for plan authoring." }, "EntitlementPlanFamilySummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "PlanCount": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Plan family summary row." }, "EntitlementPlanFamilyUpdateRequest": { "required": [ "DisplayName", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable family key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Family display name." }, "Description": { "type": "string", "description": "Optional family description.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order.", "format": "int32" }, "IsActive": { "type": "boolean", "description": "Whether this family can be assigned to plans." }, "RowVersion": { "type": "string", "description": "Required concurrency token from the current family.", "format": "uuid" } }, "additionalProperties": false, "description": "Update a plan family." }, "EntitlementPlanLimitFamilyOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/EntitlementLimitFamily" }, "Key": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Limit family option exposed by the server." }, "EntitlementPlanModelOption": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "ModelType": { "$ref": "#/components/schemas/EntitlementModelType" }, "RootResourceEntityDefinitionId": { "type": "string", "nullable": true }, "RootResourceDisplayName": { "type": "string", "nullable": true }, "RelatedResourceEntityDefinitionId": { "type": "string", "nullable": true }, "RelatedResourceDisplayName": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Entitlement model available for plan authoring." }, "EntitlementPlanRenewalPolicy": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Mode": { "$ref": "#/components/schemas/EntitlementRenewalMode" }, "LeadDays": { "type": "integer", "format": "int32", "nullable": true }, "ExternalPolicyKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Renewal policy summary attached to a plan." }, "EntitlementPlanResource": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityDisplayName": { "type": "string", "nullable": true }, "ResourceEntityInstanceId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Breadcrumbs": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceBreadcrumb" }, "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Resource attached to a plan." }, "EntitlementPlanResourceBreadcrumb": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityDisplayName": { "type": "string", "nullable": true }, "ResourceEntityInstanceId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One breadcrumb item for a selected plan resource." }, "EntitlementPlanResourceRequest": { "required": [ "EntityDefinitionId", "ResourceEntityInstanceId" ], "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "description": "Entity definition of the selected resource instance." }, "ResourceEntityInstanceId": { "type": "string", "description": "Selected runtime EntityInstance id." }, "SortOrder": { "type": "integer", "description": "Display order.", "format": "int32" } }, "additionalProperties": false, "description": "Resource selected for a plan." }, "EntitlementPlanResourceTree": { "type": "object", "properties": { "Nodes": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceTreeNode" }, "nullable": true } }, "additionalProperties": false, "description": "Flat resource hierarchy payload used by the client to build a tree." }, "EntitlementPlanResourceTreeNode": { "type": "object", "properties": { "NodeKey": { "type": "string", "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityDisplayName": { "type": "string", "nullable": true }, "ResourceEntityInstanceId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "ParentNodeKey": { "type": "string", "nullable": true }, "Breadcrumbs": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceBreadcrumb" }, "nullable": true } }, "additionalProperties": false, "description": "One resource hierarchy node." }, "EntitlementPlanResourceTreeResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementPlanResourceTree" }, "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 }, "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" } }, "EntitlementPlanTimeUnitOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "Key": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Time unit option exposed by the server." }, "EntitlementPlanWindowAnchorOption": { "type": "object", "properties": { "Value": { "$ref": "#/components/schemas/EntitlementTimeBoundQuantityWindowAnchor" }, "Key": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Time-bound quantity window anchor option exposed by the server." }, "EntitlementRelationshipPathStepDirection": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Forward", "Reverse" ], "x-enum-descriptions": { "0": "Follow a reference field that points from the step's start entity to its end entity", "1": "Walk backward across a reference field that points from the step's end entity to its start entity" } }, "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" } }, "EntitlementRenewalPolicyCreateRequest": { "required": [ "DisplayName" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable policy key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Policy display name." }, "Description": { "type": "string", "description": "Optional policy description.", "nullable": true }, "Mode": { "$ref": "#/components/schemas/EntitlementRenewalMode" }, "LeadDays": { "type": "integer", "description": "Manual review lead time in days.", "format": "int32", "nullable": true }, "ExternalPolicyKey": { "type": "string", "description": "External integration policy key.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this policy can be assigned to plans." } }, "additionalProperties": false, "description": "Create a renewal policy for one entitlement model." }, "EntitlementRenewalPolicyDeleteRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "RowVersion": { "type": "string", "description": "Required concurrency token from the current policy.", "format": "uuid" } }, "additionalProperties": false, "description": "Delete an unused renewal policy." }, "EntitlementRenewalPolicyDetail": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Mode": { "$ref": "#/components/schemas/EntitlementRenewalMode" }, "LeadDays": { "type": "integer", "format": "int32", "nullable": true }, "ExternalPolicyKey": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Renewal policy detail." }, "EntitlementRenewalPolicyDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementRenewalPolicyDetail" }, "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 }, "EntitlementRenewalPolicyList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementRenewalPolicySummary" }, "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Paginated renewal policy list response." }, "EntitlementRenewalPolicyListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitlementRenewalPolicyList" }, "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 }, "EntitlementRenewalPolicySummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Mode": { "$ref": "#/components/schemas/EntitlementRenewalMode" }, "LeadDays": { "type": "integer", "format": "int32", "nullable": true }, "ExternalPolicyKey": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Renewal policy summary row." }, "EntitlementRenewalPolicyUpdateRequest": { "required": [ "DisplayName", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable policy key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Policy display name." }, "Description": { "type": "string", "description": "Optional policy description.", "nullable": true }, "Mode": { "$ref": "#/components/schemas/EntitlementRenewalMode" }, "LeadDays": { "type": "integer", "description": "Manual review lead time in days.", "format": "int32", "nullable": true }, "ExternalPolicyKey": { "type": "string", "description": "External integration policy key.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this policy can be assigned to plans." }, "RowVersion": { "type": "string", "description": "Required concurrency token from the current policy.", "format": "uuid" } }, "additionalProperties": false, "description": "Update a renewal policy." }, "EntitlementResourceBindingMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "PlanSelectedResources", "GrantSelectedResources" ], "x-enum-descriptions": { "0": "Select concrete resources on the plan and copy them to issued entitlements", "1": "Select concrete resources at grant time when the entitlement is issued" } }, "EntitlementResourcePickerInputType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Default", "List", "LongList", "Lookup" ], "x-enum-descriptions": { "0": "Pick resources through the module's default selector, currently the plan resource tree", "1": "Pick resources from the compact entity-instance list selector", "2": "Pick resources from the entity-instance list selector optimized for large option sets", "3": "Pick resources through a lookup picker backed by a table surface" } }, "EntitlementResourceScopeMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "SelectedResource", "IncludeRelatedResources" ], "x-enum-descriptions": { "0": "Cover only the explicitly selected resource instance", "1": "Also cover related child resource instances resolved through the model-owned resource hierarchy path" } }, "EntitlementTimeBoundQuantityWindowAnchor": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "GrantStart", "CalendarPeriod" ], "x-enum-descriptions": { "0": "Start the first window at the grant moment and repeat later windows from that timestamp", "1": "Align each window to the start of the matching calendar period, such as the current month or year" } }, "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." }, "EntityCalculatedFieldRecalculationJob": { "type": "object", "properties": { "JobId": { "type": "string", "nullable": true }, "Reason": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationReason" }, "Status": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJobStatus" }, "EntityDefinitionId": { "type": "string", "nullable": true }, "EntityFieldDefinitionId": { "type": "string", "nullable": true }, "RequestedByUserId": { "type": "string", "nullable": true }, "AttemptCount": { "type": "integer", "format": "int32" }, "MaxAttempts": { "type": "integer", "format": "int32" }, "IsRetryable": { "type": "boolean" }, "IsTerminal": { "type": "boolean" }, "NextRetryAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "TotalRowCount": { "type": "integer", "format": "int32", "nullable": true }, "ProcessedRowCount": { "type": "integer", "format": "int32" }, "LastProcessedRowId": { "type": "string", "nullable": true }, "LastError": { "type": "string", "nullable": true }, "CreatedAtUtc": { "type": "string", "format": "date-time" }, "StartedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "FinishedAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Detailed operational state for one calculated-field recalculation job." }, "EntityCalculatedFieldRecalculationJobList": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "nullable": true }, "Status": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJobStatus" }, "Limit": { "type": "integer", "format": "int32" }, "TotalCount": { "type": "integer", "format": "int32" }, "Jobs": { "type": "array", "items": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJob" }, "nullable": true } }, "additionalProperties": false, "description": "Paged operational job diagnostics for calculated-field recalculation on one entity definition." }, "EntityCalculatedFieldRecalculationJobListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJobList" }, "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 }, "EntityCalculatedFieldRecalculationJobResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityCalculatedFieldRecalculationJob" }, "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 }, "EntityCalculatedFieldRecalculationJobStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Queued", "Processing", "Succeeded", "Failed", "Cancelled" ], "x-enum-descriptions": { "0": "Job is waiting for a background worker to pick it up", "1": "Job is currently recalculating field values", "2": "Job finished recalculating the affected records", "3": "Job stopped with an error before completing", "4": "Job was cancelled before it could complete" } }, "EntityCalculatedFieldRecalculationReason": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "FormulaChanged", "DefinitionImport", "ManualReconcile" ], "x-enum-descriptions": { "0": "A calculated field expression was edited, so stored values must be recomputed", "1": "An entity definition import changed calculated field configuration", "2": "An administrator requested a manual recalculation run" } }, "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." }, "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" } }, "EntityDataTransferFieldResolverTargetDecision": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "NotApplicable", "ActiveSupported", "PreserveOnlyStale", "InvalidActiveUnsupported", "InvalidWrongTargetDefinition", "InvalidMissingTarget" ], "x-enum-descriptions": { "0": "Resolver mode does not use a target field, so no target evaluation applies", "1": "Target field exists, is active, and has a supported type, so it can resolve and project values", "2": "Persisted target field no longer exists; the resolver row round-trips but cannot project values", "3": "Target field still exists but its type or table placement is not a valid resolver target", "4": "Target field belongs to a different entity definition than the reference target", "5": "Configured target field cannot be found and no persisted resolver history covers it" } }, "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" } }, "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" } }, "EntityDataTransferProfileDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Profile identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Owning entity definition identifier.", "nullable": true }, "Name": { "type": "string", "description": "User-facing profile name.", "nullable": true }, "Key": { "type": "string", "description": "Stable technical profile key.", "nullable": true }, "Direction": { "$ref": "#/components/schemas/EntityDataTransferDirection" }, "Format": { "$ref": "#/components/schemas/EntityDataTransferFormat" }, "IdentityMode": { "$ref": "#/components/schemas/EntityDataTransferIdentityMode" }, "IdentityFieldId": { "type": "string", "description": "Optional identity field identifier.", "nullable": true }, "ImportMode": { "$ref": "#/components/schemas/EntityDataTransferImportMode" }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataTransferProfileField" }, "description": "Configured profile fields.", "nullable": true }, "ReferenceResolvers": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataTransferProfileReferenceResolver" }, "description": "Configured reference resolvers.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "Description": { "type": "string", "description": "Optional user-facing workflow description.", "nullable": true } }, "additionalProperties": false, "description": "Detailed metadata for one entity data transfer profile." }, "EntityDataTransferProfileDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityDataTransferProfileDetail" }, "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 }, "EntityDataTransferProfileField": { "type": "object", "properties": { "Id": { "type": "string", "description": "Profile field identifier.", "nullable": true }, "ProfileId": { "type": "string", "description": "Owning profile identifier.", "nullable": true }, "EntityFieldDefinitionId": { "type": "string", "description": "Referenced entity field definition identifier.", "nullable": true }, "EntityDefinitionTableId": { "type": "string", "description": "Owning entity definition table identifier.", "nullable": true }, "FieldKey": { "type": "string", "description": "Referenced field key.", "nullable": true }, "FieldDisplayName": { "type": "string", "description": "Referenced field display name.", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "IncludeInExport": { "type": "boolean", "description": "Whether the field participates in export." }, "IncludeInImport": { "type": "boolean", "description": "Whether the field participates in import." }, "TableHandlingMode": { "$ref": "#/components/schemas/EntityDataTransferTableHandlingMode" }, "SortOrder": { "type": "integer", "description": "Sort order inside the profile field list.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "One configured entity data transfer profile field." }, "EntityDataTransferProfileFieldRequest": { "required": [ "EntityFieldDefinitionId" ], "type": "object", "properties": { "EntityFieldDefinitionId": { "type": "string", "description": "Referenced entity field definition identifier." }, "IncludeInExport": { "type": "boolean", "description": "Whether the field participates in export." }, "IncludeInImport": { "type": "boolean", "description": "Whether the field participates in import." }, "TableHandlingMode": { "$ref": "#/components/schemas/EntityDataTransferTableHandlingMode" }, "SortOrder": { "type": "integer", "description": "Sort order inside the profile field list.", "format": "int32" } }, "additionalProperties": false, "description": "One profile field row inside a replace-whole-slice update request." }, "EntityDataTransferProfileReferenceResolver": { "type": "object", "properties": { "Id": { "type": "string", "description": "Resolver identifier.", "nullable": true }, "ProfileFieldId": { "type": "string", "description": "Owning profile field identifier.", "nullable": true }, "ResolverMode": { "$ref": "#/components/schemas/EntityDataTransferResolverMode" }, "TargetFieldId": { "type": "string", "description": "Optional target field identifier.", "nullable": true }, "TargetFieldKey": { "type": "string", "description": "Optional target field key.", "nullable": true }, "TargetFieldDisplayName": { "type": "string", "description": "Optional target field display name.", "nullable": true }, "TargetDecision": { "$ref": "#/components/schemas/EntityDataTransferFieldResolverTargetDecision" }, "SortOrder": { "type": "integer", "description": "Sort order inside the profile field resolver list.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "One configured reference resolver for a profile field." }, "EntityDataTransferProfileReferenceResolverRequest": { "required": [ "ProfileFieldId" ], "type": "object", "properties": { "ProfileFieldId": { "type": "string", "description": "Owning profile field identifier." }, "ResolverMode": { "$ref": "#/components/schemas/EntityDataTransferResolverMode" }, "TargetFieldId": { "type": "string", "description": "Optional target field identifier.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Sort order inside the profile field resolver list.", "format": "int32" } }, "additionalProperties": false, "description": "One profile reference resolver row inside a replace-whole-slice update request." }, "EntityDataTransferProfileSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Profile identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Owning entity definition identifier.", "nullable": true }, "Name": { "type": "string", "description": "User-facing profile name.", "nullable": true }, "Key": { "type": "string", "description": "Stable technical profile key.", "nullable": true }, "Direction": { "$ref": "#/components/schemas/EntityDataTransferDirection" }, "Format": { "$ref": "#/components/schemas/EntityDataTransferFormat" }, "IdentityMode": { "$ref": "#/components/schemas/EntityDataTransferIdentityMode" }, "IdentityFieldId": { "type": "string", "description": "Optional identity field identifier.", "nullable": true }, "ImportMode": { "$ref": "#/components/schemas/EntityDataTransferImportMode" }, "FieldCount": { "type": "integer", "description": "Configured profile field count.", "format": "int32" }, "ReferenceResolverCount": { "type": "integer", "description": "Configured reference resolver count.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "Description": { "type": "string", "description": "Optional user-facing workflow description.", "nullable": true } }, "additionalProperties": false, "description": "Summary metadata for one entity data transfer profile." }, "EntityDataTransferProfileSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataTransferProfileSummary" }, "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 }, "EntityDataTransferResolverMode": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Id", "Number", "Field" ], "x-enum-descriptions": { "0": "Resolve the referenced record by its entity instance id", "1": "Resolve the referenced record by its visible entity number", "2": "Resolve the referenced record by the value of a configured target field" } }, "EntityDataTransferTableHandlingMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ReplaceAllRows", "UpsertByRowId" ], "x-enum-descriptions": { "0": "Uploaded rows become the complete child-row set, removing existing rows that are not re-uploaded", "1": "Uploaded rows with ids update matching child rows, rows without ids insert, and omitted rows are preserved" } }, "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." }, "EntityDefinitionDeleteMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ImmediateDeleted", "Scheduled" ], "x-enum-descriptions": { "0": "Definition was removed right away without a scheduled purge window", "1": "Definition is marked for deletion and will be purged after the delay window elapses" } }, "EntityDefinitionDeleteResult": { "type": "object", "properties": { "Mode": { "$ref": "#/components/schemas/EntityDefinitionDeleteMode" }, "DeletionRequestedAt": { "type": "string", "description": "Timestamp when deferred deletion was requested.", "format": "date-time", "nullable": true }, "PurgeAfterUtc": { "type": "string", "description": "Scheduled purge timestamp for deferred deletion.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Delete result for one entity definition." }, "EntityDefinitionDeleteResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityDefinitionDeleteResult" }, "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 }, "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 }, "EntityDefinitionImportPlan": { "required": [ "Security" ], "type": "object", "properties": { "Mode": { "$ref": "#/components/schemas/ImportPlanMode" }, "Header": { "$ref": "#/components/schemas/ImportPlanHeader" }, "Sections": { "type": "array", "items": { "$ref": "#/components/schemas/ImportPlanSection" }, "description": "Hierarchical plan sections.", "nullable": true }, "Security": { "$ref": "#/components/schemas/SecurityConfigurationPlanResult" } }, "additionalProperties": false, "description": "Root model for an entity definition import plan." }, "EntityDefinitionImportPlanResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityDefinitionImportPlan" }, "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." }, "EntityDefinitionIndexListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionIndex" }, "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 }, "EntityDefinitionIndexResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityDefinitionIndex" }, "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 }, "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." }, "EntityDefinitionSearchTargetRequest": { "type": "object", "properties": { "Path": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionSearchTargetSegmentRequest" }, "description": "Ordered path. Intermediate segments are Reference, InverseReference, or Table fields;\r\nthe last segment is a supported field or system target.", "nullable": true } }, "additionalProperties": false, "description": "One explicitly configured entity search target path." }, "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." }, "EntityDefinitionSearchTargetSegmentRequest": { "type": "object", "properties": { "FieldId": { "type": "string", "description": "Stable field identifier.", "nullable": true }, "FieldKey": { "type": "string", "description": "Field key resolved in the entity or table reached by the preceding segment.", "nullable": true }, "SystemTarget": { "$ref": "#/components/schemas/EntitySearchSystemTarget" } }, "additionalProperties": false, "description": "One field or system-content segment in an entity search target path." }, "EntityDefinitionSecurityApplyRequest": { "required": [ "ExpectedRowVersion", "OperationKey", "PlanToken", "UserSlotMappings" ], "type": "object", "properties": { "OperationKey": { "type": "string", "description": "Caller-owned idempotency key used by the matching plan.", "format": "uuid" }, "UserSlotMappings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Workspace-local user mappings for portable user slots." }, "PlanToken": { "type": "string", "description": "Opaque token returned by the matching Security plan." }, "ExpectedRowVersion": { "type": "string", "description": "Security configuration row version returned by the matching plan.", "format": "uuid" } }, "additionalProperties": false, "description": "Apply input for an Entity YAML v8 Security configuration." }, "EntityDefinitionSecurityPlanRequest": { "required": [ "OperationKey", "UserSlotMappings" ], "type": "object", "properties": { "OperationKey": { "type": "string", "description": "Caller-owned idempotency key reused by apply.", "format": "uuid" }, "UserSlotMappings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Workspace-local user mappings for portable user slots." }, "ExpectedRowVersion": { "type": "string", "description": "Expected current Security configuration row version; null only for create mode.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Planning input for an Entity YAML v8 Security configuration." }, "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." }, "EntityDefinitionUniqueConstraintListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionUniqueConstraint" }, "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 }, "EntityDefinitionUniqueConstraintResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityDefinitionUniqueConstraint" }, "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" } }, "EntityDetailsBackTargetAdmin": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/EntityDetailsBackTarget" }, "EntityListPageSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware entity-list-page selectors when Moltaro.Entity.Ui.Models.EntityDetailsBackTargetAdminModel.Target is EntityListPage.", "nullable": true }, "BoardId": { "type": "string", "description": "Stable provider-owned board identifier when Moltaro.Entity.Ui.Models.EntityDetailsBackTargetAdminModel.Target is Board.", "nullable": true }, "BoardKey": { "type": "string", "description": "Portable board key when Moltaro.Entity.Ui.Models.EntityDetailsBackTargetAdminModel.Target is Board.", "nullable": true }, "BoardDisplayName": { "type": "string", "description": "User-facing board label when available.", "nullable": true } }, "additionalProperties": false, "description": "Static structural back target configured on one details page." }, "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." }, "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" } }, "EntityFieldCalculationExpressionValidationError": { "type": "object", "properties": { "Field": { "type": "string", "description": "Request field the error refers to.", "nullable": true }, "Message": { "type": "string", "description": "Localized validation message.", "nullable": true }, "Code": { "type": "string", "description": "Stable machine-readable error code.", "nullable": true } }, "additionalProperties": false, "description": "One calculation expression validation error." }, "EntityFieldCalculationExpressionValidationResult": { "type": "object", "properties": { "Valid": { "type": "boolean", "description": "Whether the expression binds cleanly against the field's schema and target type." }, "Kind": { "$ref": "#/components/schemas/EntityFieldCalculationKind" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldCalculationExpressionValidationError" }, "description": "Validation errors when the expression is invalid.", "nullable": true } }, "additionalProperties": false, "description": "Result of validating a calculation expression without saving it." }, "EntityFieldCalculationExpressionValidationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityFieldCalculationExpressionValidationResult" }, "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 }, "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" } }, "EntityFieldDefaultValueRequest": { "type": "object", "properties": { "Kind": { "$ref": "#/components/schemas/EntityFieldDefaultValueKind" }, "Value": { "type": "object", "description": "Constant JSON value. A scalar Reference uses one entity-instance id string.\r\nMust be null for dynamic defaults.", "nullable": true } }, "additionalProperties": false, "description": "Default value configuration for an entity field." }, "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." }, "EntityFieldDefinitionListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldDefinition" }, "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 }, "EntityFieldDefinitionResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityFieldDefinition" }, "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 }, "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." }, "EntityFieldOptionRequest": { "required": [ "Key", "Value" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Option key." }, "Value": { "type": "string", "description": "Option display value." } }, "additionalProperties": false, "description": "Option payload 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." }, "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." }, "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" } }, "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." }, "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" } }, "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" } }, "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." }, "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" } }, "EntityJsonExportProfileResolverFieldRequest": { "required": [ "EntityFieldDefinitionId", "Resolvers" ], "type": "object", "properties": { "EntityFieldDefinitionId": { "type": "string", "description": "Owning entity field definition identifier." }, "Resolvers": { "type": "array", "items": { "$ref": "#/components/schemas/EntityJsonExportProfileResolverRequest" }, "description": "Ordered resolver rows owned by this field." } }, "additionalProperties": false, "description": "JSON export resolver configuration owned by one entity field definition." }, "EntityJsonExportProfileResolverRequest": { "type": "object", "properties": { "ResolverMode": { "$ref": "#/components/schemas/EntityDataTransferResolverMode" }, "TargetFieldId": { "type": "string", "description": "Optional target field identifier when the mode is Moltaro.Enums.EntityDataTransferResolverModeEnum.Field.", "nullable": true } }, "additionalProperties": false, "description": "One ordered JSON export resolver row for a reference-family field." }, "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." }, "EntityMutationEffect": { "type": "object", "properties": { "Id": { "type": "string", "description": "Mutation effect identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Owning entity definition identifier.", "nullable": true }, "TargetFieldId": { "type": "string", "description": "Identifier of the field the effect writes to.", "nullable": true }, "TargetFieldKey": { "type": "string", "description": "Key of the field the effect writes to.", "nullable": true }, "TargetFieldDisplayName": { "type": "string", "description": "Display name of the field the effect writes to.", "nullable": true }, "SourcePath": { "type": "string", "description": "Source value path copied into the target field when the effect fires.", "nullable": true }, "TriggerFieldIds": { "type": "array", "items": { "type": "string" }, "description": "Identifiers of the fields whose changes trigger the effect.", "nullable": true }, "TriggerFieldKeys": { "type": "array", "items": { "type": "string" }, "description": "Keys of the fields whose changes trigger the effect.", "nullable": true }, "ApplyOnMode": { "$ref": "#/components/schemas/EntityEditOperationMode" }, "AssignmentMode": { "$ref": "#/components/schemas/EntityMutationEffectAssignmentMode" }, "SortOrder": { "type": "integer", "description": "Execution order among the entity's mutation effects.", "format": "int32" }, "IsEnabled": { "type": "boolean", "description": "Whether the effect is active." }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "ApplyWhen": { "type": "string", "description": "Optional typed condition controlling whether the effect contributes a value.\r\nNull means always; false conditions can select a later fallback or clear an effect-owned target.", "nullable": true } }, "additionalProperties": false, "description": "Editable metadata for one mutation effect." }, "EntityMutationEffectAssignmentMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "SetIfEmpty", "Overwrite" ], "x-enum-descriptions": { "0": "Writes the effect value only when the target field is currently empty", "1": "Always replaces the target field value when the effect runs" } }, "EntityMutationEffectListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityMutationEffect" }, "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 }, "EntityMutationEffectResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityMutationEffect" }, "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." }, "EntityObjectHostedLayoutAdmin": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "LayoutMode": { "$ref": "#/components/schemas/EntityUiHostLayoutMode" }, "Layout": { "$ref": "#/components/schemas/EntityObjectHostedLayout" }, "DefaultLayout": { "$ref": "#/components/schemas/EntityObjectHostedLayout" }, "AvailableBlocks": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockOption" }, "description": "Blocks and binding paths currently available to add to this object-hosted layout.", "nullable": true } }, "additionalProperties": false, "description": "Admin-facing object-hosted layout state for a single record surface." }, "EntityObjectHostedLayoutAdminResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityObjectHostedLayoutAdmin" }, "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 }, "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." }, "EntityProjectionDefinitionResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityProjectionDefinition" }, "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 }, "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" } }, "EntityProjectionRebuildResult": { "type": "object", "properties": { "Created": { "type": "integer", "format": "int32" }, "Updated": { "type": "integer", "format": "int32" }, "Archived": { "type": "integer", "format": "int32" }, "Restored": { "type": "integer", "format": "int32" }, "Deleted": { "type": "integer", "format": "int32" }, "Skipped": { "type": "integer", "format": "int32" }, "Failed": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Projection synchronization or rebuild counters." }, "EntityProjectionRebuildResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityProjectionRebuildResult" }, "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 }, "EntityProjectionSynchronizationMemberStatus": { "type": "object", "properties": { "ProjectionMemberId": { "type": "string", "nullable": true }, "ReferenceFieldId": { "type": "string", "nullable": true }, "SourceEntityDefinitionId": { "type": "string", "nullable": true }, "SourceRowCount": { "type": "integer", "format": "int32" }, "ProjectionRowCount": { "type": "integer", "format": "int32" }, "MissingProjectionRowCount": { "type": "integer", "format": "int32" }, "StaleProjectionRowCount": { "type": "integer", "format": "int32" }, "DuplicateProjectionRowCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Per-member projection synchronization counters." }, "EntityProjectionSynchronizationStatus": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/EntityProjectionSynchronizationStatusValue" }, "RebuildRecommended": { "type": "boolean" }, "SourceRowCount": { "type": "integer", "format": "int32" }, "ProjectionRowCount": { "type": "integer", "format": "int32" }, "MissingProjectionRowCount": { "type": "integer", "format": "int32" }, "StaleProjectionRowCount": { "type": "integer", "format": "int32" }, "DuplicateProjectionRowCount": { "type": "integer", "format": "int32" }, "Members": { "type": "array", "items": { "$ref": "#/components/schemas/EntityProjectionSynchronizationMemberStatus" }, "nullable": true } }, "additionalProperties": false, "description": "Live consistency status for one enabled projection entity." }, "EntityProjectionSynchronizationStatusResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityProjectionSynchronizationStatus" }, "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 }, "EntityProjectionSynchronizationStatusValue": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Synchronized", "RebuildRecommended" ], "x-enum-descriptions": { "0": "Projection rows are up to date with the current projection configuration", "1": "Configuration changed since the last build, so a projection rebuild is recommended" } }, "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" } }, "EntityReferenceEligibility": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable rule identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Identifier of the source entity definition.", "nullable": true }, "TargetFieldDefinitionId": { "type": "string", "description": "Identifier of the dependent Reference field.", "nullable": true }, "Expression": { "type": "string", "description": "Eligibility expression authored against Current and Candidate.", "nullable": true }, "Message": { "type": "string", "description": "Optional default failure message.", "nullable": true }, "MessageTranslations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional localized failure messages keyed by supported locale.", "nullable": true }, "Enabled": { "type": "boolean", "description": "Whether the rule participates in runtime enforcement." }, "SchemaSource": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Owning Net Package identifier when package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "Owning package artifact identifier when package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable source identifier when package-owned.", "nullable": true }, "RowVersion": { "type": "string", "description": "Optimistic concurrency token.", "format": "uuid" }, "Dependencies": { "type": "array", "items": { "$ref": "#/components/schemas/EntityReferenceEligibilityDependency" }, "description": "Compiler-owned dependency summary.", "nullable": true } }, "additionalProperties": false, "description": "Field-owned Reference Eligibility configuration." }, "EntityReferenceEligibilityDependency": { "type": "object", "properties": { "Kind": { "$ref": "#/components/schemas/EntityReferenceEligibilityDependencyKind" }, "CanonicalPath": { "type": "string", "description": "Canonical Current or Candidate operand path.", "nullable": true }, "RootFieldDefinitionId": { "type": "string", "description": "Direct root field identifier when one exists.", "nullable": true }, "ReferencedEntityDefinitionId": { "type": "string", "description": "Definition containing the bound operand.", "nullable": true }, "ReferencedFieldDefinitionId": { "type": "string", "description": "Bound field identifier, or null for immutable system identity.", "nullable": true }, "DrivesSelectionContext": { "type": "boolean", "description": "Whether the dependency supplies Current selection context." }, "DrivesContributorValidation": { "type": "boolean", "description": "Whether contributor changes require reverse validation." } }, "additionalProperties": false, "description": "Compiler-owned Reference Eligibility dependency." }, "EntityReferenceEligibilityDependencyKind": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "CurrentField", "CurrentReferenceRoot", "CurrentReferencedField", "CandidateField", "CandidateReferenceId", "CandidateSystemId" ], "x-enum-descriptions": { "0": "A scalar field read directly from the current entity instance.", "1": "A reference field on the current entity that starts a supported one-hop path.", "2": "A scalar field read from the entity referenced by a current-entity reference field.", "3": "A scalar field read directly from the candidate entity instance.", "4": "The identifier of a reference field read from the candidate entity instance.", "5": "A supported system identifier read from the candidate entity instance." } }, "EntityReferenceEligibilityImpact": { "type": "object", "properties": { "HasViolations": { "type": "boolean", "description": "Whether at least one persisted assignment violates the proposed rule." }, "ViolationCount": { "type": "integer", "description": "Exact violation count only when the caller may observe the complete set.", "format": "int64", "nullable": true }, "ViolationSampleIds": { "type": "array", "items": { "type": "string" }, "description": "At most five actor-readable source record identifiers.", "nullable": true }, "HasIncompatibleSurfaces": { "type": "boolean", "description": "Whether an affected saved Form or Table surface lacks required context." }, "IncompatibleSurfaceCount": { "type": "integer", "description": "Exact incompatible-surface count when authorized.", "format": "int64", "nullable": true }, "IncompatibleSurfaceSamples": { "type": "array", "items": { "$ref": "#/components/schemas/EntityReferenceEligibilitySurfaceImpact" }, "description": "At most five readable incompatible surfaces.", "nullable": true } }, "additionalProperties": false, "description": "Preview of data and saved-surface impact for a proposed eligibility expression." }, "EntityReferenceEligibilityImpactResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityReferenceEligibilityImpact" }, "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 }, "EntityReferenceEligibilityResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityReferenceEligibility" }, "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." }, "EntityReferenceEligibilitySurfaceImpact": { "type": "object", "properties": { "Id": { "type": "string", "description": "Surface identifier.", "nullable": true }, "Surface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "Name": { "type": "string", "description": "Optional configured surface name.", "nullable": true } }, "additionalProperties": false, "description": "Display-safe incompatible saved-surface sample." }, "EntityReferenceEligibilityValidationError": { "type": "object", "properties": { "Field": { "type": "string", "description": "Request field or canonical operand associated with the error.", "nullable": true }, "Message": { "type": "string", "description": "Localized diagnostic text.", "nullable": true }, "Code": { "type": "string", "description": "Stable diagnostic code.", "nullable": true }, "Token": { "type": "string", "description": "Optional offending token.", "nullable": true } }, "additionalProperties": false, "description": "Structured Reference Eligibility compiler diagnostic." }, "EntityReferenceEligibilityValidationResult": { "type": "object", "properties": { "Valid": { "type": "boolean", "description": "Whether the expression and metadata bind successfully." }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityReferenceEligibilityValidationError" }, "description": "Structured compiler diagnostics.", "nullable": true }, "Dependencies": { "type": "array", "items": { "$ref": "#/components/schemas/EntityReferenceEligibilityDependency" }, "description": "Detected dependencies when validation succeeds.", "nullable": true } }, "additionalProperties": false, "description": "Dry-run result for a Reference Eligibility expression." }, "EntityReferenceEligibilityValidationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityReferenceEligibilityValidationResult" }, "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 }, "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" } }, "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." }, "EntityRuleExpressionContextType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "FieldBehavior", "Presentation", "Statement", "MutationEffect" ], "x-enum-descriptions": { "0": "Expression is validated against one table's field schema for edit-time field behavior rules", "1": "Expression is validated against the presentation schema that builds display names and subtitles", "2": "Expression is validated as a reusable statement predicate and must be a condition expression", "3": "Expression is validated as a mutation-effect condition against the primary entity table" } }, "EntityRuleExpressionType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Condition", "Template" ], "x-enum-descriptions": { "0": "Boolean expression that evaluates to true or false", "1": "Text template expression that produces a formatted display value" } }, "EntityRuleExpressionValidationError": { "type": "object", "properties": { "Message": { "type": "string", "description": "Localized validation message.", "nullable": true }, "FieldPath": { "type": "string", "description": "Resolved field path that failed validation when available.", "nullable": true }, "Token": { "type": "string", "description": "Offending token when available.", "nullable": true }, "Code": { "type": "string", "description": "Stable validation code.", "nullable": true }, "Start": { "type": "integer", "description": "Zero-based start offset in the submitted expression when available.", "format": "int32", "nullable": true }, "End": { "type": "integer", "description": "Zero-based end offset in the submitted expression when available.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "One validation error returned for a Moltaro rule expression." }, "EntityRuleExpressionValidationResult": { "type": "object", "properties": { "IsValid": { "type": "boolean", "description": "Whether the submitted expression is valid in the requested context." }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityRuleExpressionValidationError" }, "description": "Validation errors when the expression is invalid.", "nullable": true } }, "additionalProperties": false, "description": "Validation result for a Moltaro rule expression." }, "EntityRuleExpressionValidationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityRuleExpressionValidationResult" }, "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" } }, "EntitySecurityArtifactDeleteRequest": { "required": [ "OperationKey", "RowVersion" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Deletes one immediately effective Entity Security artifact." }, "EntitySecurityAssignmentRule": { "required": [ "Actions", "ActorSelectorKey", "ActorSelectorType", "EligibleTargets", "Enabled", "Key", "ResponsibilityKey", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string" }, "ResponsibilityKey": { "type": "string" }, "ActorSelectorType": { "type": "string" }, "ActorSelectorKey": { "type": "string" }, "Actions": { "type": "array", "items": { "type": "string" } }, "EligibleTargets": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityEligibleTargetSelector" } }, "Enabled": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Describes one responsibility assignment rule." }, "EntitySecurityAssignmentRuleDraft": { "required": [ "Actions", "ActorSelectorKey", "ActorSelectorType", "EligibleTargets", "Enabled", "Key", "ResponsibilityKey" ], "type": "object", "properties": { "Key": { "type": "string" }, "ResponsibilityKey": { "type": "string" }, "ActorSelectorType": { "type": "string" }, "ActorSelectorKey": { "type": "string" }, "Actions": { "type": "array", "items": { "type": "string" } }, "EligibleTargets": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityEligibleTargetSelector" } }, "Enabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Defines one responsibility assignment rule inside an atomic rule-set change." }, "EntitySecurityAssignmentRuleResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitySecurityAssignmentRule" }, "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 }, "EntitySecurityAssignmentRuleSetWriteRequest": { "required": [ "OperationKey", "ReplacedRuleKeys", "RowVersion", "Rules" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "RowVersion": { "type": "string", "format": "uuid" }, "ReplacedRuleKeys": { "type": "array", "items": { "type": "string" } }, "Rules": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityAssignmentRuleDraft" } } }, "additionalProperties": false, "description": "Atomically replaces zero or more responsibility Assignment Rules with one rule per selected assignment actor." }, "EntitySecurityAssignmentRuleWriteRequest": { "required": [ "Actions", "ActorSelectorKey", "ActorSelectorType", "EligibleTargets", "Enabled", "Key", "OperationKey", "ResponsibilityKey", "RowVersion" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "RowVersion": { "type": "string", "format": "uuid" }, "Key": { "type": "string" }, "ResponsibilityKey": { "type": "string" }, "ActorSelectorType": { "type": "string" }, "ActorSelectorKey": { "type": "string" }, "Actions": { "type": "array", "items": { "type": "string" } }, "EligibleTargets": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityEligibleTargetSelector" } }, "Enabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Creates or updates one responsibility assignment rule." }, "EntitySecurityConfiguration": { "required": [ "AssignmentRules", "InitialAssignmentRules", "PermissionAssignments", "Responsibilities", "RowVersion", "SecurityStatements" ], "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid" }, "SecurityStatements": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityStatement" } }, "PermissionAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignment" } }, "Responsibilities": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityResponsibility" } }, "InitialAssignmentRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRule" } }, "AssignmentRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySecurityAssignmentRule" } } }, "additionalProperties": false, "description": "Returns the definition-scoped security artifacts edited by Entity Definition." }, "EntitySecurityConfigurationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitySecurityConfiguration" }, "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 }, "EntitySecurityInitialAssignmentRule": { "required": [ "Enabled", "Key", "ResponsibilityKey", "RowVersion", "SubjectSource" ], "type": "object", "properties": { "Key": { "type": "string" }, "ResponsibilityKey": { "type": "string" }, "SubjectSource": { "type": "string" }, "SubjectKey": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Describes one initial responsibility rule." }, "EntitySecurityInitialAssignmentRuleResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitySecurityInitialAssignmentRule" }, "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 }, "EntitySecurityInitialAssignmentRuleWriteRequest": { "required": [ "Enabled", "Key", "OperationKey", "ResponsibilityKey", "RowVersion", "SubjectSource" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "RowVersion": { "type": "string", "format": "uuid" }, "Key": { "type": "string" }, "ResponsibilityKey": { "type": "string" }, "SubjectSource": { "type": "string" }, "SubjectKey": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Creates or updates one initial responsibility rule." }, "EntitySecurityMutationResult": { "required": [ "RowVersion" ], "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Returns the current concurrency token after deleting an artifact." }, "EntitySecurityMutationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitySecurityMutationResult" }, "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 }, "EntitySecurityPermissionAssignment": { "required": [ "Key", "PermissionId", "RowVersion", "StatementKey" ], "type": "object", "properties": { "Key": { "type": "string" }, "PermissionId": { "type": "string" }, "StatementKey": { "type": "string" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Describes one direct Permission Assignment." }, "EntitySecurityPermissionAssignmentResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitySecurityPermissionAssignment" }, "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 }, "EntitySecurityPermissionAssignmentWriteRequest": { "required": [ "Key", "OperationKey", "PermissionId", "RowVersion", "StatementKey" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "RowVersion": { "type": "string", "format": "uuid" }, "Key": { "type": "string" }, "PermissionId": { "type": "string" }, "StatementKey": { "type": "string" } }, "additionalProperties": false, "description": "Creates one immediately effective Permission Assignment." }, "EntitySecurityPermissionCatalog": { "required": [ "Permissions" ], "type": "object", "properties": { "Permissions": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityPermissionDescriptor" } } }, "additionalProperties": false, "description": "Returns the Entity permission descriptors used by the Permission UI." }, "EntitySecurityPermissionCatalogResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitySecurityPermissionCatalog" }, "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 }, "EntitySecurityResponsibility": { "required": [ "Cardinality", "EligibleResponsibilityGroupKeys", "Enabled", "FutureScheduling", "Key", "Required", "RowVersion", "SubjectMode" ], "type": "object", "properties": { "Key": { "type": "string" }, "SubjectMode": { "type": "string" }, "Cardinality": { "type": "string" }, "Required": { "type": "boolean" }, "FutureScheduling": { "type": "boolean" }, "EligibleResponsibilityGroupKeys": { "type": "array", "items": { "type": "string" } }, "Enabled": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Describes one Responsibility Definition." }, "EntitySecurityResponsibilityResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitySecurityResponsibility" }, "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 }, "EntitySecurityResponsibilityWriteRequest": { "required": [ "Cardinality", "EligibleResponsibilityGroupKeys", "Enabled", "FutureScheduling", "Key", "OperationKey", "Required", "RowVersion", "SubjectMode" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "RowVersion": { "type": "string", "format": "uuid" }, "Key": { "type": "string" }, "SubjectMode": { "type": "string" }, "Cardinality": { "type": "string" }, "Required": { "type": "boolean" }, "FutureScheduling": { "type": "boolean" }, "EligibleResponsibilityGroupKeys": { "type": "array", "items": { "type": "string" } }, "Enabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Creates or updates one Responsibility Definition." }, "EntitySecurityStatement": { "required": [ "Enabled", "Key", "RowVersion", "Source" ], "type": "object", "properties": { "Key": { "type": "string" }, "Source": { "type": "string" }, "Enabled": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Describes one current Entity Security Statement." }, "EntitySecurityStatementResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntitySecurityStatement" }, "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 }, "EntitySecurityStatementWriteRequest": { "required": [ "Enabled", "Key", "OperationKey", "RowVersion", "Source" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "RowVersion": { "type": "string", "format": "uuid" }, "Key": { "type": "string" }, "Source": { "type": "string" }, "Enabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Creates or updates one immediately effective Entity Security Statement." }, "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." }, "EntityStatementListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityStatement" }, "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 }, "EntityStatementResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityStatement" }, "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 }, "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" } }, "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" } }, "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." }, "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" } }, "EntityUiCardLabelRuleAdmin": { "type": "object", "properties": { "StatementId": { "type": "string", "description": "Statement identifier.", "nullable": true }, "Label": { "type": "string", "description": "Override chip label, or null to use the statement display name.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Rule sort order.", "format": "int32" }, "Color": { "type": "string", "description": "Chip color token.", "nullable": true }, "Variant": { "type": "string", "description": "Chip variant token.", "nullable": true } }, "additionalProperties": false, "description": "Explicit card label rule keyed by statement id." }, "EntityUiCardSurfaceConfiguration": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "SurfaceId": { "type": "string", "description": "Persisted card surface identifier.", "nullable": true }, "Name": { "type": "string", "description": "Custom card surface name.", "nullable": true }, "Key": { "type": "string", "description": "Custom card surface key.", "nullable": true }, "IsDefault": { "type": "boolean", "description": "Whether this card surface is the current default card." }, "Source": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when this card surface is package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when this card surface is package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable package surface id when this card surface is package-owned.", "nullable": true }, "Tabs": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTab" }, "description": "Configured card tabs.", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityCardUiItem" }, "description": "Configured card items.", "nullable": true }, "LabelRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiCardLabelRuleAdmin" }, "description": "Explicit card label-chip rules keyed by client-exposed statements.", "nullable": true } }, "additionalProperties": false, "description": "Admin-facing card surface configuration." }, "EntityUiCardSurfaceConfigurationOptionsAdmin": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "ItemTargets": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceFieldTargetOptionAdmin" }, "description": "Eligible field and system-field targets for card items.", "nullable": true }, "ProjectionFields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableProjectionColumnOptionAdmin" }, "description": "Eligible related-record projection fields for card items.", "nullable": true }, "SupportedColumnSpans": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Backend-supported responsive column spans for card items.", "nullable": true }, "Statements": { "type": "array", "items": { "$ref": "#/components/schemas/EntityStatementDescriptor" }, "description": "Client-exposed statements available to card label rules.", "nullable": true } }, "additionalProperties": false, "description": "Visual editor options for card surface configuration." }, "EntityUiCardSurfaceConfigurationOptionsAdminResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfigurationOptionsAdmin" }, "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 }, "EntityUiCardSurfaceConfigurationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiCardSurfaceConfiguration" }, "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 }, "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" } }, "EntityUiDetailsSurfaceConfiguration": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "SurfaceId": { "type": "string", "description": "Persisted details-page surface identifier.", "nullable": true }, "Name": { "type": "string", "description": "Details-page surface name.", "nullable": true }, "Key": { "type": "string", "description": "Stable details-page surface key.", "nullable": true }, "IsDefault": { "type": "boolean", "description": "Whether this details page is the current default." }, "SummaryCardSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware card surface selectors for details summary content.", "nullable": true }, "EditFormSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware form surface selectors for details edit flows.", "nullable": true }, "BackTarget": { "$ref": "#/components/schemas/EntityDetailsBackTargetAdmin" } }, "additionalProperties": false, "description": "Admin-facing entity details host-surface configuration." }, "EntityUiDetailsSurfaceConfigurationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiDetailsSurfaceConfiguration" }, "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 }, "EntityUiDrawerRelationSectionAdmin": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/EntityUiRelationSectionTargetAdmin" }, "Label": { "type": "string", "description": "Override label, or null to use the surface default.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Override sort order, or null to use the surface default.", "format": "int32", "nullable": true }, "Visible": { "type": "boolean", "description": "Override visibility, or null to use the surface default.", "nullable": true }, "DefaultPageSize": { "type": "integer", "description": "Override hosted table page size, or null to use the surface default.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Explicit drawer related-section override keyed by a stable relation anchor." }, "EntityUiDrawerSurfaceConfiguration": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "SurfaceId": { "type": "string", "description": "Persisted drawer surface identifier.", "nullable": true }, "Name": { "type": "string", "description": "Drawer surface name.", "nullable": true }, "Key": { "type": "string", "description": "Stable drawer surface key.", "nullable": true }, "IsDefault": { "type": "boolean", "description": "Whether this drawer is the current default." }, "SummaryCardSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware card surface selectors for drawer summary content.", "nullable": true }, "EditFormSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware form surface selectors for drawer edit flows.", "nullable": true }, "DetailsPageSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware details-page selectors for the drawer open action.", "nullable": true }, "Sections": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiDrawerRelationSectionAdmin" }, "description": "Configured related sections.", "nullable": true } }, "additionalProperties": false, "description": "Admin-facing drawer host-surface configuration." }, "EntityUiDrawerSurfaceConfigurationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiDrawerSurfaceConfiguration" }, "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 }, "EntityUiEntityListPageConfiguration": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "SurfaceId": { "type": "string", "description": "Persisted list-page surface identifier.", "nullable": true }, "Name": { "type": "string", "description": "List-page surface name.", "nullable": true }, "Key": { "type": "string", "description": "Stable list-page surface key.", "nullable": true }, "IsDefault": { "type": "boolean", "description": "Whether this list page is the current default." }, "MainTableSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware hosted table selectors for the list page.", "nullable": true } }, "additionalProperties": false, "description": "Admin-facing entity list-page configuration." }, "EntityUiEntityListPageConfigurationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiEntityListPageConfiguration" }, "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 }, "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." }, "EntityUiFieldPreferenceAdmin": { "type": "object", "properties": { "HasOverride": { "type": "boolean", "description": "Whether an explicit preference row exists for the field." }, "ReferenceInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "ReferenceRendererType": { "$ref": "#/components/schemas/ReferenceRendererType" }, "ReferenceLookupRenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Effective breadcrumb reference path.", "nullable": true }, "RowVersion": { "type": "string", "description": "Explicit row version when an override exists.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Effective admin-facing field UI preferences for one field." }, "EntityUiFieldPreferenceAdminResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiFieldPreferenceAdmin" }, "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 }, "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" } }, "EntityUiFormReferenceEligibilityCreateContextAdmin": { "type": "object", "properties": { "TargetFieldDefinitionId": { "type": "string", "description": "Dependent Reference field identifier.", "nullable": true }, "TargetFieldKey": { "type": "string", "description": "Dependent Reference field key.", "nullable": true }, "TargetFieldDisplayName": { "type": "string", "description": "Dependent Reference field display name.", "nullable": true }, "Drivers": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiFormReferenceEligibilityDriverCreateContextAdmin" }, "description": "Direct Eligibility drivers and external inputs used to derive them.", "nullable": true } }, "additionalProperties": false, "description": "Create-time Reference Eligibility context for one dependent Form target." }, "EntityUiFormReferenceEligibilityDriverCreateContextAdmin": { "type": "object", "properties": { "DriverFieldDefinitionId": { "type": "string", "description": "Direct driver field identifier.", "nullable": true }, "DriverFieldKey": { "type": "string", "description": "Direct driver field key.", "nullable": true }, "DriverFieldDisplayName": { "type": "string", "description": "Direct driver field display name.", "nullable": true }, "PossibleExternalInputFields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiFormReferenceEligibilityExternalInputAdmin" }, "description": "Alternative create inputs from which authoritative automation may derive the driver.", "nullable": true } }, "additionalProperties": false, "description": "One direct Reference Eligibility driver and its possible external create inputs." }, "EntityUiFormReferenceEligibilityExternalInputAdmin": { "type": "object", "properties": { "FieldDefinitionId": { "type": "string", "description": "Source field identifier.", "nullable": true }, "FieldKey": { "type": "string", "description": "Source field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Source field display name.", "nullable": true } }, "additionalProperties": false, "description": "One possible related-create root that may be supplied outside the visual Form composition." }, "EntityUiFormRelatedTableTargetOptionAdmin": { "type": "object", "properties": { "Key": { "type": "string", "description": "Stable visual-editor key for this relation target.", "nullable": true }, "Label": { "type": "string", "description": "Default user-facing label for the embedded child table.", "nullable": true }, "Target": { "$ref": "#/components/schemas/EntityUiSurfaceConfigurationTargetAdmin" }, "ChildEntityDefinitionId": { "type": "string", "description": "Child entity definition identifier.", "nullable": true }, "ChildEntityDisplayNameSingular": { "type": "string", "description": "Child entity singular display name.", "nullable": true }, "ChildEntityDisplayNamePlural": { "type": "string", "description": "Child entity plural display name.", "nullable": true }, "ChildReferenceFieldId": { "type": "string", "description": "Reference field identifier on the child entity that points back to the parent.", "nullable": true }, "ChildReferenceFieldKey": { "type": "string", "description": "Stable key of the child reference field.", "nullable": true }, "ChildReferenceFieldDisplayName": { "type": "string", "description": "User-facing name of the child reference field.", "nullable": true }, "TableSurfaces": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogItemAdmin" }, "description": "Explicit table surfaces available on the child entity.", "nullable": true } }, "additionalProperties": false, "description": "One direct inverse-reference target eligible for a related-table form item." }, "EntityUiFormSurfaceConfiguration": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "SurfaceId": { "type": "string", "description": "Persisted form surface identifier.", "nullable": true }, "Name": { "type": "string", "description": "Custom form surface name.", "nullable": true }, "Key": { "type": "string", "description": "Custom form surface key.", "nullable": true }, "IsDefault": { "type": "boolean", "description": "Whether this form surface is the current default form." }, "Source": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when this form surface is package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when this form surface is package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable package surface id when this form surface is package-owned.", "nullable": true }, "MaxWidth": { "type": "integer", "description": "Maximum layout width in pixels.", "format": "int32", "nullable": true }, "ColumnCount": { "type": "integer", "description": "Desktop column count.", "format": "int32", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFormUiItem" }, "description": "Configured form items.", "nullable": true } }, "additionalProperties": false, "description": "Admin-facing form surface configuration." }, "EntityUiFormSurfaceConfigurationOptionsAdmin": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "ItemTargets": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceFieldTargetOptionAdmin" }, "description": "Eligible field and system-field targets for form items.", "nullable": true }, "RelatedTableTargets": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiFormRelatedTableTargetOptionAdmin" }, "description": "Eligible direct inverse-reference targets for related-table form items.", "nullable": true } }, "additionalProperties": false, "description": "Visual editor options for form surface configuration." }, "EntityUiFormSurfaceConfigurationOptionsAdminResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfigurationOptionsAdmin" }, "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 }, "EntityUiFormSurfaceConfigurationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiFormSurfaceConfiguration" }, "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 }, "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." }, "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" } }, "EntityUiHostLayoutBlockOption": { "type": "object", "properties": { "BlockKind": { "$ref": "#/components/schemas/EntityUiHostLayoutBlockKind" }, "StandardBlock": { "$ref": "#/components/schemas/EntityUiStandardBlockKind" }, "ExtensionKey": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Icon": { "type": "string", "nullable": true }, "Available": { "type": "boolean" }, "UnavailableReason": { "type": "string", "nullable": true }, "Paths": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiHostLayoutBindingPath" }, "nullable": true }, "Required": { "type": "boolean" } }, "additionalProperties": false, "description": "Available block option for host-layout builders." }, "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." }, "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." }, "EntityUiReferenceHierarchyOptionsAdmin": { "type": "object", "properties": { "ExplicitPaths": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiReferencePathOptionAdmin" }, "description": "Explicit terminal-to-ancestor paths accepted by hierarchy metadata validation.", "nullable": true }, "RecursiveParentFields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiReferenceHierarchyParentFieldOptionAdmin" }, "description": "Ready indexed self-reference fields accepted as recursive parent sources.", "nullable": true } }, "additionalProperties": false, "description": "Backend-approved hierarchy sources for one direct scalar Reference target." }, "EntityUiReferenceHierarchyParentFieldOptionAdmin": { "type": "object", "properties": { "FieldDefinitionId": { "type": "string", "description": "Stable field identifier.", "nullable": true }, "FieldKey": { "type": "string", "description": "Stable field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "User-facing field name.", "nullable": true } }, "additionalProperties": false, "description": "One backend-approved recursive hierarchy parent field." }, "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" } }, "EntityUiReferencePathOptionAdmin": { "type": "object", "properties": { "Path": { "type": "array", "items": { "type": "string" }, "description": "Reference field keys relative to the configured reference target entity.", "nullable": true }, "Label": { "type": "string", "description": "User-facing label for the path.", "nullable": true }, "TerminalEntityDefinitionId": { "type": "string", "description": "Terminal entity definition identifier reached by this path.", "nullable": true } }, "additionalProperties": false, "description": "One backend-approved reference breadcrumb path option." }, "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." }, "EntityUiRelationSectionTargetAdmin": { "type": "object", "properties": { "SourceEntityDefinitionId": { "type": "string", "description": "Source entity definition id for the related section.", "nullable": true }, "SourceReferenceFieldId": { "type": "string", "description": "Source reference field id for the related section.", "nullable": true } }, "additionalProperties": false, "description": "Stable relation target for details-page and drawer surface configurations." }, "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" } }, "EntityUiSurfaceCatalogAdmin": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "CustomSurfaces": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogItemAdmin" }, "description": "Existing explicit surfaces for the selected surface type.", "nullable": true } }, "additionalProperties": false, "description": "Read-only admin catalog for one UI surface type." }, "EntityUiSurfaceCatalogAdminResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogAdmin" }, "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 }, "EntityUiSurfaceCatalogItemAdmin": { "type": "object", "properties": { "SurfaceId": { "type": "string", "description": "Persisted surface identifier.", "nullable": true }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "Name": { "type": "string", "description": "Surface name.", "nullable": true }, "Key": { "type": "string", "description": "Surface key.", "nullable": true }, "IsDefault": { "type": "boolean", "description": "Whether this surface is currently resolved as the default for its type." }, "IsTreeView": { "type": "boolean", "description": "Whether this Table Surface is configured as a Parent Tree View." }, "Source": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when this surface is package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when this surface is package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable package surface id when this surface is package-owned.", "nullable": true } }, "additionalProperties": false, "description": "One surface metadata entry inside the admin catalog." }, "EntityUiSurfaceConfigurationTargetAdmin": { "type": "object", "properties": { "TargetKind": { "$ref": "#/components/schemas/EntityUiSurfaceConfigurationTargetKind" }, "EntityFieldDefinitionId": { "type": "string", "description": "Entity field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.", "nullable": true }, "DisplayFieldId": { "type": "string", "description": "Display field id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.", "nullable": true }, "ObjectContextFactId": { "type": "string", "description": "Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.", "nullable": true }, "SystemField": { "$ref": "#/components/schemas/EntitySystemField" }, "ResponsibilityKey": { "type": "string", "description": "Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiSurfaceConfigurationTargetAdminModel.TargetKind is `Responsibility`.", "nullable": true } }, "additionalProperties": false, "description": "Stable field-or-system target for table, form, and card surface configurations." }, "EntityUiSurfaceConfigurationTargetKind": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "EntityField", "SystemField", "Responsibility", "DisplayField", "ObjectContextFact" ], "x-enum-descriptions": { "0": "Bind the surface item to a configured entity field definition", "1": "Bind the surface item to a built-in system field such as number, display name, or audit metadata", "2": "Bind the surface item to an active unified responsibility by stable key", "3": "Bind the surface item to a computed display field of the entity", "4": "Bind the surface item to an object context fact supplied by a module provider" } }, "EntityUiSurfaceDependencyAdmin": { "type": "object", "properties": { "SelectorId": { "type": "string", "description": "Persisted selector row identifier.", "nullable": true }, "SourceEntityDefinitionId": { "type": "string", "description": "Entity definition that owns the source surface.", "nullable": true }, "SourceSurfaceId": { "type": "string", "description": "Persisted source surface identifier.", "nullable": true }, "SourceSurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "SourceSurfaceName": { "type": "string", "description": "Source surface display name.", "nullable": true }, "SourceSurfaceKey": { "type": "string", "description": "Source surface key.", "nullable": true }, "TargetEntityDefinitionId": { "type": "string", "description": "Entity definition selected by the selector.", "nullable": true }, "TargetSurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "SelectorMode": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorMode" }, "RequestedSurfaceKey": { "type": "string", "description": "Authored custom key, when the selector uses a custom key.", "nullable": true }, "TargetMissing": { "type": "boolean", "description": "Whether the selector currently resolves to no target surface." }, "TargetSurfaceId": { "type": "string", "description": "Resolved target surface identifier, when available.", "nullable": true }, "TargetSurfaceName": { "type": "string", "description": "Resolved target surface display name, when available.", "nullable": true }, "TargetSurfaceKey": { "type": "string", "description": "Resolved target surface key, when available.", "nullable": true }, "Slot": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorSlot" }, "Priority": { "type": "integer", "description": "Selector evaluation priority.", "format": "int32" }, "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Workspace roles scoped to this selector; empty means all roles.", "nullable": true } }, "additionalProperties": false, "description": "One persisted selector edge between a source surface and its resolved target surface." }, "EntityUiSurfaceDependencyGraphAdmin": { "type": "object", "properties": { "Dependencies": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceDependencyAdmin" }, "description": "Persisted selector dependencies connected to the requested entity definition.", "nullable": true } }, "additionalProperties": false, "description": "Resolved selector dependencies that enter or leave one entity definition's UI surface catalog." }, "EntityUiSurfaceDependencyGraphAdminResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiSurfaceDependencyGraphAdmin" }, "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 }, "EntityUiSurfaceFieldTargetOptionAdmin": { "type": "object", "properties": { "Key": { "type": "string", "description": "Stable visual-editor key for this target.", "nullable": true }, "Label": { "type": "string", "description": "Default user-facing label.", "nullable": true }, "TechnicalKey": { "type": "string", "description": "Technical key for test automation and admin disambiguation.", "nullable": true }, "Target": { "$ref": "#/components/schemas/EntityUiSurfaceConfigurationTargetAdmin" }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "SortOrder": { "type": "integer", "description": "Default sort order.", "format": "int32" }, "Visible": { "type": "boolean", "description": "Default visibility." }, "Width": { "type": "integer", "description": "Default table column width when the surface is table.", "format": "int32", "nullable": true }, "TableRenderer": { "$ref": "#/components/schemas/TableColumnRenderer" }, "FormEditor": { "$ref": "#/components/schemas/FormFieldEditor" }, "CardRenderer": { "$ref": "#/components/schemas/CardFieldRenderer" }, "ReferenceInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "ReferenceRendererType": { "$ref": "#/components/schemas/ReferenceRendererType" }, "ReferenceLookupRenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Default breadcrumb reference path.", "nullable": true }, "ReferencePathOptions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiReferencePathOptionAdmin" }, "description": "Backend-approved breadcrumb path options for this reference target.", "nullable": true }, "ReferenceHierarchyOptions": { "$ref": "#/components/schemas/EntityUiReferenceHierarchyOptionsAdmin" }, "FormReferenceEligibilityCreateContext": { "$ref": "#/components/schemas/EntityUiFormReferenceEligibilityCreateContextAdmin" }, "ReferenceTargetTableSurfaces": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogItemAdmin" }, "description": "Explicit table surfaces from the referenced target entity, used by lookup field selectors.", "nullable": true }, "ReferenceTargetFormSurfaces": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogItemAdmin" }, "description": "Explicit form surfaces from the referenced target entity.", "nullable": true }, "ReferenceTargetDrawerSurfaces": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogItemAdmin" }, "description": "Explicit drawer surfaces from the referenced target entity.", "nullable": true }, "ReferenceTargetDetailsPageSurfaces": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogItemAdmin" }, "description": "Explicit details-page surfaces from the referenced target entity.", "nullable": true } }, "additionalProperties": false, "description": "One eligible field-like target and its surface defaults." }, "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" } }, "EntityUiSurfaceSelectorSlot": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "MainTable", "SummaryCard", "EditForm", "LookupTable", "CreateForm", "Drawer", "DetailsPage", "ReferenceOpenSurface", "BackEntityListPage", "RelatedTable" ], "x-enum-descriptions": { "0": "Resolve the table surface for the host's main list table", "1": "Resolve the card surface shown as the summary card on details and drawer hosts", "2": "Resolve the form surface used by edit flows", "3": "Resolve the lookup table surface for a form item using lookup reference input", "4": "Resolve the form surface used by create flows", "5": "Resolve the drawer surface used to preview an entity instance", "6": "Resolve the details-page surface used to open an entity instance", "7": "Resolve the drawer or details-page surface used to open a reference value", "8": "Resolve the entity list page used as the details-page back target", "9": "Resolve the child table surface rendered by a related-table form item" } }, "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." }, "EntityUiTableColumnConfigurationAdmin": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/EntityUiTableColumnConfigurationTargetAdmin" }, "Label": { "type": "string", "description": "Override label, or null to use the surface default.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Override sort order, or null to use the surface default.", "format": "int32", "nullable": true }, "Visible": { "type": "boolean", "description": "Override visibility, or null to use the surface default.", "nullable": true }, "Width": { "type": "integer", "description": "Override width, or null to use the surface default.", "format": "int32", "nullable": true }, "Renderer": { "$ref": "#/components/schemas/TableColumnRenderer" }, "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" } }, "additionalProperties": false, "description": "Explicit table column override keyed by a stable target anchor." }, "EntityUiTableColumnConfigurationTargetAdmin": { "type": "object", "properties": { "TargetKind": { "$ref": "#/components/schemas/EntityUiSurfaceConfigurationTargetKind" }, "EntityFieldDefinitionId": { "type": "string", "description": "Entity field id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.EntityField.", "nullable": true }, "DisplayFieldId": { "type": "string", "description": "Display field id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.DisplayField.", "nullable": true }, "ObjectContextFactId": { "type": "string", "description": "Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is Moltaro.Enums.EntityUiSurfaceConfigurationTargetKindEnum.ObjectContextFact.", "nullable": true }, "SystemField": { "$ref": "#/components/schemas/EntitySystemField" }, "ResponsibilityKey": { "type": "string", "description": "Stable responsibility key when Moltaro.Entity.Ui.Models.EntityUiTableColumnConfigurationTargetAdminModel.TargetKind is `Responsibility`.", "nullable": true } }, "additionalProperties": false, "description": "Stable field, system-field, or relation target for table column configuration." }, "EntityUiTableColumnTargetOptionAdmin": { "type": "object", "properties": { "Key": { "type": "string", "description": "Stable visual-editor key for this target.", "nullable": true }, "Label": { "type": "string", "description": "Default user-facing label.", "nullable": true }, "TechnicalKey": { "type": "string", "description": "Technical key for test automation and admin disambiguation.", "nullable": true }, "Target": { "$ref": "#/components/schemas/EntityUiTableColumnConfigurationTargetAdmin" }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "SortOrder": { "type": "integer", "description": "Default sort order.", "format": "int32" }, "Visible": { "type": "boolean", "description": "Default visibility." }, "Width": { "type": "integer", "description": "Default table column width.", "format": "int32", "nullable": true }, "TableRenderer": { "$ref": "#/components/schemas/TableColumnRenderer" }, "AllowedTableRenderers": { "type": "array", "items": { "$ref": "#/components/schemas/TableColumnRenderer" }, "description": "Explicit table renderers accepted for this target. Null remains the inherited/default choice.", "nullable": true }, "ReferenceInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "ReferenceRendererType": { "$ref": "#/components/schemas/ReferenceRendererType" }, "ReferenceLookupRenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Default breadcrumb reference path.", "nullable": true }, "ReferencePathOptions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiReferencePathOptionAdmin" }, "description": "Backend-approved breadcrumb path options for this reference target.", "nullable": true }, "ReferenceTargetDrawerSurfaces": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogItemAdmin" }, "description": "Explicit drawer surfaces from the referenced target entity.", "nullable": true }, "ReferenceTargetDetailsPageSurfaces": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceCatalogItemAdmin" }, "description": "Explicit details-page surfaces from the referenced target entity.", "nullable": true } }, "additionalProperties": false, "description": "One eligible table column target and its surface defaults." }, "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." }, "EntityUiTableProjectionColumnAdmin": { "type": "object", "properties": { "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 }, "Label": { "type": "string", "description": "Override label, or null to use the default reference path label.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Projection column sort order.", "format": "int32" }, "Visible": { "type": "boolean", "description": "Whether the projection column is visible." }, "Width": { "type": "integer", "description": "Projection column width.", "format": "int32", "nullable": true }, "Renderer": { "$ref": "#/components/schemas/TableColumnRenderer" } }, "additionalProperties": false, "description": "Explicit table projection column keyed by a typed reference path." }, "EntityUiTableProjectionColumnOptionAdmin": { "type": "object", "properties": { "Key": { "type": "string", "description": "Stable visual-editor key for this projection path.", "nullable": true }, "Label": { "type": "string", "description": "Default user-facing projection label.", "nullable": true }, "Path": { "type": "array", "items": { "type": "string" }, "description": "Reference and terminal field keys in display order.", "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 }, "TerminalFieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "SortOrder": { "type": "integer", "description": "Default sort order.", "format": "int32" }, "Visible": { "type": "boolean", "description": "Default visibility." }, "Width": { "type": "integer", "description": "Default width.", "format": "int32", "nullable": true }, "Renderer": { "$ref": "#/components/schemas/TableColumnRenderer" }, "AllowedTableRenderers": { "type": "array", "items": { "$ref": "#/components/schemas/TableColumnRenderer" }, "description": "Explicit table renderers accepted for the projected terminal field. Null remains the inherited/default choice.", "nullable": true } }, "additionalProperties": false, "description": "One eligible table projection column path and its surface defaults." }, "EntityUiTableRowRuleAdmin": { "type": "object", "properties": { "StatementId": { "type": "string", "description": "Statement identifier.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Rule sort order.", "format": "int32" }, "FontColor": { "type": "string", "description": "Optional font color override.", "nullable": true }, "BackgroundColor": { "type": "string", "description": "Optional background color override.", "nullable": true } }, "additionalProperties": false, "description": "Explicit table row highlight rule keyed by statement id." }, "EntityUiTableSurfaceConfiguration": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "SurfaceId": { "type": "string", "description": "Persisted table surface identifier.", "nullable": true }, "Name": { "type": "string", "description": "Table surface name.", "nullable": true }, "Key": { "type": "string", "description": "Table surface key.", "nullable": true }, "IsDefault": { "type": "boolean", "description": "Whether this table surface is the current default table." }, "Source": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root id when this table surface is package-owned.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact id when this table surface is package-owned.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable package surface id when this table surface is package-owned.", "nullable": true }, "CreateFormSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware form selectors used by table-scoped create flows.", "nullable": true }, "EditFormSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware default form selectors used by table edit actions without an override.", "nullable": true }, "DrawerSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware drawer selectors used by preview actions and post-form navigation.", "nullable": true }, "DetailsPageSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware details-page selectors used by open actions and post-form navigation.", "nullable": true }, "AfterCreateNavigation": { "$ref": "#/components/schemas/EntityTablePostFormNavigation" }, "AfterUpdateNavigation": { "$ref": "#/components/schemas/EntityTablePostFormNavigation" }, "Actions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUiAction" }, "description": "Explicit row actions available on this table surface.", "nullable": true }, "Columns": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableColumnConfigurationAdmin" }, "description": "Explicit column overrides keyed by stable target anchors.", "nullable": true }, "ProjectionColumns": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableProjectionColumnAdmin" }, "description": "Explicit related-record projection columns shown after root table columns.", "nullable": true }, "RowRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableRowRuleAdmin" }, "description": "Explicit table row highlight rules.", "nullable": true }, "FilterItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceFilterItemAdmin" }, "description": "Ordered filter items available for this table surface.", "nullable": true }, "SortItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceSortItemAdmin" }, "description": "Ordered sort items available for this table surface.", "nullable": true }, "DefaultSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceDefaultSortItemAdmin" }, "description": "Configured default sort sequence for this table surface.", "nullable": true }, "TreeView": { "$ref": "#/components/schemas/EntityUiTableSurfaceTreeViewConfigurationAdmin" } }, "additionalProperties": false, "description": "Admin-facing table surface configuration." }, "EntityUiTableSurfaceConfigurationOptionsAdmin": { "type": "object", "properties": { "Meta": { "$ref": "#/components/schemas/EntityUiMeta" }, "SurfaceType": { "$ref": "#/components/schemas/EntitySurfaceType" }, "ColumnTargets": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableColumnTargetOptionAdmin" }, "description": "Eligible field, system-field, and relation targets for table columns.", "nullable": true }, "ProjectionColumns": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableProjectionColumnOptionAdmin" }, "description": "Eligible related-record projection columns for table surfaces.", "nullable": true }, "FilterTargets": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceFilterTargetOptionAdmin" }, "description": "Eligible field and statement targets for table-surface filters.", "nullable": true }, "SortTargets": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceSortTargetOptionAdmin" }, "description": "Eligible field and system-field targets for table-surface sorting.", "nullable": true }, "Statements": { "type": "array", "items": { "$ref": "#/components/schemas/EntityStatementDescriptor" }, "description": "Client-exposed statements available to table row rules.", "nullable": true }, "TreeViewParentFields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceTreeViewParentFieldOptionAdmin" }, "description": "Structurally eligible self-reference fields and their physical index readiness.", "nullable": true }, "TreeViewSortFields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceTreeViewSortFieldOptionAdmin" }, "description": "Sortable primary-table fields eligible as the Tree View sibling sort field.", "nullable": true } }, "additionalProperties": false, "description": "Visual editor options for table surface configuration." }, "EntityUiTableSurfaceConfigurationOptionsAdminResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfigurationOptionsAdmin" }, "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 }, "EntityUiTableSurfaceConfigurationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityUiTableSurfaceConfiguration" }, "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 }, "EntityUiTableSurfaceDefaultSortItemAdmin": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/EntityUiTableSurfaceSortTargetAdmin" }, "Direction": { "$ref": "#/components/schemas/EntityInstanceQuerySortDirection" }, "SortOrder": { "type": "integer", "description": "Default sort display order.", "format": "int32" } }, "additionalProperties": false, "description": "One default table-surface runtime sort item." }, "EntityUiTableSurfaceFilterItemAdmin": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/EntityUiTableSurfaceFilterTargetAdmin" }, "Label": { "type": "string", "description": "Override label, or null to use the target display label.", "nullable": true }, "Visible": { "type": "boolean", "description": "Whether this filter is available in the runtime filter drawer add menu." }, "VisibleByDefault": { "type": "boolean", "description": "Whether this filter appears immediately in the runtime side panel." }, "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 }, "ReferenceHierarchy": { "$ref": "#/components/schemas/EntityUiReferenceHierarchyConfigurationAdmin" }, "SortOrder": { "type": "integer", "description": "Filter item display order.", "format": "int32" } }, "additionalProperties": false, "description": "One explicit table-surface runtime filter item." }, "EntityUiTableSurfaceFilterTargetAdmin": { "type": "object", "properties": { "TargetKind": { "$ref": "#/components/schemas/EntityInstanceQueryOptionKind" }, "Path": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceQueryTargetSegmentAdmin" }, "description": "Ordered query path for field and system-field targets. Intermediate segments must be readable\r\nprimary-table reference fields. This path controls filtering and is independent from the\r\nfilter item's `ReferencePath`, which controls lookup breadcrumb rendering.", "nullable": true }, "StatementId": { "type": "string", "description": "Statement id when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.Statement.", "nullable": true }, "StatementName": { "type": "string", "description": "Statement name for admin disambiguation and portable request inspection.", "nullable": true }, "ObjectContextFactId": { "type": "string", "description": "Object-context fact id when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.ObjectContextFact.", "nullable": true }, "ObjectContextFactFilterKey": { "type": "string", "description": "Provider-owned filter facet key when Moltaro.Entity.Ui.Models.EntityUiTableSurfaceFilterTargetAdminModel.TargetKind is Moltaro.Enums.EntityInstanceQueryOptionKindEnum.ObjectContextFact.", "nullable": true } }, "additionalProperties": false, "description": "Stable query target for table-surface filter configuration." }, "EntityUiTableSurfaceFilterTargetOptionAdmin": { "type": "object", "properties": { "Key": { "type": "string", "description": "Stable visual-editor key for this target.", "nullable": true }, "Label": { "type": "string", "description": "Default user-facing label.", "nullable": true }, "TechnicalKey": { "type": "string", "description": "Technical key for test automation and admin disambiguation.", "nullable": true }, "Target": { "$ref": "#/components/schemas/EntityUiTableSurfaceFilterTargetAdmin" }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "ReferenceInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "ReferenceRendererType": { "$ref": "#/components/schemas/ReferenceRendererType" }, "ReferenceLookupRenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Default breadcrumb reference path.", "nullable": true }, "ReferencePathOptions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiReferencePathOptionAdmin" }, "description": "Backend-approved breadcrumb path options for this reference target.", "nullable": true }, "ReferenceHierarchyOptions": { "$ref": "#/components/schemas/EntityUiReferenceHierarchyOptionsAdmin" }, "ReferenceEligibility": { "$ref": "#/components/schemas/EntityUiTableSurfaceReferenceEligibilityOptionAdmin" } }, "additionalProperties": false, "description": "One eligible table-surface filter target and its configuration metadata." }, "EntityUiTableSurfaceQueryTargetSegmentAdmin": { "type": "object", "properties": { "EntityFieldDefinitionId": { "type": "string", "description": "Entity field id for a reference or terminal entity-field segment.", "nullable": true }, "EntityFieldKey": { "type": "string", "description": "Entity field key for admin disambiguation and portable request inspection.", "nullable": true }, "SystemField": { "$ref": "#/components/schemas/EntitySystemField" }, "Special": { "$ref": "#/components/schemas/EntityInstanceQuerySpecialField" } }, "additionalProperties": false, "description": "One field or system-field segment in a table-surface filter or sort query path." }, "EntityUiTableSurfaceReferenceEligibilityOptionAdmin": { "type": "object", "properties": { "TargetFieldDefinitionId": { "type": "string", "nullable": true }, "RequiredDriverTargetKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "IsDriver": { "type": "boolean" }, "IsDependent": { "type": "boolean" }, "Singleton": { "type": "boolean" } }, "additionalProperties": false, "description": "Reference Eligibility requirements for one direct Table filter target." }, "EntityUiTableSurfaceSortItemAdmin": { "type": "object", "properties": { "Target": { "$ref": "#/components/schemas/EntityUiTableSurfaceSortTargetAdmin" }, "Label": { "type": "string", "description": "Override label, or null to use the target display label.", "nullable": true }, "Visible": { "type": "boolean", "description": "Whether this sort target is available in the runtime sorting drawer." }, "SortOrder": { "type": "integer", "description": "Sort item display order.", "format": "int32" } }, "additionalProperties": false, "description": "One explicit table-surface runtime sort item." }, "EntityUiTableSurfaceSortTargetAdmin": { "type": "object", "properties": { "Path": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceQueryTargetSegmentAdmin" }, "description": "Reference path from the queried entity to the sortable terminal field or system field.", "nullable": true } }, "additionalProperties": false, "description": "Stable sortable path for table-surface sort configuration." }, "EntityUiTableSurfaceSortTargetOptionAdmin": { "type": "object", "properties": { "Key": { "type": "string", "description": "Stable visual-editor key for this target.", "nullable": true }, "Label": { "type": "string", "description": "Default user-facing label.", "nullable": true }, "TechnicalKey": { "type": "string", "description": "Technical key for test automation and admin disambiguation.", "nullable": true }, "SortTarget": { "$ref": "#/components/schemas/EntityUiTableSurfaceSortTargetAdmin" } }, "additionalProperties": false, "description": "One eligible table-surface sort target and its configuration metadata." }, "EntityUiTableSurfaceTreeViewConfigurationAdmin": { "required": [ "ParentFieldDefinitionId", "ParentFieldKey" ], "type": "object", "properties": { "ParentFieldDefinitionId": { "type": "string", "description": "Stable parent field identifier." }, "ParentFieldKey": { "type": "string", "description": "Stable parent field key used by portable configuration." }, "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 used by portable configuration.", "nullable": true }, "SortSpecial": { "$ref": "#/components/schemas/EntityInstanceQuerySpecialField" }, "SortDirection": { "$ref": "#/components/schemas/EntityInstanceQuerySortDirection" } }, "additionalProperties": false, "description": "Parent hierarchy configuration for one table surface." }, "EntityUiTableSurfaceTreeViewParentFieldOptionAdmin": { "type": "object", "properties": { "FieldDefinitionId": { "type": "string", "description": "Stable field identifier.", "nullable": true }, "FieldKey": { "type": "string", "description": "Stable field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "User-facing field name.", "nullable": true }, "Source": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root identifier for package-owned schema.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact identifier for package-owned schema.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable package field identifier.", "nullable": true }, "Availability": { "$ref": "#/components/schemas/EntityUiTreeViewParentFieldAvailability" }, "UnavailableReason": { "type": "string", "description": "Localized explanation when the field is not ready.", "nullable": true } }, "additionalProperties": false, "description": "One structurally eligible Parent Tree View field option." }, "EntityUiTableSurfaceTreeViewSortFieldOptionAdmin": { "type": "object", "properties": { "FieldDefinitionId": { "type": "string", "description": "Stable field identifier.", "nullable": true }, "FieldKey": { "type": "string", "description": "Stable field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "User-facing field name.", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "Source": { "$ref": "#/components/schemas/EntitySchemaSource" }, "SourceNetPackageId": { "type": "string", "description": "Stable NET package root identifier for package-owned schema.", "nullable": true }, "SourcePackageId": { "type": "string", "description": "NET package artifact identifier for package-owned schema.", "nullable": true }, "SourceStableId": { "type": "string", "description": "Stable package field identifier.", "nullable": true } }, "additionalProperties": false, "description": "One sortable field eligible as the Tree View sibling sort field." }, "EntityUiTreeViewParentFieldAvailability": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Ready", "MissingBtreeIndex" ], "x-enum-descriptions": { "0": "The parent field has a valid, ready, parent-leading BTREE index and can be used by Tree View", "1": "The parent field does not have the valid, ready, parent-leading BTREE index required by Tree View" } }, "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." }, "EntityValidationRuleExpressionValidationError": { "type": "object", "properties": { "Field": { "type": "string", "description": "Request field that produced the error.", "nullable": true }, "Message": { "type": "string", "description": "Localized diagnostic message.", "nullable": true }, "FieldPath": { "type": "string", "description": "Resolved field path that failed validation when available.", "nullable": true }, "Token": { "type": "string", "description": "Offending token when available.", "nullable": true }, "Code": { "type": "string", "description": "Stable diagnostic code.", "nullable": true }, "Start": { "type": "integer", "description": "Zero-based start offset in the submitted expression when available.", "format": "int32", "nullable": true }, "End": { "type": "integer", "description": "Zero-based end offset in the submitted expression when available.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Validation-rule expression diagnostic." }, "EntityValidationRuleExpressionValidationResult": { "type": "object", "properties": { "Valid": { "type": "boolean", "description": "Whether the expression is valid." }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityValidationRuleExpressionValidationError" }, "description": "Validation diagnostics.", "nullable": true } }, "additionalProperties": false, "description": "Validation-rule expression validation result." }, "EntityValidationRuleExpressionValidationResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityValidationRuleExpressionValidationResult" }, "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 }, "EntityValidationRuleListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityValidationRule" }, "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 }, "EntityValidationRuleResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/EntityValidationRule" }, "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 }, "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" } }, "FileStorageFolderStrategy": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Unspecified", "Constant", "Daily", "Weekly", "Monthly", "Yearly" ], "x-enum-descriptions": { "0": "No folder partitioning strategy has been selected", "1": "Use one constant storage folder", "2": "Partition storage folders by day", "3": "Partition storage folders by week", "4": "Partition storage folders by month", "5": "Partition storage folders by year" } }, "FileSystemSettings": { "type": "object", "properties": { "StorageType": { "$ref": "#/components/schemas/FileBodyStorage" }, "RootPath": { "type": "string", "nullable": true }, "FolderStrategy": { "$ref": "#/components/schemas/FileStorageFolderStrategy" }, "ConstantFolderName": { "type": "string", "nullable": true }, "AllowedMimeTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "TrashRetentionTimeHours": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid" }, "FileTypeRules": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypeRule" }, "nullable": true }, "FileTypePolicyVersion": { "type": "integer", "format": "int32" }, "FileTypePolicyHash": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileSystemSettingsResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/FileSystemSettings" }, "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 }, "FileTypeRule": { "type": "object", "properties": { "Extensions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "MimeTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "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" } }, "GenerateImportPlanRequest": { "required": [ "Security", "Yaml" ], "type": "object", "properties": { "Yaml": { "type": "string", "description": "YAML document content." }, "TargetEntityDefinitionId": { "type": "string", "description": "Target entity definition for update mode; null for create mode.", "nullable": true }, "Refinements": { "type": "array", "items": { "$ref": "#/components/schemas/ImportReferenceRefinement" }, "description": "User-provided reference refinements for unresolved dependencies.", "nullable": true }, "Security": { "$ref": "#/components/schemas/EntityDefinitionSecurityPlanRequest" } }, "additionalProperties": false, "description": "Request payload to generate an import plan from YAML." }, "GeoResourceLocationCandidates": { "type": "object", "properties": { "ModuleKey": { "type": "string", "nullable": true }, "ResourceKind": { "type": "string", "nullable": true }, "ContextResourceId": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Modes": { "type": "array", "items": { "$ref": "#/components/schemas/GeoResourceLocationSourceMode" }, "nullable": true }, "AddressFields": { "type": "array", "items": { "$ref": "#/components/schemas/GeoResourceLocationFieldCandidate" }, "nullable": true }, "TargetLocationSources": { "type": "array", "items": { "$ref": "#/components/schemas/GeoResourceLocationTargetSourceCandidate" }, "nullable": true }, "SupportsBoardTargetResource": { "type": "boolean" } }, "additionalProperties": false, "description": "Candidate data needed to configure Location for one resource context." }, "GeoResourceLocationCandidatesResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/GeoResourceLocationCandidates" }, "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 }, "GeoResourceLocationFieldCandidate": { "type": "object", "properties": { "FieldId": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "CoordinatesRequired": { "type": "boolean" } }, "additionalProperties": false, "description": "Address field candidate available for Location source configuration." }, "GeoResourceLocationSource": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "ModuleKey": { "type": "string", "nullable": true }, "ResourceKind": { "type": "string", "nullable": true }, "ContextResourceId": { "type": "string", "nullable": true }, "LocationSourceKey": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "SourceKind": { "$ref": "#/components/schemas/GeoResourceLocationSourceKind" }, "SourceFieldId": { "type": "string", "nullable": true }, "TargetLocationSourceKey": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" }, "CreatedAt": { "type": "string", "format": "date-time" }, "ModifiedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Current Location source configuration for one resource context." }, "GeoResourceLocationSourceDetail": { "type": "object", "properties": { "Sources": { "type": "array", "items": { "$ref": "#/components/schemas/GeoResourceLocationSource" }, "nullable": true }, "Candidates": { "$ref": "#/components/schemas/GeoResourceLocationCandidates" } }, "additionalProperties": false, "description": "Location source configuration response with candidate metadata." }, "GeoResourceLocationSourceDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/GeoResourceLocationSourceDetail" }, "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 }, "GeoResourceLocationSourceKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "EntityAddressField", "BoardDataAddressField", "BoardTargetResource" ], "x-enum-descriptions": { "0": "Location is read from an address field on an entity record", "1": "Location is read from an address field in a board's data records", "2": "Location is delegated to the board target resource's own configured location source" } }, "GeoResourceLocationSourceMode": { "type": "object", "properties": { "SourceKind": { "$ref": "#/components/schemas/GeoResourceLocationSourceKind" }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "RequiresSourceField": { "type": "boolean" } }, "additionalProperties": false, "description": "Supported Location source mode for one resource context." }, "GeoResourceLocationSourceMutation": { "type": "object", "properties": { "Source": { "$ref": "#/components/schemas/GeoResourceLocationSource" }, "RecomputeQueued": { "type": "boolean" } }, "additionalProperties": false, "description": "Result returned after changing Location source configuration." }, "GeoResourceLocationSourceMutationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/GeoResourceLocationSourceMutation" }, "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 }, "GeoResourceLocationTargetSourceCandidate": { "type": "object", "properties": { "LocationSourceKey": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "ContextResourceId": { "type": "string", "nullable": true }, "ContextDisplayName": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Target Entity Location source candidate available for board target-resource configuration." }, "ImportConflictResolution": { "type": "object", "properties": { "ItemId": { "type": "string", "description": "Plan item identifier.", "nullable": true }, "Action": { "$ref": "#/components/schemas/ImportConflictResolutionAction" } }, "additionalProperties": false, "description": "User decision for a conflicting plan item." }, "ImportConflictResolutionAction": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "KeepOriginal", "TakeIncoming" ], "x-enum-descriptions": { "0": "Keep the existing workspace item and ignore the incoming version", "1": "Replace the existing workspace item with the incoming version" } }, "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" } }, "ImportPlanHeader": { "type": "object", "properties": { "TargetEntityDefinitionId": { "type": "string", "description": "Existing entity definition ID for update mode.", "nullable": true }, "TargetEntityDefinitionName": { "type": "string", "description": "Existing entity definition name for update mode.", "nullable": true }, "IncomingEntityName": { "type": "string", "description": "Entity name from YAML.", "nullable": true }, "Action": { "$ref": "#/components/schemas/ImportPlanAction" }, "Status": { "$ref": "#/components/schemas/ImportPlanStatus" }, "StatusMessage": { "type": "string", "description": "Explanatory message when status is not OK.", "nullable": true }, "PropertyDiffs": { "type": "array", "items": { "$ref": "#/components/schemas/ImportPlanPropertyDiff" }, "description": "Property differences for update mode.", "nullable": true } }, "additionalProperties": false, "description": "Plan header with entity definition metadata." }, "ImportPlanItem": { "type": "object", "properties": { "ItemId": { "type": "string", "description": "Identifier (YAML ID or existing ID).", "nullable": true }, "ItemKey": { "type": "string", "description": "Key/Name for display.", "nullable": true }, "ItemDisplayName": { "type": "string", "description": "Optional display name.", "nullable": true }, "Action": { "$ref": "#/components/schemas/ImportPlanAction" }, "Status": { "$ref": "#/components/schemas/ImportPlanStatus" }, "StatusMessage": { "type": "string", "description": "Explanatory message when status is not OK.", "nullable": true }, "PropertyDiffs": { "type": "array", "items": { "$ref": "#/components/schemas/ImportPlanPropertyDiff" }, "description": "Property differences when action is Update.", "nullable": true }, "Children": { "type": "array", "items": { "$ref": "#/components/schemas/ImportPlanItem" }, "description": "Nested plan items (e.g., fields within a table, options within a field).", "nullable": true }, "RequiresResolution": { "type": "boolean", "description": "Whether the item cannot be applied without an explicit conflict resolution." } }, "additionalProperties": false, "description": "One item in the import plan." }, "ImportPlanMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Create", "Update" ], "x-enum-descriptions": { "0": "Plan creates a new entity definition that does not exist in the workspace yet", "1": "Plan updates an existing entity definition in place" } }, "ImportPlanPropertyDiff": { "type": "object", "properties": { "PropertyName": { "type": "string", "description": "Property name.", "nullable": true }, "CurrentValue": { "type": "string", "description": "Current value (null for create).", "nullable": true }, "IncomingValue": { "type": "string", "description": "Incoming value from YAML.", "nullable": true } }, "additionalProperties": false, "description": "Property difference between current and incoming values." }, "ImportPlanSection": { "type": "object", "properties": { "SectionKey": { "type": "string", "description": "Machine-readable section key.", "nullable": true }, "SectionLabel": { "type": "string", "description": "Human-readable section label.", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ImportPlanItem" }, "description": "Plan items within this section.", "nullable": true } }, "additionalProperties": false, "description": "One section in the import plan (e.g., Data Schema, Statements)." }, "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" } }, "ImportReferenceRefinement": { "type": "object", "properties": { "FieldId": { "type": "string", "description": "Field identifier from YAML.", "nullable": true }, "ResolvedEntityDefinitionId": { "type": "string", "description": "Mapped entity definition ID; null to skip the field.", "nullable": true } }, "additionalProperties": false, "description": "User-provided mapping for a reference field whose target entity was not found." }, "InformationServiceAccessEntitlement": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRole" }, "DelegateParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRole" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRole" }, "RelatedResource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRole" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPath" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPath" }, "Plans": { "type": "array", "items": { "$ref": "#/components/schemas/InformationServiceAccessPlanSummary" }, "nullable": true }, "AllowedActions": { "$ref": "#/components/schemas/EntitlementOperationsEntitlementModelAllowedActions" }, "IsActive": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Information service access entitlement model detail returned by typed administration APIs." }, "InformationServiceAccessEntitlementModelRequest": { "required": [ "DisplayName", "OwnerParty", "Resource" ], "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string" }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRoleRequest" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPathRequest" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRoleRequest" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPathRequest" } }, "additionalProperties": false, "description": "Information service access entitlement model submitted by typed administration APIs." }, "InformationServiceAccessEntitlementModelUpdateRequest": { "required": [ "DisplayName", "OwnerParty", "Resource", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string" }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRoleRequest" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPathRequest" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRoleRequest" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPathRequest" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Information service access entitlement model submitted by the typed update API." }, "InformationServiceAccessEntitlementResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/InformationServiceAccessEntitlement" }, "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 }, "InformationServiceAccessPlanCreateRequest": { "required": [ "DisplayName" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable plan key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Plan display name." }, "Description": { "type": "string", "description": "Optional plan description.", "nullable": true }, "PriceAmount": { "type": "number", "description": "Optional commercial display price. It is metadata only.", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "description": "Optional three-letter currency code for the commercial display price.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this plan can be used for new grants." }, "DurationValue": { "type": "integer", "description": "Optional access duration length.", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "description": "Optional grace period length.", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "ConsumableQuantity": { "type": "number", "description": "Optional one-time consumable quantity.", "format": "double", "nullable": true }, "TimeBoundQuantity": { "type": "number", "description": "Optional periodic quantity.", "format": "double", "nullable": true }, "TimeBoundWindowValue": { "type": "integer", "description": "Optional periodic quota window length.", "format": "int32", "nullable": true }, "TimeBoundWindowUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "TimeBoundWindowAnchor": { "$ref": "#/components/schemas/EntitlementTimeBoundQuantityWindowAnchor" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceRequest" }, "description": "Concrete information resources selected for this plan.", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "description": "Optional explicit covered-party limit for delegated explicit Organization/Family models.", "format": "int32", "nullable": true }, "RenewalPolicyId": { "type": "string", "description": "Optional default renewal policy used by new grants from this plan.", "nullable": true }, "PlanFamilyIds": { "type": "array", "items": { "type": "string" }, "description": "Optional plan family ids assigned to this plan.", "nullable": true } }, "additionalProperties": false, "description": "Create an information service access plan with named usage limit terms." }, "InformationServiceAccessPlanDetail": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PriceAmount": { "type": "number", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "format": "int32", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "ResourceCount": { "type": "integer", "format": "int32" }, "Families": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanFamilyReference" }, "nullable": true }, "DurationValue": { "type": "integer", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "ConsumableQuantity": { "type": "number", "format": "double", "nullable": true }, "TimeBoundQuantity": { "type": "number", "format": "double", "nullable": true }, "TimeBoundWindowValue": { "type": "integer", "format": "int32", "nullable": true }, "TimeBoundWindowUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "TimeBoundWindowAnchor": { "$ref": "#/components/schemas/EntitlementTimeBoundQuantityWindowAnchor" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResource" }, "nullable": true }, "RenewalPolicy": { "$ref": "#/components/schemas/EntitlementPlanRenewalPolicy" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Detailed information service access plan." }, "InformationServiceAccessPlanDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/InformationServiceAccessPlanDetail" }, "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 }, "InformationServiceAccessPlanList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/InformationServiceAccessPlanSummary" }, "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Paginated information service access plan list response." }, "InformationServiceAccessPlanListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/InformationServiceAccessPlanList" }, "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 }, "InformationServiceAccessPlanSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PriceAmount": { "type": "number", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "format": "int32", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "ResourceCount": { "type": "integer", "format": "int32" }, "Families": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanFamilyReference" }, "nullable": true }, "DurationValue": { "type": "integer", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "ConsumableQuantity": { "type": "number", "format": "double", "nullable": true }, "TimeBoundQuantity": { "type": "number", "format": "double", "nullable": true }, "TimeBoundWindowValue": { "type": "integer", "format": "int32", "nullable": true }, "TimeBoundWindowUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "TimeBoundWindowAnchor": { "$ref": "#/components/schemas/EntitlementTimeBoundQuantityWindowAnchor" }, "RenewalPolicy": { "$ref": "#/components/schemas/EntitlementPlanRenewalPolicy" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Information service access plan summary row." }, "InformationServiceAccessPlanUpdateRequest": { "required": [ "DisplayName", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable plan key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Plan display name." }, "Description": { "type": "string", "description": "Optional plan description.", "nullable": true }, "PriceAmount": { "type": "number", "description": "Optional commercial display price. It is metadata only.", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "description": "Optional three-letter currency code for the commercial display price.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this plan can be used for new grants." }, "DurationValue": { "type": "integer", "description": "Optional access duration length.", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "description": "Optional grace period length.", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "ConsumableQuantity": { "type": "number", "description": "Optional one-time consumable quantity.", "format": "double", "nullable": true }, "TimeBoundQuantity": { "type": "number", "description": "Optional periodic quantity.", "format": "double", "nullable": true }, "TimeBoundWindowValue": { "type": "integer", "description": "Optional periodic quota window length.", "format": "int32", "nullable": true }, "TimeBoundWindowUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "TimeBoundWindowAnchor": { "$ref": "#/components/schemas/EntitlementTimeBoundQuantityWindowAnchor" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceRequest" }, "description": "Concrete information resources selected for this plan.", "nullable": true }, "RowVersion": { "type": "string", "description": "Required concurrency token from the current plan.", "format": "uuid" }, "MaxCoveredPartyCount": { "type": "integer", "description": "Optional explicit covered-party limit for delegated explicit Organization/Family models.", "format": "int32", "nullable": true }, "RenewalPolicyId": { "type": "string", "description": "Optional default renewal policy used by new grants from this plan.", "nullable": true }, "PlanFamilyIds": { "type": "array", "items": { "type": "string" }, "description": "Optional plan family ids assigned to this plan.", "nullable": true } }, "additionalProperties": false, "description": "Update an information service access plan with named usage limit terms." }, "ManagedSecret": { "type": "object", "properties": { "Id": { "type": "string", "description": "Secret identifier.", "nullable": true }, "Key": { "type": "string", "description": "Immutable lookup key.", "nullable": true }, "Version": { "type": "integer", "description": "Value version.", "format": "int32" }, "IsEnabled": { "type": "boolean", "description": "Whether trusted C# may resolve the secret." }, "RetiredAtUtc": { "type": "string", "description": "Terminal retirement timestamp.", "format": "date-time", "nullable": true }, "CreatedAtUtc": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "ModifiedAtUtc": { "type": "string", "description": "Last modification timestamp.", "format": "date-time", "nullable": true }, "CreatedByUserId": { "type": "string", "description": "Creating actor identifier.", "nullable": true }, "ModifiedByUserId": { "type": "string", "description": "Last modifying actor identifier.", "nullable": true }, "RowVersion": { "type": "string", "description": "Optimistic concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Write-only managed-secret metadata. No value, ciphertext, hash, length, or hint is exposed." }, "ManagedSecretListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedSecret" }, "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 }, "ManagedSecretResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ManagedSecret" }, "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 }, "MembershipEntitlement": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRole" }, "DelegateParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRole" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRole" }, "RelatedResource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRole" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPath" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPath" }, "Plans": { "type": "array", "items": { "$ref": "#/components/schemas/MembershipPlanSummary" }, "nullable": true }, "AllowedActions": { "$ref": "#/components/schemas/EntitlementOperationsEntitlementModelAllowedActions" }, "IsActive": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Membership entitlement model detail returned by typed administration APIs." }, "MembershipEntitlementModelRequest": { "required": [ "DisplayName", "OwnerParty", "Resource" ], "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string" }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRoleRequest" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPathRequest" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRoleRequest" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPathRequest" } }, "additionalProperties": false, "description": "Membership entitlement model submitted by typed administration APIs." }, "MembershipEntitlementModelUpdateRequest": { "required": [ "DisplayName", "OwnerParty", "Resource", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string" }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRoleRequest" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPathRequest" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRoleRequest" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPathRequest" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Membership entitlement model submitted by the typed update API." }, "MembershipEntitlementResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MembershipEntitlement" }, "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 }, "MembershipPlanCreateRequest": { "required": [ "DisplayName" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable plan key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Plan display name." }, "Description": { "type": "string", "description": "Optional plan description.", "nullable": true }, "PriceAmount": { "type": "number", "description": "Optional commercial display price. It is metadata only.", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "description": "Optional three-letter currency code for the commercial display price.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this plan can be used for new grants." }, "DurationValue": { "type": "integer", "description": "Optional membership duration length.", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "description": "Optional grace period length.", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceRequest" }, "description": "Concrete membership resources selected for this plan.", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "description": "Optional explicit covered-party limit for delegated explicit Organization/Family models.", "format": "int32", "nullable": true }, "RenewalPolicyId": { "type": "string", "description": "Optional default renewal policy used by new grants from this plan.", "nullable": true }, "PlanFamilyIds": { "type": "array", "items": { "type": "string" }, "description": "Optional plan family ids assigned to this plan.", "nullable": true } }, "additionalProperties": false, "description": "Create a membership plan with membership duration terms." }, "MembershipPlanDetail": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PriceAmount": { "type": "number", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "format": "int32", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "ResourceCount": { "type": "integer", "format": "int32" }, "Families": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanFamilyReference" }, "nullable": true }, "DurationValue": { "type": "integer", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResource" }, "nullable": true }, "RenewalPolicy": { "$ref": "#/components/schemas/EntitlementPlanRenewalPolicy" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Detailed membership plan." }, "MembershipPlanDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MembershipPlanDetail" }, "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 }, "MembershipPlanList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/MembershipPlanSummary" }, "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Paginated membership plan list response." }, "MembershipPlanListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MembershipPlanList" }, "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 }, "MembershipPlanSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PriceAmount": { "type": "number", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "format": "int32", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "ResourceCount": { "type": "integer", "format": "int32" }, "Families": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanFamilyReference" }, "nullable": true }, "DurationValue": { "type": "integer", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "RenewalPolicy": { "$ref": "#/components/schemas/EntitlementPlanRenewalPolicy" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Membership plan summary row." }, "MembershipPlanUpdateRequest": { "required": [ "DisplayName", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable plan key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Plan display name." }, "Description": { "type": "string", "description": "Optional plan description.", "nullable": true }, "PriceAmount": { "type": "number", "description": "Optional commercial display price. It is metadata only.", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "description": "Optional three-letter currency code for the commercial display price.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this plan can be used for new grants." }, "DurationValue": { "type": "integer", "description": "Optional membership duration length.", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "description": "Optional grace period length.", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceRequest" }, "description": "Concrete membership resources selected for this plan.", "nullable": true }, "RowVersion": { "type": "string", "description": "Required concurrency token from the current plan.", "format": "uuid" }, "MaxCoveredPartyCount": { "type": "integer", "description": "Optional explicit covered-party limit for delegated explicit Organization/Family models.", "format": "int32", "nullable": true }, "RenewalPolicyId": { "type": "string", "description": "Optional default renewal policy used by new grants from this plan.", "nullable": true }, "PlanFamilyIds": { "type": "array", "items": { "type": "string" }, "description": "Optional plan family ids assigned to this plan.", "nullable": true } }, "additionalProperties": false, "description": "Update a membership plan with membership duration terms." }, "ModuleConfigurationState": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ConfigurationRequired", "Migrating", "Active", "Disabled", "MigrationRequired", "MigrationFailed" ], "x-enum-descriptions": { "0": "Module is enabled but needs initial configuration before it can serve requests", "1": "Module data migration is currently running", "2": "Module is configured and serving requests", "3": "Module is disabled; configuration is preserved but runtime features are off", "4": "A data migration must run before the module can serve requests", "5": "The last module data migration attempt failed and needs attention" } }, "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 }, "NetOperationProjectArtifact": { "type": "object", "properties": { "Id": { "type": "string", "description": "Artifact identifier.", "nullable": true }, "ProjectId": { "type": "string", "description": "Project identifier.", "nullable": true }, "BuildId": { "type": "string", "description": "Build identifier that produced the artifact.", "nullable": true }, "RevisionId": { "type": "string", "description": "Source revision identifier used by the build.", "nullable": true }, "Status": { "$ref": "#/components/schemas/NetOperationProjectArtifactStatus" }, "IsActive": { "type": "boolean", "description": "Whether this artifact is currently active." }, "ArtifactHash": { "type": "string", "description": "Artifact content hash.", "nullable": true }, "SizeBytes": { "type": "integer", "description": "Artifact binary size in bytes.", "format": "int64" }, "DependencyMetadataJson": { "type": "string", "description": "Serialized dependency metadata.", "nullable": true }, "FunctionDescriptorJson": { "type": "string", "description": "Serialized function descriptors.", "nullable": true }, "DataSourceDescriptorJson": { "type": "string", "description": "Serialized data source descriptors.", "nullable": true }, "SchemaContractHash": { "type": "string", "description": "Workspace schema contract hash used by the build.", "nullable": true }, "PublishedByUserId": { "type": "string", "description": "User that published the artifact.", "nullable": true }, "PublishedAt": { "type": "string", "description": "Publication timestamp.", "format": "date-time", "nullable": true }, "DeactivatedByUserId": { "type": "string", "description": "User that deactivated the artifact.", "nullable": true }, "DeactivatedAt": { "type": "string", "description": "Deactivation timestamp.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Net Operation Project compiled artifact record." }, "NetOperationProjectArtifactRuntimeStatus": { "type": "object", "properties": { "ArtifactId": { "type": "string", "description": "Active artifact identifier.", "nullable": true }, "RevisionId": { "type": "string", "description": "Source revision that produced the artifact.", "nullable": true }, "BuildId": { "type": "string", "description": "Build that produced the artifact.", "nullable": true }, "IsCompatible": { "type": "boolean", "description": "Whether the current host can activate the artifact." }, "ReasonCode": { "type": "string", "description": "Stable machine-readable compatibility reason code.", "nullable": true }, "Message": { "type": "string", "description": "Localized operator-facing compatibility message.", "nullable": true }, "Metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Safe diagnostic details for the failed startup descriptor, when available.", "nullable": true } }, "description": "Runtime activation compatibility for the active Net Operation Project artifact." }, "NetOperationProjectArtifactStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Built", "Active", "Superseded", "Deactivated" ], "x-enum-descriptions": { "0": "Compiled build output that has not been activated for execution", "1": "The single artifact currently serving workspace function execution", "2": "Replaced by a newer active artifact and no longer executed", "3": "Explicitly taken out of execution without being replaced by a newer artifact" } }, "NetOperationProjectBuild": { "type": "object", "properties": { "Id": { "type": "string", "description": "Build identifier.", "nullable": true }, "ProjectId": { "type": "string", "description": "Project identifier.", "nullable": true }, "RevisionId": { "type": "string", "description": "Source revision identifier.", "nullable": true }, "BuildNumber": { "type": "integer", "description": "Monotonic build number.", "format": "int32" }, "Kind": { "$ref": "#/components/schemas/NetOperationProjectBuildKind" }, "Status": { "$ref": "#/components/schemas/NetOperationProjectBuildStatus" }, "Stage": { "$ref": "#/components/schemas/NetOperationProjectBuildStage" }, "StageMessageKey": { "type": "string", "description": "Localization key for current build stage.", "nullable": true }, "ProgressPercent": { "type": "integer", "description": "Current progress percentage.", "format": "int32" }, "RequestedByUserId": { "type": "string", "description": "Requesting user identifier.", "nullable": true }, "RequestedAt": { "type": "string", "description": "Build request timestamp.", "format": "date-time" }, "StartedAt": { "type": "string", "description": "Build start timestamp.", "format": "date-time", "nullable": true }, "CompletedAt": { "type": "string", "description": "Build completion timestamp.", "format": "date-time", "nullable": true }, "WorkerId": { "type": "string", "description": "Worker that claimed the build.", "nullable": true }, "HeartbeatAt": { "type": "string", "description": "Last worker heartbeat timestamp.", "format": "date-time", "nullable": true }, "AttemptCount": { "type": "integer", "description": "Number of worker attempts.", "format": "int32" }, "GeneratedProjectChecksum": { "type": "string", "description": "Optional generated project checksum.", "nullable": true }, "SchemaContractHash": { "type": "string", "description": "Optional schema contract hash.", "nullable": true }, "DiagnosticsJson": { "type": "string", "description": "Optional structured diagnostics JSON.", "nullable": true }, "ErrorSummary": { "type": "string", "description": "Optional short error summary.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "Failure": { "$ref": "#/components/schemas/NetOperationProjectBuildFailure" } }, "additionalProperties": false, "description": "Net Operation Project build history record." }, "NetOperationProjectBuildFailure": { "type": "object", "properties": { "ReasonCode": { "type": "string", "description": "Stable machine-readable reason code.", "nullable": true }, "Category": { "$ref": "#/components/schemas/NetOperationProjectBuildFailureCategory" }, "Retryable": { "type": "boolean", "description": "Whether retrying can reasonably succeed without operator remediation." }, "SqlState": { "type": "string", "description": "Optional PostgreSQL SQLSTATE without SQL or parameter values.", "nullable": true }, "TargetKind": { "type": "string", "description": "Optional allow-listed publication target kind.", "nullable": true }, "TargetId": { "type": "string", "description": "Optional safe logical target identifier.", "nullable": true }, "RemediationCode": { "type": "string", "description": "Stable remediation instruction code.", "nullable": true } }, "additionalProperties": false, "description": "Safe structured diagnostics for a failed Net Operation Project build." }, "NetOperationProjectBuildFailureCategory": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Unknown", "Storage", "Resource", "Connectivity", "Timeout", "Concurrency", "Constraint", "Data", "Commit", "Internal" ], "x-enum-descriptions": { "0": "The build failure could not be classified", "1": "The build failed while reading or writing stored project data", "2": "The build failed because a required resource was unavailable", "3": "The build failed because a required service could not be reached", "4": "The build did not complete within its allowed time", "5": "The build conflicted with another operation", "6": "The project violates a build constraint", "7": "The project contains invalid or inconsistent data", "8": "The build result could not be committed", "9": "The build failed because of an internal runtime error" } }, "NetOperationProjectBuildKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Build", "Check" ], "x-enum-descriptions": { "0": "Compile the revision and activate the resulting artifact as the workspace's active operational logic", "1": "Compile the revision to validate it without activating the resulting artifact" } }, "NetOperationProjectBuildListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectBuild" }, "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 }, "NetOperationProjectBuildResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectBuild" }, "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 }, "NetOperationProjectBuildStage": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Queued", "GeneratingWorkspace", "RestoringPackages", "Compiling", "StoringArtifact", "ActivatingArtifact", "DiscoveringFunctions", "PublishingFunctions", "Completed", "Failed", "Cancelled" ], "x-enum-descriptions": { "0": "Build is waiting for a background worker to pick it up", "1": "Generating the temporary project workspace and contract sources for the revision", "2": "Restoring NuGet packages for the generated project", "3": "Compiling the workspace C# source into an assembly", "4": "Persisting the compiled build artifact", "5": "Switching the workspace to the newly built artifact as the single active one", "6": "Scanning the compiled assembly for business function descriptors", "7": "Syncing discovered functions into workspace function registrations", "8": "Build finished successfully through all stages", "9": "Build stopped because a stage reported an error", "10": "Build was cancelled before it could complete" } }, "NetOperationProjectBuildStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Queued", "Running", "Succeeded", "Failed", "Cancelled" ], "x-enum-descriptions": { "0": "Build is waiting for a worker to pick it up", "1": "Build is executing its stages on a worker", "2": "Build finished all stages and produced a usable result", "3": "Build stopped because a stage ended with an error", "4": "Build was cancelled before it could finish" } }, "NetOperationProjectDeveloperAssembly": { "type": "object", "properties": { "Name": { "type": "string", "description": "Assembly name.", "nullable": true }, "Version": { "type": "string", "description": "Assembly version used by this installation.", "nullable": true }, "DocumentationUrl": { "type": "string", "description": "Public curated XML documentation URL.", "nullable": true }, "Purpose": { "type": "string", "description": "Supported Net Operation Project purpose.", "nullable": true } }, "additionalProperties": false, "description": "One supported developer assembly." }, "NetOperationProjectDeveloperSurface": { "type": "object", "properties": { "Assemblies": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectDeveloperAssembly" }, "description": "Supported developer assemblies.", "nullable": true }, "InjectableServices": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectInjectableService" }, "description": "Supported constructor-injected services.", "nullable": true }, "GeneratedContractIncludedInLanguageServices": { "type": "boolean", "description": "Whether the current generated workspace contract is automatically included in language-service snapshots." }, "GeneratedContractUserEditable": { "type": "boolean", "description": "Whether callers may edit or upload generated contract files." }, "ReferenceUrl": { "type": "string", "description": "Public .NET reference landing page.", "nullable": true } }, "additionalProperties": false, "description": "Supported C# developer surface available to Net Operation Project source." }, "NetOperationProjectDeveloperSurfaceResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectDeveloperSurface" }, "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 }, "NetOperationProjectFile": { "type": "object", "properties": { "Id": { "type": "string", "description": "File row identifier.", "nullable": true }, "RevisionId": { "type": "string", "description": "Revision identifier.", "nullable": true }, "Path": { "type": "string", "description": "Normalized relative project path.", "nullable": true }, "ContentHash": { "type": "string", "description": "SHA-256 hash of the UTF-8 content.", "nullable": true }, "ContentUtf8": { "type": "string", "description": "UTF-8 text content.", "nullable": true }, "SizeBytes": { "type": "integer", "description": "UTF-8 byte length.", "format": "int64" } }, "additionalProperties": false, "description": "One stored Net Operation Project source file." }, "NetOperationProjectFileListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectFile" }, "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 }, "NetOperationProjectFileResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectFile" }, "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 }, "NetOperationProjectInjectableService": { "type": "object", "properties": { "TypeName": { "type": "string", "description": "Fully-qualified service type name.", "nullable": true }, "AssemblyName": { "type": "string", "description": "Assembly that defines the service contract.", "nullable": true }, "Category": { "type": "string", "description": "Developer-facing service category.", "nullable": true }, "ModuleKey": { "type": "string", "description": "Owning module key, or null for core services.", "nullable": true }, "Lifetime": { "type": "string", "description": "Dependency-injection lifetime.", "nullable": true }, "Purpose": { "type": "string", "description": "Supported use of the service.", "nullable": true }, "ServiceKind": { "type": "string", "description": "Application-automation or trusted direct-database contract.", "nullable": true }, "Preferred": { "type": "boolean", "description": "Whether this is the recommended interface for its developer scenario." }, "SupportedFunctionContracts": { "type": "array", "items": { "type": "string" }, "description": "Function contracts in which the service may be used.", "nullable": true }, "ExecutionSemantics": { "type": "string", "description": "Transaction, actor, and asynchronous completion semantics.", "nullable": true }, "DocumentationUrl": { "type": "string", "description": "Public documentation for the service.", "nullable": true } }, "additionalProperties": false, "description": "One supported constructor-injected Net Operation Project service." }, "NetOperationProjectLanguageDependencyStatus": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/NetOperationProjectLanguageDependencyStatusValue" }, "PackageReferenceCount": { "type": "integer", "description": "Number of package references considered for the language snapshot.", "format": "int32" }, "ResolvedReferenceCount": { "type": "integer", "description": "Number of metadata references resolved from package compile assets.", "format": "int32" }, "Message": { "type": "string", "description": "Optional localized status message.", "nullable": true } }, "additionalProperties": false, "description": "External package reference resolution status for a Net Operation Project language response." }, "NetOperationProjectLanguageDependencyStatusValue": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "Resolving", "Resolved", "Unavailable" ], "x-enum-descriptions": { "0": "No dependency resolution has been recorded for the language", "1": "Dependency resolution for the language is currently in progress", "2": "All required language dependencies are resolved and available for builds", "3": "Required language dependencies could not be resolved, so the language cannot be used for builds" } }, "NetOperationProjectLanguageDiagnosticOrigin": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Source", "GeneratedContract" ], "x-enum-descriptions": { "0": "Diagnostic produced for workspace-owned operational source", "1": "Diagnostic produced for the Moltaro-generated workspace contract" } }, "NetOperationProjectLanguageDiagnosticSeverity": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Hidden", "Info", "Warning", "Error" ], "x-enum-descriptions": { "0": "Compiler diagnostic that is suppressed and not surfaced to the project author", "1": "Informational compiler note that does not indicate a problem with the project source", "2": "Potential problem in the project source that does not fail the build", "3": "Compilation error that fails the build and blocks producing an artifact" } }, "NetOperationProjectManualEditResult": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "Status": { "$ref": "#/components/schemas/NetOperationProjectStatus" }, "Limits": { "$ref": "#/components/schemas/NetOperationProjectSourceProcessingLimits" } }, "additionalProperties": false, "description": "Result of creating a manual Net Operation Project source revision." }, "NetOperationProjectManualEditResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectManualEditResult" }, "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 }, "NetOperationProjectPackageReference": { "type": "object", "properties": { "Include": { "type": "string", "description": "NuGet package identifier.", "nullable": true }, "Version": { "type": "string", "description": "NuGet package version.", "nullable": true } }, "additionalProperties": false, "description": "External NuGet package reference stored for a Net Operation Project source revision." }, "NetOperationProjectPackageReferences": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "PackageReferences": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectPackageReference" }, "description": "Normalized external package references.", "nullable": true }, "SourceFile": { "$ref": "#/components/schemas/NetOperationProjectSourceTreeFile" } }, "additionalProperties": false, "description": "Package references stored for a Net Operation Project source revision." }, "NetOperationProjectPackageReferencesEditResult": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "Status": { "$ref": "#/components/schemas/NetOperationProjectStatus" }, "PackageReferences": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectPackageReference" }, "description": "Normalized package references saved in the new revision.", "nullable": true } }, "additionalProperties": false, "description": "Result of creating a Net Operation Project manual edit revision for package references." }, "NetOperationProjectPackageReferencesEditResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectPackageReferencesEditResult" }, "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 }, "NetOperationProjectPackageReferencesResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectPackageReferences" }, "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 }, "NetOperationProjectRevision": { "type": "object", "properties": { "Id": { "type": "string", "description": "Revision identifier.", "nullable": true }, "ProjectId": { "type": "string", "description": "Project identifier.", "nullable": true }, "RevisionNumber": { "type": "integer", "description": "Monotonic revision number.", "format": "int32" }, "SourceKind": { "$ref": "#/components/schemas/NetOperationProjectRevisionSourceKind" }, "Status": { "$ref": "#/components/schemas/NetOperationProjectRevisionStatus" }, "Comment": { "type": "string", "description": "Optional revision comment.", "nullable": true }, "SourceChecksum": { "type": "string", "description": "Canonical source tree checksum.", "nullable": true }, "SchemaContractHash": { "type": "string", "description": "Optional schema contract hash captured with the revision.", "nullable": true }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "CreatedByUserId": { "type": "string", "description": "Creating user identifier.", "nullable": true }, "FileCount": { "type": "integer", "description": "Number of files stored in the revision.", "format": "int32" } }, "additionalProperties": false, "description": "Immutable Net Operation Project source revision." }, "NetOperationProjectRevisionListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "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 }, "NetOperationProjectRevisionSourceKind": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Bootstrap", "Upload", "ManualEdit", "System" ], "x-enum-descriptions": { "0": "Revision created as the initial generated baseline when the project was bootstrapped", "1": "Revision created from source files uploaded into the workspace project", "2": "Revision created by editing the project source directly in the workspace", "3": "Revision created automatically by the platform rather than by a user" } }, "NetOperationProjectRevisionStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Current", "Draft", "ValidatedDraft", "Failed", "Superseded" ], "x-enum-descriptions": { "0": "Revision selected as the project's current source baseline, including the initial bootstrap revision before the first artifact is built", "1": "Immutable working revision that has not been built or validated yet", "2": "Revision that passed a check build compilation without being activated", "3": "Revision whose build failed during contract generation, compilation, discovery, sync, or activation", "4": "Previously current revision replaced after a newer revision was activated" } }, "NetOperationProjectSourceChangeOperation": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Upsert", "Delete", "Rename" ], "x-enum-descriptions": { "0": "Create the source file or replace its content in the draft revision", "1": "Remove the source file from the draft revision", "2": "Move the source file to a new path in the project source tree" } }, "NetOperationProjectSourceChangeRequest": { "type": "object", "properties": { "Operation": { "$ref": "#/components/schemas/NetOperationProjectSourceChangeOperation" }, "Path": { "type": "string", "description": "Existing or target relative project path.", "nullable": true }, "NewPath": { "type": "string", "description": "New relative project path for rename operations.", "nullable": true }, "Content": { "type": "string", "description": "UTF-8 text content for upsert operations.", "nullable": true }, "ExpectedContentHash": { "type": "string", "description": "Expected SHA-256 content hash of the existing file.", "nullable": true } }, "additionalProperties": false, "description": "One source file change for a manual Net Operation Project edit revision." }, "NetOperationProjectSourceIndex": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "Entries": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectSourceIndexEntry" }, "description": "Indexed source entries.", "nullable": true }, "Diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnostic" }, "description": "All diagnostics produced for indexed sources.", "nullable": true }, "DependencyStatus": { "$ref": "#/components/schemas/NetOperationProjectLanguageDependencyStatus" } }, "additionalProperties": false, "description": "Read-only Studio source index for a Net Operation Project revision." }, "NetOperationProjectSourceIndexEntry": { "type": "object", "properties": { "Path": { "type": "string", "description": "Normalized source path.", "nullable": true }, "Kind": { "$ref": "#/components/schemas/NetOperationProjectSourceIndexEntryKind" }, "Namespace": { "type": "string", "description": "Declared namespace when discoverable.", "nullable": true }, "ClassName": { "type": "string", "description": "Primary class name when discoverable.", "nullable": true }, "StableKey": { "type": "string", "description": "Function or data-source stable key when discoverable.", "nullable": true }, "DisplayName": { "type": "string", "description": "Function or data-source display name when discoverable.", "nullable": true }, "FunctionShape": { "type": "string", "description": "Function shape when discoverable.", "nullable": true }, "EntityTarget": { "type": "string", "description": "Entity target type when discoverable.", "nullable": true }, "Diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnostic" }, "description": "Diagnostics attached to this source path.", "nullable": true } }, "additionalProperties": false, "description": "Studio navigation descriptor for one Net Operation Project source file." }, "NetOperationProjectSourceIndexEntryKind": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Function", "DataSource", "Service", "Startup", "Markdown", "PackageReferences", "UnknownCSharp", "Other" ], "x-enum-descriptions": { "0": "C# file whose primary class is a business function implementing a workspace contract", "1": "C# file whose primary class is a data source exposing queryable workspace data", "2": "Supporting C# service class under the project services folder, not a function itself", "3": "Startup or module extension code that wires up registrations for the project", "4": "Markdown documentation file kept alongside the project source", "5": "Declaration file listing the NuGet package references allowed for the project build", "6": "C# file that could not be classified into any known project source kind", "7": "File that is neither C#, markdown, nor a recognized project source kind" } }, "NetOperationProjectSourceIndexResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectSourceIndex" }, "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 }, "NetOperationProjectSourceLanguageCompletionItem": { "type": "object", "properties": { "Label": { "type": "string", "description": "Display label.", "nullable": true }, "Kind": { "type": "string", "description": "Roslyn completion tag mapped for the editor.", "nullable": true }, "Detail": { "type": "string", "description": "Short item detail.", "nullable": true }, "Documentation": { "type": "string", "description": "Optional documentation text.", "nullable": true }, "InsertText": { "type": "string", "description": "Text inserted by the editor.", "nullable": true }, "SortText": { "type": "string", "description": "Optional sort key.", "nullable": true }, "FilterText": { "type": "string", "description": "Optional filter key.", "nullable": true } }, "additionalProperties": false, "description": "One C# completion item for a Net Operation Project source buffer." }, "NetOperationProjectSourceLanguageCompletionRequest": { "type": "object", "properties": { "RevisionId": { "type": "string", "description": "Optional source revision id. When omitted, the working revision is used, then the current revision.", "nullable": true }, "Path": { "type": "string", "description": "Normalized relative source path.", "nullable": true }, "Content": { "type": "string", "description": "Current editor buffer content for the requested path.", "nullable": true }, "LineNumber": { "type": "integer", "description": "One-based editor line number.", "format": "int32" }, "Column": { "type": "integer", "description": "One-based editor column.", "format": "int32" }, "SchemaContractHash": { "type": "string", "description": "Optional schema contract hash read with the editor buffer. A mismatch rejects a stale language request.", "nullable": true } }, "additionalProperties": false, "description": "Request C# completion items for a Net Operation Project source buffer." }, "NetOperationProjectSourceLanguageCompletionResult": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageCompletionItem" }, "description": "Completion items.", "nullable": true }, "DependencyStatus": { "$ref": "#/components/schemas/NetOperationProjectLanguageDependencyStatus" } }, "additionalProperties": false, "description": "C# completion result for a Net Operation Project source buffer." }, "NetOperationProjectSourceLanguageCompletionResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageCompletionResult" }, "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 }, "NetOperationProjectSourceLanguageDiagnostic": { "type": "object", "properties": { "Severity": { "$ref": "#/components/schemas/NetOperationProjectLanguageDiagnosticSeverity" }, "Origin": { "$ref": "#/components/schemas/NetOperationProjectLanguageDiagnosticOrigin" }, "Code": { "type": "string", "description": "Compiler diagnostic id.", "nullable": true }, "Message": { "type": "string", "description": "Localized compiler diagnostic message.", "nullable": true }, "Path": { "type": "string", "description": "Normalized source path when available.", "nullable": true }, "Range": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageRange" } }, "additionalProperties": false, "description": "One C# diagnostic for a Net Operation Project source buffer." }, "NetOperationProjectSourceLanguageDiagnosticsRequest": { "type": "object", "properties": { "RevisionId": { "type": "string", "description": "Optional source revision id. When omitted, the working revision is used, then the current revision.", "nullable": true }, "Path": { "type": "string", "description": "Normalized relative source path.", "nullable": true }, "Content": { "type": "string", "description": "Current editor buffer content for the requested path.", "nullable": true }, "SchemaContractHash": { "type": "string", "description": "Optional schema contract hash read with the editor buffer. A mismatch rejects a stale language request.", "nullable": true } }, "additionalProperties": false, "description": "Request C# diagnostics for a Net Operation Project source buffer." }, "NetOperationProjectSourceLanguageDiagnosticsResult": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "Diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnostic" }, "description": "Compiler diagnostics.", "nullable": true }, "DependencyStatus": { "$ref": "#/components/schemas/NetOperationProjectLanguageDependencyStatus" }, "Limits": { "$ref": "#/components/schemas/NetOperationProjectSourceProcessingLimits" } }, "additionalProperties": false, "description": "C# diagnostics result for a Net Operation Project source buffer." }, "NetOperationProjectSourceLanguageDiagnosticsResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageDiagnosticsResult" }, "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 }, "NetOperationProjectSourceLanguageHoverRequest": { "type": "object", "properties": { "RevisionId": { "type": "string", "description": "Optional source revision id. When omitted, the working revision is used, then the current revision.", "nullable": true }, "Path": { "type": "string", "description": "Normalized relative source path.", "nullable": true }, "Content": { "type": "string", "description": "Current editor buffer content for the requested path.", "nullable": true }, "LineNumber": { "type": "integer", "description": "One-based editor line number.", "format": "int32" }, "Column": { "type": "integer", "description": "One-based editor column.", "format": "int32" }, "SchemaContractHash": { "type": "string", "description": "Optional schema contract hash read with the editor buffer. A mismatch rejects a stale language request.", "nullable": true } }, "additionalProperties": false, "description": "Request C# hover information for a Net Operation Project source buffer." }, "NetOperationProjectSourceLanguageHoverResult": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "Path": { "type": "string", "description": "Normalized source path.", "nullable": true }, "Range": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageRange" }, "Content": { "type": "string", "description": "Hover content, or null when no symbol is available at the requested position.", "nullable": true }, "Documentation": { "type": "string", "description": "XML documentation for the hovered symbol, or null when none is available.", "nullable": true }, "DependencyStatus": { "$ref": "#/components/schemas/NetOperationProjectLanguageDependencyStatus" } }, "additionalProperties": false, "description": "C# hover result for a Net Operation Project source buffer." }, "NetOperationProjectSourceLanguageHoverResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageHoverResult" }, "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 }, "NetOperationProjectSourceLanguageRange": { "type": "object", "properties": { "StartLineNumber": { "type": "integer", "description": "One-based start line number.", "format": "int32" }, "StartColumn": { "type": "integer", "description": "One-based start column.", "format": "int32" }, "EndLineNumber": { "type": "integer", "description": "One-based end line number.", "format": "int32" }, "EndColumn": { "type": "integer", "description": "One-based end column.", "format": "int32" } }, "additionalProperties": false, "description": "One-based source range for a Net Operation Project language service result." }, "NetOperationProjectSourceLanguageSignatureHelpItem": { "type": "object", "properties": { "Label": { "type": "string", "description": "Full signature label.", "nullable": true }, "Documentation": { "type": "string", "description": "Optional signature documentation.", "nullable": true }, "Parameters": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageSignatureHelpParameter" }, "description": "Parameters in declaration order.", "nullable": true } }, "additionalProperties": false, "description": "One callable signature returned for Monaco signature help." }, "NetOperationProjectSourceLanguageSignatureHelpParameter": { "type": "object", "properties": { "Label": { "type": "string", "description": "Parameter label as it appears in the signature.", "nullable": true }, "Documentation": { "type": "string", "description": "Optional parameter documentation.", "nullable": true } }, "additionalProperties": false, "description": "Signature help parameter metadata for Monaco." }, "NetOperationProjectSourceLanguageSignatureHelpRequest": { "type": "object", "properties": { "RevisionId": { "type": "string", "description": "Optional source revision id. When omitted, the working revision is used, then the current revision.", "nullable": true }, "Path": { "type": "string", "description": "Normalized relative source path.", "nullable": true }, "Content": { "type": "string", "description": "Current editor buffer content for the requested path.", "nullable": true }, "LineNumber": { "type": "integer", "description": "One-based editor line number.", "format": "int32" }, "Column": { "type": "integer", "description": "One-based editor column.", "format": "int32" }, "SchemaContractHash": { "type": "string", "description": "Optional schema contract hash read with the editor buffer. A mismatch rejects a stale language request.", "nullable": true } }, "additionalProperties": false, "description": "Request C# signature help for a Net Operation Project source buffer." }, "NetOperationProjectSourceLanguageSignatureHelpResult": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "Path": { "type": "string", "description": "Normalized source path.", "nullable": true }, "Signatures": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageSignatureHelpItem" }, "description": "Callable signatures available at the requested position.", "nullable": true }, "ActiveSignature": { "type": "integer", "description": "Zero-based active signature index.", "format": "int32" }, "ActiveParameter": { "type": "integer", "description": "Zero-based active parameter index.", "format": "int32" }, "DependencyStatus": { "$ref": "#/components/schemas/NetOperationProjectLanguageDependencyStatus" } }, "additionalProperties": false, "description": "C# signature help result for a Net Operation Project source buffer." }, "NetOperationProjectSourceLanguageSignatureHelpResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectSourceLanguageSignatureHelpResult" }, "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 }, "NetOperationProjectSourceProcessingLimits": { "type": "object", "properties": { "MaxFileCount": { "type": "integer", "description": "Maximum number of files in one source revision.", "format": "int32" }, "MaxSingleFileBytes": { "type": "integer", "description": "Maximum UTF-8 byte count of one source file.", "format": "int32" }, "MaxTotalSourceBytes": { "type": "integer", "description": "Maximum combined UTF-8 byte count of a source revision.", "format": "int32" }, "MaxManualEditChanges": { "type": "integer", "description": "Maximum number of file changes in one manual edit request.", "format": "int32" }, "DiagnosticsTimeoutSeconds": { "type": "integer", "description": "Maximum server processing time for one diagnostics request.", "format": "int32" }, "ManualEditTimeoutSeconds": { "type": "integer", "description": "Maximum server processing time for one manual edit request.", "format": "int32" }, "MaxConcurrentDiagnostics": { "type": "integer", "description": "Maximum concurrent Roslyn diagnostics analyses per host process.", "format": "int32" } }, "additionalProperties": false, "description": "Effective bounded-processing limits for Net Operation Project source authoring." }, "NetOperationProjectSourceTemplate": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable template identifier accepted by the preview endpoint.", "nullable": true }, "DefaultFolder": { "type": "string", "description": "Default project-relative source folder.", "nullable": true }, "RequiresClassName": { "type": "boolean", "description": "Whether preview requires a C# class name." }, "RequiresDisplayName": { "type": "boolean", "description": "Whether the template publishes a user-facing display name." }, "RequiresStableKey": { "type": "boolean", "description": "Whether the template publishes a stable function or data-source key." }, "RequiresTargetEntity": { "type": "boolean", "description": "Whether the template requires a target Entity Definition." } }, "additionalProperties": false, "description": "One supported Net Operation Project source template." }, "NetOperationProjectSourceTemplateListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectSourceTemplate" }, "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 }, "NetOperationProjectSourceTemplatePreview": { "type": "object", "properties": { "TemplateId": { "type": "string", "description": "Template identifier.", "nullable": true }, "ProposedPath": { "type": "string", "description": "Normalized source path for the generated file.", "nullable": true }, "Content": { "type": "string", "description": "Generated C# source content.", "nullable": true }, "ResolvedClassName": { "type": "string", "description": "Sanitized C# class name.", "nullable": true }, "ResolvedDisplayName": { "type": "string", "description": "Resolved display name used by the template.", "nullable": true }, "ResolvedStableKey": { "type": "string", "description": "Resolved stable key used by the template.", "nullable": true }, "TargetEntityDefinitionId": { "type": "string", "description": "Resolved target Entity Definition id, when applicable.", "nullable": true }, "TargetEntityClrType": { "type": "string", "description": "Generated workspace contract CLR type for the target entity, when applicable.", "nullable": true }, "Warnings": { "type": "array", "items": { "type": "string" }, "description": "Non-blocking preview warnings.", "nullable": true } }, "additionalProperties": false, "description": "Generated Net Operation Project source template preview." }, "NetOperationProjectSourceTemplatePreviewRequest": { "type": "object", "properties": { "TemplateId": { "type": "string", "description": "Template identifier.", "nullable": true }, "ClassName": { "type": "string", "description": "Requested C# class name.", "nullable": true }, "DisplayName": { "type": "string", "description": "Optional user-facing function or data-source display name.", "nullable": true }, "StableKey": { "type": "string", "description": "Optional stable function or data-source key.", "nullable": true }, "TargetEntityDefinitionId": { "type": "string", "description": "Optional target Entity Definition id for entity-scoped templates.", "nullable": true }, "Folder": { "type": "string", "description": "Optional source folder used when Path is omitted.", "nullable": true }, "Path": { "type": "string", "description": "Optional explicit source path.", "nullable": true }, "RevisionId": { "type": "string", "description": "Optional source revision id used for collision warnings.", "nullable": true } }, "additionalProperties": false, "description": "Request a generated Net Operation Project source template preview." }, "NetOperationProjectSourceTemplatePreviewResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectSourceTemplatePreview" }, "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 }, "NetOperationProjectSourceTree": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "Files": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectSourceTreeFile" }, "description": "Source file entries without file content.", "nullable": true } }, "additionalProperties": false, "description": "Source tree metadata for a Net Operation Project revision." }, "NetOperationProjectSourceTreeFile": { "type": "object", "properties": { "Id": { "type": "string", "description": "File row identifier.", "nullable": true }, "RevisionId": { "type": "string", "description": "Revision identifier.", "nullable": true }, "Path": { "type": "string", "description": "Normalized relative project path.", "nullable": true }, "ContentHash": { "type": "string", "description": "SHA-256 hash of the UTF-8 content.", "nullable": true }, "SizeBytes": { "type": "integer", "description": "UTF-8 byte length.", "format": "int64" } }, "additionalProperties": false, "description": "One source file entry in a Net Operation Project source tree." }, "NetOperationProjectSourceTreeResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectSourceTree" }, "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 }, "NetOperationProjectStatus": { "type": "object", "properties": { "ProjectId": { "type": "string", "description": "Project identifier.", "nullable": true }, "Name": { "type": "string", "description": "Project display name.", "nullable": true }, "CurrentRevision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "WorkingRevision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "ActiveArtifact": { "$ref": "#/components/schemas/NetOperationProjectArtifact" }, "LatestBuild": { "$ref": "#/components/schemas/NetOperationProjectBuild" }, "NeedsValidation": { "type": "boolean", "description": "Whether the project should be explicitly checked after schema changes." }, "CurrentSchemaContractHash": { "type": "string", "description": "Current generated workspace schema contract hash.", "nullable": true }, "IsActiveArtifactSchemaStale": { "type": "boolean", "description": "Whether the active artifact was built against a different schema contract." }, "LatestCheckBuild": { "$ref": "#/components/schemas/NetOperationProjectBuild" }, "RevisionCount": { "type": "integer", "description": "Stored source revision count.", "format": "int32" }, "BuildCount": { "type": "integer", "description": "Stored build history count.", "format": "int32" }, "ArtifactCount": { "type": "integer", "description": "Stored artifact history count.", "format": "int32" }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "ModifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "ActiveArtifactRuntimeStatus": { "$ref": "#/components/schemas/NetOperationProjectArtifactRuntimeStatus" } }, "additionalProperties": false, "description": "Net Operation Project workspace storage status." }, "NetOperationProjectStatusResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectStatus" }, "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 }, "NetOperationProjectUploadResult": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/NetOperationProjectRevision" }, "Build": { "$ref": "#/components/schemas/NetOperationProjectBuild" } }, "additionalProperties": false, "description": "Result of uploading a Net Operation Project source archive." }, "NetOperationProjectUploadResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/NetOperationProjectUploadResult" }, "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 }, "NuGetPackageSearchResult": { "type": "object", "properties": { "Id": { "type": "string", "description": "Package identifier.", "nullable": true }, "LatestVersion": { "type": "string", "description": "Latest version returned by NuGet.org for the requested search mode.", "nullable": true }, "Description": { "type": "string", "description": "Package description.", "nullable": true }, "Authors": { "type": "string", "description": "Package authors.", "nullable": true }, "IconUrl": { "type": "string", "description": "Package icon URL.", "nullable": true }, "ProjectUrl": { "type": "string", "description": "Package project URL.", "nullable": true }, "Verified": { "type": "boolean", "description": "Whether NuGet.org reports a verified package prefix." }, "TotalDownloads": { "type": "integer", "description": "Total NuGet.org downloads.", "format": "int64" }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "Package tags.", "nullable": true } }, "additionalProperties": false, "description": "NuGet.org package search result for Net Operation Project package management." }, "NuGetPackageSearchResultListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/NuGetPackageSearchResult" }, "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 }, "NuGetPackageVersion": { "type": "object", "properties": { "Version": { "type": "string", "description": "Package version.", "nullable": true }, "IsPrerelease": { "type": "boolean", "description": "Whether the version is a prerelease version." } }, "additionalProperties": false, "description": "NuGet.org package version option for Net Operation Project package management." }, "NuGetPackageVersionListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/NuGetPackageVersion" }, "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 }, "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 }, "PermissionDesc": { "type": "object", "properties": { "Group": { "type": "string", "description": "Group identifier used to categorize permissions.", "nullable": true }, "Code": { "type": "string", "description": "Permission code within the group.", "nullable": true }, "Name": { "type": "string", "description": "Optional display name or localization key.", "nullable": true }, "Description": { "type": "string", "description": "Optional description or localization key.", "nullable": true }, "PresentationKind": { "$ref": "#/components/schemas/PermissionPresentationKind" } }, "additionalProperties": false, "description": "Defines a permission that can be assigned to roles." }, "PermissionDescListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDesc" }, "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 }, "PermissionPresentationKind": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Defines how a permission is presented when roles are configured.", "format": "int32", "x-enum-varnames": [ "Capability", "ModuleAccess", "Hidden" ], "x-enum-descriptions": { "0": "The permission is an independently assignable capability.", "1": "The permission grants access to a product module.", "2": "The permission remains valid but is not offered in general role management." } }, "PlanSecurityAccessPolicyChangeRequest": { "required": [ "ChangeKind", "ExpectedRowVersion", "OperationKey" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "ExpectedRowVersion": { "type": "string", "format": "uuid" }, "ChangeKind": { "$ref": "#/components/schemas/SecurityAccessPolicyChangeKind" }, "OriginalPolicyKey": { "type": "string", "nullable": true }, "Draft": { "$ref": "#/components/schemas/SecurityAccessPolicyDraft" } }, "additionalProperties": false, "description": "Plans one atomic Access Policy create, update, rename, or delete." }, "PlanSecurityFieldNormalizationRequest": { "required": [ "ExpectedRowVersion", "OperationKey" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "ExpectedRowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Plans explicit removal of structurally redundant field refinements." }, "PlanSecurityPermissionBindingsRequest": { "required": [ "Bindings", "ExpectedRowVersion", "OperationKey" ], "type": "object", "properties": { "OperationKey": { "type": "string", "format": "uuid" }, "ExpectedRowVersion": { "type": "string", "format": "uuid" }, "Bindings": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityPermissionBindingPatch" } } }, "additionalProperties": false, "description": "Plans an atomic partial Permission binding patch." }, "PreviewBoardStatementRequest": { "type": "object", "properties": { "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "Expression": { "type": "string", "nullable": true }, "Values": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true }, "Collections": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "nullable": true } }, "additionalProperties": false, "description": "Evaluate a Board Statement against an explicit proposed context.\r\nValues are keyed by canonical profile path. Collection rows are keyed by collection path." }, "PreviewEntityReferenceEligibilityImpactRequest": { "required": [ "Expression" ], "type": "object", "properties": { "Expression": { "type": "string", "description": "Proposed eligibility expression." } }, "additionalProperties": false, "description": "Request to preview persisted-data and saved-surface impact." }, "PreviewWorkspaceUiPageGeneratorRequest": { "type": "object", "properties": { "Kind": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorKind" }, "BaseRevisionId": { "type": "string", "nullable": true }, "BaseSourceChecksum": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Icon": { "type": "string", "nullable": true }, "Layout": { "$ref": "#/components/schemas/WorkspaceUiPageLayout" }, "RoutePath": { "type": "string", "nullable": true }, "EntityList": { "$ref": "#/components/schemas/WorkspaceUiEntityListGeneratorRequest" }, "EntityDetails": { "$ref": "#/components/schemas/WorkspaceUiEntityDetailsGeneratorRequest" }, "ExternalApiExample": { "$ref": "#/components/schemas/WorkspaceUiExternalApiExampleGeneratorRequest" }, "MenuPlacement": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorMenuPlacementRequest" } }, "additionalProperties": false, "description": "Preview one deterministic generated page against an immutable source revision." }, "PreviewWorkspaceUiProjectSourceTemplateRequest": { "type": "object", "properties": { "TemplateId": { "type": "string", "description": "Stable template identifier.", "nullable": true }, "BaseRevisionId": { "type": "string", "description": "Working revision on which generation is based.", "nullable": true }, "BaseSourceChecksum": { "type": "string", "description": "Expected checksum of the working revision.", "nullable": true }, "Key": { "type": "string", "description": "Lowercase kebab-case page, component, store, or client key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Human-readable title used in generated locale resources.", "nullable": true }, "Icon": { "type": "string", "description": "Optional MDI icon for a generated page manifest entry.", "nullable": true }, "Layout": { "$ref": "#/components/schemas/WorkspaceUiPageLayout" }, "RoutePath": { "type": "string", "description": "Optional strict relative route pattern. Page starters default to and require the named parameters `:entityId` and `:instanceId`.", "nullable": true }, "FunctionKey": { "type": "string", "description": "Exact published C# function key used by command and background-function client templates.", "nullable": true } }, "additionalProperties": false, "description": "Generate a deterministic Workspace UI source-template preview." }, "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": { } }, "QueueNetOperationProjectBuildRequest": { "type": "object", "properties": { "RevisionId": { "type": "string", "description": "Optional revision identifier; defaults to the working revision.", "nullable": true }, "Kind": { "$ref": "#/components/schemas/NetOperationProjectBuildKind" } }, "additionalProperties": false, "description": "Request payload to queue a Net Operation Project build or check." }, "ReactivateEntitlementOperationsModelRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "Reason": { "type": "string", "description": "Optional administrator reason.", "nullable": true }, "RowVersion": { "type": "string", "description": "Required concurrency token from the current model.", "format": "uuid" } }, "additionalProperties": false, "description": "Request used to reactivate a model without changing its shape." }, "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" } }, "RecordMatchingFuzzyAlgorithm": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "DamerauLevenshtein" ], "x-enum-descriptions": { "0": "Measure edit distance using the Damerau-Levenshtein algorithm" } }, "RecordMatchingFuzzyFieldSettings": { "type": "object", "properties": { "Algorithm": { "$ref": "#/components/schemas/RecordMatchingFuzzyAlgorithm" }, "MaxDistance": { "type": "integer", "description": "Inclusive distance threshold from one through three.", "format": "int32" }, "MinimumLength": { "type": "integer", "description": "Minimum normalized rune length; at least twice the threshold plus one.", "format": "int32" }, "Weight": { "type": "integer", "description": "Field contribution to rule similarity, from one through one hundred.", "format": "int32" }, "DiacriticMode": { "$ref": "#/components/schemas/RecordMatchingDiacriticMode" }, "TokenOrderMode": { "$ref": "#/components/schemas/RecordMatchingTokenOrderMode" } }, "additionalProperties": false, "description": "Configuration for one fuzzy TextKey field binding." }, "RecordMatchingFuzzyFieldSettingsResult": { "type": "object", "properties": { "Algorithm": { "$ref": "#/components/schemas/RecordMatchingFuzzyAlgorithm" }, "MaxDistance": { "type": "integer", "description": "Inclusive distance threshold from one through three.", "format": "int32" }, "MinimumLength": { "type": "integer", "description": "Minimum normalized rune length required for both values.", "format": "int32" }, "Weight": { "type": "integer", "description": "Field contribution to the fuzzy rule similarity, from one through one hundred.", "format": "int32" }, "DiacriticMode": { "$ref": "#/components/schemas/RecordMatchingDiacriticMode" }, "TokenOrderMode": { "$ref": "#/components/schemas/RecordMatchingTokenOrderMode" } }, "additionalProperties": false, "description": "Configured fuzzy TextKey field settings." }, "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" } }, "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" } }, "RecordMatchingMatchMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "ExactNormalized", "Fuzzy" ], "x-enum-descriptions": { "0": "Require normalized values to be equal", "1": "Allow similarity-based matching" } }, "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" } }, "RecordMatchingProfileDetail": { "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" }, "Rules": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingRule" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Full record-matching profile configuration." }, "RecordMatchingProfileDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RecordMatchingProfileDetail" }, "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 }, "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." }, "RecordMatchingProfileSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingProfileSummary" }, "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 }, "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." }, "RecordMatchingRule": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "MatchMode": { "$ref": "#/components/schemas/RecordMatchingMatchMode" }, "Score": { "type": "integer", "format": "int32" }, "SortOrder": { "type": "integer", "format": "int32" }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingRuleField" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Configured exact-normalized or fuzzy matching rule." }, "RecordMatchingRuleField": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable rule-field identifier.", "nullable": true }, "EntityFieldDefinitionId": { "type": "string", "description": "Bound entity-field definition identifier.", "nullable": true }, "FieldKey": { "type": "string", "description": "Portable technical field key.", "nullable": true }, "FieldDisplayName": { "type": "string", "description": "Current actor-readable field label.", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "Normalizer": { "$ref": "#/components/schemas/RecordMatchingNormalizer" }, "SortOrder": { "type": "integer", "description": "Deterministic field order within the rule.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Optimistic-concurrency version.", "format": "uuid" }, "ComparisonMode": { "$ref": "#/components/schemas/RecordMatchingFieldComparisonMode" }, "FuzzySettings": { "$ref": "#/components/schemas/RecordMatchingFuzzyFieldSettingsResult" } }, "additionalProperties": false, "description": "Configured field binding for one matching rule." }, "RecordMatchingRuleFieldRequest": { "type": "object", "properties": { "EntityFieldDefinitionId": { "type": "string", "description": "Bound entity-field definition identifier.", "nullable": true }, "Normalizer": { "$ref": "#/components/schemas/RecordMatchingNormalizer" }, "SortOrder": { "type": "integer", "description": "Deterministic field order within the rule.", "format": "int32" }, "ComparisonMode": { "$ref": "#/components/schemas/RecordMatchingFieldComparisonMode" }, "FuzzySettings": { "$ref": "#/components/schemas/RecordMatchingFuzzyFieldSettings" } }, "additionalProperties": false, "description": "Request payload for one field binding inside a matching rule. Omitted trailing comparison properties\r\npreserve the additive exact-field behavior used by earlier clients." }, "RecordMatchingRuleRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "MatchMode": { "$ref": "#/components/schemas/RecordMatchingMatchMode" }, "Score": { "type": "integer", "format": "int32" }, "SortOrder": { "type": "integer", "format": "int32" }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingRuleFieldRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Request payload for one exact-normalized or fuzzy matching rule." }, "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 }, "RecordMatchingTargetEntityDefinition": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingTargetField" }, "nullable": true } }, "additionalProperties": false, "description": "Selectable entity definition for record matching." }, "RecordMatchingTargetField": { "type": "object", "properties": { "Id": { "type": "string", "description": "Entity-field definition identifier.", "nullable": true }, "Key": { "type": "string", "description": "Portable technical field key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Current field label.", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "Normalizers": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingNormalizer" }, "description": "Supported exact and fuzzy normalizers.", "nullable": true }, "SupportsFuzzy": { "type": "boolean", "description": "Whether this field supports fuzzy TextKey comparison." }, "FuzzyAlgorithms": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingFuzzyAlgorithm" }, "description": "Supported fuzzy algorithms when SupportsFuzzy is true.", "nullable": true } }, "additionalProperties": false, "description": "Selectable primary-table field for record matching, including exact normalizers and explicit fuzzy support." }, "RecordMatchingTargetKind": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "EntityDefinition" ], "x-enum-descriptions": { "0": "Match records within an Entity Definition" } }, "RecordMatchingTargetOptions": { "type": "object", "properties": { "Entities": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingTargetEntityDefinition" }, "nullable": true } }, "additionalProperties": false, "description": "Entity definition and compatible primary-table fields available for profile configuration." }, "RecordMatchingTargetOptionsResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RecordMatchingTargetOptions" }, "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 }, "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" } }, "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" } }, "ReorderBoardConstraintBindingsRequest": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BoardConstraintBindingOrderRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Reorder bindings inside one Board Constraint." }, "ReorderBoardConstraintsRequest": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BoardConstraintOrderRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Reorder Board Constraints." }, "ReorderBoardStatementsRequest": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatementOrderRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Reorder Board Statements." }, "ReorderBoardStatusesRequest": { "required": [ "Items" ], "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatusOrderRequest" }, "description": "Status order rows." } }, "additionalProperties": false, "description": "Reorders board statuses." }, "ReorderBoardTransitionsRequest": { "required": [ "Items" ], "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTransitionOrderRequest" }, "description": "Transition order rows." } }, "additionalProperties": false, "description": "Reorders board transitions." }, "ReorderEntitlementPlansRequest": { "required": [ "PlanIds" ], "type": "object", "properties": { "PlanIds": { "type": "array", "items": { "type": "string" }, "description": "Plan ids in target display order." } }, "additionalProperties": false, "description": "Explicit plan ordering inside one entitlement model." }, "ReorderEntityFieldsRequest": { "required": [ "FieldIds" ], "type": "object", "properties": { "FieldIds": { "type": "array", "items": { "type": "string" }, "description": "Field identifiers in the target order." } }, "additionalProperties": false, "description": "Request payload to reorder fields inside one entity table." }, "ReorderEntityValidationRuleItemRequest": { "required": [ "Id", "RowVersion" ], "type": "object", "properties": { "Id": { "type": "string", "description": "Validation rule identifier." }, "RowVersion": { "type": "string", "description": "Concurrency token for the validation rule.", "format": "uuid" } }, "additionalProperties": false, "description": "One validation rule row in the requested order." }, "ReorderEntityValidationRulesRequest": { "required": [ "Rules" ], "type": "object", "properties": { "Rules": { "type": "array", "items": { "$ref": "#/components/schemas/ReorderEntityValidationRuleItemRequest" }, "description": "All active validation rules in the desired order." } }, "additionalProperties": false, "description": "Replace validation rule ordering for one entity definition." }, "ReplaceBoardAttentionSignalPolicyRequest": { "required": [ "Reasons" ], "type": "object", "properties": { "Reasons": { "type": "array", "items": { "$ref": "#/components/schemas/BoardAttentionSignalPolicyReasonRequest" }, "description": "Full replacement list of AttentionSignal reason rows. At least one row is required, every required board signal type key must be present exactly once, and duplicate type keys are rejected." }, "Audience": { "type": "array", "items": { "$ref": "#/components/schemas/BoardAttentionSignalAudienceSubjectRequest" }, "description": "Full replacement list of audience subjects that receive projected board AttentionSignals. Duplicate subjects are rejected. Null or empty clears the audience.", "nullable": true }, "RowVersion": { "type": "string", "description": "Optional expected AttentionSignal policy row version for optimistic concurrency. Must be omitted when the board has no AttentionSignal policy yet; when replacing an existing policy, a supplied value must match the current policy row version or the request fails with a conflict.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Replaces the board AttentionSignal projection and delivery policy." }, "ReplaceBoardDueDatePolicyRequest": { "type": "object", "properties": { "Enabled": { "type": "boolean", "description": "Whether due-date tracking is enabled for the board. Disabled boards keep stored item due dates but stop due-date state evaluation." }, "TimeMode": { "$ref": "#/components/schemas/BoardDueDateTimeMode" }, "DisabledBoardStatusIds": { "type": "array", "items": { "type": "string" }, "description": "Board status ids whose items suppress due-date state evaluation. Each id must reference an existing status of the board. Null or empty disables no statuses.", "nullable": true }, "Expectations": { "type": "array", "items": { "$ref": "#/components/schemas/BoardDueDateStatusExpectationRequest" }, "description": "Full replacement list of ordered status expectation rows. Duplicate rows with the same status, offset, unit, and severity are rejected. Null or empty clears all expectations.", "nullable": true }, "RowVersion": { "type": "string", "description": "Optional expected due-date policy row version for optimistic concurrency. Must be omitted when the board has no due-date policy yet; when replacing an existing policy, a supplied value must match the current policy row version or the request fails with a conflict.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Replaces a board due-date process policy." }, "ReplaceBoardTargetDefinitionCardFieldsRequest": { "required": [ "Fields", "RowVersion" ], "type": "object", "properties": { "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetDefinitionCardFieldRequest" }, "description": "Required full replacement list of card field rows; null is rejected while an empty list removes all configured card fields. Each row must reference a field from the target's card field catalog, the same field may appear only once per status scope, and each status scope (including the all-statuses scope) may hold at most 8 fields." }, "RowVersion": { "type": "string", "description": "Required expected target definition row version for optimistic concurrency. It must match the current row version or the request fails with a conflict.", "format": "uuid" } }, "additionalProperties": false, "description": "Replaces configured card fields on one canonical board target definition." }, "ReplaceBoardTargetDefinitionInitialFieldMappingsRequest": { "required": [ "Mappings", "RowVersion" ], "type": "object", "properties": { "Mappings": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTargetDefinitionInitialFieldMappingRequest" }, "description": "Required full replacement list of initial field mapping rows; null is rejected while an empty list removes all configured mappings. Available only for EntityDefinition targets, and each destination field may be mapped at most once." }, "RowVersion": { "type": "string", "description": "Required expected target definition row version for optimistic concurrency. It must match the current row version or the request fails with a conflict.", "format": "uuid" } }, "additionalProperties": false, "description": "Replaces configured initial field mappings on one canonical board target definition." }, "ReplaceEntityObjectHostedLayoutRequest": { "type": "object", "properties": { "Layout": { "$ref": "#/components/schemas/EntityObjectHostedLayout" } }, "additionalProperties": false, "description": "Request payload to replace an object-hosted layout for a details page or drawer." }, "ReplaceEntityUiCardSurfaceConfigurationRequest": { "type": "object", "properties": { "Tabs": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTab" }, "description": "Configured card tabs.", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityCardUiItem" }, "description": "Configured card items.", "nullable": true }, "LabelRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiCardLabelRuleAdmin" }, "description": "Explicit card label-chip rules keyed by client-exposed statements.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to replace an explicit card surface configuration." }, "ReplaceEntityUiDetailsSurfaceConfigurationRequest": { "type": "object", "properties": { "SummaryCardSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware card surface selectors for details summary content.", "nullable": true }, "EditFormSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware form surface selectors for details edit flows.", "nullable": true }, "BackTarget": { "$ref": "#/components/schemas/EntityDetailsBackTargetAdmin" } }, "additionalProperties": false, "description": "Request payload to replace the entity details host-surface configuration." }, "ReplaceEntityUiDrawerSurfaceConfigurationRequest": { "type": "object", "properties": { "SummaryCardSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware card surface selectors for drawer summary content.", "nullable": true }, "EditFormSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware form surface selectors for drawer edit flows.", "nullable": true }, "DetailsPageSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware details-page selectors for the drawer open action.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to replace the drawer host-surface configuration." }, "ReplaceEntityUiEntityListPageConfigurationRequest": { "type": "object", "properties": { "MainTableSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware hosted table selectors for the list page.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to replace the entity list-page configuration." }, "ReplaceEntityUiFormSurfaceConfigurationRequest": { "type": "object", "properties": { "MaxWidth": { "type": "integer", "description": "Maximum layout width in pixels.", "format": "int32", "nullable": true }, "ColumnCount": { "type": "integer", "description": "Desktop column count.", "format": "int32", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFormUiItem" }, "description": "Configured form items.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to replace an explicit form surface configuration." }, "ReplaceEntityUiTableSurfaceConfigurationRequest": { "type": "object", "properties": { "CreateFormSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware form selectors used by table-scoped create flows.", "nullable": true }, "EditFormSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware default form selectors used by table edit actions without an override.", "nullable": true }, "DrawerSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware drawer selectors used by preview actions and post-form navigation.", "nullable": true }, "DetailsPageSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiSurfaceSelectorAdmin" }, "description": "Role-aware details-page selectors used by open actions and post-form navigation.", "nullable": true }, "AfterCreateNavigation": { "$ref": "#/components/schemas/EntityTablePostFormNavigation" }, "AfterUpdateNavigation": { "$ref": "#/components/schemas/EntityTablePostFormNavigation" }, "Actions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTableUiAction" }, "description": "Explicit row actions available on this table surface.", "nullable": true }, "Columns": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableColumnConfigurationAdmin" }, "description": "Explicit column configuration keyed by stable target anchors.", "nullable": true }, "ProjectionColumns": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableProjectionColumnAdmin" }, "description": "Explicit related-record projection columns shown after root table columns.", "nullable": true }, "RowRules": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableRowRuleAdmin" }, "description": "Explicit table row highlight rules.", "nullable": true }, "FilterItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceFilterItemAdmin" }, "description": "Ordered filter items available for this table surface.", "nullable": true }, "SortItems": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceSortItemAdmin" }, "description": "Ordered sort items available for this table surface.", "nullable": true }, "DefaultSort": { "type": "array", "items": { "$ref": "#/components/schemas/EntityUiTableSurfaceDefaultSortItemAdmin" }, "description": "Default runtime data explorer sort sequence for this table surface.", "nullable": true }, "TreeView": { "$ref": "#/components/schemas/EntityUiTableSurfaceTreeViewConfigurationAdmin" } }, "additionalProperties": false, "description": "Request payload to replace the table surface configuration." }, "ReplaceScopedRolePermissionsRequest": { "type": "object", "properties": { "Assignments": { "type": "array", "items": { "$ref": "#/components/schemas/ScopedRolePermissionAssignmentRequest" }, "description": "Role assignments to apply inside the scope.", "nullable": true } }, "additionalProperties": false, "description": "Request to replace role assignments inside a bounded permission scope." }, "ResourceOpenTarget": { "type": "object", "properties": { "TargetCode": { "type": "string", "nullable": true }, "Parameters": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "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" } }, "RoleDetail": { "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." }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "Tag names assigned to the role.", "nullable": true }, "Users": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" }, "description": "Users assigned to the role.", "nullable": true }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-secret integration metadata.", "nullable": true } }, "additionalProperties": false, "description": "Full details for a workspace role." }, "RoleDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RoleDetail" }, "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 }, "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 }, "RotateManagedSecretRequest": { "type": "object", "properties": { "Value": { "type": "string", "description": "Replacement value, limited to 64 KiB in UTF-8. It is stored without transformation and never returned.", "nullable": true }, "RowVersion": { "type": "string", "description": "Expected concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Replace a managed-secret value and increment its value version." }, "RuntimeMenuAdminNode": { "type": "object", "properties": { "Id": { "type": "string", "description": "Node identifier.", "nullable": true }, "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 URL for external-link leaves.", "nullable": true }, "PageCode": { "type": "string", "description": "Frontend-owned 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 }, "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Role identifiers that restrict visibility of this node and its descendants.", "nullable": true }, "Children": { "type": "array", "items": { "$ref": "#/components/schemas/RuntimeMenuAdminNode" }, "description": "Child nodes.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "EntityListPageSurfaceKey": { "type": "string", "description": "Explicit entity-list page key, or null for the default page.", "nullable": true } }, "additionalProperties": false, "description": "One runtime-menu node for admin read models." }, "RuntimeMenuDetail": { "type": "object", "properties": { "Id": { "type": "string", "description": "Menu identifier.", "nullable": true }, "Name": { "type": "string", "description": "Menu display name.", "nullable": true }, "Description": { "type": "string", "description": "Optional free-form description.", "nullable": true }, "Priority": { "type": "integer", "description": "Resolution priority.", "format": "int32" }, "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Assigned role identifiers.", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/RuntimeMenuAdminNode" }, "description": "Whole menu tree.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Full runtime-menu detail for admin editing." }, "RuntimeMenuDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RuntimeMenuDetail" }, "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" } }, "RuntimeMenuModulePageCatalog": { "type": "object", "properties": { "PageCode": { "type": "string", "description": "Stable page code stored by Runtime Menu configuration.", "nullable": true }, "DisplayName": { "type": "string", "description": "Localized page display name.", "nullable": true }, "Icon": { "type": "string", "description": "MDI icon name.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order inside the owning module.", "format": "int32" }, "ModuleKey": { "type": "string", "description": "Owning module key.", "nullable": true }, "RouteName": { "type": "string", "description": "WebApp named-route contract returned by runtime resolution.", "nullable": true }, "IsModuleEnabled": { "type": "boolean", "description": "Whether the owning module is enabled." }, "IsAvailable": { "type": "boolean", "description": "Whether the page can currently resolve at runtime." }, "RequiredPermissions": { "type": "array", "items": { "type": "string" }, "description": "Static workspace permission prerequisites.", "nullable": true }, "IsDeprecated": { "type": "boolean", "description": "Whether this stable page code is deprecated." }, "ReplacementPageCode": { "type": "string", "description": "Optional stable replacement page code.", "nullable": true } }, "additionalProperties": false, "description": "One built-in module page available for Runtime Menu configuration." }, "RuntimeMenuModulePageCatalogListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RuntimeMenuModulePageCatalog" }, "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 }, "RuntimeMenuNodeRequest": { "required": [ "Icon", "Kind", "Label", "SortOrder" ], "type": "object", "properties": { "Kind": { "$ref": "#/components/schemas/RuntimeMenuItemKind" }, "SortOrder": { "type": "integer", "description": "Sibling sort order.", "format": "int32" }, "Label": { "type": "string", "description": "Display label." }, "Icon": { "type": "string", "description": "MDI icon name." }, "LeafType": { "$ref": "#/components/schemas/RuntimeMenuLeafType" }, "EntityDefinitionId": { "type": "string", "description": "Target entity definition identifier; required for Data Explorer leaves.", "nullable": true }, "Children": { "type": "array", "items": { "$ref": "#/components/schemas/RuntimeMenuNodeRequest" }, "description": "Nested children; only one additional level is supported.", "nullable": true }, "Href": { "type": "string", "description": "Absolute HTTP(S) URL or app-relative path beginning with a single slash; required for external-link leaves. Backslashes, control characters, protocol-relative paths, and surrounding whitespace are rejected.", "nullable": true }, "PageCode": { "type": "string", "description": "Registered stable module page code; required for module-page leaves. Known pages of disabled modules remain valid configuration and become available when the module is enabled.", "nullable": true }, "WorkspaceUiPageKey": { "type": "string", "description": "Workspace UI page key; required for workspace-page leaves.", "nullable": true }, "CatalogDefinitionId": { "type": "string", "description": "Runtime Catalog Definition identifier; required for Catalog leaves.", "nullable": true }, "EntityListPageSurfaceKey": { "type": "string", "description": "Optional explicit entity-list page key for Data Explorer leaves; null resolves the current default.", "nullable": true }, "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Optional role identifiers that add a visibility restriction to this node and its descendants.", "nullable": true } }, "additionalProperties": false, "description": "One runtime-menu node submitted by the admin UI." }, "RuntimeMenuSummary": { "type": "object", "properties": { "Id": { "type": "string", "description": "Menu identifier.", "nullable": true }, "Name": { "type": "string", "description": "Menu display name.", "nullable": true }, "Description": { "type": "string", "description": "Optional free-form description.", "nullable": true }, "Priority": { "type": "integer", "description": "Resolution priority.", "format": "int32" }, "AppliesToAllUsers": { "type": "boolean", "description": "True when no roles are assigned." }, "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Assigned role identifiers.", "nullable": true }, "ItemCount": { "type": "integer", "description": "Configured node count.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "One runtime-menu row for admin lists." }, "RuntimeMenuSummaryListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RuntimeMenuSummary" }, "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 }, "SchemaChangePlan": { "type": "object", "properties": { "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "description": "Warnings produced by the planned schema mutation.", "nullable": true }, "RequiresConfirmation": { "type": "boolean", "description": "Whether the mutation must be explicitly confirmed before it can be applied." }, "ConfirmationToken": { "type": "string", "description": "Stateless confirmation token accepted by the matching apply endpoint.", "nullable": true } }, "additionalProperties": false, "description": "Schema change awareness result for a planned entity schema mutation." }, "SchemaChangePlanResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/SchemaChangePlan" }, "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 }, "ScopedRolePermissionAssignment": { "type": "object", "properties": { "RoleId": { "type": "string", "description": "Workspace role identifier.", "nullable": true }, "RoleName": { "type": "string", "description": "Workspace role display name.", "nullable": true }, "IsLocked": { "type": "boolean", "description": "Whether the role assignment is system-managed and cannot be edited here." }, "PermissionKeys": { "type": "array", "items": { "type": "string" }, "description": "Normalized permission keys assigned or inherited inside this scope.", "nullable": true } }, "additionalProperties": false, "description": "Role assignment for a bounded permission scope." }, "ScopedRolePermissionAssignmentRequest": { "type": "object", "properties": { "RoleId": { "type": "string", "description": "Workspace role identifier.", "nullable": true }, "PermissionKeys": { "type": "array", "items": { "type": "string" }, "description": "Normalized permission keys assigned to the role inside this scope.", "nullable": true } }, "additionalProperties": false, "description": "Replacement role assignment for a bounded permission scope." }, "ScopedRolePermissions": { "type": "object", "properties": { "Permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDesc" }, "description": "Permissions that can be managed in this scope.", "nullable": true }, "Assignments": { "type": "array", "items": { "$ref": "#/components/schemas/ScopedRolePermissionAssignment" }, "description": "Role assignments inside this scope.", "nullable": true } }, "additionalProperties": false, "description": "Bounded permission scope with role assignments." }, "ScopedRolePermissionsResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ScopedRolePermissions" }, "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 }, "SecurityAccessPolicy": { "required": [ "Enabled", "Key", "PermissionIds", "Source" ], "type": "object", "properties": { "Key": { "type": "string" }, "Source": { "type": "string" }, "Enabled": { "type": "boolean" }, "PermissionIds": { "type": "array", "items": { "type": "string" } }, "GuidedCondition": { "$ref": "#/components/schemas/SecurityGuidedConditionProjection" } }, "additionalProperties": false, "description": "Describes one Access Policy projected from a Statement and its Permission Assignments." }, "SecurityAccessPolicyAdministration": { "required": [ "CapabilityGroups", "Health", "Permissions", "Policies", "ProfileKey", "ResourceKind", "RowVersion" ], "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid" }, "ProfileKey": { "type": "string" }, "ResourceKind": { "type": "string" }, "Policies": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityAccessPolicy" } }, "CapabilityGroups": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityCapabilityGroup" } }, "Permissions": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityPermissionDescriptor" } }, "Health": { "$ref": "#/components/schemas/SecurityAdministrationHealth" } }, "additionalProperties": false, "description": "Returns the policy-first administration projection for one exact Security profile." }, "SecurityAccessPolicyAdministrationResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/SecurityAccessPolicyAdministration" }, "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 }, "SecurityAccessPolicyChangeKind": { "enum": [ 0, 1, 2 ], "type": "string", "description": "Identifies one policy-first administration change.", "x-enum-varnames": [ "Create", "Update", "Delete" ], "x-enum-descriptions": { "0": "Creates a new Access Policy.", "1": "Updates or renames an existing Access Policy.", "2": "Deletes an existing Access Policy and its Permission Assignments." } }, "SecurityAccessPolicyDraft": { "required": [ "Enabled", "Key", "PermissionIds", "Source" ], "type": "object", "properties": { "Key": { "type": "string" }, "Source": { "type": "string" }, "Enabled": { "type": "boolean" }, "PermissionIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Describes the desired policy state compiled into canonical Security artifacts." }, "SecurityAdministrationApplyResult": { "required": [ "AppliedChanges", "AuditCorrelationId", "CompletedAt", "Kind", "OperationKey", "RowVersion" ], "type": "object", "properties": { "Kind": { "type": "string" }, "OperationKey": { "type": "string", "format": "uuid" }, "RowVersion": { "type": "string", "format": "uuid" }, "AppliedChanges": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityCanonicalConfigurationChange" } }, "CompletedAt": { "type": "string", "format": "date-time" }, "AuditCorrelationId": { "type": "string" } }, "additionalProperties": false, "description": "Returns durable evidence for one completed policy-first administration operation." }, "SecurityAdministrationApplyResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/SecurityAdministrationApplyResult" }, "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 }, "SecurityAdministrationCoverage": { "required": [ "RootViewCovered", "UncoveredExactPermissionIds" ], "type": "object", "properties": { "RootViewCovered": { "type": "boolean" }, "UncoveredExactPermissionIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Summarizes configuration coverage after a proposed policy administration change." }, "SecurityAdministrationDiagnostic": { "required": [ "Arguments", "Code", "Field", "RequiresAcknowledgement", "Severity" ], "type": "object", "properties": { "Code": { "type": "string" }, "Field": { "type": "string" }, "Severity": { "$ref": "#/components/schemas/SecurityAdministrationDiagnosticSeverity" }, "RequiresAcknowledgement": { "type": "boolean" }, "Arguments": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Describes one stable plan diagnostic." }, "SecurityAdministrationDiagnosticSeverity": { "enum": [ 0, 1, 2 ], "type": "string", "description": "Classifies one policy administration diagnostic.", "x-enum-varnames": [ "Information", "Warning", "Error" ], "x-enum-descriptions": { "0": "Provides informational context for the planned change.", "1": "Identifies a condition that may require acknowledgement before apply.", "2": "Identifies a blocker that prevents the planned change from being applied." } }, "SecurityAdministrationHealth": { "required": [ "DisabledPolicyCount", "RedundantFieldRefinementCount", "RootViewCovered", "UncoveredExactPermissionCount", "UnusedPolicyCount" ], "type": "object", "properties": { "RootViewCovered": { "type": "boolean" }, "DisabledPolicyCount": { "type": "integer", "format": "int32" }, "UnusedPolicyCount": { "type": "integer", "format": "int32" }, "UncoveredExactPermissionCount": { "type": "integer", "format": "int32" }, "RedundantFieldRefinementCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Summarizes configuration-level Security health without evaluating a concrete user or record." }, "SecurityAdministrationPermissionGroupDelta": { "required": [ "AddedPermissionIds", "GroupKey", "RemovedPermissionIds", "RetainedPermissionIds" ], "type": "object", "properties": { "GroupKey": { "type": "string" }, "AddedPermissionIds": { "type": "array", "items": { "type": "string" } }, "RetainedPermissionIds": { "type": "array", "items": { "type": "string" } }, "RemovedPermissionIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Summarizes exact Permission changes inside one stable capability group." }, "SecurityAdministrationPlanResult": { "required": [ "AddedPermissionIds", "Blockers", "CanApply", "Changes", "Coverage", "Kind", "Normalizations", "OperationKey", "PermissionGroupDeltas", "PlanToken", "RemovedPermissionIds", "RetainedPermissionIds", "RowVersion", "Warnings" ], "type": "object", "properties": { "Kind": { "type": "string" }, "OperationKey": { "type": "string", "format": "uuid" }, "PlanToken": { "type": "string" }, "RowVersion": { "type": "string", "format": "uuid" }, "Changes": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityCanonicalConfigurationChange" } }, "AddedPermissionIds": { "type": "array", "items": { "type": "string" } }, "RetainedPermissionIds": { "type": "array", "items": { "type": "string" } }, "RemovedPermissionIds": { "type": "array", "items": { "type": "string" } }, "PermissionGroupDeltas": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityAdministrationPermissionGroupDelta" } }, "Normalizations": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityFieldNormalization" } }, "Coverage": { "$ref": "#/components/schemas/SecurityAdministrationCoverage" }, "Warnings": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityAdministrationDiagnostic" } }, "Blockers": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityAdministrationDiagnostic" } }, "CanApply": { "type": "boolean" } }, "additionalProperties": false, "description": "Returns a deterministic policy-first administration plan." }, "SecurityAdministrationPlanResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/SecurityAdministrationPlanResult" }, "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 }, "SecurityAuthoringOptions": { "required": [ "Roles" ], "type": "object", "properties": { "Roles": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityRoleAuthoringOption" } } }, "additionalProperties": false, "description": "Returns stable principal references available to authoring surfaces." }, "SecurityAuthoringOptionsResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/SecurityAuthoringOptions" }, "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 }, "SecurityCanonicalConfigurationChange": { "required": [ "Action", "Family", "Key" ], "type": "object", "properties": { "Family": { "type": "string" }, "Key": { "type": "string" }, "Action": { "type": "string" }, "PermissionId": { "type": "string", "nullable": true }, "StatementKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Describes one exact canonical Statement or Permission Assignment change." }, "SecurityCapabilityGroup": { "required": [ "Key", "PermissionIds" ], "type": "object", "properties": { "Key": { "type": "string" }, "PermissionIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Groups exact Permissions for policy-first selection without introducing a persisted preset." }, "SecurityConfigurationPlanResult": { "type": "object", "properties": { "Kind": { "type": "string", "nullable": true }, "OperationKey": { "type": "string", "format": "uuid" }, "PlanToken": { "type": "string", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" }, "Changes": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityPortableChange" }, "nullable": true }, "Blockers": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityPortableDiagnostic" }, "nullable": true }, "CanApply": { "type": "boolean" } }, "additionalProperties": false, "description": "Returns a deterministic atomic replacement plan." }, "SecurityEligibleTargetSelector": { "required": [ "SelectorType" ], "type": "object", "properties": { "SelectorType": { "type": "string" }, "SelectorKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Identifies one eligible assignment target selector." }, "SecurityFieldNormalization": { "required": [ "InheritedFromPermissionId", "PermissionId", "RemovedAssignmentKeys" ], "type": "object", "properties": { "PermissionId": { "type": "string" }, "InheritedFromPermissionId": { "type": "string" }, "RemovedAssignmentKeys": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Describes one field refinement proven redundant by exact Statement-key-set equality." }, "SecurityGuidedCondition": { "required": [ "Expression", "Kind" ], "type": "object", "properties": { "Kind": { "type": "string" }, "Expression": { "type": "string" } }, "additionalProperties": false, "description": "Describes one guided condition while retaining its exact DSL expression." }, "SecurityGuidedConditionProjection": { "required": [ "Conditions", "MatchMode" ], "type": "object", "properties": { "MatchMode": { "type": "string" }, "Conditions": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityGuidedCondition" } } }, "additionalProperties": false, "description": "Describes a guided condition projection that can round-trip to the canonical Statement DSL." }, "SecurityPermissionBindingPatch": { "required": [ "PermissionId", "StatementKeys" ], "type": "object", "properties": { "PermissionId": { "type": "string" }, "StatementKeys": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Replaces the complete Statement-key set for one exact Permission." }, "SecurityPermissionDescriptor": { "required": [ "Category", "PermissionId", "PermissionKey", "SupportsCreate", "SupportsExisting" ], "type": "object", "properties": { "PermissionId": { "type": "string" }, "PermissionKey": { "type": "string" }, "Category": { "type": "string" }, "SelectorKey": { "type": "string", "nullable": true }, "ParentPermissionKey": { "type": "string", "nullable": true }, "ValueFamily": { "type": "string", "nullable": true }, "SupportsCreate": { "type": "boolean" }, "SupportsExisting": { "type": "boolean" } }, "additionalProperties": false, "description": "Describes one assignable permission." }, "SecurityPortableChange": { "type": "object", "properties": { "Family": { "type": "string", "nullable": true }, "Identity": { "type": "string", "nullable": true }, "Action": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Describes one portable configuration change." }, "SecurityPortableDiagnostic": { "type": "object", "properties": { "Code": { "type": "string", "nullable": true }, "Path": { "type": "string", "nullable": true }, "Arguments": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Describes one portable validation diagnostic." }, "SecurityRoleAuthoringOption": { "required": [ "Name", "RoleId", "RoleKey" ], "type": "object", "properties": { "RoleId": { "type": "string" }, "RoleKey": { "type": "string" }, "Name": { "type": "string" } }, "additionalProperties": false, "description": "Describes one workspace role available to a Statement editor." }, "SoftwareLicenseEntitlement": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRole" }, "DelegateParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRole" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRole" }, "RelatedResource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRole" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPath" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPath" }, "Plans": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwareLicensePlanSummary" }, "nullable": true }, "AllowedActions": { "$ref": "#/components/schemas/EntitlementOperationsEntitlementModelAllowedActions" }, "IsActive": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Software license entitlement model detail returned by typed administration APIs." }, "SoftwareLicenseEntitlementModelRequest": { "required": [ "DisplayName", "OwnerParty", "Resource" ], "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string" }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRoleRequest" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPathRequest" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRoleRequest" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPathRequest" } }, "additionalProperties": false, "description": "Software license entitlement model submitted by typed administration APIs." }, "SoftwareLicenseEntitlementModelUpdateRequest": { "required": [ "DisplayName", "OwnerParty", "Resource", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string" }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRoleRequest" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPathRequest" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRoleRequest" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPathRequest" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Software license entitlement model submitted by the typed update API." }, "SoftwareLicenseEntitlementResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/SoftwareLicenseEntitlement" }, "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 }, "SoftwareLicensePlanCreateRequest": { "required": [ "DisplayName" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable plan key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Plan display name." }, "Description": { "type": "string", "description": "Optional plan description.", "nullable": true }, "PriceAmount": { "type": "number", "description": "Optional commercial display price. It is metadata only.", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "description": "Optional three-letter currency code for the commercial display price.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this plan can be used for new grants." }, "DurationValue": { "type": "integer", "description": "Optional license duration length.", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "description": "Optional grace period length.", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceRequest" }, "description": "Concrete software resources selected for this plan.", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "description": "Optional explicit covered-party limit for delegated explicit Organization/Family models.", "format": "int32", "nullable": true }, "RenewalPolicyId": { "type": "string", "description": "Optional default renewal policy used by new grants from this plan.", "nullable": true }, "PlanFamilyIds": { "type": "array", "items": { "type": "string" }, "description": "Optional plan family ids assigned to this plan.", "nullable": true } }, "additionalProperties": false, "description": "Create a software license plan with license duration terms." }, "SoftwareLicensePlanDetail": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PriceAmount": { "type": "number", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "format": "int32", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "ResourceCount": { "type": "integer", "format": "int32" }, "Families": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanFamilyReference" }, "nullable": true }, "DurationValue": { "type": "integer", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResource" }, "nullable": true }, "RenewalPolicy": { "$ref": "#/components/schemas/EntitlementPlanRenewalPolicy" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Detailed software license plan." }, "SoftwareLicensePlanDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/SoftwareLicensePlanDetail" }, "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 }, "SoftwareLicensePlanList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwareLicensePlanSummary" }, "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Paginated software license plan list response." }, "SoftwareLicensePlanListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/SoftwareLicensePlanList" }, "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 }, "SoftwareLicensePlanSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PriceAmount": { "type": "number", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "format": "int32", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "ResourceCount": { "type": "integer", "format": "int32" }, "Families": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanFamilyReference" }, "nullable": true }, "DurationValue": { "type": "integer", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "RenewalPolicy": { "$ref": "#/components/schemas/EntitlementPlanRenewalPolicy" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Software license plan summary row." }, "SoftwareLicensePlanUpdateRequest": { "required": [ "DisplayName", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable plan key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Plan display name." }, "Description": { "type": "string", "description": "Optional plan description.", "nullable": true }, "PriceAmount": { "type": "number", "description": "Optional commercial display price. It is metadata only.", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "description": "Optional three-letter currency code for the commercial display price.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this plan can be used for new grants." }, "DurationValue": { "type": "integer", "description": "Optional license duration length.", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "description": "Optional grace period length.", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceRequest" }, "description": "Concrete software resources selected for this plan.", "nullable": true }, "RowVersion": { "type": "string", "description": "Required concurrency token from the current plan.", "format": "uuid" }, "MaxCoveredPartyCount": { "type": "integer", "description": "Optional explicit covered-party limit for delegated explicit Organization/Family models.", "format": "int32", "nullable": true }, "RenewalPolicyId": { "type": "string", "description": "Optional default renewal policy used by new grants from this plan.", "nullable": true }, "PlanFamilyIds": { "type": "array", "items": { "type": "string" }, "description": "Optional plan family ids assigned to this plan.", "nullable": true } }, "additionalProperties": false, "description": "Update a software license plan with license duration terms." }, "StopBusinessFunctionJobRetriesRequest": { "type": "object", "properties": { "ExpectedModifiedAt": { "type": "string", "description": "Last Job ModifiedAt observed by the administrator.", "format": "date-time" } }, "additionalProperties": false, "description": "Optimistic concurrency request for stopping a queued job's current retry chain." }, "StringListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "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 }, "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 }, "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" } }, "TestBusinessFunctionInvocationRequest": { "type": "object", "properties": { "Args": { "type": "object", "description": "Optional JSON arguments exposed as `ctx.args`.", "nullable": true }, "CorrelationId": { "type": "string", "description": "Optional correlation identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Optional related entity definition identifier for entity-scoped execution.", "nullable": true }, "EntityInstanceId": { "type": "string", "description": "Optional related entity instance identifier for entity-scoped execution.", "nullable": true }, "EntityOperation": { "type": "string", "description": "Optional related entity operation label for entity-scoped execution.", "nullable": true }, "Record": { "type": "object", "description": "Optional draft/current entity record exposed to dynamic functions and package entity bridges.", "nullable": true }, "PreviousRecord": { "type": "object", "description": "Optional previous entity record exposed to dynamic functions and package entity bridges.", "nullable": true } }, "additionalProperties": false, "description": "Admin test invocation request for a published business function." }, "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" } }, "UpdateBoardConstraintBindingRequest": { "type": "object", "properties": { "TriggerType": { "$ref": "#/components/schemas/BoardConstraintTriggerType" }, "FromBoardStatusId": { "type": "string", "nullable": true }, "ToBoardStatusId": { "type": "string", "nullable": true }, "BoardStatusId": { "type": "string", "nullable": true }, "LogicalOperator": { "$ref": "#/components/schemas/BoardConstraintLogicalOperator" }, "BoardStatementIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "IsEnabled": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Update one Board Constraint Binding." }, "UpdateBoardConstraintRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "FailureMessage": { "type": "string", "nullable": true }, "IsEnabled": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Update a Board Constraint." }, "UpdateBoardDataFieldMetadataRequest": { "type": "object", "properties": { "ShowOnBoardCard": { "type": "boolean", "description": "Whether the field appears in the compact kanban-card board-data zone.", "nullable": true }, "ShowOnDrawerDetails": { "type": "boolean", "description": "Whether the field appears in the generated drawer/details card surface.", "nullable": true }, "BoardCardVisibleWhen": { "type": "string", "description": "Optional board-context visibility expression for the kanban-card projection.", "nullable": true }, "DrawerDetailsVisibleWhen": { "type": "string", "description": "Optional board-context visibility expression for the drawer/details card surface.", "nullable": true } }, "additionalProperties": false, "description": "Board-owned visibility metadata for one board data field." }, "UpdateBoardRequest": { "required": [ "DisplayName", "Key", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Required stable board key." }, "DisplayName": { "type": "string", "description": "Board display name." }, "Description": { "type": "string", "description": "Board description.", "nullable": true }, "RowVersion": { "type": "string", "description": "Required expected board row version.", "format": "uuid" }, "TagsEnabled": { "type": "boolean", "description": "Optional replacement tag setting. Null preserves the current setting.", "nullable": true }, "BoardType": { "$ref": "#/components/schemas/BoardType" }, "BoardCycleActivationMode": { "$ref": "#/components/schemas/BoardCycleActivationMode" } }, "additionalProperties": false, "description": "Updates board identity fields." }, "UpdateBoardStatementRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "Expression": { "type": "string", "nullable": true }, "IsEnabled": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Update a reusable Board Statement." }, "UpdateBoardStatusRequest": { "required": [ "DisplayName", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable status key.", "nullable": true }, "DisplayName": { "type": "string", "description": "Status display name." }, "Description": { "type": "string", "description": "Status description.", "nullable": true }, "Color": { "type": "string", "description": "Optional status visual color token.", "nullable": true }, "MetaType": { "$ref": "#/components/schemas/BoardStatusMetaType" }, "SortOrder": { "type": "integer", "description": "Display order.", "format": "int32" }, "IsActive": { "type": "boolean", "description": "Whether the status can receive board items." }, "RowVersion": { "type": "string", "description": "Required expected status row version.", "format": "uuid" } }, "additionalProperties": false, "description": "Updates a board status." }, "UpdateBoardTargetDefinitionRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "TargetKind": { "$ref": "#/components/schemas/BoardTargetKind" }, "TargetModelId": { "type": "string", "description": "Target model id. Required and must reference an existing Entity Definition for EntityDefinition targets; optional for advanced Entitlement targets, where null accepts any Entitlement model; must be null for Itself targets.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order of the target definition inside the board target catalog.", "format": "int32" }, "IsActive": { "type": "boolean", "description": "Whether the target definition is active for board runtime use, such as adding target objects to the board." }, "RowVersion": { "type": "string", "description": "Required expected target definition row version for optimistic concurrency. It must match the current row version or the request fails with a conflict.", "format": "uuid" }, "RepeatPolicy": { "$ref": "#/components/schemas/BoardTargetRepeatPolicy" }, "CreateCommentPolicy": { "$ref": "#/components/schemas/CreateCommentPolicy" }, "ReadCommentPolicy": { "$ref": "#/components/schemas/ReadCommentPolicy" }, "CreateAttachmentPolicy": { "$ref": "#/components/schemas/CreateAttachmentPolicy" }, "ReadAttachmentPolicy": { "$ref": "#/components/schemas/ReadAttachmentPolicy" } }, "additionalProperties": false, "description": "Updates a canonical board target definition." }, "UpdateBoardTransitionRequest": { "required": [ "FromBoardStatusId", "RowVersion", "ToBoardStatusId" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable transition key.", "nullable": true }, "FromBoardStatusId": { "type": "string", "description": "Source status id." }, "ToBoardStatusId": { "type": "string", "description": "Target status id." }, "DisplayName": { "type": "string", "description": "Transition display name.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Display order inside the source status.", "format": "int32" }, "IsActive": { "type": "boolean", "description": "Whether transition is available." }, "RowVersion": { "type": "string", "description": "Required expected transition row version.", "format": "uuid" }, "LinkPrerequisites": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTransitionLinkPrerequisiteRequest" }, "description": "Replacement active-link prerequisites. Null preserves the current prerequisites.", "nullable": true } }, "additionalProperties": false, "description": "Updates a board transition." }, "UpdateBusinessFunctionActionBindingRequest": { "type": "object", "properties": { "BusinessFunctionId": { "type": "string", "description": "Business function identifier.", "nullable": true }, "EntityDefinitionId": { "type": "string", "description": "Entity definition identifier for entity-scoped action targets.", "nullable": true }, "EntityUiSurfaceModelId": { "type": "string", "description": "Entity UI surface model identifier when binding to a concrete surface.", "nullable": true }, "Surface": { "$ref": "#/components/schemas/EntitySurfaceType" }, "ActionTargetScope": { "$ref": "#/components/schemas/BusinessFunctionActionTargetScope" }, "Placement": { "$ref": "#/components/schemas/ActionPlacement" }, "SortOrder": { "type": "integer", "description": "Action order within the placement.", "format": "int32" }, "IsEnabled": { "type": "boolean", "description": "Whether the binding is enabled." }, "Label": { "type": "string", "description": "Optional label override.", "nullable": true }, "Icon": { "type": "string", "description": "Optional icon override.", "nullable": true }, "PermissionKey": { "type": "string", "description": "Optional action-specific permission gate.", "nullable": true }, "RowVersion": { "type": "string", "description": "Expected concurrency token.", "format": "uuid" }, "ToolbarPresentation": { "$ref": "#/components/schemas/EntityUiActionToolbarPresentation" }, "Color": { "type": "string", "description": "Vuetify color token.", "nullable": true }, "Variant": { "type": "string", "description": "Vuetify variant token.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update a function-backed UI action." }, "UpdateBusinessFunctionApiPublicationSettingsRequest": { "type": "object", "properties": { "IsEnabled": { "type": "boolean", "description": "Whether the publication is invocable." }, "RowVersion": { "type": "string", "description": "Optimistic concurrency token of the publication row.", "format": "uuid" } }, "additionalProperties": false, "description": "Request payload for updating admin-owned API publication settings." }, "UpdateBusinessFunctionHttpEndpointSettingsRequest": { "type": "object", "properties": { "IsEnabled": { "type": "boolean" }, "AuthMode": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointAuthMode" }, "ActorMode": { "$ref": "#/components/schemas/BusinessFunctionHttpEndpointActorMode" }, "ActorUserId": { "type": "string", "nullable": true }, "MaxBodyBytes": { "type": "integer", "format": "int32", "nullable": true }, "MaxFormFieldCount": { "type": "integer", "format": "int32", "nullable": true }, "MaxFormKeyLength": { "type": "integer", "format": "int32", "nullable": true }, "MaxFormValueLength": { "type": "integer", "format": "int32", "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Update admin-owned HTTP endpoint function settings." }, "UpdateBusinessFunctionScheduleRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Schedule name.", "nullable": true }, "BusinessFunctionId": { "type": "string", "description": "Published global function identifier.", "nullable": true }, "TimeZone": { "type": "string", "description": "Optional schedule time zone identifier; empty values inherit the workspace time zone.", "nullable": true }, "CronExpression": { "type": "string", "description": "Cron expression.", "nullable": true }, "Args": { "type": "object", "description": "Optional JSON arguments exposed as `ctx.args`.", "nullable": true }, "Status": { "$ref": "#/components/schemas/BusinessFunctionScheduleStatus" }, "RowVersion": { "type": "string", "description": "Expected concurrency token.", "format": "uuid" }, "TimeoutSeconds": { "type": "integer", "description": "Maximum duration for one scheduled occurrence; defaults to 60 seconds.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update a business-function schedule." }, "UpdateEntitlementOperationsModelSecurityRequest": { "required": [ "Grants" ], "type": "object", "properties": { "Grants": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOperationsModelSecurityGrantRequest" } } }, "additionalProperties": false, "description": "Security settings replacement request for one entitlement model." }, "UpdateEntityDataTransferProfileBaseRequest": { "required": [ "Key", "Name", "RowVersion" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing profile name." }, "Key": { "type": "string", "description": "Stable technical profile key." }, "Direction": { "$ref": "#/components/schemas/EntityDataTransferDirection" }, "Format": { "$ref": "#/components/schemas/EntityDataTransferFormat" }, "IdentityMode": { "$ref": "#/components/schemas/EntityDataTransferIdentityMode" }, "IdentityFieldId": { "type": "string", "description": "Optional identity field identifier.", "nullable": true }, "ImportMode": { "$ref": "#/components/schemas/EntityDataTransferImportMode" }, "RowVersion": { "type": "string", "description": "Expected profile row version.", "format": "uuid" }, "Description": { "type": "string", "description": "Optional user-facing workflow description.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update the base metadata of an entity data transfer profile." }, "UpdateEntityDataTransferProfileFieldsRequest": { "required": [ "Fields", "RowVersion" ], "type": "object", "properties": { "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataTransferProfileFieldRequest" }, "description": "Full replacement profile field collection." }, "RowVersion": { "type": "string", "description": "Expected profile row version.", "format": "uuid" } }, "additionalProperties": false, "description": "Request payload to replace all configured profile fields." }, "UpdateEntityDataTransferProfileReferenceResolversRequest": { "required": [ "ReferenceResolvers", "RowVersion" ], "type": "object", "properties": { "ReferenceResolvers": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataTransferProfileReferenceResolverRequest" }, "description": "Full replacement reference resolver collection." }, "RowVersion": { "type": "string", "description": "Expected profile row version.", "format": "uuid" } }, "additionalProperties": false, "description": "Request payload to replace all configured profile reference resolvers." }, "UpdateEntityDefinitionAuditSettingsRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "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 }, "RowVersion": { "type": "string", "description": "Expected row version.", "format": "uuid" } }, "additionalProperties": false, "description": "Request payload to update entity audit settings." }, "UpdateEntityDefinitionBaseRequest": { "required": [ "DisplayNamePlural", "DisplayNameSingular", "Name", "RowVersion" ], "type": "object", "properties": { "Name": { "type": "string", "description": "Internal entity name." }, "DisplayNameSingular": { "type": "string", "description": "User-facing singular name." }, "DisplayNamePlural": { "type": "string", "description": "User-facing plural name." }, "Description": { "type": "string", "description": "Optional entity description.", "nullable": true }, "RowVersion": { "type": "string", "description": "Expected row version.", "format": "uuid" }, "IsReadOnly": { "type": "boolean", "description": "Whether runtime writes should be blocked for this entity. Null preserves the current value.", "nullable": true }, "DisabledOperations": { "$ref": "#/components/schemas/EntityOperationPolicy" }, "SchemaChangeConfirmationToken": { "type": "string", "description": "Confirmation token returned by the matching schema-change-plan endpoint; required when the planned change is destructive.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update base entity definition settings." }, "UpdateEntityDefinitionDefaultSortItemRequest": { "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": "Request payload for one entity-level default runtime sort item." }, "UpdateEntityDefinitionDisplayFieldsRequest": { "required": [ "DisplayFields", "RowVersion" ], "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid" }, "DisplayFields": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateEntityDisplayFieldRequest" } } }, "additionalProperties": false, "description": "Replace the read-time display fields for one entity definition." }, "UpdateEntityDefinitionDisplaySettingsRequest": { "required": [ "PresentationRules", "RowVersion" ], "type": "object", "properties": { "NumberPrefix": { "type": "string", "description": "Number prefix.", "nullable": true }, "PresentationRules": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateEntityPresentationRuleRequest" }, "description": "Presentation rules to persist for the entity definition." }, "RowVersion": { "type": "string", "description": "Expected row version.", "format": "uuid" }, "DefaultSort": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateEntityDefinitionDefaultSortItemRequest" }, "description": "Entity-level default runtime sort sequence.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update numbering and presentation settings." }, "UpdateEntityDefinitionFeaturesRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "CommentsEnabled": { "type": "boolean", "description": "Whether comments are enabled." }, "AttachmentsEnabled": { "type": "boolean", "description": "Whether attachments are enabled." }, "TagsEnabled": { "type": "boolean", "description": "Whether tags are enabled." }, "RowVersion": { "type": "string", "description": "Expected row version.", "format": "uuid" } }, "additionalProperties": false, "description": "Request payload to update entity feature toggles." }, "UpdateEntityDefinitionObjectContextFactsRequest": { "required": [ "ObjectContextFacts", "RowVersion" ], "type": "object", "properties": { "RowVersion": { "type": "string", "format": "uuid" }, "ObjectContextFacts": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateEntityObjectContextFactRequest" } } }, "additionalProperties": false, "description": "Replace object-context facts configured for one entity definition." }, "UpdateEntityDefinitionSearchTargetsRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "SearchTargets": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDefinitionSearchTargetRequest" }, "description": "Complete replacement set. An empty set disables runtime search.", "nullable": true }, "RowVersion": { "type": "string", "description": "Expected entity definition concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Replaces every configured search target for one entity definition." }, "UpdateEntityDisplayFieldRequest": { "required": [ "DisplayName", "Key", "Rules" ], "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string" }, "DisplayName": { "type": "string" }, "SortOrder": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true }, "Rules": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateEntityDisplayFieldRuleRequest" } } }, "additionalProperties": false, "description": "Read-time display field entry in a replace request." }, "UpdateEntityDisplayFieldRuleRequest": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Template": { "type": "string", "nullable": true }, "Condition": { "type": "string", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "One ordered rule for a read-time display field replace request. Templates support optionLabel(SelectPath) for configured Select option captions." }, "UpdateEntityFieldCalculationRequest": { "required": [ "RowVersion" ], "type": "object", "properties": { "Expression": { "type": "string", "description": "Calculated-field expression. Null or whitespace clears the calculation.", "nullable": true }, "RowVersion": { "type": "string", "description": "Expected row version.", "format": "uuid" } }, "additionalProperties": false, "description": "Request payload to update a field calculation without changing other field metadata." }, "UpdateEntityFieldRequest": { "required": [ "DisplayName", "Key", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Field key." }, "DisplayName": { "type": "string", "description": "Field display name." }, "VisibleWhen": { "type": "string", "description": "Visibility condition expression.", "nullable": true }, "RequiredWhen": { "type": "string", "description": "Requiredness condition expression.", "nullable": true }, "EditableWhen": { "type": "string", "description": "Editability condition expression.", "nullable": true }, "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" }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldOptionRequest" }, "description": "Select options when applicable.", "nullable": true }, "RowVersion": { "type": "string", "description": "Expected row version.", "format": "uuid" }, "AddressCoordinatesRequired": { "type": "boolean", "description": "Whether address values must carry latitude and longitude." }, "IsReadOnly": { "type": "boolean", "description": "Whether runtime writes should skip this field. Null preserves the current value.", "nullable": true }, "SchemaChangeConfirmationToken": { "type": "string", "description": "Confirmation token returned by the matching schema-change-plan endpoint; required when the planned change is destructive.", "nullable": true }, "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 }, "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": "Classifier Catalog Definition identifier for Classifier fields.", "nullable": true }, "DefaultValue": { "$ref": "#/components/schemas/EntityFieldDefaultValueRequest" } }, "additionalProperties": false, "description": "Request payload to update field metadata without changing the type." }, "UpdateEntityJsonExportProfileRequest": { "required": [ "Key", "Name", "ReferenceResolvers", "RowVersion", "SelectedFieldIds" ], "type": "object", "properties": { "Name": { "type": "string", "description": "User-facing profile name." }, "Key": { "type": "string", "description": "Stable technical profile key." }, "IdentityMode": { "$ref": "#/components/schemas/EntityDataTransferIdentityMode" }, "IdentityFieldId": { "type": "string", "description": "Optional identity field identifier.", "nullable": true }, "SelectedFieldIds": { "type": "array", "items": { "type": "string" }, "description": "Ordered export-selected entity field identifiers." }, "ReferenceResolvers": { "type": "array", "items": { "$ref": "#/components/schemas/EntityJsonExportProfileResolverFieldRequest" }, "description": "Resolver configuration keyed by entity field definition identifier." }, "RowVersion": { "type": "string", "description": "Expected profile row version.", "format": "uuid" }, "Description": { "type": "string", "description": "Optional user-facing workflow description.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update one JSON export profile slice." }, "UpdateEntityMutationEffectRequest": { "required": [ "RowVersion", "SourcePath", "TargetFieldId", "TriggerFieldIds" ], "type": "object", "properties": { "TargetFieldId": { "type": "string" }, "SourcePath": { "type": "string" }, "TriggerFieldIds": { "type": "array", "items": { "type": "string" } }, "ApplyOnMode": { "$ref": "#/components/schemas/EntityEditOperationMode" }, "AssignmentMode": { "$ref": "#/components/schemas/EntityMutationEffectAssignmentMode" }, "SortOrder": { "type": "integer", "format": "int32" }, "IsEnabled": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" }, "ApplyWhen": { "type": "string", "description": "Optional typed condition that must evaluate to true before the effect may apply.\r\nBlank or null means always. The condition may use primary fields, one scalar reference hop,\r\nand `Operation.Mode`; its root fields become additional triggers.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update an entity mutation effect." }, "UpdateEntityObjectContextFactRequest": { "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" } }, "additionalProperties": false, "description": "One requested object-context fact configuration row." }, "UpdateEntityPresentationRuleRequest": { "type": "object", "properties": { "Id": { "type": "string", "description": "Existing rule identifier when updating an existing entry.", "nullable": true }, "Target": { "$ref": "#/components/schemas/EntityPresentationTarget" }, "Template": { "type": "string", "description": "Render template. Use optionLabel(SelectPath) inside a placeholder to render a Select option caption while direct field interpolation keeps the stored key.", "nullable": true }, "Condition": { "type": "string", "description": "Condition expression; null means always.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Stable ordering inside the target slot.", "format": "int32" }, "RowVersion": { "type": "string", "description": "Expected row version for an existing rule when provided.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "One entity presentation rule entry used by the definition display settings request." }, "UpdateEntityProjectionFieldMappingRequest": { "required": [ "ReferenceFieldId", "SourcePath" ], "type": "object", "properties": { "Id": { "type": "string", "description": "Existing mapping identifier when updating; null creates a new mapping.", "nullable": true }, "ReferenceFieldId": { "type": "string", "description": "Reference field of the member this mapping belongs to." }, "TargetKind": { "$ref": "#/components/schemas/EntityProjectionMappingTargetKind" }, "TargetFieldId": { "type": "string", "description": "Target projection field identifier; required when the target kind is Field, must be omitted for DisplayName and Subtitle targets.", "nullable": true }, "SourcePath": { "type": "array", "items": { "type": "string" }, "description": "Field-key path from the source row as ordered segments, for example [\"Category\", \"DisplayName\"]; intermediate segments must be single-value references." }, "TransformKind": { "$ref": "#/components/schemas/EntityProjectionTransformKind" }, "TransformSettingsJson": { "type": "string", "description": "Reserved for future transform settings; must be valid JSON when provided and is not read by the Copy transform.", "nullable": true }, "SortOrder": { "type": "integer", "description": "Mapping order within the member.", "format": "int32" } }, "additionalProperties": false, "description": "Projection-entity field mapping update item. Copies one source value into a projection field or presentation value when the owning member's row synchronizes." }, "UpdateEntityProjectionMemberRequest": { "required": [ "ReferenceFieldId" ], "type": "object", "properties": { "Id": { "type": "string", "description": "Existing member identifier when updating; null creates a new member.", "nullable": true }, "ReferenceFieldId": { "type": "string", "description": "Identifier of the projection entity's single-value Reference field that links to the source rows. The field becomes projection-managed while selected." }, "MemberKey": { "type": "string", "description": "Stable technical key of the member; derived from the reference field when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Administrative display name of the member; falls back to the source entity's singular display name when omitted.", "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." } }, "additionalProperties": false, "description": "Projection-entity source member update item. Each member binds one single-value reference field of the projection entity to one source entity definition." }, "UpdateEntityProjectionRequest": { "type": "object", "properties": { "IsEnabled": { "type": "boolean", "description": "Whether projection is enabled. Enabling requires at least two members and runs a preflight scan over existing rows." }, "RowVersion": { "type": "string", "description": "Expected projection configuration row version when updating an existing configuration. Omit it for the first configuration.", "format": "uuid" }, "Members": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateEntityProjectionMemberRequest" }, "description": "Full replacement list of source members; one entry per participating single-value reference field.", "nullable": true }, "Mappings": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateEntityProjectionFieldMappingRequest" }, "description": "Full replacement list of field mappings across all members.", "nullable": true } }, "additionalProperties": false, "description": "Projection-entity configuration update request. Replaces the full member and mapping configuration in one call." }, "UpdateEntityStatementRequest": { "required": [ "DisplayName", "Expression", "Name", "RowVersion" ], "type": "object", "properties": { "Name": { "type": "string", "description": "Stable technical statement key." }, "DisplayName": { "type": "string", "description": "User-facing statement label." }, "Expression": { "type": "string", "description": "SQL-like statement expression." }, "ExposeInClient": { "type": "boolean", "description": "Whether runtime payloads expose this statement." }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Update one entity statement." }, "UpdateEntityValidationRuleRequest": { "required": [ "DisplayName", "Expression", "Message", "Name", "RowVersion" ], "type": "object", "properties": { "Name": { "type": "string", "description": "Stable technical validation rule key." }, "DisplayName": { "type": "string", "description": "User-facing validation rule label." }, "Expression": { "type": "string", "description": "Boolean validation expression." }, "Message": { "type": "string", "description": "User-facing validation failure message." }, "Enabled": { "type": "boolean", "description": "Whether this validation rule is active." }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "MessageTranslations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional localized validation failure message templates keyed by locale.", "nullable": true } }, "additionalProperties": false, "description": "Update one entity validation rule." }, "UpdateFileSystemSettingsRequest": { "type": "object", "properties": { "FileTypeRules": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypeRule" }, "nullable": true }, "TrashRetentionTimeHours": { "type": "integer", "format": "int32" }, "RowVersion": { "type": "string", "format": "uuid" }, "AllowedMimeTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UpdateNetOperationProjectPackageReferencesRequest": { "type": "object", "properties": { "BaseRevisionId": { "type": "string", "description": "Working revision the package reference edit was based on.", "nullable": true }, "BaseSourceChecksum": { "type": "string", "description": "Source checksum of the base revision.", "nullable": true }, "Comment": { "type": "string", "description": "Optional revision comment.", "nullable": true }, "PackageReferences": { "type": "array", "items": { "$ref": "#/components/schemas/NetOperationProjectPackageReference" }, "description": "Complete desired package reference set.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create an immutable Net Operation Project revision from package reference changes." }, "UpdateRecordMatchingProfileRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "TargetKind": { "$ref": "#/components/schemas/RecordMatchingTargetKind" }, "TargetEntityDefinitionId": { "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" }, "Rules": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMatchingRuleRequest" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request payload for replacing a record-matching profile." }, "UpdateResponsibilityGroupRequest": { "type": "object", "properties": { "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 }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional complete replacement of non-secret integration metadata. Null preserves existing metadata.", "nullable": true } }, "additionalProperties": false, "description": "Update one responsibility group." }, "UpdateResponsibilityGroupUsersRequest": { "type": "object", "properties": { "UserIds": { "type": "array", "items": { "type": "string" }, "description": "User identifiers to assign.", "nullable": true } }, "additionalProperties": false, "description": "Replace users assigned to a responsibility group." }, "UpdateRolePermissionsRequest": { "type": "object", "properties": { "PermissionKeys": { "type": "array", "items": { "type": "string" }, "description": "List of normalized permission keys.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update role permissions." }, "UpdateRoleRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Role display name.", "nullable": true }, "Description": { "type": "string", "description": "Role description.", "nullable": true }, "AutoAssign": { "type": "boolean", "description": "Whether to auto-assign the role to new users." }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional complete replacement of non-secret integration metadata. Null preserves existing metadata.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update a workspace role." }, "UpdateRoleUsersRequest": { "type": "object", "properties": { "UserIds": { "type": "array", "items": { "type": "string" }, "description": "User identifiers to assign.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update the users assigned to a role." }, "UpdateRuntimeMenuRequest": { "required": [ "Items", "Name", "Priority", "RowVersion" ], "type": "object", "properties": { "Name": { "type": "string", "description": "Menu display name." }, "Description": { "type": "string", "description": "Optional free-form description.", "nullable": true }, "Priority": { "type": "integer", "description": "Resolution priority.", "format": "int32" }, "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Optional role scope; empty means all users.", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/RuntimeMenuNodeRequest" }, "description": "Whole menu tree." }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Replace one user menu." }, "UpdateUserRequest": { "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 (required).", "nullable": true }, "LastName": { "type": "string", "description": "Last name.", "nullable": true }, "UserType": { "$ref": "#/components/schemas/UserType" }, "EmailConfirmed": { "type": "boolean", "description": "Whether the optional email is confirmed.", "nullable": true }, "IsBlocked": { "type": "boolean", "description": "Whether the user is blocked.", "nullable": true }, "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Complete desired role set. Null preserves current memberships.", "nullable": true }, "ExpectedRowVersion": { "type": "string", "description": "Optional current concurrency token.", "nullable": true }, "ExtendedData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional complete replacement of non-secret integration metadata. Null preserves existing metadata.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update a workspace user profile." }, "UpdateUserRolesRequest": { "type": "object", "properties": { "RoleIds": { "type": "array", "items": { "type": "string" }, "description": "Role identifiers to assign.", "nullable": true } }, "additionalProperties": false, "description": "Request payload to update role assignments for a user." }, "UpsertEntityReferenceEligibilityRequest": { "required": [ "Expression" ], "type": "object", "properties": { "Expression": { "type": "string", "description": "Expression authored against Current and Candidate." }, "Message": { "type": "string", "description": "Optional default failure message.", "nullable": true }, "MessageTranslations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional localized failure messages keyed by supported locale.", "nullable": true }, "Enabled": { "type": "boolean", "description": "Requested runtime state." }, "RowVersion": { "type": "string", "description": "Expected row version when replacing an existing rule.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request to create or replace field-owned Reference Eligibility metadata." }, "UpsertEntityUiFieldPreferenceRequest": { "type": "object", "properties": { "ReferenceInputType": { "$ref": "#/components/schemas/ReferenceInputType" }, "ReferenceRendererType": { "$ref": "#/components/schemas/ReferenceRendererType" }, "ReferenceLookupRenderType": { "$ref": "#/components/schemas/ReferenceLookupRenderType" }, "ReferencePath": { "type": "array", "items": { "type": "string" }, "description": "Optional breadcrumb reference path.", "nullable": true }, "RowVersion": { "type": "string", "description": "Expected explicit row version when updating, or null when creating.", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request payload to create or update explicit field UI preferences." }, "UpsertGeoResourceLocationSourceRequest": { "required": [ "ContextResourceId", "DisplayName", "ModuleKey", "ResourceKind", "SourceKind" ], "type": "object", "properties": { "ModuleKey": { "type": "string" }, "ResourceKind": { "type": "string" }, "ContextResourceId": { "type": "string" }, "LocationSourceKey": { "type": "string", "nullable": true }, "DisplayName": { "type": "string" }, "SourceKind": { "$ref": "#/components/schemas/GeoResourceLocationSourceKind" }, "SourceFieldId": { "type": "string", "nullable": true }, "TargetLocationSourceKey": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Request for creating or replacing a Location source configuration." }, "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." }, "UserDetail": { "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" }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "DeletedAt": { "type": "string", "description": "Deletion timestamp, if deleted.", "format": "date-time", "nullable": true }, "OriginalUserName": { "type": "string", "description": "Original user name before deletion.", "nullable": true }, "OriginalEmail": { "type": "string", "description": "Original email before deletion.", "nullable": true }, "Roles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleSummary" }, "description": "Roles assigned to the 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": "Detailed representation of a workspace user." }, "UserDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/UserDetail" }, "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 }, "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." }, "UserWorkerOption": { "type": "object", "properties": { "Id": { "type": "string", "description": "Worker entity instance identifier.", "nullable": true }, "DisplayName": { "type": "string", "description": "Worker presentation built from FirstName and LastName.", "nullable": true }, "Number": { "type": "string", "description": "Worker business number.", "nullable": true } }, "additionalProperties": false, "description": "A minimal active Worker option exposed to workspace administrators." }, "UserWorkerOptionListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/UserWorkerOption" }, "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 }, "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." }, "ValidateBoardConstraintBindingRequest": { "type": "object", "properties": { "TriggerType": { "$ref": "#/components/schemas/BoardConstraintTriggerType" }, "FromBoardStatusId": { "type": "string", "nullable": true }, "ToBoardStatusId": { "type": "string", "nullable": true }, "BoardStatusId": { "type": "string", "nullable": true }, "LogicalOperator": { "$ref": "#/components/schemas/BoardConstraintLogicalOperator" }, "BoardStatementIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Validate a Board Constraint Binding without persisting it." }, "ValidateBoardStatementRequest": { "type": "object", "properties": { "BoardTargetDefinitionId": { "type": "string", "nullable": true }, "Expression": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Validate and bind a Board Statement expression without persisting it." }, "ValidateEntityFieldCalculationRequest": { "required": [ "Expression" ], "type": "object", "properties": { "Expression": { "type": "string", "description": "Calculation expression to validate against the field's schema and target type." } }, "additionalProperties": false, "description": "Request payload to validate a calculation expression without saving it." }, "ValidateEntityReferenceEligibilityRequest": { "required": [ "Expression" ], "type": "object", "properties": { "Expression": { "type": "string", "description": "Expression authored against Current and Candidate." } }, "additionalProperties": false, "description": "Request to validate a Reference Eligibility expression without saving it." }, "ValidateEntityRuleExpressionRequest": { "type": "object", "properties": { "ExpressionType": { "$ref": "#/components/schemas/EntityRuleExpressionType" }, "ContextType": { "$ref": "#/components/schemas/EntityRuleExpressionContextType" }, "EntityDefinitionTableId": { "type": "string", "description": "Target table identifier for field behavior expressions.", "nullable": true }, "Value": { "type": "string", "description": "Raw expression value to validate.", "nullable": true }, "PendingRootFieldKey": { "type": "string", "description": "Unsaved root field key that should be treated as available during field-behavior validation.", "nullable": true }, "PendingRootFieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "PendingRootAllowMultiple": { "type": "boolean", "description": "Whether the unsaved root field stores multiple values.", "nullable": true }, "PendingRootReferenceToEntityDefinitionId": { "type": "string", "description": "Reference target definition for an unsaved root reference field.", "nullable": true } }, "additionalProperties": false, "description": "Request payload used to validate a Moltaro rule expression before saving metadata." }, "ValidateEntityValidationRuleExpressionRequest": { "required": [ "Expression" ], "type": "object", "properties": { "Expression": { "type": "string", "description": "Boolean validation expression." } }, "additionalProperties": false, "description": "Validate one entity validation-rule expression before saving metadata." }, "WarrantyEntitlement": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRole" }, "DelegateParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRole" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRole" }, "RelatedResource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRole" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPath" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPath" }, "Plans": { "type": "array", "items": { "$ref": "#/components/schemas/WarrantyPlanSummary" }, "nullable": true }, "AllowedActions": { "$ref": "#/components/schemas/EntitlementOperationsEntitlementModelAllowedActions" }, "IsActive": { "type": "boolean" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Warranty entitlement model detail returned by typed administration APIs." }, "WarrantyEntitlementModelRequest": { "required": [ "DisplayName", "OwnerParty", "Resource" ], "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string" }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRoleRequest" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPathRequest" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRoleRequest" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPathRequest" } }, "additionalProperties": false, "description": "Warranty entitlement model submitted by typed administration APIs." }, "WarrantyEntitlementModelUpdateRequest": { "required": [ "DisplayName", "OwnerParty", "Resource", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string" }, "Description": { "type": "string", "nullable": true }, "PartyType": { "$ref": "#/components/schemas/EntitlementPartyType" }, "AccessMode": { "$ref": "#/components/schemas/EntitlementModelAccessMode" }, "OwnerParty": { "$ref": "#/components/schemas/EntitlementOperationsPartyRoleRequest" }, "PartyDelegationPath": { "$ref": "#/components/schemas/EntitlementOperationsPartyDelegationPathRequest" }, "ResourceScopeMode": { "$ref": "#/components/schemas/EntitlementResourceScopeMode" }, "Resource": { "$ref": "#/components/schemas/EntitlementOperationsResourceRoleRequest" }, "ResourceHierarchyPath": { "$ref": "#/components/schemas/EntitlementOperationsResourceHierarchyPathRequest" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Warranty entitlement model submitted by the typed update API." }, "WarrantyEntitlementResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WarrantyEntitlement" }, "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 }, "WarrantyPlanCreateRequest": { "required": [ "DisplayName" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable plan key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Plan display name." }, "Description": { "type": "string", "description": "Optional plan description.", "nullable": true }, "PriceAmount": { "type": "number", "description": "Optional commercial display price. It is metadata only.", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "description": "Optional three-letter currency code for the commercial display price.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this plan can be used for new grants." }, "DurationValue": { "type": "integer", "description": "Optional warranty duration length.", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "description": "Optional grace period length.", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "ConsumableQuantity": { "type": "number", "description": "Optional total claim or use quantity.", "format": "double", "nullable": true }, "TimeBoundQuantity": { "type": "number", "description": "Optional periodic claim or use quantity.", "format": "double", "nullable": true }, "TimeBoundWindowValue": { "type": "integer", "description": "Optional periodic quota window length.", "format": "int32", "nullable": true }, "TimeBoundWindowUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "TimeBoundWindowAnchor": { "$ref": "#/components/schemas/EntitlementTimeBoundQuantityWindowAnchor" }, "IssuedTermsRequirement": { "$ref": "#/components/schemas/EntitlementIssuedTermsRequirement" }, "MaxCoveredPartyCount": { "type": "integer", "description": "Optional explicit covered-party limit for delegated explicit Organization/Family models.", "format": "int32", "nullable": true }, "RenewalPolicyId": { "type": "string", "description": "Unsupported for Warranty v1. Must be null.", "nullable": true }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceRequest" }, "description": "Unsupported for Warranty v1. Must be empty because resources are selected when the entitlement is granted.", "nullable": true }, "PlanFamilyIds": { "type": "array", "items": { "type": "string" }, "description": "Optional plan family ids assigned to this plan.", "nullable": true } }, "additionalProperties": false, "description": "Create a warranty plan with validity, claim quantity, and issued terms settings." }, "WarrantyPlanDetail": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PriceAmount": { "type": "number", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "format": "int32", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "ResourceCount": { "type": "integer", "format": "int32" }, "Families": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanFamilyReference" }, "nullable": true }, "DurationValue": { "type": "integer", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "ConsumableQuantity": { "type": "number", "format": "double", "nullable": true }, "TimeBoundQuantity": { "type": "number", "format": "double", "nullable": true }, "TimeBoundWindowValue": { "type": "integer", "format": "int32", "nullable": true }, "TimeBoundWindowUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "TimeBoundWindowAnchor": { "$ref": "#/components/schemas/EntitlementTimeBoundQuantityWindowAnchor" }, "IssuedTermsRequirement": { "$ref": "#/components/schemas/EntitlementIssuedTermsRequirement" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResource" }, "nullable": true }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Detailed warranty plan." }, "WarrantyPlanDetailResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WarrantyPlanDetail" }, "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 }, "WarrantyPlanList": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/WarrantyPlanSummary" }, "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Paginated warranty plan list response." }, "WarrantyPlanListResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WarrantyPlanList" }, "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 }, "WarrantyPlanSummary": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "EntitlementModelId": { "type": "string", "nullable": true }, "EntitlementModelDisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "PriceAmount": { "type": "number", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "nullable": true }, "MaxCoveredPartyCount": { "type": "integer", "format": "int32", "nullable": true }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "ResourceCount": { "type": "integer", "format": "int32" }, "Families": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanFamilyReference" }, "nullable": true }, "DurationValue": { "type": "integer", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "ConsumableQuantity": { "type": "number", "format": "double", "nullable": true }, "TimeBoundQuantity": { "type": "number", "format": "double", "nullable": true }, "TimeBoundWindowValue": { "type": "integer", "format": "int32", "nullable": true }, "TimeBoundWindowUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "TimeBoundWindowAnchor": { "$ref": "#/components/schemas/EntitlementTimeBoundQuantityWindowAnchor" }, "IssuedTermsRequirement": { "$ref": "#/components/schemas/EntitlementIssuedTermsRequirement" }, "RowVersion": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "Warranty plan summary row." }, "WarrantyPlanUpdateRequest": { "required": [ "DisplayName", "RowVersion" ], "type": "object", "properties": { "Key": { "type": "string", "description": "Optional stable plan key. The server generates one when omitted.", "nullable": true }, "DisplayName": { "type": "string", "description": "Plan display name." }, "Description": { "type": "string", "description": "Optional plan description.", "nullable": true }, "PriceAmount": { "type": "number", "description": "Optional commercial display price. It is metadata only.", "format": "double", "nullable": true }, "PriceCurrencyCode": { "type": "string", "description": "Optional three-letter currency code for the commercial display price.", "nullable": true }, "IsActive": { "type": "boolean", "description": "Whether this plan can be used for new grants." }, "DurationValue": { "type": "integer", "description": "Optional warranty duration length.", "format": "int32", "nullable": true }, "DurationUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "GracePeriodValue": { "type": "integer", "description": "Optional grace period length.", "format": "int32", "nullable": true }, "GracePeriodUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "ConsumableQuantity": { "type": "number", "description": "Optional total claim or use quantity.", "format": "double", "nullable": true }, "TimeBoundQuantity": { "type": "number", "description": "Optional periodic claim or use quantity.", "format": "double", "nullable": true }, "TimeBoundWindowValue": { "type": "integer", "description": "Optional periodic quota window length.", "format": "int32", "nullable": true }, "TimeBoundWindowUnit": { "$ref": "#/components/schemas/EntitlementTimeUnit" }, "TimeBoundWindowAnchor": { "$ref": "#/components/schemas/EntitlementTimeBoundQuantityWindowAnchor" }, "IssuedTermsRequirement": { "$ref": "#/components/schemas/EntitlementIssuedTermsRequirement" }, "RowVersion": { "type": "string", "description": "Required concurrency token from the current plan.", "format": "uuid" }, "MaxCoveredPartyCount": { "type": "integer", "description": "Optional explicit covered-party limit for delegated explicit Organization/Family models.", "format": "int32", "nullable": true }, "RenewalPolicyId": { "type": "string", "description": "Unsupported for Warranty v1. Must be null.", "nullable": true }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementPlanResourceRequest" }, "description": "Unsupported for Warranty v1. Must be empty because resources are selected when the entitlement is granted.", "nullable": true }, "PlanFamilyIds": { "type": "array", "items": { "type": "string" }, "description": "Optional plan family ids assigned to this plan.", "nullable": true } }, "additionalProperties": false, "description": "Update a warranty plan with validity, claim quantity, and issued terms settings." }, "WorkspaceUiEntityDetailsGeneratorRequest": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "nullable": true }, "ParameterName": { "type": "string", "nullable": true }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiEntityDetailsGroupRequest" }, "nullable": true } }, "additionalProperties": false, "description": "Entity-details generator settings." }, "WorkspaceUiEntityDetailsGroupRequest": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "FieldIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "One named read-only field group on a generated details page." }, "WorkspaceUiEntityListGeneratorRequest": { "type": "object", "properties": { "EntityDefinitionId": { "type": "string", "nullable": true }, "ColumnFieldIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "InitialSort": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorSortRequest" }, "PageSize": { "type": "integer", "format": "int32", "nullable": true }, "QuickFilterFieldIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "RowTarget": { "$ref": "#/components/schemas/WorkspaceUiEntityListRowTarget" }, "WorkspaceUiDetailsPageKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Entity-list generator settings." }, "WorkspaceUiEntityListRowTarget": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "None", "StandardEntityDetails", "WorkspaceUiPage" ], "x-enum-descriptions": { "0": "Row activation performs no navigation", "1": "Open the standard Moltaro entity details for the row record", "2": "Open a custom Workspace UI details page for the row record" } }, "WorkspaceUiExternalApiExampleGeneratorRequest": { "type": "object", "properties": { "Preset": { "$ref": "#/components/schemas/WorkspaceUiExternalApiExamplePreset" }, "BaseCurrency": { "type": "string", "nullable": true }, "QuoteCurrencies": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "External API example generator settings." }, "WorkspaceUiExternalApiExamplePreset": { "enum": [ 0 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "FrankfurterExchangeRates" ], "x-enum-descriptions": { "0": "Currency exchange rate demo backed by the public Frankfurter API" } }, "WorkspaceUiExternalApiExamplePresetOption": { "type": "object", "properties": { "Preset": { "$ref": "#/components/schemas/WorkspaceUiExternalApiExamplePreset" }, "NameKey": { "type": "string", "nullable": true }, "DescriptionKey": { "type": "string", "nullable": true }, "ProviderUrl": { "type": "string", "nullable": true }, "DefaultBaseCurrency": { "type": "string", "nullable": true }, "DefaultQuoteCurrencies": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "One supported external API example preset." }, "WorkspaceUiPageGeneratorApplyResult": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/WorkspaceUiProjectRevision" }, "MainFilePath": { "type": "string", "nullable": true }, "Menu": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorMenuApplyResult" } }, "additionalProperties": false, "description": "Result of applying one page generator." }, "WorkspaceUiPageGeneratorApplyResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorApplyResult" }, "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 }, "WorkspaceUiPageGeneratorCatalog": { "type": "object", "properties": { "BaseRevisionId": { "type": "string", "nullable": true }, "BaseSourceChecksum": { "type": "string", "nullable": true }, "Generators": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorDefinition" }, "nullable": true }, "ExternalApiPresets": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiExternalApiExamplePresetOption" }, "nullable": true }, "Entities": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorEntity" }, "nullable": true }, "Pages": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorExistingPage" }, "nullable": true }, "RuntimeMenus": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorRuntimeMenu" }, "nullable": true }, "CanPlaceInRuntimeMenu": { "type": "boolean" } }, "additionalProperties": false, "description": "Catalog used to configure the page wizard." }, "WorkspaceUiPageGeneratorCatalogResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorCatalog" }, "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 }, "WorkspaceUiPageGeneratorDefinition": { "type": "object", "properties": { "Kind": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorKind" }, "NameKey": { "type": "string", "nullable": true }, "DescriptionKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One supported deterministic page generator." }, "WorkspaceUiPageGeneratorEntity": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayNameSingular": { "type": "string", "nullable": true }, "DisplayNamePlural": { "type": "string", "nullable": true }, "SearchConfigured": { "type": "boolean" }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorEntityField" }, "nullable": true } }, "additionalProperties": false, "description": "Safe generator capability projection for one Entity Definition." }, "WorkspaceUiPageGeneratorEntityField": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Key": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/EntityFieldType" }, "CanUseAsListColumn": { "type": "boolean" }, "CanUseAsQuickFilter": { "type": "boolean" }, "CanSort": { "type": "boolean" }, "CanUseOnDetailsPage": { "type": "boolean" }, "SelectOptions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorSelectOption" }, "nullable": true } }, "additionalProperties": false, "description": "Safe generator capability projection for one Entity Definition field." }, "WorkspaceUiPageGeneratorExistingPage": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "TitleKey": { "type": "string", "nullable": true }, "Icon": { "type": "string", "nullable": true }, "Layout": { "$ref": "#/components/schemas/WorkspaceUiPageLayout" }, "RoutePath": { "type": "string", "nullable": true }, "RouteParameters": { "type": "array", "items": { "type": "string" }, "nullable": true }, "EntityDefinitionId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One page declared by the selected working source revision." }, "WorkspaceUiPageGeneratorKind": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Blank", "EntityList", "EntityDetails", "ExternalApiExample" ], "x-enum-descriptions": { "0": "Generate an empty page scaffold with no prebuilt content", "1": "Generate a grid page listing records of a selected entity", "2": "Generate a details page showing a single entity record", "3": "Generate a demo page that calls an external HTTP API" } }, "WorkspaceUiPageGeneratorMenuApplyResult": { "type": "object", "properties": { "Requested": { "type": "boolean" }, "Applied": { "type": "boolean" }, "RuntimeMenuId": { "type": "string", "nullable": true }, "RuntimeMenuCreated": { "type": "boolean" }, "RuntimeMenuItemId": { "type": "string", "nullable": true }, "WorkspaceUiPageKey": { "type": "string", "nullable": true }, "RuntimeMenuItemCreated": { "type": "boolean" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" }, "nullable": true } }, "additionalProperties": false, "description": "Outcome of optional runtime-menu placement after source creation." }, "WorkspaceUiPageGeneratorMenuPlacementRequest": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "RuntimeMenuId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Optional root-leaf runtime-menu placement." }, "WorkspaceUiPageGeneratorMenuPlan": { "type": "object", "properties": { "Requested": { "type": "boolean" }, "Eligible": { "type": "boolean" }, "RuntimeMenuId": { "type": "string", "nullable": true }, "Label": { "type": "string", "nullable": true }, "Icon": { "type": "string", "nullable": true }, "PageKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Optional runtime-menu change shown independently from source changes." }, "WorkspaceUiPageGeneratorPreview": { "type": "object", "properties": { "Kind": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorKind" }, "BaseRevisionId": { "type": "string", "nullable": true }, "BaseSourceChecksum": { "type": "string", "nullable": true }, "PageKey": { "type": "string", "nullable": true }, "MainFilePath": { "type": "string", "nullable": true }, "Changes": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplateChange" }, "nullable": true }, "MenuPlan": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorMenuPlan" } }, "additionalProperties": false, "description": "Deterministic preview of one generated page." }, "WorkspaceUiPageGeneratorPreviewResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiPageGeneratorPreview" }, "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 }, "WorkspaceUiPageGeneratorRuntimeMenu": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One runtime menu available for optional root-leaf placement." }, "WorkspaceUiPageGeneratorSelectOption": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One display-safe Select option exposed to the generator." }, "WorkspaceUiPageGeneratorSortRequest": { "type": "object", "properties": { "FieldId": { "type": "string", "nullable": true }, "Direction": { "$ref": "#/components/schemas/EntityInstanceQuerySortDirection" } }, "additionalProperties": false, "description": "Initial sort for a generated entity list." }, "WorkspaceUiPageLayout": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Default", "Fullscreen" ], "x-enum-descriptions": { "0": "Render the page inside the standard app shell", "1": "Let the page own the full content viewport inside the standard app shell" } }, "WorkspaceUiProjectArtifact": { "type": "object", "properties": { "Id": { "type": "string", "description": "Artifact identifier.", "nullable": true }, "ProjectId": { "type": "string", "description": "Workspace UI project identifier.", "nullable": true }, "BuildId": { "type": "string", "description": "Successful build that produced the artifact.", "nullable": true }, "RevisionId": { "type": "string", "description": "Source revision used by the build.", "nullable": true }, "Status": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactStatus" }, "IsActive": { "type": "boolean", "description": "Whether this artifact is active." }, "AssetsAvailable": { "type": "boolean", "description": "Whether JavaScript and CSS bytes remain stored." }, "AssetsPurgedAt": { "type": "string", "description": "Asset purge timestamp.", "format": "date-time", "nullable": true }, "ArtifactHash": { "type": "string", "description": "Combined JavaScript/CSS SHA-256 hash.", "nullable": true }, "JavaScriptContentHash": { "type": "string", "description": "JavaScript SHA-256 content hash.", "nullable": true }, "JavaScriptIntegrity": { "type": "string", "description": "JavaScript SHA-256 integrity value.", "nullable": true }, "JavaScriptSizeBytes": { "type": "integer", "description": "JavaScript size in bytes.", "format": "int64" }, "CssContentHash": { "type": "string", "description": "CSS SHA-256 content hash.", "nullable": true }, "CssIntegrity": { "type": "string", "description": "CSS SHA-256 integrity value.", "nullable": true }, "CssSizeBytes": { "type": "integer", "description": "CSS size in bytes.", "format": "int64" }, "TotalSizeBytes": { "type": "integer", "description": "Combined JavaScript and CSS size.", "format": "int64" }, "PageDescriptorJson": { "type": "string", "description": "Validated page descriptors.", "nullable": true }, "LocaleDescriptorJson": { "type": "string", "description": "Validated locale descriptors.", "nullable": true }, "DependencyMetadataJson": { "type": "string", "description": "Pinned dependency and toolchain metadata.", "nullable": true }, "WebAppVersion": { "type": "string", "description": "Moltaro WebApp version used by the build.", "nullable": true }, "HostContractVersion": { "type": "integer", "description": "Workspace UI host contract version.", "format": "int32" }, "VueVersion": { "type": "string", "description": "Vue version.", "nullable": true }, "PiniaVersion": { "type": "string", "description": "Pinia version.", "nullable": true }, "VuetifyVersion": { "type": "string", "description": "Vuetify version.", "nullable": true }, "ViteVersion": { "type": "string", "description": "Vite version.", "nullable": true }, "TypeScriptVersion": { "type": "string", "description": "TypeScript version.", "nullable": true }, "EslintVersion": { "type": "string", "description": "ESLint version.", "nullable": true }, "ToolchainFingerprint": { "type": "string", "description": "Resolved toolchain fingerprint.", "nullable": true }, "PublishedByUserId": { "type": "string", "description": "Publishing user identifier.", "nullable": true }, "PublishedAt": { "type": "string", "description": "Publication timestamp.", "format": "date-time", "nullable": true }, "DeactivatedByUserId": { "type": "string", "description": "Deactivating user identifier.", "nullable": true }, "DeactivatedAt": { "type": "string", "description": "Deactivation timestamp.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Immutable Workspace UI runtime artifact metadata." }, "WorkspaceUiProjectArtifactCompatibility": { "type": "object", "properties": { "ArtifactId": { "type": "string", "description": "Artifact identifier.", "nullable": true }, "IsCompatible": { "type": "boolean", "description": "Whether the artifact matches the current browser runtime contract." }, "CanActivate": { "type": "boolean", "description": "Whether the artifact can be activated now." }, "CanRollback": { "type": "boolean", "description": "Whether the artifact can be restored now." }, "DiagnosticCode": { "type": "string", "description": "Stable compatibility result code.", "nullable": true } }, "additionalProperties": false, "description": "Compatibility and lifecycle readiness for one stored artifact." }, "WorkspaceUiProjectArtifactLifecycleResult": { "type": "object", "properties": { "Artifact": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifact" }, "ProjectRowVersion": { "type": "string", "description": "New project concurrency token.", "format": "uuid" }, "RefreshRequired": { "type": "boolean", "description": "Whether an already-open application must be fully refreshed." } }, "additionalProperties": false, "description": "Result of a Workspace UI artifact lifecycle state change." }, "WorkspaceUiProjectArtifactLifecycleResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactLifecycleResult" }, "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 }, "WorkspaceUiProjectArtifactListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifact" }, "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 }, "WorkspaceUiProjectArtifactPurgeRequest": { "type": "object", "properties": { "ExpectedArtifactRowVersion": { "type": "string", "description": "Expected artifact concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Purge inactive Workspace UI artifact bytes with optimistic concurrency." }, "WorkspaceUiProjectArtifactResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifact" }, "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 }, "WorkspaceUiProjectArtifactStateChangeRequest": { "type": "object", "properties": { "ExpectedProjectRowVersion": { "type": "string", "description": "Expected project concurrency token.", "format": "uuid" }, "ExpectedArtifactRowVersion": { "type": "string", "description": "Expected artifact concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Change a Workspace UI artifact publication state with optimistic concurrency." }, "WorkspaceUiProjectArtifactStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Built", "Active", "Superseded", "Deactivated", "Purged" ], "x-enum-descriptions": { "0": "Artifact was compiled successfully and is inactive", "1": "Artifact is the single active runtime artifact served to the workspace", "2": "Artifact was replaced as active by a newer activated artifact", "3": "Artifact was explicitly deactivated without a replacement", "4": "Artifact output was removed and is no longer available for activation" } }, "WorkspaceUiProjectBuild": { "type": "object", "properties": { "Id": { "type": "string", "description": "Build identifier.", "nullable": true }, "ProjectId": { "type": "string", "description": "Workspace UI project identifier.", "nullable": true }, "RevisionId": { "type": "string", "description": "Source revision identifier.", "nullable": true }, "BuildNumber": { "type": "integer", "description": "Monotonic project build number.", "format": "int32" }, "Kind": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildKind" }, "Status": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildStatus" }, "Stage": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildStage" }, "StageMessageKey": { "type": "string", "description": "Optional localization key for the current stage.", "nullable": true }, "ProgressPercent": { "type": "integer", "description": "Progress from zero through one hundred.", "format": "int32" }, "RequestedByUserId": { "type": "string", "description": "Requesting user identifier.", "nullable": true }, "RequestedAt": { "type": "string", "description": "Request timestamp.", "format": "date-time" }, "ClaimedAt": { "type": "string", "description": "Worker claim timestamp.", "format": "date-time", "nullable": true }, "WorkerId": { "type": "string", "description": "Claiming worker identifier.", "nullable": true }, "HeartbeatAt": { "type": "string", "description": "Latest worker heartbeat.", "format": "date-time", "nullable": true }, "AttemptCount": { "type": "integer", "description": "Number of worker claims.", "format": "int32" }, "StartedAt": { "type": "string", "description": "Execution start timestamp.", "format": "date-time", "nullable": true }, "CancellationRequestedByUserId": { "type": "string", "description": "User that requested cancellation.", "nullable": true }, "CancellationRequestedAt": { "type": "string", "description": "Cancellation request timestamp.", "format": "date-time", "nullable": true }, "CompletedAt": { "type": "string", "description": "Completion timestamp.", "format": "date-time", "nullable": true }, "GeneratedProjectChecksum": { "type": "string", "description": "Checksum of the generated build project.", "nullable": true }, "ToolchainFingerprint": { "type": "string", "description": "Resolved build toolchain fingerprint.", "nullable": true }, "HostContractVersion": { "type": "integer", "description": "Workspace UI host contract version used by the build.", "format": "int32", "nullable": true }, "Diagnostics": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildDiagnostics" }, "ErrorSummary": { "type": "string", "description": "Bounded error summary.", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Workspace UI check or build history record." }, "WorkspaceUiProjectBuildCancellationRequest": { "type": "object", "properties": { "ExpectedRowVersion": { "type": "string", "description": "Expected build concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Request cancellation of one queued or running Workspace UI build." }, "WorkspaceUiProjectBuildDiagnostics": { "type": "object", "properties": { "FormatVersion": { "type": "integer", "description": "Diagnostics payload format version.", "format": "int32" }, "CompilationId": { "type": "string", "description": "Content-derived compilation identity.", "nullable": true }, "SourceChecksum": { "type": "string", "description": "Canonical source checksum.", "nullable": true }, "HostContractFingerprint": { "type": "string", "description": "Host contract fingerprint used by compilation.", "nullable": true }, "PermissionCatalogFingerprint": { "type": "string", "description": "Permission catalog fingerprint used by compilation.", "nullable": true }, "Diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiProjectCompilationDiagnostic" }, "description": "Structured compiler diagnostics.", "nullable": true } }, "additionalProperties": false, "description": "Bounded structured diagnostics persisted for one Workspace UI check or build." }, "WorkspaceUiProjectBuildKind": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Check", "Build" ], "x-enum-descriptions": { "0": "Validate the project source without producing an artifact", "1": "Compile the project source into an inactive immutable artifact" } }, "WorkspaceUiProjectBuildListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiProjectBuild" }, "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 }, "WorkspaceUiProjectBuildResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiProjectBuild" }, "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 }, "WorkspaceUiProjectBuildStage": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Queued", "ResolvingToolchain", "PreparingWorkspace", "ValidatingSource", "GeneratingProject", "TypeChecking", "Linting", "Bundling", "InspectingArtifact", "StoringArtifact", "Completed", "Failed", "Cancelled" ], "x-enum-descriptions": { "0": "Wait for a build slot before the pipeline starts", "1": "Resolve the offline Node toolchain for the build", "2": "Prepare an isolated working directory with the revision source", "3": "Validate the revision source files before compilation", "4": "Generate the compilable Vue project around the source", "5": "Type-check the project with vue-tsc", "6": "Lint the project with ESLint", "7": "Bundle the project into JS and CSS outputs", "8": "Inspect the bundled output before it is stored", "9": "Store the immutable inactive artifact", "10": "Finish the pipeline after all stages succeeded", "11": "Stop the pipeline after a stage failed", "12": "Stop the pipeline because the build was cancelled" } }, "WorkspaceUiProjectBuildStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Queued", "Running", "Succeeded", "Failed", "Cancelled" ], "x-enum-descriptions": { "0": "Build is waiting in the queue for a worker to pick it up", "1": "Build pipeline is currently executing its stages", "2": "Build completed all stages and produced a valid result", "3": "Build stopped because a stage reported blocking errors", "4": "Build was cancelled before it could finish" } }, "WorkspaceUiProjectCompatibility": { "type": "object", "properties": { "IsBuildToolchainReady": { "type": "boolean", "description": "Whether checks and builds can use the packaged offline toolchain." }, "IsRuntimeContractReady": { "type": "boolean", "description": "Whether publication can validate the packaged browser runtime contract." }, "RuntimeIdentifier": { "type": "string", "description": "Packaged toolchain runtime identifier.", "nullable": true }, "NodeVersion": { "type": "string", "description": "Packaged Node version.", "nullable": true }, "HostContractVersion": { "type": "integer", "description": "Current Workspace UI host contract version.", "format": "int32", "nullable": true }, "HostContractFingerprint": { "type": "string", "description": "Current Workspace UI host contract fingerprint.", "nullable": true }, "ToolchainFingerprint": { "type": "string", "description": "Current offline toolchain fingerprint.", "nullable": true }, "DependencyVersions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Current immutable dependency versions.", "nullable": true }, "Artifact": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifactCompatibility" }, "Diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiProjectCompatibilityDiagnostic" }, "description": "Safe localized diagnostics.", "nullable": true } }, "additionalProperties": false, "description": "Safe Workspace UI build-toolchain and runtime compatibility status." }, "WorkspaceUiProjectCompatibilityDiagnostic": { "type": "object", "properties": { "Code": { "type": "string", "description": "Stable diagnostic code without deployment details.", "nullable": true }, "Message": { "type": "string", "description": "Localized operator-facing message.", "nullable": true } }, "additionalProperties": false, "description": "One safe Workspace UI compatibility diagnostic." }, "WorkspaceUiProjectCompatibilityResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiProjectCompatibility" }, "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 }, "WorkspaceUiProjectCompilationDiagnostic": { "type": "object", "properties": { "Code": { "type": "string", "description": "Stable compiler diagnostic code.", "nullable": true }, "Severity": { "$ref": "#/components/schemas/WorkspaceUiProjectCompilationDiagnosticSeverity" }, "Stage": { "$ref": "#/components/schemas/WorkspaceUiProjectBuildStage" }, "Message": { "type": "string", "description": "Invariant developer-facing diagnostic text.", "nullable": true }, "Path": { "type": "string", "description": "Optional canonical source path.", "nullable": true }, "StartLine": { "type": "integer", "description": "Optional one-based start line.", "format": "int32", "nullable": true }, "StartColumn": { "type": "integer", "description": "Optional one-based start column.", "format": "int32", "nullable": true }, "EndLine": { "type": "integer", "description": "Optional one-based end line.", "format": "int32", "nullable": true }, "EndColumn": { "type": "integer", "description": "Optional one-based end column.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "One bounded diagnostic emitted by the Workspace UI compiler." }, "WorkspaceUiProjectCompilationDiagnosticSeverity": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Info", "Warning", "Error" ], "x-enum-descriptions": { "0": "Informational diagnostic that does not affect the build", "1": "Warning diagnostic that does not block the build", "2": "Error diagnostic that blocks the build" } }, "WorkspaceUiProjectFile": { "type": "object", "properties": { "Id": { "type": "string", "description": "File row identifier.", "nullable": true }, "RevisionId": { "type": "string", "description": "Revision identifier.", "nullable": true }, "Path": { "type": "string", "description": "Normalized relative source path.", "nullable": true }, "ContentHash": { "type": "string", "description": "SHA-256 hash of the UTF-8 content.", "nullable": true }, "ContentUtf8": { "type": "string", "description": "UTF-8 source text.", "nullable": true }, "SizeBytes": { "type": "integer", "description": "UTF-8 byte length.", "format": "int64" } }, "additionalProperties": false, "description": "One UTF-8 source file in an immutable Workspace UI revision." }, "WorkspaceUiProjectFileChangeOperation": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Upsert", "Rename", "Delete" ], "x-enum-descriptions": { "0": "Add the file or replace its content in the revision", "1": "Move the file to a new path within the revision", "2": "Remove the file from the revision" } }, "WorkspaceUiProjectFileChangeRequest": { "type": "object", "properties": { "Operation": { "$ref": "#/components/schemas/WorkspaceUiProjectFileChangeOperation" }, "Path": { "type": "string", "description": "Existing or target normalized relative project path.", "nullable": true }, "NewPath": { "type": "string", "description": "New normalized relative project path for a rename.", "nullable": true }, "ContentUtf8": { "type": "string", "description": "UTF-8 text content for an upsert.", "nullable": true }, "ExpectedContentHash": { "type": "string", "description": "Expected SHA-256 hash of the existing file.", "nullable": true } }, "additionalProperties": false, "description": "One source-file change for an immutable Workspace UI revision." }, "WorkspaceUiProjectFileResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiProjectFile" }, "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 }, "WorkspaceUiProjectRevision": { "type": "object", "properties": { "Id": { "type": "string", "description": "Revision identifier.", "nullable": true }, "ProjectId": { "type": "string", "description": "Workspace UI project identifier.", "nullable": true }, "RevisionNumber": { "type": "integer", "description": "Monotonic revision number.", "format": "int32" }, "SourceKind": { "$ref": "#/components/schemas/WorkspaceUiProjectRevisionSourceKind" }, "Status": { "$ref": "#/components/schemas/WorkspaceUiProjectRevisionStatus" }, "Comment": { "type": "string", "description": "Optional revision comment.", "nullable": true }, "SourceChecksum": { "type": "string", "description": "SHA-256 checksum of the canonical source tree.", "nullable": true }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "CreatedByUserId": { "type": "string", "description": "Creating user identifier.", "nullable": true }, "FileCount": { "type": "integer", "description": "Number of stored source files.", "format": "int32" } }, "additionalProperties": false, "description": "Immutable Workspace UI source revision metadata." }, "WorkspaceUiProjectRevisionDeletionRequest": { "type": "object", "properties": { "ExpectedProjectRowVersion": { "type": "string", "description": "Expected project concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Delete one disposable Workspace UI revision with optimistic project concurrency." }, "WorkspaceUiProjectRevisionListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiProjectRevision" }, "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 }, "WorkspaceUiProjectRevisionResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiProjectRevision" }, "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 }, "WorkspaceUiProjectRevisionSourceKind": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Provisioned", "ArchiveUpload", "ManualEdit", "TemplateApply" ], "x-enum-descriptions": { "0": "Revision created by Moltaro empty-project provisioning", "1": "Revision created from an uploaded ZIP source archive", "2": "Revision created by manual edits through Studio or the API", "3": "Revision created by applying a template or page generator" } }, "WorkspaceUiProjectRevisionStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Current", "Draft", "ValidatedDraft", "Failed", "Superseded" ], "x-enum-descriptions": { "0": "Revision whose source snapshot is the current baseline of the project", "1": "Immutable source revision that has not been validated or built yet", "2": "Draft revision whose source passed validation without producing an artifact", "3": "Revision whose validation or build failed", "4": "Older revision replaced by a newer current revision" } }, "WorkspaceUiProjectSourceTemplate": { "type": "object", "properties": { "Id": { "type": "string", "description": "Stable template identifier.", "nullable": true }, "NameKey": { "type": "string", "description": "Localization key for the template name.", "nullable": true }, "DescriptionKey": { "type": "string", "description": "Localization key for the template description.", "nullable": true }, "CreatesMultipleFiles": { "type": "boolean", "description": "Whether the template may update multiple source files atomically." } }, "additionalProperties": false, "description": "One deterministic Workspace UI source template available to authoring clients." }, "WorkspaceUiProjectSourceTemplateApplyResult": { "type": "object", "properties": { "TemplateId": { "type": "string", "description": "Applied stable template identifier.", "nullable": true }, "Revision": { "$ref": "#/components/schemas/WorkspaceUiProjectRevision" } }, "additionalProperties": false, "description": "Result of atomically applying a source template." }, "WorkspaceUiProjectSourceTemplateApplyResultResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplateApplyResult" }, "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 }, "WorkspaceUiProjectSourceTemplateChange": { "type": "object", "properties": { "Operation": { "$ref": "#/components/schemas/WorkspaceUiProjectFileChangeOperation" }, "Path": { "type": "string", "description": "Canonical source path.", "nullable": true }, "ContentUtf8": { "type": "string", "description": "Deterministically generated UTF-8 content.", "nullable": true }, "ExpectedContentHash": { "type": "string", "description": "Expected current hash for an updated file.", "nullable": true }, "CreatesFile": { "type": "boolean", "description": "Whether the change creates a new file." } }, "additionalProperties": false, "description": "One generated source-file change in a template preview." }, "WorkspaceUiProjectSourceTemplateListResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplate" }, "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 }, "WorkspaceUiProjectSourceTemplatePreview": { "type": "object", "properties": { "Template": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplate" }, "BaseRevisionId": { "type": "string", "description": "Revision against which the preview was generated.", "nullable": true }, "BaseSourceChecksum": { "type": "string", "description": "Canonical source checksum of that revision.", "nullable": true }, "Changes": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplateChange" }, "description": "Ordered generated changes that will be applied atomically.", "nullable": true } }, "additionalProperties": false, "description": "A deterministic, server-generated template preview against one immutable base revision." }, "WorkspaceUiProjectSourceTemplatePreviewResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTemplatePreview" }, "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 }, "WorkspaceUiProjectSourceTree": { "type": "object", "properties": { "Revision": { "$ref": "#/components/schemas/WorkspaceUiProjectRevision" }, "Files": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTreeFile" }, "description": "Source files ordered by normalized path.", "nullable": true } }, "additionalProperties": false, "description": "Workspace UI source revision with its complete ordered file tree." }, "WorkspaceUiProjectSourceTreeFile": { "type": "object", "properties": { "Id": { "type": "string", "description": "File row identifier.", "nullable": true }, "RevisionId": { "type": "string", "description": "Revision identifier.", "nullable": true }, "Path": { "type": "string", "description": "Normalized relative source path.", "nullable": true }, "ContentHash": { "type": "string", "description": "SHA-256 hash of the UTF-8 content.", "nullable": true }, "SizeBytes": { "type": "integer", "description": "UTF-8 byte length.", "format": "int64" } }, "additionalProperties": false, "description": "Metadata for one source file in an immutable Workspace UI revision." }, "WorkspaceUiProjectSourceTreeResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiProjectSourceTree" }, "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 }, "WorkspaceUiProjectStatus": { "type": "object", "properties": { "ProjectId": { "type": "string", "description": "Singleton project identifier.", "nullable": true }, "Name": { "type": "string", "description": "Project display name.", "nullable": true }, "CurrentRevision": { "$ref": "#/components/schemas/WorkspaceUiProjectRevision" }, "WorkingRevision": { "$ref": "#/components/schemas/WorkspaceUiProjectRevision" }, "ActiveArtifact": { "$ref": "#/components/schemas/WorkspaceUiProjectArtifact" }, "LatestBuild": { "$ref": "#/components/schemas/WorkspaceUiProjectBuild" }, "NeedsValidation": { "type": "boolean", "description": "Whether source compatibility must be checked." }, "RevisionCount": { "type": "integer", "description": "Stored revision count.", "format": "int32" }, "BuildCount": { "type": "integer", "description": "Stored build count.", "format": "int32" }, "ArtifactCount": { "type": "integer", "description": "Stored artifact count.", "format": "int32" }, "CreatedAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "ModifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time", "nullable": true }, "RowVersion": { "type": "string", "description": "Concurrency token.", "format": "uuid" } }, "additionalProperties": false, "description": "Workspace UI project storage and lifecycle status." }, "WorkspaceUiProjectStatusResponse": { "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WorkspaceUiProjectStatus" }, "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 } }, "securitySchemes": { "WorkspaceBearer": { "type": "http", "description": "Workspace bearer token or service API key. Example: `Bearer {token}`", "scheme": "bearer", "bearerFormat": "Bearer" } } }, "tags": [ { "name": "Admin Record Matching", "description": "Manage record-matching and duplicate-detection profiles." }, { "name": "Admin Responsibility Groups", "description": "Manage responsibility groups and memberships." }, { "name": "Admin Roles", "description": "Manage workspace roles (admin only)." }, { "name": "Roles", "description": "Read workspace roles." }, { "name": "Admin Users", "description": "Manage workspace users (admin only)." }, { "name": "Users", "description": "Read workspace users." }, { "name": "Agent Integration", "description": "Workspace-local agent integration facts and the downloadable guide for this installation.\r\nThese endpoints require the caller to already know and reach the workspace API host." }, { "name": "API Functions", "description": "Admin API for command and API enqueue publications." }, { "name": "Boards Configuration", "description": "Configure Moltaro Boards for a workspace." }, { "name": "Boards Security", "description": "Administers the two Security Statement profiles owned by one Board." }, { "name": "Entitlement Operations", "description": "Configure Moltaro Entitlement Operations for a workspace." }, { "name": "Entitlement Operations Plans", "description": "Manage runtime plans that belong to one Moltaro Entitlement Operations model." }, { "name": "Entitlement Operations Renewal", "description": "Renewal policy and workflow operation APIs for Moltaro Entitlement Operations." }, { "name": "Entity Data Transfer Profiles", "description": "Manage entity data transfer profile metadata." }, { "name": "Entity Definition Portability", "description": "Export and import entity definitions as YAML." }, { "name": "Entity Definitions", "description": "Manage entity definitions: create record types, update their settings, and control constraints, indexes, and deletion. Destructive changes follow a plan-then-apply flow with confirmation tokens. Concepts: https://moltaro.com/docs/user/data-structure/entity-definitions/" }, { "name": "Entity Fields", "description": "Manage schema fields of entity definition tables: create, update, reorder, change type, and delete fields. Destructive changes follow a plan-then-apply flow. Field semantics: https://moltaro.com/docs/user/data-structure/entity-definitions/fields-and-schema/" }, { "name": "Entity Mutation Effects", "description": "Manage entity mutation effects." }, { "name": "Entity Security", "description": "Manages the immediately effective Entity Security configuration shown by Entity Definition." }, { "name": "Entity Statements", "description": "Manage entity statements." }, { "name": "Entity UI Actions", "description": "Manage function-backed UI actions for supported Moltaro surfaces." }, { "name": "Entity UI Surfaces", "description": "Manage field UI preferences independently from field schema metadata." }, { "name": "Entity Validation Rules", "description": "Manage entity validation rules." }, { "name": "File System", "description": "Manage workspace file system settings." }, { "name": "Function Catalog", "description": "Read published business-function catalog entries and launch admin global actions." }, { "name": "Function Operations", "description": "Read operational diagnostics for business-function execution." }, { "name": "Function Schedules", "description": "Manage CRON schedules for published business functions." }, { "name": "Geo Location Sources", "description": "Configure Location sources used by core geo classification." }, { "name": "HTTP Endpoint Functions", "description": "Admin API for discovered inbound HTTP endpoint functions." }, { "name": "Managed Secrets", "description": "Owner/admin lifecycle API for write-only credentials used by trusted C# business logic.\r\nValues are accepted only on create and rotate and are never returned by any operation." }, { "name": "Net Operation Project", "description": "Manage the workspace Net Operation Project source tree." }, { "name": "Responsibility Groups", "description": "Read responsibility groups in Moltaro." }, { "name": "User Menus", "description": "Manage user menus." }, { "name": "Workspace UI Project", "description": "Manage Workspace UI source, builds, and explicit artifact publication." } ] }