{ "openapi": "3.1.1", "info": { "title": "Tdp.Gateway.WebApi", "description": "TestJG Digital Platform API documentation", "version": "v1" }, "servers": [ { "url": "https://api.tdp.irisjg.com/" } ], "paths": { "/api/projects/admin/event_store/list": { "post": { "tags": [ "event_store" ], "summary": "Event Stores - Alpha", "description": "Gets a list of Event Stores", "operationId": "ProjectsAdminEventStoreList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventStoreListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventStoreListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/admin/event_store/count": { "post": { "tags": [ "event_store" ], "summary": "Event Stores Count - Alpha", "description": "Get Event Stores count", "operationId": "ProjectsAdminEventStoreCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventStoreCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/admin/event_store/fetch": { "post": { "tags": [ "event_store" ], "summary": "Details - Alpha", "description": "Get Event Store details", "operationId": "ProjectsAdminEventStoreFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventStoreFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventStoreFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/admin/event_store/reset": { "post": { "tags": [ "event_store" ], "summary": "Reset event store - Alpha", "description": "Resets a specific event store, clearing its persisted domain events and projection data.", "operationId": "ProjectsAdminEventStoreReset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventStoreResetCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/admin/event_store/reset_bulk": { "post": { "tags": [ "event_store" ], "summary": "Reset bulk event stores - Alpha", "description": "Resets a bulk selection of event stores, clearing all persisted domain events and projection data.", "operationId": "ProjectsAdminEventStoreResetBulk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventStoreResetBulkCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/admin/projection/list": { "post": { "tags": [ "projection" ], "summary": "Projections - Alpha", "description": "Gets a list of Projections", "operationId": "ProjectsAdminProjectionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/admin/projection/count": { "post": { "tags": [ "projection" ], "summary": "Projections Count - Alpha", "description": "Get Projections count", "operationId": "ProjectsAdminProjectionCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/admin/projection/fetch": { "post": { "tags": [ "projection" ], "summary": "Details - Alpha", "description": "Get Projection details", "operationId": "ProjectsAdminProjectionFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/admin/projection/rebuild": { "post": { "tags": [ "projection" ], "summary": "Rebuild projection - Alpha", "description": "Rebuilds a specific projection to synchronize it with the current event store state.", "operationId": "ProjectsAdminProjectionRebuild", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionRebuildCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/admin/projection/rebuild_bulk": { "post": { "tags": [ "projection" ], "summary": "Rebuild bulk projections - Alpha", "description": "Rebuilds a bulk selection of projections to synchronize them with the current event store state.", "operationId": "ProjectsAdminProjectionRebuildBulk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectionRebuildBulkCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/element_description/list": { "post": { "tags": [ "element_description" ], "summary": "Element Descriptions - Alpha", "description": "Gets a list of Element Descriptions", "operationId": "ProjectsModuleElementDescriptionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementDescriptionListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementDescriptionListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/element_description/count": { "post": { "tags": [ "element_description" ], "summary": "Element Descriptions Count - Alpha", "description": "Get Element Descriptions count", "operationId": "ProjectsModuleElementDescriptionCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementDescriptionCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/element_description/fetch": { "post": { "tags": [ "element_description" ], "summary": "Details - Alpha", "description": "Get Element Description details", "operationId": "ProjectsModuleElementDescriptionFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementDescriptionFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementDescriptionFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/module_description/list": { "post": { "tags": [ "module_description" ], "summary": "Module Descriptions - Alpha", "description": "Gets a list of Module Descriptions", "operationId": "ProjectsModuleModuleDescriptionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModuleDescriptionListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModuleDescriptionListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/module_description/count": { "post": { "tags": [ "module_description" ], "summary": "Module Descriptions Count - Alpha", "description": "Get Module Descriptions count", "operationId": "ProjectsModuleModuleDescriptionCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModuleDescriptionCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/module_description/fetch": { "post": { "tags": [ "module_description" ], "summary": "Details - Alpha", "description": "Get Module Description details", "operationId": "ProjectsModuleModuleDescriptionFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModuleDescriptionFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModuleDescriptionFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/feature_description/list": { "post": { "tags": [ "feature_description" ], "summary": "Feature Descriptions - Alpha", "description": "Gets a list of Feature Descriptions", "operationId": "ProjectsModuleFeatureDescriptionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureDescriptionListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureDescriptionListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/feature_description/count": { "post": { "tags": [ "feature_description" ], "summary": "Feature Descriptions Count - Alpha", "description": "Get Feature Descriptions count", "operationId": "ProjectsModuleFeatureDescriptionCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureDescriptionCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/feature_description/fetch": { "post": { "tags": [ "feature_description" ], "summary": "Details - Alpha", "description": "Get Feature Description details", "operationId": "ProjectsModuleFeatureDescriptionFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureDescriptionFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureDescriptionFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/entity_description/list": { "post": { "tags": [ "entity_description" ], "summary": "Entity Descriptions - Alpha", "description": "Gets a list of Entity Descriptions", "operationId": "ProjectsModuleEntityDescriptionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDescriptionListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDescriptionListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/entity_description/count": { "post": { "tags": [ "entity_description" ], "summary": "Entity Descriptions Count - Alpha", "description": "Get Entity Descriptions count", "operationId": "ProjectsModuleEntityDescriptionCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDescriptionCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/entity_description/fetch": { "post": { "tags": [ "entity_description" ], "summary": "Details - Alpha", "description": "Get Entity Description details", "operationId": "ProjectsModuleEntityDescriptionFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDescriptionFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDescriptionFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/notification_description/list": { "post": { "tags": [ "notification_description" ], "summary": "Notification Descriptions - Alpha", "description": "Gets a list of Notification Descriptions", "operationId": "ProjectsModuleNotificationDescriptionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDescriptionListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDescriptionListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/notification_description/count": { "post": { "tags": [ "notification_description" ], "summary": "Notification Descriptions Count - Alpha", "description": "Get Notification Descriptions count", "operationId": "ProjectsModuleNotificationDescriptionCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDescriptionCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/notification_description/fetch": { "post": { "tags": [ "notification_description" ], "summary": "Details - Alpha", "description": "Get Notification Description details", "operationId": "ProjectsModuleNotificationDescriptionFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDescriptionFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDescriptionFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/operation_description/list": { "post": { "tags": [ "operation_description" ], "summary": "Operation Descriptions - Alpha", "description": "Gets a list of Operation Descriptions", "operationId": "ProjectsModuleOperationDescriptionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationDescriptionListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationDescriptionListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/operation_description/count": { "post": { "tags": [ "operation_description" ], "summary": "Operation Descriptions Count - Alpha", "description": "Get Operation Descriptions count", "operationId": "ProjectsModuleOperationDescriptionCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationDescriptionCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/operation_description/fetch": { "post": { "tags": [ "operation_description" ], "summary": "Details - Alpha", "description": "Get Operation Description details", "operationId": "ProjectsModuleOperationDescriptionFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationDescriptionFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationDescriptionFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/permission_description/list": { "post": { "tags": [ "permission_description" ], "summary": "Permission Descriptions - Alpha", "description": "Gets a list of Permission Descriptions", "operationId": "ProjectsModulePermissionDescriptionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionDescriptionListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionDescriptionListQueryResultExtended" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/permission_description/count": { "post": { "tags": [ "permission_description" ], "summary": "Permission Descriptions Count - Alpha", "description": "Get Permission Descriptions count", "operationId": "ProjectsModulePermissionDescriptionCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionDescriptionCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/permission_description/fetch": { "post": { "tags": [ "permission_description" ], "summary": "Details - Alpha", "description": "Get Permission Description details", "operationId": "ProjectsModulePermissionDescriptionFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionDescriptionFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionDescriptionFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/setting_description/list": { "post": { "tags": [ "setting_description" ], "summary": "Setting Descriptions - Alpha", "description": "Gets a list of Setting Descriptions", "operationId": "ProjectsModuleSettingDescriptionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDescriptionListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDescriptionListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/setting_description/count": { "post": { "tags": [ "setting_description" ], "summary": "Setting Descriptions Count - Alpha", "description": "Get Setting Descriptions count", "operationId": "ProjectsModuleSettingDescriptionCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDescriptionCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/setting_description/fetch": { "post": { "tags": [ "setting_description" ], "summary": "Details - Alpha", "description": "Get Setting Description details", "operationId": "ProjectsModuleSettingDescriptionFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDescriptionFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDescriptionFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/setting_value/list": { "post": { "tags": [ "setting_value" ], "summary": "Setting Values - NotImplemented", "description": "Gets a list of Setting Values", "operationId": "ProjectsModuleSettingValueList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingValueListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingValueListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/setting_value/count": { "post": { "tags": [ "setting_value" ], "summary": "Setting Values Count - NotImplemented", "description": "Get Setting Values count", "operationId": "ProjectsModuleSettingValueCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingValueCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/setting_value/fetch": { "post": { "tags": [ "setting_value" ], "summary": "Details - NotImplemented", "description": "Get Setting Value details", "operationId": "ProjectsModuleSettingValueFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingValueFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingValueFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/setting_value/define": { "post": { "tags": [ "setting_value" ], "summary": "Define - NotImplemented", "description": "Defines a Setting Value", "operationId": "ProjectsModuleSettingValueDefine", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingValueDefineCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/module/setting_value/reset": { "post": { "tags": [ "setting_value" ], "summary": "Reset SettingValue - NotImplemented", "description": "Resets a SettingValue instance to the inherited scope default.", "operationId": "ProjectsModuleSettingValueReset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingValueResetCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/culture/list": { "post": { "tags": [ "culture" ], "summary": "Cultures - Alpha", "description": "Gets a list of Cultures", "operationId": "ProjectsProjectCultureList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CultureListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CultureListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/culture/count": { "post": { "tags": [ "culture" ], "summary": "Cultures Count - Alpha", "description": "Get Cultures count", "operationId": "ProjectsProjectCultureCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CultureCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/project/list": { "post": { "tags": [ "project" ], "summary": "Projects - Alpha", "description": "Gets a list of Projects", "operationId": "ProjectsProjectProjectList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/project/count": { "post": { "tags": [ "project" ], "summary": "Projects Count - Alpha", "description": "Get Projects count", "operationId": "ProjectsProjectProjectCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/project/fetch": { "post": { "tags": [ "project" ], "summary": "Details - Alpha", "description": "Get Project details", "operationId": "ProjectsProjectProjectFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectFetchQueryResultExtended" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/project/create": { "post": { "tags": [ "project" ], "summary": "Create - Alpha", "description": "Creates a new Project", "operationId": "ProjectsProjectProjectCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreateCommandExtended" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/project/update": { "post": { "tags": [ "project" ], "summary": "Update - Alpha", "description": "Updates a Project", "operationId": "ProjectsProjectProjectUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateCommandExtended" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/project/delete": { "post": { "tags": [ "project" ], "summary": "Delete - Alpha", "description": "Deletes a Project", "operationId": "ProjectsProjectProjectDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDeleteCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/project/restore": { "post": { "tags": [ "project" ], "summary": "Restore project - Alpha", "description": "Restores a previously deleted project.", "operationId": "ProjectsProjectProjectRestore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRestoreCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/project/login_manttest": { "post": { "tags": [ "project" ], "summary": "Login to MantTest - Alpha", "description": "Authenticates a user with provided credentials for the MantTest system and establishes a session.", "operationId": "ProjectsProjectProjectLoginManttest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectLoginMantTestCommandExtended" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MantTestProjectLoginCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/project/validate/manttest_credentials": { "post": { "tags": [ "project" ], "summary": "Validate MantTest Credentials - Alpha", "description": "Validates provided credentials for the MantTest system without establishing a session.", "operationId": "ProjectsProjectProjectManttestCredentials", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectValidateMantTestCredentialsCommandExtended" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license/fetch": { "post": { "tags": [ "usage_license" ], "summary": "Details - Alpha", "description": "Get Usage License details", "operationId": "ProjectsProjectUsageLicenseFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license/fetch_access": { "post": { "tags": [ "usage_license" ], "summary": "Details - Alpha", "description": "Get Usage License details", "operationId": "ProjectsProjectUsageLicenseFetchAccess", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseFetchAccessQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseFetchAccessQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license/fetch_batch_access": { "post": { "tags": [ "usage_license" ], "summary": "Details Batch - Alpha", "description": "Get multiple Usage Licenses details", "operationId": "ProjectsProjectUsageLicenseFetchBatchAccess", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseFetchAccessBatchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseFetchAccessBatchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license/list": { "post": { "tags": [ "usage_license" ], "summary": "Usage Licenses - Alpha", "description": "Gets a list of Usage Licenses", "operationId": "ProjectsProjectUsageLicenseList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license/count": { "post": { "tags": [ "usage_license" ], "summary": "Usage Licenses Count - Alpha", "description": "Get Usage Licenses count", "operationId": "ProjectsProjectUsageLicenseCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license/list_project": { "post": { "tags": [ "usage_license" ], "summary": "Usage Licenses - Alpha", "description": "Gets a list of Usage Licenses", "operationId": "ProjectsProjectUsageLicenseListProject", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseProjectListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseProjectListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license/count_project": { "post": { "tags": [ "usage_license" ], "summary": "Usage Licenses Count - Alpha", "description": "Get Usage Licenses count", "operationId": "ProjectsProjectUsageLicenseCountProject", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseProjectCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license/create": { "post": { "tags": [ "usage_license" ], "summary": "Create - Alpha", "description": "Creates a new Usage License", "operationId": "ProjectsProjectUsageLicenseCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseCreateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license/update": { "post": { "tags": [ "usage_license" ], "summary": "Update - Alpha", "description": "Updates a Usage License", "operationId": "ProjectsProjectUsageLicenseUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseUpdateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license/update_access": { "post": { "tags": [ "usage_license" ], "summary": "Update Access - Alpha", "description": "Operation to update usage license access", "operationId": "ProjectsProjectUsageLicenseUpdateAccess", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseUpdateAccessCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license_contract/fetch": { "post": { "tags": [ "usage_license_contract" ], "summary": "Details - Alpha", "description": "Get Usage License Contract details", "operationId": "ProjectsProjectUsageLicenseContractFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseContractFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseContractFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license_contract/list": { "post": { "tags": [ "usage_license_contract" ], "summary": "Usage License Contracts - Alpha", "description": "Gets a list of Usage License Contracts", "operationId": "ProjectsProjectUsageLicenseContractList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseContractListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseContractListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license_contract/count": { "post": { "tags": [ "usage_license_contract" ], "summary": "Usage License Contracts Count - Alpha", "description": "Get Usage License Contracts count", "operationId": "ProjectsProjectUsageLicenseContractCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseContractCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license_contract/create": { "post": { "tags": [ "usage_license_contract" ], "summary": "Create - Alpha", "description": "Creates a new Usage License Contract", "operationId": "ProjectsProjectUsageLicenseContractCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseContractCreateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license_contract/update": { "post": { "tags": [ "usage_license_contract" ], "summary": "Update - Alpha", "description": "Updates a Usage License Contract", "operationId": "ProjectsProjectUsageLicenseContractUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseContractUpdateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license_contract/renew": { "post": { "tags": [ "usage_license_contract" ], "summary": "Renew Contract - Alpha", "description": "Creates a renewal child contract linked to the current contract.", "operationId": "ProjectsProjectUsageLicenseContractRenew", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseContractRenewCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/usage_license_contract/update_renewal_status": { "post": { "tags": [ "usage_license_contract" ], "summary": "Update Renewal Status - Alpha", "description": "Updates the renewal phase and economic status of a contract based on current conditions.", "operationId": "ProjectsProjectUsageLicenseContractUpdateRenewalStatus", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageLicenseContractUpdateRenewalStatusCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/identity_provider/fetch": { "post": { "tags": [ "identity_provider" ], "summary": "Details - NotImplemented", "description": "Get Identity Provider details", "operationId": "ProjectsProjectIdentityProviderFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/identity_provider/list": { "post": { "tags": [ "identity_provider" ], "summary": "Identity Providers - NotImplemented", "description": "Gets a list of Identity Providers", "operationId": "ProjectsProjectIdentityProviderList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/identity_provider/count": { "post": { "tags": [ "identity_provider" ], "summary": "Identity Providers Count - NotImplemented", "description": "Get Identity Providers count", "operationId": "ProjectsProjectIdentityProviderCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/identity_provider/create": { "post": { "tags": [ "identity_provider" ], "summary": "Create - NotImplemented", "description": "Creates a new Identity Provider", "operationId": "ProjectsProjectIdentityProviderCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderCreateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/identity_provider/update": { "post": { "tags": [ "identity_provider" ], "summary": "Update - NotImplemented", "description": "Updates a Identity Provider", "operationId": "ProjectsProjectIdentityProviderUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderUpdateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/identity_provider/delete": { "post": { "tags": [ "identity_provider" ], "summary": "Delete - NotImplemented", "description": "Deletes a Identity Provider", "operationId": "ProjectsProjectIdentityProviderDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderDeleteCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/project/identity_provider/restore": { "post": { "tags": [ "identity_provider" ], "summary": "Restore identity provider - NotImplemented", "description": "Restores a previously deleted identity provider.", "operationId": "ProjectsProjectIdentityProviderRestore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderRestoreCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user/fetch": { "post": { "tags": [ "user" ], "summary": "Details - Alpha", "description": "Get User details", "operationId": "ProjectsUserUserFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserFetchQueryResultExtended" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user/list": { "post": { "tags": [ "user" ], "summary": "Users - Alpha", "description": "Gets a list of Users", "operationId": "ProjectsUserUserList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user/count": { "post": { "tags": [ "user" ], "summary": "Users Count - Alpha", "description": "Get Users count", "operationId": "ProjectsUserUserCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user/create_admin": { "post": { "tags": [ "user" ], "summary": "Create Global Administrator - Alpha", "description": "Create a user with global administrative privileges and elevated access across the entire system", "operationId": "ProjectsUserUserCreateAdmin", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreateGlobalAdministratorCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user/create": { "post": { "tags": [ "user" ], "summary": "Create Local User - NotImplemented", "description": "Create a regular application user with licenses and standard permissions", "operationId": "ProjectsUserUserCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreateLocalCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user/create_service": { "post": { "tags": [ "user" ], "summary": "Create Service User - NotImplemented", "description": "Create a service account for automated processes, integrations, or system services", "operationId": "ProjectsUserUserCreateService", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreateServiceCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user/update": { "post": { "tags": [ "user" ], "summary": "Update - Alpha", "description": "Updates a User", "operationId": "ProjectsUserUserUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user/delete": { "post": { "tags": [ "user" ], "summary": "Delete - Alpha", "description": "Deletes a User", "operationId": "ProjectsUserUserDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeleteCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user/restore": { "post": { "tags": [ "user" ], "summary": "Restore user - Alpha", "description": "Restores a previously deleted user.", "operationId": "ProjectsUserUserRestore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRestoreCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_group/fetch": { "post": { "tags": [ "user_group" ], "summary": "Details - Alpha", "description": "Get User Group details", "operationId": "ProjectsUserUserGroupFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_group/list": { "post": { "tags": [ "user_group" ], "summary": "User Groups - Alpha", "description": "Gets a list of User Groups", "operationId": "ProjectsUserUserGroupList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_group/count": { "post": { "tags": [ "user_group" ], "summary": "User Groups Count - Alpha", "description": "Get User Groups count", "operationId": "ProjectsUserUserGroupCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_group/create": { "post": { "tags": [ "user_group" ], "summary": "Create - Alpha", "description": "Creates a new User Group", "operationId": "ProjectsUserUserGroupCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupCreateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_group/update": { "post": { "tags": [ "user_group" ], "summary": "Update - Alpha", "description": "Updates a User Group", "operationId": "ProjectsUserUserGroupUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupUpdateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_group/delete": { "post": { "tags": [ "user_group" ], "summary": "Delete - Alpha", "description": "Deletes a User Group", "operationId": "ProjectsUserUserGroupDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupDeleteCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_group/restore": { "post": { "tags": [ "user_group" ], "summary": "Restore user group - Alpha", "description": "Restores a previously deleted user group.", "operationId": "ProjectsUserUserGroupRestore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupRestoreCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_session/fetch": { "post": { "tags": [ "user_session" ], "summary": "Details - Alpha", "description": "Get User Session details", "operationId": "ProjectsUserUserSessionFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_session/list": { "post": { "tags": [ "user_session" ], "summary": "User Sessions - Alpha", "description": "Gets a list of User Sessions", "operationId": "ProjectsUserUserSessionList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_session/count": { "post": { "tags": [ "user_session" ], "summary": "User Sessions Count - Alpha", "description": "Get User Sessions count", "operationId": "ProjectsUserUserSessionCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_session/metadata": { "get": { "tags": [ "user_session" ], "summary": "Get my session metadata - Alpha", "description": "Fetches metadata for the current user session.", "operationId": "ProjectsUserUserSessionMetadata", "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionGetMetadataQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_session/available_operations": { "get": { "tags": [ "user_session" ], "summary": "Get available operations - Alpha", "description": "Fetches the list of available operations for the current user session.", "operationId": "ProjectsUserUserSessionAvailableOperations", "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionAvailableOperationsQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_session/create": { "post": { "tags": [ "user_session" ], "summary": "Create - Alpha", "description": "Creates a new User Session", "operationId": "ProjectsUserUserSessionCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionCreateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionCreateCommandResult" } } } } }, "security": [ { } ] } }, "/api/projects/user/user_session/close": { "post": { "tags": [ "user_session" ], "summary": "Close user session - Alpha", "description": "Closes a user session.", "operationId": "ProjectsUserUserSessionClose", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionCloseCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_session/delete": { "post": { "tags": [ "user_session" ], "summary": "Delete - Alpha", "description": "Deletes a User Session", "operationId": "ProjectsUserUserSessionDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionDeleteCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_session/close_me": { "post": { "tags": [ "user_session" ], "summary": "Close my session - Alpha", "description": "Closes the current user session.", "operationId": "ProjectsUserUserSessionCloseMe", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionCloseMeCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_project/fetch": { "post": { "tags": [ "user_project" ], "summary": "Details - Alpha", "description": "Get User details", "operationId": "ProjectsUserUserProjectFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectFetchQueryResultExtended" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_project/list": { "post": { "tags": [ "user_project" ], "summary": "Users - Alpha", "description": "Gets a list of Users", "operationId": "ProjectsUserUserProjectList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectListQueryExtended" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectListQueryResultExtended" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_project/count": { "post": { "tags": [ "user_project" ], "summary": "Users Count - Alpha", "description": "Get Users count", "operationId": "ProjectsUserUserProjectCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_project/email_status": { "post": { "tags": [ "user_project" ], "summary": "Details - Alpha", "description": "Get User details", "operationId": "ProjectsUserUserProjectEmailStatus", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectEmailStatusQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectEmailStatusQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_project/create": { "post": { "tags": [ "user_project" ], "summary": "Create - Alpha", "description": "Creates a new User", "operationId": "ProjectsUserUserProjectCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectCreateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_project/update": { "post": { "tags": [ "user_project" ], "summary": "Update - Alpha", "description": "Updates a User", "operationId": "ProjectsUserUserProjectUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectUpdateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_project/delete": { "post": { "tags": [ "user_project" ], "summary": "Delete - Alpha", "description": "Deletes a User", "operationId": "ProjectsUserUserProjectDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectDeleteCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/user_project/restore": { "post": { "tags": [ "user_project" ], "summary": "Restore user - Alpha", "description": "Restores a previously removed user from the project.", "operationId": "ProjectsUserUserProjectRestore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectRestoreExtendedCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/role/fetch": { "post": { "tags": [ "role" ], "summary": "Details - Alpha", "description": "Get Role details", "operationId": "ProjectsUserRoleFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleFetchQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleFetchQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/role/list": { "post": { "tags": [ "role" ], "summary": "Roles - Alpha", "description": "Gets a list of Roles", "operationId": "ProjectsUserRoleList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleListQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleListQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/role/count": { "post": { "tags": [ "role" ], "summary": "Roles Count - Alpha", "description": "Get Roles count", "operationId": "ProjectsUserRoleCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleCountQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountQueryResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/role/create": { "post": { "tags": [ "role" ], "summary": "Create - Alpha", "description": "Creates a new Role", "operationId": "ProjectsUserRoleCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleCreateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/role/update": { "post": { "tags": [ "role" ], "summary": "Update - Alpha", "description": "Updates a Role", "operationId": "ProjectsUserRoleUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUpdateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/role/delete": { "post": { "tags": [ "role" ], "summary": "Delete - Alpha", "description": "Deletes a Role", "operationId": "ProjectsUserRoleDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDeleteCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/role/restore": { "post": { "tags": [ "role" ], "summary": "Restore role - Alpha", "description": "Restores a previously deleted role.", "operationId": "ProjectsUserRoleRestore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleRestoreCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessCommandResult" } } } } }, "security": [ { }, { } ] } }, "/api/projects/user/role/duplicate": { "post": { "tags": [ "role" ], "summary": "Duplicate Role - Alpha", "description": "Duplicates an existing role.", "operationId": "ProjectsUserRoleDuplicate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDuplicateCommand" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommandResult" } } } } }, "security": [ { }, { } ] } } }, "components": { "schemas": { "AccessType": { "enum": [ "Manager", "Worker", "Reader", "EndUser" ] }, "AccessTypeDesc": { "required": [ "accessType", "displayName" ], "type": "object", "properties": { "accessType": { "description": "The access type.", "$ref": "#/components/schemas/AccessType" }, "displayName": { "type": "string", "description": "The localized display name for the access type." } }, "description": "Access type descriptor used in user session creation responses." }, "BoolFilter": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToSingleFilterOfboolean" } ] } } }, "ContainsFilter": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } } }, "ContinuationQueryPaging": { "type": "object", "properties": { "pageSize": { "type": [ "null", "integer" ], "format": "int32" }, "continuationToken": { "type": [ "null", "string" ] } } }, "CountQueryResult": { "required": [ "count" ], "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "CreateCommandResult": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } } }, "CultureCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional list filter criteria.", "$ref": "#/components/schemas/CultureListQueryFilter" } ] } }, "description": "Represents a query that returns the count of cultures matching an optional filter." }, "CultureItem": { "required": [ "id", "englishName", "nativeName" ], "type": "object", "properties": { "id": { "type": "string", "description": "The culture identifier." }, "englishName": { "type": "string", "description": "The English display name." }, "nativeName": { "type": "string", "description": "The native display name." } }, "description": "Represents a culture item returned in list results." }, "CultureListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional list filter criteria.", "$ref": "#/components/schemas/CultureListQueryFilter" } ] } }, "description": "Represents a query that lists available cultures." }, "CultureListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text filter applied to culture fields." } }, "description": "Represents filter criteria for culture list and count queries." }, "CultureListQueryResult": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CultureItem" }, "description": "The returned culture items." } }, "description": "Represents the result of a culture list query." }, "DateTimeOffsetFilter": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfDateTimeOffset" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfDateTimeOffset" } ] }, "greaterThanOrEqualTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GreaterThanOrEqualToFilterOfDateTimeOffset" } ] }, "greaterThan": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GreaterThanFilterOfDateTimeOffset" } ] }, "lessThanOrEqualTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LessThanOrEqualToFilterOfDateTimeOffset" } ] }, "lessThan": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LessThanFilterOfDateTimeOffset" } ] } } }, "DecimalFilter": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfdecimal" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfdecimal" } ] }, "greaterThanOrEqualTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GreaterThanOrEqualToFilterOfdecimal" } ] }, "greaterThan": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GreaterThanFilterOfdecimal" } ] }, "lessThanOrEqualTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LessThanOrEqualToFilterOfdecimal" } ] }, "lessThan": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LessThanFilterOfdecimal" } ] } } }, "DeletedFilter": { "enum": [ "NonDeleted", "OnlyDeleted", "All" ], "default": "NonDeleted" }, "DomainElementKind": { "enum": [ "Module", "Feature", "Entity", "Operation", "Permission", "Setting", "Notification" ] }, "DomainEntityTenancyMode": { "enum": [ "Global", "Project" ], "description": "Defines tenancy behavior for entity data ownership." }, "DomainOperationAccessMode": { "enum": [ "Global", "Project", "Hybrid" ], "description": "Defines access scope requirements for an operation." }, "DomainOperationPurpose": { "enum": [ "List", "Count", "Fetch", "FetchBatch", "Create", "Define", "Update", "Delete", "Restore", "IdExists", "Custom" ], "description": "Defines the semantic purpose of an operation." }, "DomainOperationScope": { "enum": [ "Instance", "Collection", "Support", "BulkAction" ], "description": "Defines the target scope category for an operation." }, "DomainOperationStability": { "enum": [ "NotImplemented", "Alpha", "Beta", "Stable", "Obsolete", "Retired" ], "description": "Defines the lifecycle stability level for an operation." }, "DomainOperationType": { "enum": [ "Query", "Command", "Report", "Audit", "Subscription", "Validation" ], "description": "Defines the operation category." }, "DomainSettingScope": { "enum": [ "Global", "Project", "User", "UserProject" ] }, "ElementDescriptionCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria applied to the count.", "$ref": "#/components/schemas/ElementDescriptionListQueryFilter" } ] } }, "description": "Represents a query for counting element descriptions." }, "ElementDescriptionDetails": { "required": [ "id", "parentId", "name", "displayName", "order", "description", "kind" ], "type": "object", "properties": { "id": { "type": "string", "description": "The element identifier." }, "parentId": { "type": [ "null", "string" ], "description": "The optional parent element identifier." }, "name": { "type": "string", "description": "The internal element name." }, "displayName": { "type": "string", "description": "The element display name." }, "order": { "type": "integer", "description": "The element ordering index.", "format": "int32" }, "description": { "type": [ "null", "string" ], "description": "The optional element description text." }, "kind": { "description": "The domain element kind.", "$ref": "#/components/schemas/DomainElementKind" } }, "description": "Represents detailed information for a domain element." }, "ElementDescriptionFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The element identifier." } }, "description": "Represents a query for fetching element description details by identifier." }, "ElementDescriptionFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched element description details.", "$ref": "#/components/schemas/ElementDescriptionDetails" } }, "description": "Represents the result of an element description fetch query." }, "ElementDescriptionItem": { "required": [ "id", "parentId", "name", "displayName", "order", "kind" ], "type": "object", "properties": { "id": { "type": "string", "description": "The element identifier." }, "parentId": { "type": [ "null", "string" ], "description": "The optional parent element identifier." }, "name": { "type": "string", "description": "The internal element name." }, "displayName": { "type": "string", "description": "The element display name." }, "order": { "type": "integer", "description": "The element ordering index.", "format": "int32" }, "kind": { "description": "The domain element kind.", "$ref": "#/components/schemas/DomainElementKind" } }, "description": "Represents a list item describing a domain element." }, "ElementDescriptionListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria for the list operation.", "$ref": "#/components/schemas/ElementDescriptionListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting instructions for the result set.", "$ref": "#/components/schemas/SortingStepsOfElementDescriptionSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging request.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents a paged query for listing element descriptions." }, "ElementDescriptionListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text search criteria." }, "parentId": { "type": [ "null", "string" ], "description": "Optional parent element identifier filter." }, "displayName": { "type": [ "null", "string" ], "description": "Optional display name filter." }, "kind": { "oneOf": [ { "type": "null" }, { "description": "Optional domain element kind filter.", "$ref": "#/components/schemas/DomainElementKind" } ] } }, "description": "Represents filter criteria for element description listing." }, "ElementDescriptionListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ElementDescriptionItem" }, "description": "The items returned for the current page." }, "paging": { "description": "The continuation paging metadata.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the paged result of an element description list query." }, "ElementDescriptionSortingField": { "enum": [ "Id", "ParentId", "Kind", "Name", "DisplayName", "Order" ], "description": "Defines sortable fields for element description list queries." }, "EndsWithFilter": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } } }, "EntityDescriptionCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria applied to the count.", "$ref": "#/components/schemas/EntityDescriptionListQueryFilter" } ] } }, "description": "Represents a query for counting entity descriptions." }, "EntityDescriptionDetails": { "required": [ "id", "parentId", "name", "idPrefix", "displayName", "displayNamePlural", "order", "description", "tenancyMode", "isReadOnly", "isCustomizable" ], "type": "object", "properties": { "id": { "type": "string", "description": "The entity identifier." }, "parentId": { "type": "string", "description": "The parent entity identifier." }, "name": { "type": "string", "description": "The internal entity name." }, "idPrefix": { "type": [ "null", "string" ], "description": "The optional entity identifier prefix." }, "displayName": { "type": "string", "description": "The entity display name." }, "displayNamePlural": { "type": "string", "description": "The entity plural display name." }, "order": { "type": "integer", "description": "The entity ordering index.", "format": "int32" }, "description": { "type": [ "null", "string" ], "description": "The optional entity description text." }, "tenancyMode": { "description": "The domain entity tenancy mode.", "$ref": "#/components/schemas/DomainEntityTenancyMode" }, "isReadOnly": { "type": "boolean", "description": "Indicates whether the entity is read-only." }, "isCustomizable": { "type": "boolean", "description": "Indicates whether the entity is customizable." } }, "description": "Represents detailed information for a domain entity." }, "EntityDescriptionFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The entity identifier." } }, "description": "Represents a query for fetching entity description details by identifier." }, "EntityDescriptionFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched entity description details.", "$ref": "#/components/schemas/EntityDescriptionDetails" } }, "description": "Represents the result of an entity description fetch query." }, "EntityDescriptionItem": { "required": [ "id", "parentId", "name", "idPrefix", "displayName", "displayNamePlural", "order", "tenancyMode", "isReadOnly", "isCustomizable" ], "type": "object", "properties": { "id": { "type": "string", "description": "The entity identifier." }, "parentId": { "type": "string", "description": "The parent entity identifier." }, "name": { "type": "string", "description": "The internal entity name." }, "idPrefix": { "type": [ "null", "string" ], "description": "The optional entity identifier prefix." }, "displayName": { "type": "string", "description": "The entity display name." }, "displayNamePlural": { "type": "string", "description": "The entity plural display name." }, "order": { "type": "integer", "description": "The entity ordering index.", "format": "int32" }, "tenancyMode": { "description": "The domain entity tenancy mode.", "$ref": "#/components/schemas/DomainEntityTenancyMode" }, "isReadOnly": { "type": "boolean", "description": "Indicates whether the entity is read-only." }, "isCustomizable": { "type": "boolean", "description": "Indicates whether the entity is customizable." } }, "description": "Represents a list item describing a domain entity." }, "EntityDescriptionListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria for the list operation.", "$ref": "#/components/schemas/EntityDescriptionListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting instructions for the result set.", "$ref": "#/components/schemas/SortingStepsOfEntityDescriptionSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging request.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents a paged query for listing entity descriptions." }, "EntityDescriptionListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text search criteria." }, "parentId": { "type": [ "null", "string" ], "description": "Optional parent entity identifier filter." }, "displayName": { "type": [ "null", "string" ], "description": "Optional display name filter." }, "tenancyMode": { "oneOf": [ { "type": "null" }, { "description": "Optional tenancy mode filter.", "$ref": "#/components/schemas/DomainEntityTenancyMode" } ] }, "isReadOnly": { "type": [ "null", "boolean" ], "description": "Optional read-only state filter." }, "isCustomizable": { "type": [ "null", "boolean" ], "description": "Optional customizable state filter." } }, "description": "Represents filter criteria for entity description listing." }, "EntityDescriptionListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDescriptionItem" }, "description": "The items returned for the current page." }, "paging": { "description": "The continuation paging metadata.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the paged result of an entity description list query." }, "EntityDescriptionSortingField": { "enum": [ "Id", "ParentId", "Name", "DisplayName", "TenancyMode", "Order" ], "description": "Defines sortable fields for entity description list queries." }, "EntityFilter": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfstring" } ] } } }, "EntityVisibility": { "required": [ "entityType", "entityId" ], "type": "object", "properties": { "entityType": { "type": "string" }, "entityId": { "type": "string" } } }, "EnumFilterOfAccessType": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfAccessType" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfAccessType" } ] } } }, "EnumFilterOfDomainSettingScope": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfDomainSettingScope" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfDomainSettingScope" } ] } } }, "EnumFilterOfIdentityProviderStatus": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfIdentityProviderStatus" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfIdentityProviderStatus" } ] } } }, "EnumFilterOfIdentityProviderType": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfIdentityProviderType" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfIdentityProviderType" } ] } } }, "EnumFilterOfProjectEconomicStatus": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfProjectEconomicStatus" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfProjectEconomicStatus" } ] } } }, "EnumFilterOfProjectStatus": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfProjectStatus" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfProjectStatus" } ] } } }, "EnumFilterOfUsageLicenseContractEconomicStatus": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfUsageLicenseContractEconomicStatus" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfUsageLicenseContractEconomicStatus" } ] } } }, "EnumFilterOfUsageLicenseContractPaymentMoment": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfUsageLicenseContractPaymentMoment" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfUsageLicenseContractPaymentMoment" } ] } } }, "EnumFilterOfUsageLicenseContractPeriodicity": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfUsageLicenseContractPeriodicity" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfUsageLicenseContractPeriodicity" } ] } } }, "EnumFilterOfUsageLicenseEconomicStatus": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfUsageLicenseEconomicStatus" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfUsageLicenseEconomicStatus" } ] } } }, "EnumFilterOfUserType": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfUserType" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfUserType" } ] } } }, "EqualsToFilterOfAccessType": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/AccessType" } } } }, "EqualsToFilterOfDateTimeOffset": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string", "format": "date-time" } } } }, "EqualsToFilterOfdecimal": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "EqualsToFilterOfDomainSettingScope": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/DomainSettingScope" } } } }, "EqualsToFilterOfIdentityProviderStatus": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderStatus" } } } }, "EqualsToFilterOfIdentityProviderType": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderType" } } } }, "EqualsToFilterOfint": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "EqualsToFilterOfProjectEconomicStatus": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectEconomicStatus" } } } }, "EqualsToFilterOfProjectStatus": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectStatus" } } } }, "EqualsToFilterOfstring": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } } }, "EqualsToFilterOfUsageLicenseContractEconomicStatus": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseContractEconomicStatus" } } } }, "EqualsToFilterOfUsageLicenseContractPaymentMoment": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseContractPaymentMoment" } } } }, "EqualsToFilterOfUsageLicenseContractPeriodicity": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseContractPeriodicity" } } } }, "EqualsToFilterOfUsageLicenseEconomicStatus": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseEconomicStatus" } } } }, "EqualsToFilterOfUserType": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/UserType" } } } }, "EqualsToSingleFilterOfboolean": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "boolean" } } }, "EventStoreCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria applied to the count.", "$ref": "#/components/schemas/EventStoreListQueryFilter" } ] } }, "description": "Represents a query for counting event stores." }, "EventStoreDetails": { "required": [ "id", "displayName", "eventCount", "streamCount", "eventSequenceNumber", "highWaterMark" ], "type": "object", "properties": { "id": { "type": "string", "description": "The event store identifier." }, "displayName": { "type": "string", "description": "The user-facing display name." }, "eventCount": { "type": "integer", "description": "The total number of persisted events.", "format": "int64" }, "streamCount": { "type": "integer", "description": "The total number of event streams.", "format": "int64" }, "eventSequenceNumber": { "type": "integer", "description": "The latest event sequence number.", "format": "int64" }, "highWaterMark": { "type": "integer", "description": "The latest projection high-water mark.", "format": "int64" } }, "description": "Represents detailed information for an event store." }, "EventStoreFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The event store identifier." }, "deleted": { "description": "The deleted-item filtering behavior.", "$ref": "#/components/schemas/DeletedFilter" } }, "description": "Represents a query for fetching event store details by identifier." }, "EventStoreFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched event store details.", "$ref": "#/components/schemas/EventStoreDetails" } }, "description": "Represents the result of an event store fetch query." }, "EventStoreItem": { "required": [ "id", "displayName", "eventCount", "streamCount", "eventSequenceNumber", "highWaterMark" ], "type": "object", "properties": { "id": { "type": "string", "description": "The event store identifier." }, "displayName": { "type": "string", "description": "The user-facing display name." }, "eventCount": { "type": "integer", "description": "The total number of persisted events.", "format": "int64" }, "streamCount": { "type": "integer", "description": "The total number of event streams.", "format": "int64" }, "eventSequenceNumber": { "type": "integer", "description": "The latest event sequence number.", "format": "int64" }, "highWaterMark": { "type": "integer", "description": "The latest projection high-water mark.", "format": "int64" } }, "description": "Represents a list item describing an event store." }, "EventStoreListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria for the list operation.", "$ref": "#/components/schemas/EventStoreListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting instructions for the result set.", "$ref": "#/components/schemas/SortingStepsOfEventStoreSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging request.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents a paged query for listing event stores." }, "EventStoreListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text search criteria." } }, "description": "Represents filter criteria for event store listing." }, "EventStoreListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EventStoreItem" }, "description": "The items returned for the current page." }, "paging": { "description": "The continuation paging metadata.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the paged result of an event store list query." }, "EventStoreResetBulkCommand": { "type": "object", "properties": { "ids": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Optional list of event store IDs to reset. Mutually exclusive with Filter." }, "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter to select event stores to reset. Mutually exclusive with Ids.", "$ref": "#/components/schemas/EventStoreListQueryFilter" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging applied when Filter is specified.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents a command that resets a bulk selection of event stores identified by IDs or filter." }, "EventStoreResetCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The module identifier of the event store to reset." } }, "description": "Represents a command that resets a specific event store by identifier." }, "EventStoreSortingField": { "enum": [ "Id", "DisplayName" ], "description": "Defines sortable fields for event store list queries." }, "FeatureDescriptionCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria reused from the list query.", "$ref": "#/components/schemas/FeatureDescriptionListQueryFilter" } ] } }, "description": "Represents the query contract for counting feature descriptions with optional filtering." }, "FeatureDescriptionDetails": { "required": [ "id", "parentId", "name", "displayName", "order", "description" ], "type": "object", "properties": { "id": { "type": "string", "description": "The feature identifier." }, "parentId": { "type": "string", "description": "The parent feature identifier." }, "name": { "type": "string", "description": "The internal feature name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "order": { "type": "integer", "description": "The feature order value.", "format": "int32" }, "description": { "type": [ "null", "string" ], "description": "Optional descriptive text for the feature." } }, "description": "Represents the detailed projection of a feature description." }, "FeatureDescriptionFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The feature identifier to fetch." } }, "description": "Represents the query contract for fetching a feature description by identifier." }, "FeatureDescriptionFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched feature details.", "$ref": "#/components/schemas/FeatureDescriptionDetails" } }, "description": "Represents the result of a feature description fetch query." }, "FeatureDescriptionItem": { "required": [ "id", "parentId", "name", "displayName", "order" ], "type": "object", "properties": { "id": { "type": "string", "description": "The feature identifier." }, "parentId": { "type": "string", "description": "The parent feature identifier." }, "name": { "type": "string", "description": "The internal feature name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "order": { "type": "integer", "description": "The feature order value.", "format": "int32" } }, "description": "Represents a feature description item returned by list queries." }, "FeatureDescriptionListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria used to narrow the listed feature descriptions.", "$ref": "#/components/schemas/FeatureDescriptionListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting steps applied to the result set.", "$ref": "#/components/schemas/SortingStepsOfFeatureDescriptionSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging parameters.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents the query contract for listing feature descriptions with optional filtering, sorting, and paging." }, "FeatureDescriptionListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional text search term applied across searchable fields." }, "parentId": { "type": [ "null", "string" ], "description": "Optional parent feature identifier filter." }, "displayName": { "type": [ "null", "string" ], "description": "Optional display name filter." } }, "description": "Represents optional filter criteria for feature description list and count queries." }, "FeatureDescriptionListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureDescriptionItem" }, "description": "The list items returned for the current page." }, "paging": { "description": "The continuation paging information for the current page.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the result of a feature description list query." }, "FeatureDescriptionSortingField": { "enum": [ "Id", "ParentId", "Name", "DisplayName", "Order" ], "description": "Defines sortable fields for feature description list queries." }, "GreaterThanFilterOfDateTimeOffset": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "format": "date-time" } } }, "GreaterThanFilterOfdecimal": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "double" } } }, "GreaterThanFilterOfint": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } }, "GreaterThanOrEqualToFilterOfDateTimeOffset": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "format": "date-time" } } }, "GreaterThanOrEqualToFilterOfdecimal": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "double" } } }, "GreaterThanOrEqualToFilterOfint": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } }, "GroupAssignment": { "required": [ "groupId", "allowReading", "allowWriting" ], "type": "object", "properties": { "groupId": { "type": "string" }, "allowReading": { "type": "boolean" }, "allowWriting": { "type": "boolean" } } }, "HttpValidationProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "integer" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "IdentityProviderCommandUpdateDescriptions": { "required": [ "displayName" ], "type": "object", "properties": { "displayName": { "type": "string" } }, "description": "Represents a command payload to update identity provider descriptions." }, "IdentityProviderCommandUpdateDomains": { "required": [ "domains" ], "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "string" } } }, "description": "Represents a command payload to update identity provider domains." }, "IdentityProviderCommandUpdateOidc": { "required": [ "model" ], "type": "object", "properties": { "model": { "$ref": "#/components/schemas/IdentityProviderOidcModel" } }, "description": "Represents a command payload to update OIDC identity provider settings." }, "IdentityProviderCommandUpdateSaml2": { "required": [ "model" ], "type": "object", "properties": { "model": { "$ref": "#/components/schemas/IdentityProviderSaml2Model" } }, "description": "Represents a command payload to update SAML2 identity provider settings." }, "IdentityProviderCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filtering criteria shared with the list query.", "$ref": "#/components/schemas/IdentityProviderListQueryFilter" } ] } }, "description": "Represents a query that returns the count of identity providers matching an optional filter." }, "IdentityProviderCreateCommand": { "required": [ "displayName", "domains", "saml2", "oidc" ], "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name for the identity provider." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "The domains associated with the identity provider." }, "saml2": { "oneOf": [ { "type": "null" }, { "description": "The optional SAML2 protocol configuration.", "$ref": "#/components/schemas/IdentityProviderSaml2Model" } ] }, "oidc": { "oneOf": [ { "type": "null" }, { "description": "The optional OIDC protocol configuration.", "$ref": "#/components/schemas/IdentityProviderOidcModel" } ] } }, "description": "Command to create an identity provider." }, "IdentityProviderDeleteCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the identity provider to delete." } }, "description": "Command to delete an identity provider." }, "IdentityProviderDetails": { "required": [ "id", "displayName", "domains", "status", "type", "saml2", "oidc", "createdAt", "modifiedAt", "deleted", "version" ], "type": "object", "properties": { "id": { "type": "string", "description": "The identity provider identifier." }, "displayName": { "type": "string", "description": "The display name." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Associated domains." }, "status": { "description": "The identity provider status.", "$ref": "#/components/schemas/IdentityProviderStatus" }, "type": { "description": "The identity provider type.", "$ref": "#/components/schemas/IdentityProviderType" }, "saml2": { "oneOf": [ { "type": "null" }, { "description": "Optional SAML2 settings.", "$ref": "#/components/schemas/IdentityProviderSaml2Model" } ] }, "oidc": { "oneOf": [ { "type": "null" }, { "description": "Optional OIDC settings.", "$ref": "#/components/schemas/IdentityProviderOidcModel" } ] }, "createdAt": { "type": "string", "description": "The creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "The last modification timestamp.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Indicates whether the identity provider is soft-deleted." }, "version": { "type": "integer", "description": "The entity version.", "format": "int64" } }, "description": "Represents full identity provider details." }, "IdentityProviderFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The identity provider identifier." }, "deleted": { "description": "Deleted-state visibility filter.", "$ref": "#/components/schemas/DeletedFilter" } }, "description": "Represents a query that fetches identity provider details by identifier." }, "IdentityProviderFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched identity provider details.", "$ref": "#/components/schemas/IdentityProviderDetails" } }, "description": "Represents the result of an identity provider fetch query." }, "IdentityProviderItem": { "required": [ "id", "displayName", "domains", "status", "type", "createdAt", "modifiedAt", "deleted" ], "type": "object", "properties": { "id": { "type": "string", "description": "The identity provider identifier." }, "displayName": { "type": "string", "description": "The display name." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Associated domains." }, "status": { "description": "The identity provider status.", "$ref": "#/components/schemas/IdentityProviderStatus" }, "type": { "description": "The identity provider type.", "$ref": "#/components/schemas/IdentityProviderType" }, "createdAt": { "type": "string", "description": "The creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "The last modification timestamp.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Indicates whether the item is soft-deleted." } }, "description": "Represents a list projection for an identity provider." }, "IdentityProviderListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filtering criteria for list and count operations.", "$ref": "#/components/schemas/IdentityProviderListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting instructions.", "$ref": "#/components/schemas/SortingStepsOfIdentityProviderSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging input.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents a paged query that lists identity providers." }, "IdentityProviderListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text filter applied across searchable fields." }, "deleted": { "oneOf": [ { "type": "null" }, { "description": "Optional deleted-state filter.", "$ref": "#/components/schemas/DeletedFilter" } ] }, "displayName": { "oneOf": [ { "type": "null" }, { "description": "Optional display-name filter.", "$ref": "#/components/schemas/StringFilter" } ] }, "status": { "oneOf": [ { "type": "null" }, { "description": "Optional status filter.", "$ref": "#/components/schemas/EnumFilterOfIdentityProviderStatus" } ] }, "type": { "oneOf": [ { "type": "null" }, { "description": "Optional type filter.", "$ref": "#/components/schemas/EnumFilterOfIdentityProviderType" } ] }, "createdAt": { "oneOf": [ { "type": "null" }, { "description": "Optional created-at filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "modifiedAt": { "oneOf": [ { "type": "null" }, { "description": "Optional modified-at filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] } }, "description": "Represents filtering criteria for identity provider list and count queries." }, "IdentityProviderListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderItem" }, "description": "The returned list items." }, "paging": { "description": "The continuation paging state for subsequent requests.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the result of an identity provider list query." }, "IdentityProviderOidcModel": { "required": [ "metadataUrl", "clientId", "clientSecret", "signInName", "responseType", "scopes", "responseMode", "httpBinding", "claimMappings" ], "type": "object", "properties": { "metadataUrl": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "signInName": { "type": "string" }, "responseType": { "type": "string" }, "scopes": { "type": "string" }, "responseMode": { "type": "string" }, "httpBinding": { "type": "string" }, "claimMappings": { "type": "object", "additionalProperties": { "type": "string" } } }, "description": "Represents OpenID Connect configuration details for an identity provider." }, "IdentityProviderRestoreCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the identity provider to restore." } }, "description": "Command to restore a deleted identity provider." }, "IdentityProviderSaml2Model": { "required": [ "metadataUrl", "signInName", "samlMessageSigning", "claimMappings" ], "type": "object", "properties": { "metadataUrl": { "type": "string" }, "signInName": { "type": "string" }, "samlMessageSigning": { "type": "string" }, "claimMappings": { "type": "object", "additionalProperties": { "type": "string" } } }, "description": "Represents SAML2 configuration details for an identity provider." }, "IdentityProviderSortingField": { "enum": [ "Id", "DisplayName", "Status", "Type", "CreatedAt", "ModifiedAt" ], "description": "Defines supported sorting fields for identity provider list results." }, "IdentityProviderStatus": { "enum": [ "Created", "SettingUp", "Active", "Archiving", "Archived" ], "description": "Represents the status of an identity provider." }, "IdentityProviderType": { "enum": [ "None", "Saml2", "Oidc" ], "description": "Represents the type of an identity provider." }, "IdentityProviderUpdateCommand": { "required": [ "id", "updateDescriptions", "updateDomains", "updateSaml2", "updateOidc" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the identity provider to update." }, "updateDescriptions": { "oneOf": [ { "type": "null" }, { "description": "Optional display name and description updates.", "$ref": "#/components/schemas/IdentityProviderCommandUpdateDescriptions" } ] }, "updateDomains": { "oneOf": [ { "type": "null" }, { "description": "Optional domain updates.", "$ref": "#/components/schemas/IdentityProviderCommandUpdateDomains" } ] }, "updateSaml2": { "oneOf": [ { "type": "null" }, { "description": "Optional SAML2 protocol updates.", "$ref": "#/components/schemas/IdentityProviderCommandUpdateSaml2" } ] }, "updateOidc": { "oneOf": [ { "type": "null" }, { "description": "Optional OIDC protocol updates.", "$ref": "#/components/schemas/IdentityProviderCommandUpdateOidc" } ] } }, "description": "Command to update an existing identity provider." }, "Int32Filter": { "type": "object", "properties": { "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfint" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfint" } ] }, "greaterThanOrEqualTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GreaterThanOrEqualToFilterOfint" } ] }, "greaterThan": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GreaterThanFilterOfint" } ] }, "lessThanOrEqualTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LessThanOrEqualToFilterOfint" } ] }, "lessThan": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LessThanFilterOfint" } ] } } }, "LessThanFilterOfDateTimeOffset": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "format": "date-time" } } }, "LessThanFilterOfdecimal": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "double" } } }, "LessThanFilterOfint": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } }, "LessThanOrEqualToFilterOfDateTimeOffset": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "format": "date-time" } } }, "LessThanOrEqualToFilterOfdecimal": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "double" } } }, "LessThanOrEqualToFilterOfint": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } }, "MantTestProjectCredentials": { "required": [ "userName", "password" ], "type": "object", "properties": { "userName": { "type": "string" }, "password": { "type": "string" } } }, "MantTestProjectInfo": { "required": [ "url", "alias", "userName" ], "type": "object", "properties": { "url": { "type": "string" }, "alias": { "type": "string" }, "userName": { "type": "string" } } }, "MantTestProjectLoginCommandResult": { "required": [ "url", "alias", "loginId" ], "type": "object", "properties": { "url": { "type": "string", "description": "Login URL." }, "alias": { "type": "string", "description": "Project alias." }, "loginId": { "type": "string", "description": "Login identifier." } }, "description": "Response payload for MantTest project login requests." }, "MantTestProjectUpsertCommand": { "required": [ "url", "credentials" ], "type": "object", "properties": { "url": { "$ref": "#/components/schemas/MantTestProjectUrl" }, "credentials": { "$ref": "#/components/schemas/MantTestProjectCredentials" } } }, "MantTestProjectUrl": { "required": [ "url", "alias" ], "type": "object", "properties": { "url": { "type": "string" }, "alias": { "type": "string" } } }, "ModuleActivationType": { "enum": [ "OnDemand", "ByDefault", "Required" ], "description": "Defines how a module is activated in an environment." }, "ModuleDescriptionCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria reused from the list query.", "$ref": "#/components/schemas/ModuleDescriptionListQueryFilter" } ] } }, "description": "Represents the query contract for counting module descriptions with optional filtering." }, "ModuleDescriptionDetails": { "required": [ "id", "name", "displayName", "order", "description", "activationType", "dependsOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "The module identifier." }, "name": { "type": "string", "description": "The internal module name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "order": { "type": "integer", "description": "The module order value.", "format": "int32" }, "description": { "type": [ "null", "string" ], "description": "Optional descriptive text for the module." }, "activationType": { "description": "The module activation type.", "$ref": "#/components/schemas/ModuleActivationType" }, "dependsOn": { "type": "array", "items": { "type": "string" }, "description": "The module identifiers this module depends on." } }, "description": "Represents the detailed projection of a module description." }, "ModuleDescriptionFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The module identifier to fetch." } }, "description": "Represents the query contract for fetching a module description by identifier." }, "ModuleDescriptionFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched module details.", "$ref": "#/components/schemas/ModuleDescriptionDetails" } }, "description": "Represents the result of a module description fetch query." }, "ModuleDescriptionItem": { "required": [ "id", "name", "displayName", "order", "activationType" ], "type": "object", "properties": { "id": { "type": "string", "description": "The module identifier." }, "name": { "type": "string", "description": "The internal module name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "order": { "type": "integer", "description": "The module order value.", "format": "int32" }, "activationType": { "description": "The module activation type.", "$ref": "#/components/schemas/ModuleActivationType" } }, "description": "Represents a module description item returned by list queries." }, "ModuleDescriptionListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria used to narrow the listed module descriptions.", "$ref": "#/components/schemas/ModuleDescriptionListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting steps applied to the result set.", "$ref": "#/components/schemas/SortingStepsOfModuleDescriptionSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging parameters.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents the query contract for listing module descriptions with optional filtering, sorting, and paging." }, "ModuleDescriptionListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional text search term applied across searchable fields." }, "displayName": { "type": [ "null", "string" ], "description": "Optional display name filter." }, "activationType": { "oneOf": [ { "type": "null" }, { "description": "Optional activation type filter.", "$ref": "#/components/schemas/ModuleActivationType" } ] } }, "description": "Represents optional filter criteria for module description list and count queries." }, "ModuleDescriptionListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleDescriptionItem" }, "description": "The list items returned for the current page." }, "paging": { "description": "The continuation paging information for the current page.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the result of a module description list query." }, "ModuleDescriptionSortingField": { "enum": [ "Id", "Name", "DisplayName", "ActivationType", "Order" ], "description": "Defines sortable fields for module description list queries." }, "NotContainsFilter": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } } }, "NotEndsWithFilter": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } } }, "NotEqualsToFilterOfAccessType": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/AccessType" } } } }, "NotEqualsToFilterOfDateTimeOffset": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string", "format": "date-time" } } } }, "NotEqualsToFilterOfdecimal": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "NotEqualsToFilterOfDomainSettingScope": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/DomainSettingScope" } } } }, "NotEqualsToFilterOfIdentityProviderStatus": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderStatus" } } } }, "NotEqualsToFilterOfIdentityProviderType": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderType" } } } }, "NotEqualsToFilterOfint": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "NotEqualsToFilterOfProjectEconomicStatus": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectEconomicStatus" } } } }, "NotEqualsToFilterOfProjectStatus": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectStatus" } } } }, "NotEqualsToFilterOfstring": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } } }, "NotEqualsToFilterOfUsageLicenseContractEconomicStatus": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseContractEconomicStatus" } } } }, "NotEqualsToFilterOfUsageLicenseContractPaymentMoment": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseContractPaymentMoment" } } } }, "NotEqualsToFilterOfUsageLicenseContractPeriodicity": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseContractPeriodicity" } } } }, "NotEqualsToFilterOfUsageLicenseEconomicStatus": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseEconomicStatus" } } } }, "NotEqualsToFilterOfUserType": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/UserType" } } } }, "NotificationDescriptionCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria reused from the list query.", "$ref": "#/components/schemas/NotificationDescriptionListQueryFilter" } ] } }, "description": "Represents the query contract for counting notification descriptions with optional filtering." }, "NotificationDescriptionDetails": { "required": [ "id", "parentId", "name", "displayName", "order", "description", "dataSchema" ], "type": "object", "properties": { "id": { "type": "string", "description": "The notification identifier." }, "parentId": { "type": "string", "description": "The parent entity identifier." }, "name": { "type": "string", "description": "The internal notification name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "order": { "type": "integer", "description": "The notification order value.", "format": "int32" }, "description": { "type": [ "null", "string" ], "description": "Optional descriptive text for the notification." }, "dataSchema": { "type": [ "null", "string" ], "description": "Optional serialized schema describing notification data." } }, "description": "Represents the detailed projection of a notification description." }, "NotificationDescriptionFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The notification identifier to fetch." } }, "description": "Represents the query contract for fetching a notification description by identifier." }, "NotificationDescriptionFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched notification details.", "$ref": "#/components/schemas/NotificationDescriptionDetails" } }, "description": "Represents the result of a notification description fetch query." }, "NotificationDescriptionItem": { "required": [ "id", "parentId", "name", "displayName", "order" ], "type": "object", "properties": { "id": { "type": "string", "description": "The notification identifier." }, "parentId": { "type": "string", "description": "The parent entity identifier." }, "name": { "type": "string", "description": "The internal notification name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "order": { "type": "integer", "description": "The notification order value.", "format": "int32" } }, "description": "Represents a notification description item returned by list queries." }, "NotificationDescriptionListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria used to narrow the listed notification descriptions.", "$ref": "#/components/schemas/NotificationDescriptionListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting steps applied to the result set.", "$ref": "#/components/schemas/SortingStepsOfNotificationDescriptionSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging parameters.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents the query contract for listing notification descriptions with optional filtering, sorting, and paging." }, "NotificationDescriptionListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional text search term applied across searchable fields." }, "parentId": { "type": [ "null", "string" ], "description": "Optional parent identifier filter." }, "displayName": { "type": [ "null", "string" ], "description": "Optional display name filter." } }, "description": "Represents optional filter criteria for notification description list and count queries." }, "NotificationDescriptionListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDescriptionItem" }, "description": "The list items returned for the current page." }, "paging": { "description": "The continuation paging information for the current page.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the result of a notification description list query." }, "NotificationDescriptionSortingField": { "enum": [ "Id", "ParentId", "Name", "DisplayName", "Order" ], "description": "Defines sortable fields for notification description list queries." }, "NotStartsWithFilter": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } } }, "OperationDescriptionCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria reused from the list query.", "$ref": "#/components/schemas/OperationDescriptionListQueryFilter" } ] } }, "description": "Represents the query contract for counting operation descriptions with optional filtering." }, "OperationDescriptionDetails": { "required": [ "id", "parentId", "name", "displayName", "description", "path", "type", "scope", "purpose", "permissionId", "order", "accessMode", "stability" ], "type": "object", "properties": { "id": { "type": "string", "description": "The operation identifier." }, "parentId": { "type": "string", "description": "The parent entity identifier." }, "name": { "type": "string", "description": "The internal operation name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "description": { "type": [ "null", "string" ], "description": "Optional descriptive text for the operation." }, "path": { "type": "string", "description": "The operation path." }, "type": { "description": "The operation type.", "$ref": "#/components/schemas/DomainOperationType" }, "scope": { "description": "The operation scope.", "$ref": "#/components/schemas/DomainOperationScope" }, "purpose": { "description": "The operation purpose.", "$ref": "#/components/schemas/DomainOperationPurpose" }, "permissionId": { "type": [ "null", "string" ], "description": "Optional permission identifier associated with the operation." }, "order": { "type": "integer", "description": "The operation order value.", "format": "int32" }, "accessMode": { "description": "The operation access mode.", "$ref": "#/components/schemas/DomainOperationAccessMode" }, "stability": { "description": "The operation stability level.", "$ref": "#/components/schemas/DomainOperationStability" } }, "description": "Represents the detailed projection of an operation description." }, "OperationDescriptionFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The operation identifier to fetch." } }, "description": "Represents the query contract for fetching an operation description by identifier." }, "OperationDescriptionFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched operation details.", "$ref": "#/components/schemas/OperationDescriptionDetails" } }, "description": "Represents the result of an operation description fetch query." }, "OperationDescriptionItem": { "required": [ "id", "parentId", "name", "displayName", "path", "type", "scope", "purpose", "order", "accessMode", "stability" ], "type": "object", "properties": { "id": { "type": "string", "description": "The operation identifier." }, "parentId": { "type": "string", "description": "The parent entity identifier." }, "name": { "type": "string", "description": "The internal operation name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "path": { "type": "string", "description": "The operation path." }, "type": { "description": "The operation type.", "$ref": "#/components/schemas/DomainOperationType" }, "scope": { "description": "The operation scope.", "$ref": "#/components/schemas/DomainOperationScope" }, "purpose": { "description": "The operation purpose.", "$ref": "#/components/schemas/DomainOperationPurpose" }, "order": { "type": "integer", "description": "The operation order value.", "format": "int32" }, "accessMode": { "description": "The operation access mode.", "$ref": "#/components/schemas/DomainOperationAccessMode" }, "stability": { "description": "The operation stability level.", "$ref": "#/components/schemas/DomainOperationStability" } }, "description": "Represents an operation description item returned by list queries." }, "OperationDescriptionListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria used to narrow the listed operation descriptions.", "$ref": "#/components/schemas/OperationDescriptionListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting steps applied to the result set.", "$ref": "#/components/schemas/SortingStepsOfOperationDescriptionSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging parameters.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents the query contract for listing operation descriptions with optional filtering, sorting, and paging." }, "OperationDescriptionListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional text search term applied across searchable fields." }, "parentId": { "type": [ "null", "string" ], "description": "Optional parent identifier filter." }, "displayName": { "type": [ "null", "string" ], "description": "Optional display name filter." }, "type": { "oneOf": [ { "type": "null" }, { "description": "Optional operation type filter.", "$ref": "#/components/schemas/DomainOperationType" } ] }, "scope": { "oneOf": [ { "type": "null" }, { "description": "Optional operation scope filter.", "$ref": "#/components/schemas/DomainOperationScope" } ] }, "purpose": { "oneOf": [ { "type": "null" }, { "description": "Optional operation purpose filter.", "$ref": "#/components/schemas/DomainOperationPurpose" } ] }, "accessMode": { "oneOf": [ { "type": "null" }, { "description": "Optional operation access mode filter.", "$ref": "#/components/schemas/DomainOperationAccessMode" } ] } }, "description": "Represents optional filter criteria for operation description list and count queries." }, "OperationDescriptionListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OperationDescriptionItem" }, "description": "The list items returned for the current page." }, "paging": { "description": "The continuation paging information for the current page.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the result of an operation description list query." }, "OperationDescriptionSortingField": { "enum": [ "Id", "ParentId", "Name", "DisplayName", "Type", "Scope", "Purpose", "AccessMode", "Order" ], "description": "Defines sortable fields for operation description list queries." }, "OptionalDateTimeOffsetFilter": { "type": "object", "properties": { "isPresent": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ValuePresenceFilter" } ] }, "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfDateTimeOffset" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfDateTimeOffset" } ] }, "greaterThanOrEqualTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GreaterThanOrEqualToFilterOfDateTimeOffset" } ] }, "greaterThan": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GreaterThanFilterOfDateTimeOffset" } ] }, "lessThanOrEqualTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LessThanOrEqualToFilterOfDateTimeOffset" } ] }, "lessThan": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LessThanFilterOfDateTimeOffset" } ] } } }, "OptionalEntityFilter": { "type": "object", "properties": { "isPresent": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ValuePresenceFilter" } ] }, "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfstring" } ] } } }, "OptionalEnumFilterOfAccessType": { "type": "object", "properties": { "isPresent": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ValuePresenceFilter" } ] }, "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfAccessType" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfAccessType" } ] } } }, "OptionalEnumFilterOfUserType": { "type": "object", "properties": { "isPresent": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ValuePresenceFilter" } ] }, "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfUserType" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfUserType" } ] } } }, "OptionalStringFilter": { "type": "object", "properties": { "isPresent": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ValuePresenceFilter" } ] }, "contains": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContainsFilter" } ] }, "startsWith": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StartsWithFilter" } ] }, "endsWith": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EndsWithFilter" } ] }, "notContains": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotContainsFilter" } ] }, "notStartsWith": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotStartsWithFilter" } ] }, "notEndsWith": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEndsWithFilter" } ] }, "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfstring" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfstring" } ] } } }, "PermissionAssignment": { "required": [ "permissionId", "permissionMode" ], "type": "object", "properties": { "permissionId": { "type": "string" }, "permissionMode": { "$ref": "#/components/schemas/PermissionMode" } } }, "PermissionAssignmentView": { "required": [ "permissionId", "permissionMode" ], "type": "object", "properties": { "permissionId": { "type": "string", "description": "The permission identifier." }, "permissionMode": { "description": "The mode assigned to this permission in the role.", "$ref": "#/components/schemas/PermissionMode" } }, "description": "A single permission assignment as stored in a role." }, "PermissionDescriptionCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria reused from the list query.", "$ref": "#/components/schemas/PermissionDescriptionListQueryFilter" } ] } }, "description": "Represents the query contract for counting permission descriptions with optional filtering." }, "PermissionDescriptionDetails": { "required": [ "id", "parentId", "name", "displayName", "order", "description", "accessTypes" ], "type": "object", "properties": { "id": { "type": "string", "description": "The permission identifier." }, "parentId": { "type": "string", "description": "The parent entity identifier." }, "name": { "type": "string", "description": "The internal permission name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "order": { "type": "integer", "description": "The permission order value.", "format": "int32" }, "description": { "type": [ "null", "string" ], "description": "Optional descriptive text for the permission." }, "accessTypes": { "type": "array", "items": { "$ref": "#/components/schemas/AccessType" }, "description": "The access types granted by the permission." } }, "description": "Represents the detailed projection of a permission description." }, "PermissionDescriptionFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The permission identifier to fetch." } }, "description": "Represents the query contract for fetching a permission description by identifier." }, "PermissionDescriptionFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched permission details.", "$ref": "#/components/schemas/PermissionDescriptionDetails" } }, "description": "Represents the result of a permission description fetch query." }, "PermissionDescriptionItemExtended": { "required": [ "id", "parentId", "name", "displayName", "order", "canAssign" ], "type": "object", "properties": { "id": { "type": "string", "description": "The permission identifier." }, "parentId": { "type": "string", "description": "The parent entity identifier." }, "name": { "type": "string", "description": "The internal permission name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "order": { "type": "integer", "description": "The permission order value.", "format": "int32" }, "canAssign": { "type": "boolean", "description": "`true` when the calling user holds this permission and may assign it to roles;\n `false` otherwise." } }, "description": "Extended permission description item that includes a per-user bool PermissionDescriptionItemExtended.CanAssign flag." }, "PermissionDescriptionListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria used to narrow the listed permission descriptions.", "$ref": "#/components/schemas/PermissionDescriptionListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting steps applied to the result set.", "$ref": "#/components/schemas/SortingStepsOfPermissionDescriptionSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging parameters.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents the query contract for listing permission descriptions with optional filtering, sorting, and paging." }, "PermissionDescriptionListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional text search term applied across searchable fields." }, "parentId": { "type": [ "null", "string" ], "description": "Optional parent identifier filter." }, "displayName": { "type": [ "null", "string" ], "description": "Optional display name filter." }, "accessType": { "oneOf": [ { "type": "null" }, { "description": "Optional access type filter.", "$ref": "#/components/schemas/AccessType" } ] } }, "description": "Represents optional filter criteria for permission description list and count queries." }, "PermissionDescriptionListQueryResultExtended": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDescriptionItemExtended" }, "description": "The enriched permission items for the current page." }, "paging": { "description": "The continuation paging information for the current page.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Extended list query result that enriches each permission item with a per-user can-edit flag." }, "PermissionDescriptionSortingField": { "enum": [ "Id", "ParentId", "Name", "DisplayName", "Order" ], "description": "Defines sortable fields for permission description list queries." }, "PermissionMode": { "enum": [ "Allowed", "Denied" ] }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "integer" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } }, "ProjectAlias": { "required": [ "alias" ], "type": "object", "properties": { "alias": { "type": "string" } } }, "ProjectCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filtering criteria shared with the list query.", "$ref": "#/components/schemas/ProjectListQueryFilter" } ] } }, "description": "Represents a query that returns the count of projects matching an optional filter." }, "ProjectCreateCommandExtended": { "required": [ "alias", "descriptions", "moduleAssignments", "mantTestProject" ], "type": "object", "properties": { "alias": { "$ref": "#/components/schemas/ProjectAlias" }, "descriptions": { "$ref": "#/components/schemas/ProjectDescriptions" }, "moduleAssignments": { "$ref": "#/components/schemas/ProjectCreateModuleAssignments" }, "mantTestProject": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MantTestProjectUpsertCommand" } ] } } }, "ProjectCreateModuleAssignments": { "required": [ "addModules" ], "type": "object", "properties": { "addModules": { "type": "array", "items": { "type": "string" } } } }, "ProjectDeleteCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The project identifier." } }, "description": "Represents a command to delete a project." }, "ProjectDesc": { "required": [ "projectId", "projectAlias" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "The project identifier." }, "projectAlias": { "type": "string", "description": "The project alias." } }, "description": "Project descriptor used in user session creation responses." }, "ProjectDescriptions": { "required": [ "displayName" ], "type": "object", "properties": { "displayName": { "type": "string" } } }, "ProjectDetailsExtended": { "required": [ "id", "alias", "descriptions", "moduleAssignments", "economicData", "status", "mantTestProjectInfo", "createdAt", "modifiedAt", "deleted", "version" ], "type": "object", "properties": { "id": { "type": "string", "description": "The project identifier." }, "alias": { "description": "The project alias.", "$ref": "#/components/schemas/ProjectAlias" }, "descriptions": { "description": "Localized project descriptions.", "$ref": "#/components/schemas/ProjectDescriptions" }, "moduleAssignments": { "description": "Assigned modules for the project.", "$ref": "#/components/schemas/ProjectModuleAssignments" }, "economicData": { "description": "Project economic configuration.", "$ref": "#/components/schemas/ProjectEconomicData" }, "status": { "description": "The current project status.", "$ref": "#/components/schemas/ProjectStatus" }, "mantTestProjectInfo": { "oneOf": [ { "type": "null" }, { "description": "Optional MantTest project information.", "$ref": "#/components/schemas/MantTestProjectInfo" } ] }, "createdAt": { "type": "string", "description": "The creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "The last modification timestamp.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Indicates whether the project is soft-deleted." }, "version": { "type": "integer", "description": "The concurrency version.", "format": "int64" } }, "description": "Represents an extended detailed projection for a project." }, "ProjectEconomicData": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "default": 0 }, "amountUnit": { "type": "string", "default": "" }, "status": { "$ref": "#/components/schemas/ProjectEconomicStatus" } } }, "ProjectEconomicStatus": { "enum": [ "Sent", "Received", "InContract", "Pending", "PartiallySent", "PartiallyReceived", "PartiallyPending", "NonBillable" ] }, "ProjectFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The project identifier." }, "deleted": { "description": "Deleted-state visibility filter.", "$ref": "#/components/schemas/DeletedFilter" } }, "description": "Represents a query that fetches project details by identifier." }, "ProjectFetchQueryResultExtended": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched extended project details.", "$ref": "#/components/schemas/ProjectDetailsExtended" } }, "description": "Represents the result of an extended project fetch query." }, "ProjectInfo": { "required": [ "id", "displayName", "alias" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "alias": { "type": "string" } } }, "ProjectionCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria applied to the count.", "$ref": "#/components/schemas/ProjectionListQueryFilter" } ] } }, "description": "Represents a query for counting projections." }, "ProjectionDetails": { "required": [ "id", "eventStoreId", "name", "moduleDisplayName", "sequence", "rebuildThreshold", "behindBy", "mode", "action", "timestamp", "exception" ], "type": "object", "properties": { "id": { "type": "string", "description": "The projection identifier." }, "eventStoreId": { "type": "string", "description": "The event store identifier for the owning module." }, "name": { "type": "string", "description": "The projection name." }, "moduleDisplayName": { "type": "string", "description": "The display name of the owning module." }, "sequence": { "type": "integer", "description": "The projection sequence position.", "format": "int64" }, "rebuildThreshold": { "type": "integer", "description": "The rebuild threshold for the projection.", "format": "int64" }, "behindBy": { "type": "integer", "description": "The lag behind the high-water mark.", "format": "int64" }, "mode": { "type": "string", "description": "The projection mode." }, "action": { "type": "string", "description": "The current projection action." }, "timestamp": { "type": "string", "description": "The projection status timestamp.", "format": "date-time" }, "exception": { "oneOf": [ { "type": "null" }, { "description": "The latest projection exception information, when present.", "$ref": "#/components/schemas/ProjectionExceptionInfo" } ] } }, "description": "Represents detailed information for a projection." }, "ProjectionExceptionInfo": { "required": [ "type", "message", "stackTrace" ], "type": "object", "properties": { "type": { "type": "string", "description": "The exception type name." }, "message": { "type": "string", "description": "The exception message." }, "stackTrace": { "type": "string", "description": "The exception stack trace." } }, "description": "Represents exception details for projection status." }, "ProjectionFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The projection identifier." }, "deleted": { "description": "The deleted-item filtering behavior.", "$ref": "#/components/schemas/DeletedFilter" } }, "description": "Represents a query for fetching projection details by identifier." }, "ProjectionFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched projection details.", "$ref": "#/components/schemas/ProjectionDetails" } }, "description": "Represents the result of a projection fetch query." }, "ProjectionItem": { "required": [ "id", "eventStoreId", "name", "moduleDisplayName", "sequence", "rebuildThreshold", "behindBy", "mode", "action", "timestamp", "exception" ], "type": "object", "properties": { "id": { "type": "string", "description": "The projection identifier." }, "eventStoreId": { "type": "string", "description": "The event store identifier for the owning module." }, "name": { "type": "string", "description": "The projection name." }, "moduleDisplayName": { "type": "string", "description": "The display name of the owning module." }, "sequence": { "type": "integer", "description": "The projection sequence position.", "format": "int64" }, "rebuildThreshold": { "type": "integer", "description": "The rebuild threshold for the projection.", "format": "int64" }, "behindBy": { "type": "integer", "description": "The lag behind the high-water mark.", "format": "int64" }, "mode": { "type": "string", "description": "The projection mode." }, "action": { "type": "string", "description": "The current projection action." }, "timestamp": { "type": "string", "description": "The projection status timestamp.", "format": "date-time" }, "exception": { "oneOf": [ { "type": "null" }, { "description": "The latest projection exception information, when present.", "$ref": "#/components/schemas/ProjectionExceptionInfo" } ] } }, "description": "Represents a list item describing a projection." }, "ProjectionListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria for the list operation.", "$ref": "#/components/schemas/ProjectionListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting instructions for the result set.", "$ref": "#/components/schemas/SortingStepsOfProjectionSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging request.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents a paged query for listing projections." }, "ProjectionListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text search criteria." } }, "description": "Represents filter criteria for projection listing." }, "ProjectionListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectionItem" }, "description": "The items returned for the current page." }, "paging": { "description": "The continuation paging metadata.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the paged result of a projection list query." }, "ProjectionRebuildBulkCommand": { "type": "object", "properties": { "ids": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Optional list of projection IDs to rebuild. Mutually exclusive with Filter." }, "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter to select projections to rebuild. Mutually exclusive with Ids.", "$ref": "#/components/schemas/ProjectionListQueryFilter" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging applied when Filter is specified.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents a command that rebuilds a bulk selection of projections identified by IDs or filter." }, "ProjectionRebuildCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The projection identifier to rebuild." } }, "description": "Represents a command that rebuilds a specific projection by identifier." }, "ProjectionSortingField": { "enum": [ "Id", "EventStoreId", "Name", "ModuleDisplayName", "Sequence", "BehindBy", "Timestamp" ], "description": "Defines sortable fields for projection list queries." }, "ProjectItem": { "required": [ "id", "alias", "displayName", "status", "amount", "amountUnit", "economicStatus", "createdAt", "modifiedAt", "deleted" ], "type": "object", "properties": { "id": { "type": "string", "description": "The project identifier." }, "alias": { "type": "string", "description": "The project alias." }, "displayName": { "type": "string", "description": "The project display name." }, "status": { "description": "The current project status.", "$ref": "#/components/schemas/ProjectStatus" }, "amount": { "type": "number", "description": "The configured project amount.", "format": "double" }, "amountUnit": { "type": "string", "description": "The amount unit." }, "economicStatus": { "description": "The project economic status.", "$ref": "#/components/schemas/ProjectEconomicStatus" }, "createdAt": { "type": "string", "description": "The creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "The last modification timestamp.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Indicates whether the project is soft-deleted." } }, "description": "Represents a list projection for a project." }, "ProjectListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filtering criteria shared with list and count operations.", "$ref": "#/components/schemas/ProjectListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting instructions for the returned items.", "$ref": "#/components/schemas/SortingStepsOfProjectSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging input.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents a paged query that lists projects." }, "ProjectListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text filter applied across searchable fields." }, "deleted": { "oneOf": [ { "type": "null" }, { "description": "Optional deleted-state filter.", "$ref": "#/components/schemas/DeletedFilter" } ] }, "alias": { "oneOf": [ { "type": "null" }, { "description": "Optional alias filter.", "$ref": "#/components/schemas/StringFilter" } ] }, "displayName": { "oneOf": [ { "type": "null" }, { "description": "Optional display-name filter.", "$ref": "#/components/schemas/StringFilter" } ] }, "status": { "oneOf": [ { "type": "null" }, { "description": "Optional project status filter.", "$ref": "#/components/schemas/EnumFilterOfProjectStatus" } ] }, "economicStatus": { "oneOf": [ { "type": "null" }, { "description": "Optional project economic status filter.", "$ref": "#/components/schemas/EnumFilterOfProjectEconomicStatus" } ] }, "createdAt": { "oneOf": [ { "type": "null" }, { "description": "Optional created-at filter.", "$ref": "#/components/schemas/DateTimeOffsetFilter" } ] }, "modifiedAt": { "oneOf": [ { "type": "null" }, { "description": "Optional modified-at filter.", "$ref": "#/components/schemas/DateTimeOffsetFilter" } ] } }, "description": "Represents filtering criteria for project list and count queries." }, "ProjectListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectItem" }, "description": "The returned project items." }, "paging": { "description": "The continuation paging state for subsequent requests.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the result of a project list query." }, "ProjectLoginMantTestCommandExtended": { "type": "object", "description": "Command contract for triggering MantTest login workflow support action." }, "ProjectModuleAssignment": { "required": [ "moduleId", "status" ], "type": "object", "properties": { "moduleId": { "type": "string" }, "status": { "$ref": "#/components/schemas/ProjectModuleAssignmentStatus" } } }, "ProjectModuleAssignments": { "required": [ "assignments" ], "type": "object", "properties": { "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectModuleAssignment" } } } }, "ProjectModuleAssignmentStatus": { "enum": [ "Initializing", "Enabled", "Removing" ] }, "ProjectRestoreCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The project identifier." } }, "description": "Represents a command to restore a project." }, "ProjectSortingField": { "enum": [ "Id", "Alias", "DisplayName", "Status", "CreatedAt", "ModifiedAt", "Deleted" ], "description": "Defines supported sorting fields for project list results." }, "ProjectStatus": { "enum": [ "Draft", "Normal", "ReadOnly", "Inactive", "Archived" ], "description": "Represents the status of a project." }, "ProjectUpdateCommandExtended": { "required": [ "id", "alias", "descriptions", "moduleAssignments", "status", "mantTestProject" ], "type": "object", "properties": { "id": { "type": "string" }, "alias": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProjectAlias" } ] }, "descriptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProjectDescriptions" } ] }, "moduleAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProjectUpdateModuleAssignments" } ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProjectUpdateStatus" } ] }, "mantTestProject": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MantTestProjectUpsertCommand" } ] } } }, "ProjectUpdateModuleAssignments": { "required": [ "addModules", "removeModules" ], "type": "object", "properties": { "addModules": { "type": "array", "items": { "type": "string" } }, "removeModules": { "type": "array", "items": { "type": "string" } } } }, "ProjectUpdateStatus": { "required": [ "status", "publicReason", "internalReason" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/ProjectStatus" }, "publicReason": { "type": "string" }, "internalReason": { "type": "string" } } }, "ProjectValidateMantTestCredentialsCommandExtended": { "required": [ "url", "alias", "userName", "password" ], "type": "object", "properties": { "url": { "type": "string" }, "alias": { "type": "string" }, "userName": { "type": "string" }, "password": { "type": "string" } } }, "RoleAccessType": { "required": [ "accessType" ], "type": "object", "properties": { "accessType": { "$ref": "#/components/schemas/AccessType" } } }, "RoleCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria to narrow the count.", "$ref": "#/components/schemas/RoleListQueryFilter" } ] } }, "description": "Query to count the roles matching an optional filter." }, "RoleCreateCommand": { "required": [ "descriptions", "accessType", "permissionAssignments", "visibility" ], "type": "object", "properties": { "descriptions": { "description": "The display name and description for the role.", "$ref": "#/components/schemas/RoleDescriptions" }, "accessType": { "description": "The access type that determines what project members can do with the role.", "$ref": "#/components/schemas/RoleAccessType" }, "permissionAssignments": { "description": "The set of permissions to assign to the role.", "$ref": "#/components/schemas/RolePermissionAssignments" }, "visibility": { "description": "Defines which user groups can see and receive the role.", "$ref": "#/components/schemas/RoleVisibility" } }, "description": "Command to create a new role with the specified descriptions, access type, permission assignments, and visibility." }, "RoleDeleteCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the role to delete." } }, "description": "Command to soft-delete a role by its identifier." }, "RoleDescriptions": { "required": [ "displayName" ], "type": "object", "properties": { "displayName": { "type": "string" }, "description": { "type": [ "null", "string" ] } } }, "RoleDetails": { "required": [ "id", "descriptions", "accessType", "permissionAssignments", "visibility", "createdAt", "modifiedAt", "deleted", "version" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the role." }, "descriptions": { "description": "The display name and description text of the role.", "$ref": "#/components/schemas/RoleDescriptions" }, "accessType": { "description": "The access type assigned to the role.", "$ref": "#/components/schemas/RoleAccessType" }, "permissionAssignments": { "description": "The set of permissions assigned to the role, each annotated with per-user modifiability.", "$ref": "#/components/schemas/RolePermissionAssignmentsView" }, "visibility": { "description": "The visibility configuration controlling which user groups receive the role.", "$ref": "#/components/schemas/RoleVisibility" }, "createdAt": { "type": "string", "description": "The UTC timestamp when the role was created.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "The UTC timestamp when the role was last modified.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Indicates whether the role has been soft-deleted." }, "version": { "type": "integer", "description": "The current event stream version of the role aggregate.", "format": "int64" } }, "description": "Full details of a role returned from a fetch operation." }, "RoleDuplicateCommand": { "required": [ "sourceId", "descriptions" ], "type": "object", "properties": { "sourceId": { "type": "string", "description": "The identifier of the role to duplicate." }, "descriptions": { "description": "The descriptions for the new duplicated role.", "$ref": "#/components/schemas/RoleDescriptions" } }, "description": "Command to create a new role by duplicating an existing one with new descriptions." }, "RoleFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the role to fetch." }, "deleted": { "description": "Controls whether to include, exclude, or require deleted state.", "$ref": "#/components/schemas/DeletedFilter" } }, "description": "Query to fetch a single role's full details by ID." }, "RoleFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The complete role details including descriptions, permissions, and metadata.", "$ref": "#/components/schemas/RoleDetails" } }, "description": "Result of a RoleFetchQuery containing the full role details." }, "RoleInfo": { "required": [ "id", "displayName" ], "type": "object", "properties": { "id": { "type": "string", "description": "The role identifier." }, "displayName": { "type": "string", "description": "The human-readable display name of the role." } }, "description": "Summary information for a role, combining the identifier and display name." }, "RoleItem": { "required": [ "id", "displayName", "accessType", "createdAt", "modifiedAt", "deleted" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the role." }, "displayName": { "type": "string", "description": "The human-readable display name of the role." }, "accessType": { "description": "The access type assigned to the role.", "$ref": "#/components/schemas/AccessType" }, "createdAt": { "type": "string", "description": "The UTC timestamp when the role was created.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "The UTC timestamp when the role was last modified.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Indicates whether the role has been soft-deleted." } }, "description": "A single role item returned in a list query result, containing summary-level fields." }, "RoleListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria to narrow results.", "$ref": "#/components/schemas/RoleListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting instructions. Defaults to display name ascending.", "$ref": "#/components/schemas/SortingStepsOfRoleSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging token and page size.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Query to retrieve a paginated, filtered, and sorted list of roles." }, "RoleListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text search against the role display name." }, "id": { "oneOf": [ { "type": "null" }, { "description": "Optional filter to include, exclude, or show only specific role IDs.", "$ref": "#/components/schemas/StringFilter" } ] }, "deleted": { "oneOf": [ { "type": "null" }, { "description": "Optional filter to include, exclude, or show only deleted roles.", "$ref": "#/components/schemas/DeletedFilter" } ] }, "displayName": { "oneOf": [ { "type": "null" }, { "description": "Optional string filter on the role display name.", "$ref": "#/components/schemas/StringFilter" } ] }, "description": { "oneOf": [ { "type": "null" }, { "description": "Optional string filter on the role description, supporting null/empty matching.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "accessType": { "oneOf": [ { "type": "null" }, { "description": "Optional enum filter on the role access type.", "$ref": "#/components/schemas/EnumFilterOfAccessType" } ] }, "createdAt": { "oneOf": [ { "type": "null" }, { "description": "Optional date/time filter on when the role was created.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "modifiedAt": { "oneOf": [ { "type": "null" }, { "description": "Optional date/time filter on when the role was last modified.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "permissionIds": { "oneOf": [ { "type": "null" }, { "description": "Optional filter to return only roles that contain all of the specified permission IDs.", "$ref": "#/components/schemas/EntityFilter" } ] } }, "description": "Filter criteria for the role list query." }, "RoleListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RoleItem" }, "description": "The list of role items matching the query filter and sorting." }, "paging": { "description": "Continuation paging token for fetching the next page of results.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Result of a RoleListQuery containing the matching role items and paging state." }, "RolePermissionAssignments": { "required": [ "permissionAssignments" ], "type": "object", "properties": { "permissionAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionAssignment" } } } }, "RolePermissionAssignmentsView": { "required": [ "permissionAssignments" ], "type": "object", "properties": { "permissionAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionAssignmentView" }, "description": "The enriched permission assignments." } }, "description": "Permission-assignments wrapper that uses PermissionAssignmentView items,\nannotating each entry with per-user modifiability." }, "RoleRestoreCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the role to restore." } }, "description": "Command to restore a previously deleted role by its identifier." }, "RoleSortingField": { "enum": [ "Id", "DisplayName", "Description", "AccessType", "CreatedAt", "ModifiedAt" ], "description": "Defines the fields by which a role list query result can be sorted." }, "RoleUpdateCommand": { "required": [ "id", "updateDescriptions", "updatePermissionAssignments", "updateVisibility" ], "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the role to update." }, "updateDescriptions": { "oneOf": [ { "type": "null" }, { "description": "Optional new descriptions to apply. When `null`, descriptions are unchanged.", "$ref": "#/components/schemas/RoleDescriptions" } ] }, "updatePermissionAssignments": { "oneOf": [ { "type": "null" }, { "description": "Optional new permission assignments to apply. When `null`, permissions are unchanged.", "$ref": "#/components/schemas/RolePermissionAssignments" } ] }, "updateVisibility": { "oneOf": [ { "type": "null" }, { "description": "Optional new visibility settings to apply. When `null`, visibility is unchanged.", "$ref": "#/components/schemas/RoleVisibility" } ] } }, "description": "Command to update an existing role's descriptions, permission assignments, and/or visibility." }, "RoleVisibility": { "required": [ "visibility" ], "type": "object", "properties": { "visibility": { "type": "array", "items": { "$ref": "#/components/schemas/EntityVisibility" } } } }, "ServiceUserScope": { "enum": [ "Global", "Tenanted" ] }, "SettingDescriptionCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria reused from the list query.", "$ref": "#/components/schemas/SettingDescriptionListQueryFilter" } ] } }, "description": "Represents the query contract for counting setting descriptions with optional filtering." }, "SettingDescriptionDetails": { "required": [ "id", "parentId", "name", "displayName", "order", "description", "dataSchema", "defaultValue", "storeScope", "readScope", "writeScope", "readPermissionId", "writePermissionId" ], "type": "object", "properties": { "id": { "type": "string", "description": "The setting identifier." }, "parentId": { "type": "string", "description": "The parent entity identifier." }, "name": { "type": "string", "description": "The internal setting name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "order": { "type": "integer", "description": "The setting order value.", "format": "int32" }, "description": { "type": [ "null", "string" ], "description": "Optional descriptive text for the setting." }, "dataSchema": { "type": "string", "description": "The serialized schema used to validate setting values." }, "defaultValue": { "type": "string", "description": "The default serialized value." }, "storeScope": { "description": "The storage scope where the value is persisted.", "$ref": "#/components/schemas/DomainSettingScope" }, "readScope": { "description": "The scope required to read the setting value.", "$ref": "#/components/schemas/DomainSettingScope" }, "writeScope": { "description": "The scope required to write the setting value.", "$ref": "#/components/schemas/DomainSettingScope" }, "readPermissionId": { "type": "string", "description": "The permission identifier required to read the setting value." }, "writePermissionId": { "type": "string", "description": "The permission identifier required to write the setting value." }, "securityLevel": { "description": "The target security level applied to persisted values for the setting.", "$ref": "#/components/schemas/SettingSecurityLevel" } }, "description": "Represents the detailed projection of a setting description." }, "SettingDescriptionFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The setting identifier to fetch." } }, "description": "Represents the query contract for fetching a setting description by identifier." }, "SettingDescriptionFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched setting details.", "$ref": "#/components/schemas/SettingDescriptionDetails" } }, "description": "Represents the result of a setting description fetch query." }, "SettingDescriptionItem": { "required": [ "id", "parentId", "name", "displayName", "order", "readScope", "writeScope" ], "type": "object", "properties": { "id": { "type": "string", "description": "The setting identifier." }, "parentId": { "type": "string", "description": "The parent entity identifier." }, "name": { "type": "string", "description": "The internal setting name." }, "displayName": { "type": "string", "description": "The display name shown to users." }, "order": { "type": "integer", "description": "The setting order value.", "format": "int32" }, "readScope": { "oneOf": [ { "type": "null" }, { "description": "The read scope of the setting, when available.", "$ref": "#/components/schemas/DomainSettingScope" } ] }, "writeScope": { "oneOf": [ { "type": "null" }, { "description": "The write scope of the setting, when available.", "$ref": "#/components/schemas/DomainSettingScope" } ] } }, "description": "Represents a setting description item returned by list queries." }, "SettingDescriptionListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria used to narrow the listed setting descriptions.", "$ref": "#/components/schemas/SettingDescriptionListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting steps applied to the result set.", "$ref": "#/components/schemas/SortingStepsOfSettingDescriptionSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging parameters.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents the query contract for listing setting descriptions with optional filtering, sorting, and paging." }, "SettingDescriptionListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional text search term applied across searchable fields." }, "parentId": { "type": [ "null", "string" ], "description": "Optional parent identifier filter." }, "displayName": { "type": [ "null", "string" ], "description": "Optional display name filter." }, "readScope": { "oneOf": [ { "type": "null" }, { "description": "Optional read scope filter.", "$ref": "#/components/schemas/DomainSettingScope" } ] }, "writeScope": { "oneOf": [ { "type": "null" }, { "description": "Optional write scope filter.", "$ref": "#/components/schemas/DomainSettingScope" } ] } }, "description": "Represents optional filter criteria for setting description list and count queries." }, "SettingDescriptionListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SettingDescriptionItem" }, "description": "The list items returned for the current page." }, "paging": { "description": "The continuation paging information for the current page.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the result of a setting description list query." }, "SettingDescriptionSortingField": { "enum": [ "Id", "ParentId", "Name", "DisplayName", "ReadScope", "WriteScope", "Order" ], "description": "Defines sortable fields for setting description list queries." }, "SettingSecurityLevel": { "enum": [ "None", "Protected", "Secured", "Hashed", "SaltedHash" ], "description": "Defines how a setting value is protected when persisted and returned.", "default": "None" }, "SettingValueCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SettingValueListQueryFilter" } ] } } }, "SettingValueDefineCommand": { "required": [ "value", "settingId" ], "type": "object", "properties": { "value": { "type": "string" }, "settingId": { "type": "string" } } }, "SettingValueDetails": { "required": [ "settingId", "scope", "value", "createdAt", "modifiedAt", "version" ], "type": "object", "properties": { "settingId": { "type": "string", "description": "The setting identifier." }, "scope": { "description": "The scope that supplied the effective value.", "$ref": "#/components/schemas/DomainSettingScope" }, "value": { "type": "string", "description": "The value formatted for the current read policy." }, "createdAt": { "type": "string", "description": "The timestamp when the persisted override was created, or when the default fallback was synthesized.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "The timestamp when the persisted override was last modified, or when the default fallback was synthesized.", "format": "date-time" }, "version": { "type": "integer", "description": "The persisted version, or `0` for a synthesized default fallback.", "format": "int64" }, "securityLevel": { "description": "The persisted or effective security level applied to the value.", "$ref": "#/components/schemas/SettingSecurityLevel" }, "isDefaultValue": { "type": "boolean", "description": "`true` when the result was synthesized from the setting default because no persisted override exists; otherwise, `false`.", "default": false } }, "description": "Represents the effective value details returned for a setting fetch operation." }, "SettingValueFetchQuery": { "required": [ "settingId" ], "type": "object", "properties": { "settingId": { "type": "string", "description": "The setting identifier." } }, "description": "Represents a query for fetching the effective value of a setting in the current scope." }, "SettingValueFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The fetched setting value details.", "$ref": "#/components/schemas/SettingValueDetails" } }, "description": "Represents the result of a setting-value fetch query." }, "SettingValueItem": { "required": [ "id", "settingId", "elementId", "elementType", "createdAt", "modifiedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "settingId": { "type": "string" }, "elementId": { "type": "string" }, "elementType": { "$ref": "#/components/schemas/DomainSettingScope" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } } }, "SettingValueListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SettingValueListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SortingStepsOfSettingValueSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } } }, "SettingValueListQueryFilter": { "type": "object", "properties": { "elementType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EnumFilterOfDomainSettingScope" } ] }, "textQuery": { "type": [ "null", "string" ] } } }, "SettingValueListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SettingValueItem" } }, "paging": { "$ref": "#/components/schemas/ContinuationQueryPaging" } } }, "SettingValueResetCommand": { "required": [ "settingId" ], "type": "object", "properties": { "settingId": { "type": "string" } } }, "SettingValueSortingField": { "enum": [ "Id", "SettingId", "CreatedAt", "ModifiedAt" ] }, "SortingDirection": { "enum": [ "Ascending", "Descending" ], "default": "Ascending" }, "SortingStepOfElementDescriptionSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/ElementDescriptionSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfEntityDescriptionSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/EntityDescriptionSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfEventStoreSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/EventStoreSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfFeatureDescriptionSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/FeatureDescriptionSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfIdentityProviderSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/IdentityProviderSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfModuleDescriptionSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/ModuleDescriptionSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfNotificationDescriptionSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/NotificationDescriptionSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfOperationDescriptionSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/OperationDescriptionSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfPermissionDescriptionSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/PermissionDescriptionSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfProjectionSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/ProjectionSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfProjectSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/ProjectSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfRoleSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/RoleSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfSettingDescriptionSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/SettingDescriptionSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfSettingValueSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/SettingValueSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfUsageLicenseContractSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/UsageLicenseContractSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfUsageLicenseProjectSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/UsageLicenseProjectSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfUsageLicenseSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/UsageLicenseSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfUserGroupSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/UserGroupSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfUserProjectSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/UserProjectSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfUserSessionSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/UserSessionSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepOfUserSortingField": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/UserSortingField" }, "direction": { "$ref": "#/components/schemas/SortingDirection" } } }, "SortingStepsOfElementDescriptionSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfElementDescriptionSortingField" } } } }, "SortingStepsOfEntityDescriptionSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfEntityDescriptionSortingField" } } } }, "SortingStepsOfEventStoreSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfEventStoreSortingField" } } } }, "SortingStepsOfFeatureDescriptionSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfFeatureDescriptionSortingField" } } } }, "SortingStepsOfIdentityProviderSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfIdentityProviderSortingField" } } } }, "SortingStepsOfModuleDescriptionSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfModuleDescriptionSortingField" } } } }, "SortingStepsOfNotificationDescriptionSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfNotificationDescriptionSortingField" } } } }, "SortingStepsOfOperationDescriptionSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfOperationDescriptionSortingField" } } } }, "SortingStepsOfPermissionDescriptionSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfPermissionDescriptionSortingField" } } } }, "SortingStepsOfProjectionSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfProjectionSortingField" } } } }, "SortingStepsOfProjectSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfProjectSortingField" } } } }, "SortingStepsOfRoleSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfRoleSortingField" } } } }, "SortingStepsOfSettingDescriptionSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfSettingDescriptionSortingField" } } } }, "SortingStepsOfSettingValueSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfSettingValueSortingField" } } } }, "SortingStepsOfUsageLicenseContractSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfUsageLicenseContractSortingField" } } } }, "SortingStepsOfUsageLicenseProjectSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfUsageLicenseProjectSortingField" } } } }, "SortingStepsOfUsageLicenseSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfUsageLicenseSortingField" } } } }, "SortingStepsOfUserGroupSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfUserGroupSortingField" } } } }, "SortingStepsOfUserProjectSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfUserProjectSortingField" } } } }, "SortingStepsOfUserSessionSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfUserSessionSortingField" } } } }, "SortingStepsOfUserSortingField": { "type": "object", "properties": { "by": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SortingStepOfUserSortingField" } } } }, "StartsWithFilter": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } } }, "StringFilter": { "type": "object", "properties": { "contains": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContainsFilter" } ] }, "startsWith": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StartsWithFilter" } ] }, "endsWith": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EndsWithFilter" } ] }, "notContains": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotContainsFilter" } ] }, "notStartsWith": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotStartsWithFilter" } ] }, "notEndsWith": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEndsWithFilter" } ] }, "equalsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EqualsToFilterOfstring" } ] }, "notEqualsTo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NotEqualsToFilterOfstring" } ] } } }, "SuccessCommandResult": { "type": "object" }, "UsageLicenseAccessDetails": { "required": [ "id", "descriptions", "security", "visibility", "createdAt", "modifiedAt", "version" ], "type": "object", "properties": { "id": { "type": "string" }, "descriptions": { "$ref": "#/components/schemas/UsageLicenseDescriptions" }, "security": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserProjectSecurity" } ] }, "visibility": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserProjectVisibility" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "format": "int64" } } }, "UsageLicenseContractCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filtering criteria shared with the list query.", "$ref": "#/components/schemas/UsageLicenseContractListQueryFilter" } ] } }, "description": "Represents a query that returns the count of usage license contracts matching an optional filter." }, "UsageLicenseContractCreateCommand": { "required": [ "usageLicenseId", "descriptions", "definition", "economicData" ], "type": "object", "properties": { "usageLicenseId": { "type": "string", "description": "Identifier of the parent usage license." }, "descriptions": { "description": "Localized descriptions for the contract.", "$ref": "#/components/schemas/UsageLicenseContractDescriptions" }, "definition": { "description": "Definition details for the contract.", "$ref": "#/components/schemas/UsageLicenseContractDefinition" }, "economicData": { "description": "Economic data associated with the contract.", "$ref": "#/components/schemas/UsageLicenseContractEconomicData" } }, "description": "Command to create a usage license contract." }, "UsageLicenseContractDefinition": { "required": [ "startDate", "endDate", "periodicity", "paymentMoment" ], "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "periodicity": { "$ref": "#/components/schemas/UsageLicenseContractPeriodicity" }, "paymentMoment": { "$ref": "#/components/schemas/UsageLicenseContractPaymentMoment" } } }, "UsageLicenseContractDescriptions": { "required": [ "proposalPath", "notes", "externalProjectCode" ], "type": "object", "properties": { "proposalPath": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "externalProjectCode": { "type": [ "null", "string" ] } } }, "UsageLicenseContractDetails": { "required": [ "id", "project", "usageLicense", "descriptions", "definition", "economicData", "renewalData", "createdAt", "modifiedAt", "version" ], "type": "object", "properties": { "id": { "type": "string" }, "project": { "$ref": "#/components/schemas/ProjectInfo" }, "usageLicense": { "$ref": "#/components/schemas/UsageLicenseInfo" }, "descriptions": { "$ref": "#/components/schemas/UsageLicenseContractDescriptions" }, "definition": { "$ref": "#/components/schemas/UsageLicenseContractDefinition" }, "economicData": { "$ref": "#/components/schemas/UsageLicenseContractEconomicData" }, "renewalData": { "$ref": "#/components/schemas/UsageLicenseContractRenewalData" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "format": "int64" } } }, "UsageLicenseContractEconomicData": { "required": [ "amount", "amountUnit", "status" ], "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "amountUnit": { "type": "string" }, "status": { "$ref": "#/components/schemas/UsageLicenseContractEconomicStatus" } } }, "UsageLicenseContractEconomicStatus": { "enum": [ "Pending", "Sent", "Received", "InContract", "Expired", "Cancelled" ] }, "UsageLicenseContractFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The usage license contract identifier." }, "deleted": { "description": "Deleted-state visibility filter.", "$ref": "#/components/schemas/DeletedFilter" } }, "description": "Represents a query that fetches usage license contract details by identifier." }, "UsageLicenseContractFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "$ref": "#/components/schemas/UsageLicenseContractDetails" } } }, "UsageLicenseContractItem": { "required": [ "id", "usageLicenseId", "projectId", "projectAlias", "usageLicenseClientName", "proposalPath", "notes", "externalProjectCode", "startDate", "endDate", "periodicity", "paymentMoment", "amount", "amountUnit", "status", "nextContractId", "renewalPhase", "noRenewalUntil", "createdAt", "modifiedAt" ], "type": "object", "properties": { "id": { "type": "string", "description": "The usage license contract identifier." }, "usageLicenseId": { "type": "string", "description": "The related usage license identifier." }, "projectId": { "type": "string", "description": "The related project identifier." }, "projectAlias": { "type": "string", "description": "The related project alias." }, "usageLicenseClientName": { "type": "string", "description": "The usage license client name." }, "proposalPath": { "type": [ "null", "string" ], "description": "The proposal path, when available." }, "notes": { "type": [ "null", "string" ], "description": "Optional free-form notes." }, "externalProjectCode": { "type": [ "null", "string" ], "description": "Optional external project code." }, "startDate": { "type": "string", "description": "The contract start date.", "format": "date-time" }, "endDate": { "type": "string", "description": "The contract end date.", "format": "date-time" }, "periodicity": { "description": "The contract periodicity.", "$ref": "#/components/schemas/UsageLicenseContractPeriodicity" }, "paymentMoment": { "description": "The payment moment.", "$ref": "#/components/schemas/UsageLicenseContractPaymentMoment" }, "amount": { "type": "number", "description": "The configured amount.", "format": "double" }, "amountUnit": { "type": "string", "description": "The amount unit." }, "status": { "description": "The economic status.", "$ref": "#/components/schemas/UsageLicenseContractEconomicStatus" }, "nextContractId": { "type": [ "null", "string" ], "description": "The identifier of the renewed child contract, when any." }, "renewalPhase": { "description": "The external renewal workflow phase.", "$ref": "#/components/schemas/UsageLicenseContractRenewalPhase" }, "noRenewalUntil": { "type": [ "null", "string" ], "description": "The date until which external automation is paused.", "format": "date-time" }, "createdAt": { "type": "string", "description": "The creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "The last modification timestamp.", "format": "date-time" } }, "description": "Represents a list projection for a usage license contract." }, "UsageLicenseContractListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filtering criteria shared with the count query.", "$ref": "#/components/schemas/UsageLicenseContractListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting instructions for the returned items.", "$ref": "#/components/schemas/SortingStepsOfUsageLicenseContractSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging input.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Represents a paged query that lists usage license contracts." }, "UsageLicenseContractListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text filter applied across searchable fields." }, "projectId": { "oneOf": [ { "type": "null" }, { "description": "Optional project identifier filter.", "$ref": "#/components/schemas/EntityFilter" } ] }, "projectAlias": { "oneOf": [ { "type": "null" }, { "description": "Optional project alias filter.", "$ref": "#/components/schemas/StringFilter" } ] }, "usageLicenseId": { "oneOf": [ { "type": "null" }, { "description": "Optional usage license identifier filter.", "$ref": "#/components/schemas/EntityFilter" } ] }, "usageLicenseClientName": { "oneOf": [ { "type": "null" }, { "description": "Optional usage license client name filter.", "$ref": "#/components/schemas/StringFilter" } ] }, "startDate": { "oneOf": [ { "type": "null" }, { "description": "Optional contract start-date filter.", "$ref": "#/components/schemas/DateTimeOffsetFilter" } ] }, "endDate": { "oneOf": [ { "type": "null" }, { "description": "Optional contract end-date filter.", "$ref": "#/components/schemas/DateTimeOffsetFilter" } ] }, "periodicity": { "oneOf": [ { "type": "null" }, { "description": "Optional periodicity filter.", "$ref": "#/components/schemas/EnumFilterOfUsageLicenseContractPeriodicity" } ] }, "paymentMoment": { "oneOf": [ { "type": "null" }, { "description": "Optional payment-moment filter.", "$ref": "#/components/schemas/EnumFilterOfUsageLicenseContractPaymentMoment" } ] }, "amount": { "oneOf": [ { "type": "null" }, { "description": "Optional amount filter.", "$ref": "#/components/schemas/DecimalFilter" } ] }, "status": { "oneOf": [ { "type": "null" }, { "description": "Optional economic-status filter.", "$ref": "#/components/schemas/EnumFilterOfUsageLicenseContractEconomicStatus" } ] }, "nextContractId": { "oneOf": [ { "type": "null" }, { "description": "Optional child-contract presence or value filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "noRenewalUntil": { "oneOf": [ { "type": "null" }, { "description": "Optional no-renewal-until filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "createdAt": { "oneOf": [ { "type": "null" }, { "description": "Optional created-at filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "modifiedAt": { "oneOf": [ { "type": "null" }, { "description": "Optional modified-at filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] } }, "description": "Represents filtering criteria for usage license contract list and count queries." }, "UsageLicenseContractListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseContractItem" }, "description": "The returned usage license contract items." }, "paging": { "description": "The continuation paging state for subsequent requests.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Represents the result of a usage license contract list query." }, "UsageLicenseContractPaymentMoment": { "enum": [ "InAdvance", "FirstMonth", "SecondMonth", "ThirdMonth" ] }, "UsageLicenseContractPeriodicity": { "enum": [ "Monthly", "Quarterly", "SemiAnnually", "Annually" ] }, "UsageLicenseContractRenewalData": { "required": [ "nextContractId", "renewalPhase", "noRenewalUntil" ], "type": "object", "properties": { "nextContractId": { "type": [ "null", "string" ], "description": "Identifier of the renewed child contract linked to this contract, when one exists." }, "renewalPhase": { "oneOf": [ { "type": "null" }, { "description": "Current external renewal workflow phase for the contract.", "$ref": "#/components/schemas/UsageLicenseContractRenewalPhase" } ] }, "noRenewalUntil": { "type": [ "null", "string" ], "description": "Date until which renewal processing is blocked.", "format": "date-time" } }, "description": "Describes the renewal state associated with a usage license contract." }, "UsageLicenseContractRenewalPhase": { "enum": [ "Phase0", "Phase1", "Phase2", "Phase3", "Phase4", "Phase5" ] }, "UsageLicenseContractRenewCommand": { "required": [ "parentContractId", "amount", "proposalPath", "externalProjectCode" ], "type": "object", "properties": { "parentContractId": { "type": "string", "description": "Identifier of the contract being renewed." }, "amount": { "type": "number", "description": "Final renewed amount resolved by the caller.", "format": "double" }, "proposalPath": { "type": "string", "description": "Final renewed route resolved by the caller." }, "externalProjectCode": { "type": "string", "description": "Final renewed Netsuite code resolved by the caller." } }, "description": "Command to renew an existing usage license contract by creating its child contract." }, "UsageLicenseContractSortingField": { "enum": [ "Id", "ProjectId", "ProjectAlias", "UsageLicenseId", "UsageLicenseClientName", "StartDate", "EndDate", "PaymentMoment", "Periodicity", "Amount", "Status", "CreatedAt", "ModifiedAt" ], "description": "Defines supported sorting fields for usage license contract list results." }, "UsageLicenseContractUpdateCommand": { "required": [ "id", "updateDescriptions", "updateDefinition", "updateEconomicData", "updateRenewalData" ], "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the contract to update." }, "updateDescriptions": { "oneOf": [ { "type": "null" }, { "description": "Updated localized descriptions, when provided.", "$ref": "#/components/schemas/UsageLicenseContractDescriptions" } ] }, "updateDefinition": { "oneOf": [ { "type": "null" }, { "description": "Updated definition details, when provided.", "$ref": "#/components/schemas/UsageLicenseContractDefinition" } ] }, "updateEconomicData": { "oneOf": [ { "type": "null" }, { "description": "Updated economic data, when provided.", "$ref": "#/components/schemas/UsageLicenseContractEconomicData" } ] }, "updateRenewalData": { "oneOf": [ { "type": "null" }, { "description": "Updated renewal data, when provided.", "$ref": "#/components/schemas/UsageLicenseContractRenewalData" } ] } }, "description": "Command to update a usage license contract." }, "UsageLicenseContractUpdateRenewalStatusCommand": { "required": [ "id", "currentDate" ], "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the contract to update." }, "currentDate": { "type": "string", "description": "Current date used to calculate the theoretical renewal phase.", "format": "date-time" } }, "description": "Command to update external renewal workflow state for a usage license contract." }, "UsageLicenseCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UsageLicenseListQueryFilter" } ] } } }, "UsageLicenseCreateCommand": { "required": [ "projectId", "descriptions", "usageLimits", "identityProvider" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Project identifier." }, "descriptions": { "description": "Usage license descriptions.", "$ref": "#/components/schemas/UsageLicenseDescriptions" }, "usageLimits": { "description": "Usage limits.", "$ref": "#/components/schemas/UsageLicenseLimits" }, "identityProvider": { "description": "Identity provider settings.", "$ref": "#/components/schemas/UsageLicenseIdentityProvider" } }, "description": "Creates a usage license for a project." }, "UsageLicenseDesc": { "required": [ "usageLicenseId", "clientName", "projectId", "projectAlias" ], "type": "object", "properties": { "usageLicenseId": { "type": "string", "description": "The usage license identifier." }, "clientName": { "type": "string", "description": "The client display name." }, "projectId": { "type": "string", "description": "The related project identifier." }, "projectAlias": { "type": "string", "description": "The related project alias." } }, "description": "Usage license descriptor used in user session creation responses." }, "UsageLicenseDescriptions": { "required": [ "clientName", "clientCulture", "clientContacts", "responsibleForRenewals", "petitionRequired", "nonBillableLicense" ], "type": "object", "properties": { "clientName": { "type": "string" }, "clientCulture": { "type": "string" }, "clientContacts": { "type": "array", "items": { "type": "string" } }, "responsibleForRenewals": { "type": "array", "items": { "type": "string" } }, "petitionRequired": { "type": "boolean" }, "nonBillableLicense": { "type": "boolean" }, "automaticRenewal": { "type": "boolean", "default": false }, "otherServices": { "type": [ "null", "string" ] }, "excludeIpc": { "type": "boolean", "default": false } } }, "UsageLicenseDetails": { "required": [ "id", "project", "descriptions", "usageLimits", "economicData", "identityProvider", "security", "visibility", "createdAt", "modifiedAt", "version" ], "type": "object", "properties": { "id": { "type": "string" }, "project": { "$ref": "#/components/schemas/ProjectInfo" }, "descriptions": { "$ref": "#/components/schemas/UsageLicenseDescriptions" }, "usageLimits": { "$ref": "#/components/schemas/UsageLicenseLimits" }, "economicData": { "$ref": "#/components/schemas/UsageLicenseEconomicData" }, "identityProvider": { "$ref": "#/components/schemas/UsageLicenseIdentityProvider" }, "security": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserProjectSecurity" } ] }, "visibility": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserProjectVisibility" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "format": "int64" } } }, "UsageLicenseEconomicData": { "required": [ "amount", "amountUnit", "status" ], "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "amountUnit": { "type": "string" }, "status": { "$ref": "#/components/schemas/UsageLicenseEconomicStatus" } } }, "UsageLicenseEconomicStatus": { "enum": [ "Sent", "Received", "InContract", "Pending" ] }, "UsageLicenseFetchAccessBatchQuery": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "deleted": { "$ref": "#/components/schemas/DeletedFilter" }, "notFoundIsError": { "type": "boolean", "default": false } } }, "UsageLicenseFetchAccessBatchQueryResult": { "required": [ "items", "notFound" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseAccessDetails" } }, "notFound": { "type": "array", "items": { "type": "string" } } } }, "UsageLicenseFetchAccessQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "$ref": "#/components/schemas/DeletedFilter" } } }, "UsageLicenseFetchAccessQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "$ref": "#/components/schemas/UsageLicenseAccessDetails" } } }, "UsageLicenseFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "$ref": "#/components/schemas/DeletedFilter" } } }, "UsageLicenseFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "$ref": "#/components/schemas/UsageLicenseDetails" } } }, "UsageLicenseIdentityProvider": { "required": [ "identityProviderId" ], "type": "object", "properties": { "identityProviderId": { "type": [ "null", "string" ] } } }, "UsageLicenseInfo": { "required": [ "id", "clientName" ], "type": "object", "properties": { "id": { "type": "string" }, "clientName": { "type": "string" } } }, "UsageLicenseItem": { "required": [ "id", "projectId", "clientName", "responsibleForRenewals", "petitionRequired", "nonBillableLicense", "amount", "amountUnit", "status", "hasIdentityProvider", "createdAt", "modifiedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "clientName": { "type": "string" }, "responsibleForRenewals": { "type": "string" }, "petitionRequired": { "type": "boolean" }, "nonBillableLicense": { "type": "boolean" }, "amount": { "type": "number", "format": "double" }, "amountUnit": { "type": "string" }, "status": { "$ref": "#/components/schemas/UsageLicenseEconomicStatus" }, "hasIdentityProvider": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } } }, "UsageLicenseLimit": { "required": [ "maximumUsage", "doNotLimit" ], "type": "object", "properties": { "maximumUsage": { "type": "integer", "format": "int32" }, "doNotLimit": { "type": "boolean" } } }, "UsageLicenseLimits": { "required": [ "managers", "workers", "readers", "endUsers" ], "type": "object", "properties": { "managers": { "$ref": "#/components/schemas/UsageLicenseLimit" }, "workers": { "$ref": "#/components/schemas/UsageLicenseLimit" }, "readers": { "$ref": "#/components/schemas/UsageLicenseLimit" }, "endUsers": { "$ref": "#/components/schemas/UsageLicenseLimit" } } }, "UsageLicenseListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UsageLicenseListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SortingStepsOfUsageLicenseSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } } }, "UsageLicenseListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ] }, "projectId": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EntityFilter" } ] }, "clientName": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StringFilter" } ] }, "petitionRequired": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BoolFilter" } ] }, "nonBillableLicense": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BoolFilter" } ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EnumFilterOfUsageLicenseEconomicStatus" } ] }, "identityProvider": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OptionalEntityFilter" } ] }, "accessType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OptionalEnumFilterOfAccessType" } ] }, "createdAt": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "modifiedAt": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] } } }, "UsageLicenseListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseItem" } }, "paging": { "$ref": "#/components/schemas/ContinuationQueryPaging" } } }, "UsageLicenseProjectCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UsageLicenseProjectListQueryFilter" } ] } } }, "UsageLicenseProjectItem": { "required": [ "id", "clientName", "createdAt", "modifiedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "clientName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" } } }, "UsageLicenseProjectListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UsageLicenseProjectListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SortingStepsOfUsageLicenseProjectSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } } }, "UsageLicenseProjectListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ] } } }, "UsageLicenseProjectListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLicenseProjectItem" } }, "paging": { "$ref": "#/components/schemas/ContinuationQueryPaging" } } }, "UsageLicenseProjectSortingField": { "enum": [ "Id", "ClientName" ] }, "UsageLicenseSortingField": { "enum": [ "Id", "ClientName", "PetitionRequired", "NonBillableLicense", "Status", "Amount", "CreatedAt", "ModifiedAt" ] }, "UsageLicenseUpdateAccessCommand": { "required": [ "id", "updateSecurity", "updateVisibility" ], "type": "object", "properties": { "id": { "type": "string", "description": "Usage license identifier." }, "updateSecurity": { "oneOf": [ { "type": "null" }, { "description": "Optional security update.", "$ref": "#/components/schemas/UserProjectSecurity" } ] }, "updateVisibility": { "oneOf": [ { "type": "null" }, { "description": "Optional visibility update.", "$ref": "#/components/schemas/UserProjectVisibility" } ] } }, "description": "Updates usage license access settings." }, "UsageLicenseUpdateCommand": { "required": [ "id", "updateDescriptions", "updateUsageLimits", "updateIdentityProvider" ], "type": "object", "properties": { "id": { "type": "string", "description": "Usage license identifier." }, "updateDescriptions": { "oneOf": [ { "type": "null" }, { "description": "Optional descriptions update.", "$ref": "#/components/schemas/UsageLicenseDescriptions" } ] }, "updateUsageLimits": { "oneOf": [ { "type": "null" }, { "description": "Optional usage limits update.", "$ref": "#/components/schemas/UsageLicenseLimits" } ] }, "updateIdentityProvider": { "oneOf": [ { "type": "null" }, { "description": "Optional identity provider update.", "$ref": "#/components/schemas/UsageLicenseIdentityProvider" } ] } }, "description": "Updates usage license fields." }, "UserActive": { "required": [ "isActive" ], "type": "object", "properties": { "isActive": { "type": "boolean" }, "publicReason": { "type": [ "null", "string" ], "description": "This property is required if IsActive is false, and null otherwise." }, "internalReason": { "type": [ "null", "string" ], "description": "This property is required if IsActive is false, and null otherwise." } } }, "UserContact": { "required": [ "contactId", "displayName", "contactTypeId", "value" ], "type": "object", "properties": { "contactId": { "type": "string" }, "displayName": { "type": "string" }, "contactTypeId": { "type": "string" }, "value": { "type": "string" } } }, "UserContacts": { "required": [ "contacts" ], "type": "object", "properties": { "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/UserContact" } } } }, "UserCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria shared with list queries.", "$ref": "#/components/schemas/UserListQueryFilter" } ] } }, "description": "Query to count users matching an optional filter." }, "UserCreateGlobalAdministratorCommand": { "required": [ "email", "descriptions", "contacts", "active" ], "type": "object", "properties": { "email": { "type": "string" }, "descriptions": { "$ref": "#/components/schemas/UserDescriptions" }, "contacts": { "$ref": "#/components/schemas/UserContacts" }, "active": { "$ref": "#/components/schemas/UserActive" } }, "description": "Command to create a global administrator user." }, "UserCreateLocalCommand": { "required": [ "email", "descriptions", "contacts", "active" ], "type": "object", "properties": { "email": { "type": "string" }, "descriptions": { "$ref": "#/components/schemas/UserDescriptions" }, "contacts": { "$ref": "#/components/schemas/UserContacts" }, "active": { "$ref": "#/components/schemas/UserActive" } }, "description": "Command to create a local user." }, "UserCreateServiceCommand": { "required": [ "email", "descriptions", "contacts", "active", "scope" ], "type": "object", "properties": { "email": { "type": "string", "description": "Service user email address." }, "descriptions": { "description": "Display name and optional name parts.", "$ref": "#/components/schemas/UserDescriptions" }, "contacts": { "description": "Contact information.", "$ref": "#/components/schemas/UserContacts" }, "active": { "description": "Initial activation state.", "$ref": "#/components/schemas/UserActive" }, "scope": { "description": "Determines whether the service user operates with global admin-level access\n(ServiceUserScope.Global) or as a tenanted user subject to project\nRBAC and quota (ServiceUserScope.Tenanted).", "$ref": "#/components/schemas/ServiceUserScope" } }, "description": "Command to create a service user. TDP always creates and manages the Entra ID\napplication registration; linking to an existing app is not supported." }, "UserDeleteCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } }, "description": "Command to delete a user." }, "UserDescriptions": { "required": [ "displayName" ], "type": "object", "properties": { "displayName": { "type": "string" }, "givenName": { "type": [ "null", "string" ] }, "surname": { "type": [ "null", "string" ] } } }, "UserDetailsExtended": { "required": [ "id", "userType", "email", "descriptions", "requiredContacts", "contacts", "active", "externalIdentifiers", "serviceIdentifiers", "purge", "lastLoginDate", "createdAt", "modifiedAt", "deleted", "version" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique user identifier." }, "userType": { "description": "User classification.", "$ref": "#/components/schemas/UserType" }, "email": { "type": "string", "description": "User email address." }, "descriptions": { "description": "User description values.", "$ref": "#/components/schemas/UserDescriptions" }, "requiredContacts": { "description": "Required contact information.", "$ref": "#/components/schemas/UserContacts" }, "contacts": { "description": "Optional contact information.", "$ref": "#/components/schemas/UserContacts" }, "active": { "description": "User active state details.", "$ref": "#/components/schemas/UserActive" }, "externalIdentifiers": { "oneOf": [ { "type": "null" }, { "description": "External identity provider identifiers.", "$ref": "#/components/schemas/UserExternalIdentifiers" } ] }, "serviceIdentifiers": { "oneOf": [ { "type": "null" }, { "description": "Service identifiers value object.", "$ref": "#/components/schemas/UserServiceIdentifiers" } ] }, "purge": { "oneOf": [ { "type": "null" }, { "description": "Purge metadata for soft-delete lifecycle.", "$ref": "#/components/schemas/UserPurge" } ] }, "lastLoginDate": { "type": [ "null", "string" ], "description": "Most recent user login timestamp.", "format": "date-time" }, "createdAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Soft-delete flag." }, "version": { "type": "integer", "description": "Concurrency version.", "format": "int64" } }, "description": "Extended user details model including last login date." }, "UserExternalIdentifiers": { "required": [ "objectId" ], "type": "object", "properties": { "objectId": { "type": "string" }, "identityProviderId": { "type": [ "null", "string" ] } } }, "UserFetchByEmailStatus": { "enum": [ "Exists", "NotExists", "Deleted" ] }, "UserFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "User identifier." }, "deleted": { "description": "Soft-delete filter.", "$ref": "#/components/schemas/DeletedFilter" } }, "description": "Query to fetch one user by identifier." }, "UserFetchQueryResultExtended": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "Extended user details payload.", "$ref": "#/components/schemas/UserDetailsExtended" } }, "description": "Extended fetch query result containing user details and derived metadata." }, "UserGroupCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filters to apply when counting user groups.", "$ref": "#/components/schemas/UserGroupListQueryFilter" } ] } }, "description": "Query to count user groups matching optional filter criteria." }, "UserGroupCreateCommand": { "required": [ "descriptions" ], "type": "object", "properties": { "descriptions": { "description": "The display name and optional description for the new user group.", "$ref": "#/components/schemas/UserGroupDescriptions" } }, "description": "Command to create a new user group." }, "UserGroupDeleteCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user group to delete." } }, "description": "Command to delete a user group." }, "UserGroupDescriptions": { "required": [ "displayName" ], "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the user group." }, "description": { "type": [ "null", "string" ], "description": "An optional description providing additional context about the user group." } }, "description": "Represents the display and descriptive information for a user group." }, "UserGroupDetails": { "required": [ "id", "descriptions", "createdAt", "modifiedAt", "deleted", "version" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user group." }, "descriptions": { "description": "The display name and optional description of the user group.", "$ref": "#/components/schemas/UserGroupDescriptions" }, "createdAt": { "type": "string", "description": "The date and time when the user group was created.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "The date and time when the user group was last modified.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Indicates whether the user group has been deleted." }, "version": { "type": "integer", "description": "The version number of the user group aggregate for concurrency control.", "format": "int64" } }, "description": "Contains complete details about a user group." }, "UserGroupFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user group to retrieve." }, "deleted": { "description": "Filter to include, exclude, or show only deleted user groups.", "$ref": "#/components/schemas/DeletedFilter" } }, "description": "Query to fetch detailed information about a specific user group." }, "UserGroupFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "The detailed information about the user group.", "$ref": "#/components/schemas/UserGroupDetails" } }, "description": "The result containing detailed information about a fetched user group." }, "UserGroupItem": { "required": [ "id", "displayName", "createdAt", "modifiedAt", "deleted" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user group." }, "displayName": { "type": "string", "description": "The display name of the user group." }, "createdAt": { "type": "string", "description": "The date and time when the user group was created.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "The date and time when the user group was last modified.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Indicates whether the user group has been deleted." } }, "description": "Represents a summary of a user group in list results." }, "UserGroupListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filters to apply to the list query.", "$ref": "#/components/schemas/UserGroupListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting configuration for result ordering.", "$ref": "#/components/schemas/SortingStepsOfUserGroupSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional pagination parameters to limit and offset results.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Query to retrieve a paginated list of user groups." }, "UserGroupListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional full-text search query against user group names and descriptions." }, "deleted": { "oneOf": [ { "type": "null" }, { "description": "Optional filter to include, exclude, or show only deleted user groups.", "$ref": "#/components/schemas/DeletedFilter" } ] }, "displayName": { "oneOf": [ { "type": "null" }, { "description": "Optional filter to match against user group display names.", "$ref": "#/components/schemas/StringFilter" } ] }, "description": { "oneOf": [ { "type": "null" }, { "description": "Optional filter to match against user group descriptions.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "createdAt": { "oneOf": [ { "type": "null" }, { "description": "Optional filter on user group creation date and time.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "modifiedAt": { "oneOf": [ { "type": "null" }, { "description": "Optional filter on user group modification date and time.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] } }, "description": "Filter criteria for user group list queries." }, "UserGroupListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupItem" }, "description": "The collection of user group items matching the query criteria." }, "paging": { "description": "Pagination information for navigating the result set.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "The result set from a user group list query." }, "UserGroupRestoreCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user group to restore." } }, "description": "Command to restore a deleted user group." }, "UserGroupSortingField": { "enum": [ "Id", "DisplayName", "CreatedAt", "ModifiedAt" ], "description": "Enumeration of fields available for sorting user group list results." }, "UserGroupUpdateCommand": { "required": [ "id", "updateDescriptions" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user group to update." }, "updateDescriptions": { "oneOf": [ { "type": "null" }, { "description": "The updated display name and optional description. Only non-null values will be updated.", "$ref": "#/components/schemas/UserGroupDescriptions" } ] } }, "description": "Command to update an existing user group." }, "UserInfo": { "required": [ "id", "displayName", "email", "purgeDate" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "purgeDate": { "type": [ "null", "string" ], "format": "date-time" } } }, "UserItem": { "required": [ "id", "type", "email", "displayName", "givenName", "surname", "isActive", "objectId", "identityProviderId", "clientId", "serviceUserScope", "purgeDate", "lastLoginDate", "createdAt", "modifiedAt", "deleted" ], "type": "object", "properties": { "id": { "type": "string", "description": "User identifier." }, "type": { "description": "User type value.", "$ref": "#/components/schemas/UserType" }, "email": { "type": "string", "description": "User email address." }, "displayName": { "type": "string", "description": "Display name." }, "givenName": { "type": [ "null", "string" ], "description": "Given name." }, "surname": { "type": [ "null", "string" ], "description": "Surname." }, "isActive": { "type": "boolean", "description": "Indicates whether the user is active." }, "objectId": { "type": [ "null", "string" ], "description": "External object identifier." }, "identityProviderId": { "type": [ "null", "string" ], "description": "Identity provider identifier." }, "clientId": { "type": [ "null", "string" ], "description": "Client identifier." }, "serviceUserScope": { "oneOf": [ { "type": "null" }, { "description": "Scope of the service user; null for non-service users.", "$ref": "#/components/schemas/ServiceUserScope" } ] }, "purgeDate": { "type": [ "null", "string" ], "description": "Scheduled purge date.", "format": "date-time" }, "lastLoginDate": { "type": [ "null", "string" ], "description": "Most recent login timestamp.", "format": "date-time" }, "createdAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Soft-delete flag." } }, "description": "User list-item projection." }, "UserListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria.", "$ref": "#/components/schemas/UserListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting steps.", "$ref": "#/components/schemas/SortingStepsOfUserSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging request.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Query to list users with optional filtering, sorting, and continuation paging." }, "UserListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Full-text query term." }, "deleted": { "oneOf": [ { "type": "null" }, { "description": "Soft-delete filter.", "$ref": "#/components/schemas/DeletedFilter" } ] }, "type": { "oneOf": [ { "type": "null" }, { "description": "User type filter.", "$ref": "#/components/schemas/EnumFilterOfUserType" } ] }, "email": { "oneOf": [ { "type": "null" }, { "description": "Email filter.", "$ref": "#/components/schemas/StringFilter" } ] }, "displayName": { "oneOf": [ { "type": "null" }, { "description": "Display-name filter.", "$ref": "#/components/schemas/StringFilter" } ] }, "objectId": { "oneOf": [ { "type": "null" }, { "description": "External object-id filter.", "$ref": "#/components/schemas/StringFilter" } ] }, "givenName": { "oneOf": [ { "type": "null" }, { "description": "Given-name filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "surname": { "oneOf": [ { "type": "null" }, { "description": "Surname filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "isActive": { "oneOf": [ { "type": "null" }, { "description": "Active-state filter.", "$ref": "#/components/schemas/BoolFilter" } ] }, "lastLoginDate": { "oneOf": [ { "type": "null" }, { "description": "Last-login-date filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "createdAt": { "oneOf": [ { "type": "null" }, { "description": "Creation-date filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "modifiedAt": { "oneOf": [ { "type": "null" }, { "description": "Modification-date filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] } }, "description": "Filter criteria for listing users." }, "UserListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserItem" }, "description": "Current page items." }, "paging": { "description": "Continuation paging metadata.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Paged result for user list queries." }, "UserProjectActive": { "required": [ "isActive" ], "type": "object", "properties": { "isActive": { "type": "boolean" }, "publicReason": { "type": [ "null", "string" ] }, "internalReason": { "type": [ "null", "string" ] } } }, "UserProjectCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria.", "$ref": "#/components/schemas/UserProjectListQueryFilter" } ] } }, "description": "Query contract for counting user-project associations that match optional filters." }, "UserProjectCreateCommand": { "required": [ "defineUser", "license", "security", "visibility", "groups", "active" ], "type": "object", "properties": { "defineUser": { "description": "The user identity details to assign.", "$ref": "#/components/schemas/UserProjectDefineUser" }, "license": { "description": "The usage license configuration.", "$ref": "#/components/schemas/UserProjectLicense" }, "security": { "description": "The security configuration for the user project.", "$ref": "#/components/schemas/UserProjectSecurity" }, "visibility": { "description": "The visibility configuration for the user project.", "$ref": "#/components/schemas/UserProjectVisibility" }, "groups": { "description": "The group membership configuration.", "$ref": "#/components/schemas/UserProjectGroups" }, "active": { "description": "The activation status configuration.", "$ref": "#/components/schemas/UserProjectActive" } }, "description": "Command to create a user project assignment." }, "UserProjectDefineUser": { "type": "object", "properties": { "userId": { "type": [ "null", "string" ] }, "user": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserCreateLocalCommand" } ] } } }, "UserProjectDeleteCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user project assignment to delete." } }, "description": "Command to delete a user project assignment." }, "UserProjectDetailsExtended": { "required": [ "id", "user", "project", "usageLicense", "security", "visibility", "groups", "active", "lastLoginDate", "createdAt", "modifiedAt", "deleted" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique user-project identifier." }, "user": { "description": "User summary information.", "$ref": "#/components/schemas/UserInfo" }, "project": { "description": "Project summary information.", "$ref": "#/components/schemas/ProjectInfo" }, "usageLicense": { "oneOf": [ { "type": "null" }, { "description": "Usage license summary when available.", "$ref": "#/components/schemas/UsageLicenseInfo" } ] }, "security": { "description": "Security settings with resolved role names for the relation.", "$ref": "#/components/schemas/UserProjectSecurityExtended" }, "visibility": { "description": "Visibility settings for the relation.", "$ref": "#/components/schemas/UserProjectVisibility" }, "groups": { "description": "Group assignment details.", "$ref": "#/components/schemas/UserProjectGroups" }, "active": { "description": "Active-state details.", "$ref": "#/components/schemas/UserProjectActive" }, "lastLoginDate": { "type": [ "null", "string" ], "description": "Most recent login timestamp for the relation.", "format": "date-time" }, "createdAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Soft-delete flag." } }, "description": "Extended user-project details with enriched user/project/license references." }, "UserProjectEmailStatusQuery": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "description": "Email to evaluate." } }, "description": "Query contract for resolving user and user-project status by email." }, "UserProjectEmailStatusQueryResult": { "required": [ "userId", "userStatus", "userProjectId", "userProjectStatus" ], "type": "object", "properties": { "userId": { "type": [ "null", "string" ], "description": "Matched user identifier when available." }, "userStatus": { "description": "Status of user lookup by email.", "$ref": "#/components/schemas/UserFetchByEmailStatus" }, "userProjectId": { "type": [ "null", "string" ], "description": "Matched user-project identifier when available." }, "userProjectStatus": { "description": "Status of user-project lookup by email.", "$ref": "#/components/schemas/UserFetchByEmailStatus" } }, "description": "Result contract for UserProjectEmailStatusQuery." }, "UserProjectFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "User-project identifier." }, "deleted": { "description": "Deleted-state filter.", "$ref": "#/components/schemas/DeletedFilter" } }, "description": "Query contract for fetching a user-project association by identifier." }, "UserProjectFetchQueryResultExtended": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "Extended user-project details.", "$ref": "#/components/schemas/UserProjectDetailsExtended" } }, "description": "Extended fetch query result for a user-project relation." }, "UserProjectGroups": { "required": [ "groupAssignments" ], "type": "object", "properties": { "groupAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAssignment" } }, "defaultGroup": { "type": [ "null", "string" ] } } }, "UserProjectItemExtended": { "required": [ "id", "usageLicenseId", "userType", "userEmail", "displayName", "givenName", "surname", "roleCount", "accessType", "hasDefaultGroup", "groupAssignmentCount", "isActive", "purgeDate", "lastLoginDate", "createdAt", "modifiedAt", "deleted" ], "type": "object", "properties": { "id": { "type": "string", "description": "User-project identifier." }, "usageLicenseId": { "type": "string", "description": "Usage license identifier." }, "userType": { "oneOf": [ { "type": "null" }, { "description": "User type value.", "$ref": "#/components/schemas/UserType" } ] }, "userEmail": { "type": [ "null", "string" ], "description": "User email value." }, "displayName": { "type": [ "null", "string" ], "description": "User display name." }, "givenName": { "type": [ "null", "string" ], "description": "User given name." }, "surname": { "type": [ "null", "string" ], "description": "User surname." }, "roleCount": { "type": "integer", "description": "Assigned role count.", "format": "int32" }, "accessType": { "description": "Access type.", "$ref": "#/components/schemas/AccessType" }, "hasDefaultGroup": { "type": "boolean", "description": "Indicates whether a default group is assigned." }, "groupAssignmentCount": { "type": "integer", "description": "Assigned group count.", "format": "int32" }, "isActive": { "type": "boolean", "description": "Indicates whether relation is active." }, "purgeDate": { "type": [ "null", "string" ], "description": "Scheduled purge date.", "format": "date-time" }, "lastLoginDate": { "type": [ "null", "string" ], "description": "Most recent login timestamp.", "format": "date-time" }, "createdAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Soft-delete flag." } }, "description": "Extended list item model for user-project entities." }, "UserProjectLicense": { "required": [ "usageLicenseId" ], "type": "object", "properties": { "usageLicenseId": { "type": "string" } } }, "UserProjectListQueryExtended": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria for narrowing list results.", "$ref": "#/components/schemas/UserProjectListQueryFilterExtended" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting configuration for result ordering.", "$ref": "#/components/schemas/SortingStepsOfUserProjectSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging configuration.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Extended list query for user-project entities." }, "UserProjectListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text query." }, "deleted": { "oneOf": [ { "type": "null" }, { "description": "Optional soft-delete filter.", "$ref": "#/components/schemas/DeletedFilter" } ] }, "userId": { "oneOf": [ { "type": "null" }, { "description": "Optional user identifier filter.", "$ref": "#/components/schemas/EntityFilter" } ] }, "usageLicenseId": { "oneOf": [ { "type": "null" }, { "description": "Optional usage-license identifier filter.", "$ref": "#/components/schemas/EntityFilter" } ] }, "userType": { "oneOf": [ { "type": "null" }, { "description": "Optional user type filter.", "$ref": "#/components/schemas/OptionalEnumFilterOfUserType" } ] }, "userEmail": { "oneOf": [ { "type": "null" }, { "description": "Optional user email filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "displayName": { "oneOf": [ { "type": "null" }, { "description": "Optional display-name filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "givenName": { "oneOf": [ { "type": "null" }, { "description": "Optional given-name filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "surname": { "oneOf": [ { "type": "null" }, { "description": "Optional surname filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "roles": { "oneOf": [ { "type": "null" }, { "description": "Optional role assignment filter.", "$ref": "#/components/schemas/EntityFilter" } ] }, "roleCount": { "oneOf": [ { "type": "null" }, { "description": "Optional role-count filter.", "$ref": "#/components/schemas/Int32Filter" } ] }, "accessType": { "oneOf": [ { "type": "null" }, { "description": "Optional access-type filter.", "$ref": "#/components/schemas/EnumFilterOfAccessType" } ] }, "hasDefaultGroup": { "oneOf": [ { "type": "null" }, { "description": "Optional default-group flag filter.", "$ref": "#/components/schemas/BoolFilter" } ] }, "groupAssignments": { "oneOf": [ { "type": "null" }, { "description": "Optional group assignment filter.", "$ref": "#/components/schemas/EntityFilter" } ] }, "groupAssignmentCount": { "oneOf": [ { "type": "null" }, { "description": "Optional group-assignment-count filter.", "$ref": "#/components/schemas/Int32Filter" } ] }, "isActive": { "oneOf": [ { "type": "null" }, { "description": "Optional active-state filter.", "$ref": "#/components/schemas/BoolFilter" } ] }, "createdAt": { "oneOf": [ { "type": "null" }, { "description": "Optional creation timestamp filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "modifiedAt": { "oneOf": [ { "type": "null" }, { "description": "Optional modification timestamp filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] } }, "description": "Filter criteria for UserProjectListQuery." }, "UserProjectListQueryFilterExtended": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Optional free-text query." }, "deleted": { "oneOf": [ { "type": "null" }, { "description": "Optional soft-delete filter.", "$ref": "#/components/schemas/DeletedFilter" } ] }, "usageLicenseId": { "oneOf": [ { "type": "null" }, { "description": "Optional usage-license identifier filter.", "$ref": "#/components/schemas/EntityFilter" } ] }, "userType": { "oneOf": [ { "type": "null" }, { "description": "Optional user type filter.", "$ref": "#/components/schemas/OptionalEnumFilterOfUserType" } ] }, "userEmail": { "oneOf": [ { "type": "null" }, { "description": "Optional user email filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "displayName": { "oneOf": [ { "type": "null" }, { "description": "Optional display-name filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "givenName": { "oneOf": [ { "type": "null" }, { "description": "Optional given-name filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "surname": { "oneOf": [ { "type": "null" }, { "description": "Optional surname filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "roles": { "oneOf": [ { "type": "null" }, { "description": "Optional role assignment filter.", "$ref": "#/components/schemas/EntityFilter" } ] }, "roleCount": { "oneOf": [ { "type": "null" }, { "description": "Optional role-count filter.", "$ref": "#/components/schemas/Int32Filter" } ] }, "accessType": { "oneOf": [ { "type": "null" }, { "description": "Optional access-type filter.", "$ref": "#/components/schemas/EnumFilterOfAccessType" } ] }, "hasDefaultGroup": { "oneOf": [ { "type": "null" }, { "description": "Optional default-group flag filter.", "$ref": "#/components/schemas/BoolFilter" } ] }, "groupAssignments": { "oneOf": [ { "type": "null" }, { "description": "Optional group assignment filter.", "$ref": "#/components/schemas/EntityFilter" } ] }, "groupAssignmentCount": { "oneOf": [ { "type": "null" }, { "description": "Optional group-assignment-count filter.", "$ref": "#/components/schemas/Int32Filter" } ] }, "isActive": { "oneOf": [ { "type": "null" }, { "description": "Optional active-state filter.", "$ref": "#/components/schemas/BoolFilter" } ] }, "createdAt": { "oneOf": [ { "type": "null" }, { "description": "Optional creation timestamp filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "modifiedAt": { "oneOf": [ { "type": "null" }, { "description": "Optional modification timestamp filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] } }, "description": "Filter criteria for UserProjectListQueryExtended.\nExcludes `UserId` which is an internal-only filter." }, "UserProjectListQueryResultExtended": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserProjectItemExtended" }, "description": "Page items." }, "paging": { "description": "Continuation paging metadata.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Extended list query result for user-project entities." }, "UserProjectRestoreExtendedCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user project assignment to restore." }, "update": { "oneOf": [ { "type": "null" }, { "description": "Optional update to apply after the restore.", "$ref": "#/components/schemas/UserProjectRestoreUpdateCommand" } ] } }, "description": "Extended command to restore a soft-deleted user project assignment, with an optional\nupdate applied immediately after the restore." }, "UserProjectRestoreUpdateCommand": { "required": [ "updateUser", "updateLicense", "updateSecurity", "updateVisibility", "updateGroups", "updateActive" ], "type": "object", "properties": { "updateUser": { "oneOf": [ { "type": "null" }, { "description": "Optional user identity updates.", "$ref": "#/components/schemas/UserUpdateCommand" } ] }, "updateLicense": { "oneOf": [ { "type": "null" }, { "description": "Optional license updates.", "$ref": "#/components/schemas/UserProjectLicense" } ] }, "updateSecurity": { "oneOf": [ { "type": "null" }, { "description": "Optional security updates.", "$ref": "#/components/schemas/UserProjectSecurity" } ] }, "updateVisibility": { "oneOf": [ { "type": "null" }, { "description": "Optional visibility updates.", "$ref": "#/components/schemas/UserProjectVisibility" } ] }, "updateGroups": { "oneOf": [ { "type": "null" }, { "description": "Optional group updates.", "$ref": "#/components/schemas/UserProjectGroups" } ] }, "updateActive": { "oneOf": [ { "type": "null" }, { "description": "Optional activation status updates.", "$ref": "#/components/schemas/UserProjectActive" } ] } }, "description": "Update command for UserProjectRestoreExtendedCommand.\nCarries the same update fields as UserProjectUpdateCommand but without an `Id`,\nsince the identity is already provided by the enclosing restore command." }, "UserProjectSecurity": { "required": [ "roles", "accessType" ], "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "accessType": { "$ref": "#/components/schemas/AccessType" } } }, "UserProjectSecurityExtended": { "required": [ "roles", "accessType" ], "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleInfo" }, "description": "Role assignments with identifier and display name." }, "accessType": { "description": "Access type for the relation.", "$ref": "#/components/schemas/AccessType" } }, "description": "Extended security settings for a user-project relation, with resolved role names." }, "UserProjectSortingField": { "enum": [ "Id", "RoleCount", "AccessType", "HasDefaultGroup", "GroupAssignmentCount", "IsActive", "UserType", "UserEmail", "DisplayName", "GivenName", "Surname", "CreatedAt", "ModifiedAt" ], "description": "Fields available for sorting user-project list results." }, "UserProjectUpdateCommand": { "required": [ "id", "updateUser", "updateLicense", "updateSecurity", "updateVisibility", "updateGroups", "updateActive" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user project assignment to update." }, "updateUser": { "oneOf": [ { "type": "null" }, { "description": "Optional user identity updates.", "$ref": "#/components/schemas/UserUpdateCommand" } ] }, "updateLicense": { "oneOf": [ { "type": "null" }, { "description": "Optional license updates.", "$ref": "#/components/schemas/UserProjectLicense" } ] }, "updateSecurity": { "oneOf": [ { "type": "null" }, { "description": "Optional security updates.", "$ref": "#/components/schemas/UserProjectSecurity" } ] }, "updateVisibility": { "oneOf": [ { "type": "null" }, { "description": "Optional visibility updates.", "$ref": "#/components/schemas/UserProjectVisibility" } ] }, "updateGroups": { "oneOf": [ { "type": "null" }, { "description": "Optional group updates.", "$ref": "#/components/schemas/UserProjectGroups" } ] }, "updateActive": { "oneOf": [ { "type": "null" }, { "description": "Optional activation status updates.", "$ref": "#/components/schemas/UserProjectActive" } ] } }, "description": "Command to update an existing user project assignment." }, "UserProjectVisibility": { "required": [ "visibility", "visibilityManagers" ], "type": "object", "properties": { "visibility": { "type": "array", "items": { "$ref": "#/components/schemas/EntityVisibility" } }, "visibilityManagers": { "type": "array", "items": { "type": "string" } } } }, "UserPurge": { "required": [ "purgeDate" ], "type": "object", "properties": { "purgeDate": { "type": "string", "format": "date-time" } } }, "UserRestoreCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } }, "description": "Command to restore a soft-deleted user." }, "UserServiceIdentifiers": { "required": [ "clientId", "appObjectId" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "The application (client) ID of the app registration." }, "appObjectId": { "type": "string", "description": "The object ID of the app registration. Used for Graph update, delete, and purge operations." }, "secretExpireDate": { "type": [ "null", "string" ], "description": "Expiry date of the app registration client secret, if known.", "format": "date-time" } }, "description": "Entra ID identifiers for a service user's application registration.\nStored on the user aggregate after provisioning and used for subsequent Graph operations." }, "UserSessionAvailableOperations": { "required": [ "modules", "features", "entities", "operations" ], "type": "object", "properties": { "modules": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleDescriptionItem" }, "description": "Available modules." }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureDescriptionItem" }, "description": "Available features." }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDescriptionItem" }, "description": "Available entities." }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/OperationDescriptionItem" }, "description": "Available operations." } }, "description": "Available modules/features/entities/operations in the current session context." }, "UserSessionAvailableOperationsQueryResult": { "required": [ "availableOperations" ], "type": "object", "properties": { "availableOperations": { "description": "Available operation payload.", "$ref": "#/components/schemas/UserSessionAvailableOperations" } }, "description": "Result containing available operation metadata." }, "UserSessionCloseCommand": { "required": [ "id", "reason", "description" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user session to close." }, "reason": { "description": "The close reason.", "$ref": "#/components/schemas/UserSessionCloseReason" }, "description": { "type": "string", "description": "The close description." } }, "description": "Command to close an existing user session." }, "UserSessionCloseMeCommand": { "type": "object", "description": "Command to close the current authenticated user session." }, "UserSessionCloseReason": { "enum": [ "UserLoggedOut", "SessionExpired", "SessionClosed" ] }, "UserSessionCountQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria.", "$ref": "#/components/schemas/UserSessionListQueryFilter" } ] } }, "description": "Query to count user sessions matching an optional filter." }, "UserSessionCreateCommand": { "required": [ "mode", "usageLicenseId", "projectId", "accessType" ], "type": "object", "properties": { "mode": { "description": "The session creation mode.", "$ref": "#/components/schemas/UserSessionMode" }, "usageLicenseId": { "type": [ "null", "string" ], "description": "The optional usage license identifier." }, "projectId": { "type": [ "null", "string" ], "description": "The optional project identifier." }, "accessType": { "oneOf": [ { "type": "null" }, { "description": "The optional access type.", "$ref": "#/components/schemas/AccessType" } ] } }, "description": "Command to create a user session." }, "UserSessionCreateCommandResult": { "required": [ "status" ], "type": "object", "properties": { "status": { "description": "The creation status.", "$ref": "#/components/schemas/UserSessionCreationStatus" }, "sessionId": { "type": [ "null", "string" ], "description": "The optional created session identifier." }, "usageLicenses": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UsageLicenseDesc" }, "description": "The optional list of available usage licenses." }, "projects": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ProjectDesc" }, "description": "The optional list of available projects." }, "accessTypes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AccessTypeDesc" }, "description": "The optional list of available access types." } }, "description": "Result payload for creating a user session." }, "UserSessionCreationStatus": { "enum": [ "Success", "SelectLicense", "SelectProject", "SelectAccessType" ] }, "UserSessionDeleteCommand": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user session to delete." } }, "description": "Command to delete a user session." }, "UserSessionDetails": { "required": [ "id", "userType", "userId", "usageLicenseId", "projectId", "userProjectId", "accessType", "startDate", "lastAccessDate", "closedAt", "duration", "isClosed", "closeReason", "closeDescription", "createdAt", "modifiedAt", "deleted", "version" ], "type": "object", "properties": { "id": { "type": "string", "description": "Session identifier." }, "userType": { "description": "User type value.", "$ref": "#/components/schemas/UserType" }, "userId": { "type": "string", "description": "User identifier." }, "usageLicenseId": { "type": [ "null", "string" ], "description": "Usage-license identifier." }, "projectId": { "type": [ "null", "string" ], "description": "Project identifier." }, "userProjectId": { "type": [ "null", "string" ], "description": "User-project identifier." }, "accessType": { "oneOf": [ { "type": "null" }, { "description": "Access type value.", "$ref": "#/components/schemas/AccessType" } ] }, "startDate": { "type": "string", "description": "Session start timestamp.", "format": "date-time" }, "lastAccessDate": { "type": "string", "description": "Session last-access timestamp.", "format": "date-time" }, "closedAt": { "type": [ "null", "string" ], "description": "Session close timestamp.", "format": "date-time" }, "duration": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string", "description": "Session duration." }, "isClosed": { "type": "boolean", "description": "Indicates whether session is closed." }, "closeReason": { "oneOf": [ { "type": "null" }, { "description": "Close reason value.", "$ref": "#/components/schemas/UserSessionCloseReason" } ] }, "closeDescription": { "type": [ "null", "string" ], "description": "Close description." }, "createdAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Soft-delete flag." }, "version": { "type": "integer", "description": "Concurrency version.", "format": "int64" } }, "description": "Detailed user-session model returned from fetch operations." }, "UserSessionFetchQuery": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Session identifier." }, "deleted": { "description": "Soft-delete filter.", "$ref": "#/components/schemas/DeletedFilter" } }, "description": "Query to fetch one user session by identifier." }, "UserSessionFetchQueryResult": { "required": [ "details" ], "type": "object", "properties": { "details": { "description": "Fetched session details.", "$ref": "#/components/schemas/UserSessionDetails" } }, "description": "Fetch result containing user-session details." }, "UserSessionGetMetadataQueryResult": { "required": [ "metadata", "lastAccess" ], "type": "object", "properties": { "metadata": { "description": "Session metadata payload.", "$ref": "#/components/schemas/UserSessionMetadata" }, "lastAccess": { "type": [ "null", "string" ], "description": "Last-access timestamp when available.", "format": "date-time" } }, "description": "Result containing session metadata and most recent access timestamp." }, "UserSessionItem": { "required": [ "id", "userId", "userIsAdmin", "userDisplayName", "userEmail", "usageLicenseId", "clientName", "projectId", "userProjectId", "projectAlias", "accessType", "startDate", "lastAccessDate", "closedAt", "duration", "isOpen", "createdAt", "modifiedAt", "deleted" ], "type": "object", "properties": { "id": { "type": "string", "description": "Session identifier." }, "userId": { "type": "string", "description": "User identifier." }, "userIsAdmin": { "type": "boolean", "description": "Indicates whether user has admin role." }, "userDisplayName": { "type": "string", "description": "User display name." }, "userEmail": { "type": "string", "description": "User email address." }, "usageLicenseId": { "type": [ "null", "string" ], "description": "Usage-license identifier." }, "clientName": { "type": [ "null", "string" ], "description": "Client name." }, "projectId": { "type": [ "null", "string" ], "description": "Project identifier." }, "userProjectId": { "type": [ "null", "string" ], "description": "User-project identifier." }, "projectAlias": { "type": [ "null", "string" ], "description": "Project alias." }, "accessType": { "oneOf": [ { "type": "null" }, { "description": "Session access type.", "$ref": "#/components/schemas/AccessType" } ] }, "startDate": { "type": "string", "description": "Session start timestamp.", "format": "date-time" }, "lastAccessDate": { "type": "string", "description": "Session last-access timestamp.", "format": "date-time" }, "closedAt": { "type": [ "null", "string" ], "description": "Session close timestamp.", "format": "date-time" }, "duration": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string", "description": "Session duration." }, "isOpen": { "type": "boolean", "description": "Indicates whether session is open." }, "createdAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time" }, "modifiedAt": { "type": "string", "description": "Last modification timestamp.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Soft-delete flag." } }, "description": "User-session list-item projection." }, "UserSessionListQuery": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "null" }, { "description": "Optional filter criteria.", "$ref": "#/components/schemas/UserSessionListQueryFilter" } ] }, "sorting": { "oneOf": [ { "type": "null" }, { "description": "Optional sorting steps.", "$ref": "#/components/schemas/SortingStepsOfUserSessionSortingField" } ] }, "paging": { "oneOf": [ { "type": "null" }, { "description": "Optional continuation paging request.", "$ref": "#/components/schemas/ContinuationQueryPaging" } ] } }, "description": "Query to list user sessions with optional filtering, sorting, and continuation paging." }, "UserSessionListQueryFilter": { "type": "object", "properties": { "textQuery": { "type": [ "null", "string" ], "description": "Full-text query term." }, "deleted": { "oneOf": [ { "type": "null" }, { "description": "Soft-delete filter.", "$ref": "#/components/schemas/DeletedFilter" } ] }, "userId": { "oneOf": [ { "type": "null" }, { "description": "User identifier filter.", "$ref": "#/components/schemas/EntityFilter" } ] }, "userIsAdmin": { "oneOf": [ { "type": "null" }, { "description": "User admin-state filter.", "$ref": "#/components/schemas/BoolFilter" } ] }, "userDisplayName": { "oneOf": [ { "type": "null" }, { "description": "User display-name filter.", "$ref": "#/components/schemas/StringFilter" } ] }, "userEmail": { "oneOf": [ { "type": "null" }, { "description": "User email filter.", "$ref": "#/components/schemas/StringFilter" } ] }, "usageLicenseId": { "oneOf": [ { "type": "null" }, { "description": "Usage-license identifier filter.", "$ref": "#/components/schemas/OptionalEntityFilter" } ] }, "clientName": { "oneOf": [ { "type": "null" }, { "description": "Client-name filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "projectId": { "oneOf": [ { "type": "null" }, { "description": "Project identifier filter.", "$ref": "#/components/schemas/OptionalEntityFilter" } ] }, "userProjectId": { "oneOf": [ { "type": "null" }, { "description": "User-project identifier filter.", "$ref": "#/components/schemas/OptionalEntityFilter" } ] }, "projectAlias": { "oneOf": [ { "type": "null" }, { "description": "Project-alias filter.", "$ref": "#/components/schemas/OptionalStringFilter" } ] }, "accessType": { "oneOf": [ { "type": "null" }, { "description": "Access-type filter.", "$ref": "#/components/schemas/OptionalEnumFilterOfAccessType" } ] }, "startDate": { "oneOf": [ { "type": "null" }, { "description": "Session start-date filter.", "$ref": "#/components/schemas/DateTimeOffsetFilter" } ] }, "lastAccessDate": { "oneOf": [ { "type": "null" }, { "description": "Session last-access-date filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "closedAt": { "oneOf": [ { "type": "null" }, { "description": "Session close-date filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "isOpen": { "oneOf": [ { "type": "null" }, { "description": "Open-state filter.", "$ref": "#/components/schemas/BoolFilter" } ] }, "createdAt": { "oneOf": [ { "type": "null" }, { "description": "Creation-date filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] }, "modifiedAt": { "oneOf": [ { "type": "null" }, { "description": "Modification-date filter.", "$ref": "#/components/schemas/OptionalDateTimeOffsetFilter" } ] } }, "description": "Filter criteria for user-session list queries." }, "UserSessionListQueryResult": { "required": [ "items", "paging" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserSessionItem" }, "description": "Current page items." }, "paging": { "description": "Continuation paging metadata.", "$ref": "#/components/schemas/ContinuationQueryPaging" } }, "description": "Paged result for user-session list queries." }, "UserSessionMetadata": { "required": [ "id", "userType", "accessType", "startDate" ], "type": "object", "properties": { "id": { "type": "string", "description": "Session identifier." }, "userType": { "description": "User type value.", "$ref": "#/components/schemas/UserType" }, "accessType": { "oneOf": [ { "type": "null" }, { "description": "Access type value.", "$ref": "#/components/schemas/AccessType" } ] }, "startDate": { "type": "string", "description": "Session start timestamp.", "format": "date-time" } }, "description": "Core metadata model for a user session." }, "UserSessionMode": { "enum": [ "Interactive", "Immediate" ] }, "UserSessionSortingField": { "enum": [ "Id", "UserIsAdmin", "UserDisplayName", "UserEmail", "ClientName", "ProjectAlias", "AccessType", "StartDate", "LastAccessDate", "ClosedAt", "IsOpen", "CreatedAt", "ModifiedAt" ], "description": "Sortable fields for user-session list queries." }, "UserSortingField": { "enum": [ "Id", "Type", "Email", "DisplayName", "GivenName", "Surname", "IsActive", "LastLoginDate", "CreatedAt", "ModifiedAt" ], "description": "Sortable fields for user list queries." }, "UserType": { "enum": [ "GlobalAdministrator", "LocalUser", "ExternalUser", "ServiceUser" ] }, "UserUpdateCommand": { "required": [ "id", "updateDescriptions", "updateContacts", "updateActive", "updateExternalIdentifiers", "updateServiceIdentifiers", "updatePurge" ], "type": "object", "properties": { "id": { "type": "string" }, "updateDescriptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserDescriptions" } ] }, "updateContacts": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserContacts" } ] }, "updateActive": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserActive" } ] }, "updateExternalIdentifiers": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserExternalIdentifiers" } ] }, "updateServiceIdentifiers": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserServiceIdentifiers" } ] }, "updatePurge": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserPurge" } ] } }, "description": "Command to update an existing user." }, "ValuePresenceFilter": { "required": [ "isPresent" ], "type": "object", "properties": { "isPresent": { "type": "boolean" } } } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Authorization header using the Bearer scheme.", "scheme": "Bearer", "bearerFormat": "JWT" }, "SessionId": { "type": "apiKey", "description": "Session identifier for authenticated requests.", "name": "X-TDP-SessionID", "in": "header" } } }, "tags": [ { "name": "event_store" }, { "name": "projection" }, { "name": "element_description" }, { "name": "module_description" }, { "name": "feature_description" }, { "name": "entity_description" }, { "name": "notification_description" }, { "name": "operation_description" }, { "name": "permission_description" }, { "name": "setting_description" }, { "name": "setting_value" }, { "name": "culture" }, { "name": "project" }, { "name": "usage_license" }, { "name": "usage_license_contract" }, { "name": "identity_provider" }, { "name": "user" }, { "name": "user_group" }, { "name": "user_session" }, { "name": "user_project" }, { "name": "role" } ] }