{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula DigitalAgents Command", "description": "**DigitalAgents Command API**:


DigitalAgents Command API provides endpoints in order to retrieve all related models and their versions.


**DigitalAgents Command API provides**:
", "version": "1.0" }, "servers": [ { "url": "/digitalagentscommand" } ], "paths": { "/api/agent": { "post": { "tags": [ "Agent" ], "summary": "Registers a new agent in the central agent registry. If no Id is supplied, one is generated.", "description": "

Required permissions:
Following permissions are required: AgentConfigurationAccess", "operationId": "CreateAgent", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The agent configuration to create.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AgentRequestDtoServiceRequest" } ] } } } }, "responses": { "201": { "description": "Created. Returns the newly registered agent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRequestDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/agent/{agentId}": { "put": { "tags": [ "Agent" ], "summary": "Updates the base configuration of an existing agent registry entry. SLO definitions are left untouched.\nAgentType cannot be changed via this endpoint (it is part of the storage key) — use delete+recreate instead.", "description": "

Required permissions:
Following permissions are required: AgentConfigurationAccess", "operationId": "UpdateAgent", "parameters": [ { "name": "agentId", "in": "path", "description": "The unique identifier of the agent.", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The updated agent configuration.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AgentRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK. Returns the updated agent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRequestDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. The agent does not exist for the current tenant.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "Agent" ], "summary": "Deletes an agent from the central agent registry.", "description": "

Required permissions:
Following permissions are required: AgentConfigurationAccess", "operationId": "DeleteAgent", "parameters": [ { "name": "agentId", "in": "path", "description": "The unique identifier of the agent.", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "204": { "description": "No Content. The agent was deleted (idempotent — also returned if the agent did not exist)." }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/agentslos/{agentId}/slos": { "put": { "tags": [ "AgentSlos" ], "summary": "Replaces the SLO definitions for an agent.", "description": "

Required permissions:
Following permissions are required: AgentConfigurationAccess", "operationId": "UpdateAgentSlos", "parameters": [ { "name": "agentId", "in": "path", "description": "The unique identifier of the agent.", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The list of SLO definitions to set on the agent.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SloDefinitionListServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK. The SLO definitions have been updated." }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. The agent does not exist for the current tenant.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/configurablesections/save": { "post": { "tags": [ "ConfigurableSections" ], "summary": "Upserts a configurable section for the current tenant.", "description": "This endpoint saves the configurable section associated with the tenant.

Required permissions:
Following permissions are required: DigitalAgentsAccess", "operationId": "SaveConfigurableSections", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1 containing the widget and metric configuration.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurableSectionsDashboardDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK. The command centre configuration has been added/updated." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/configurablesections/delete": { "delete": { "tags": [ "ConfigurableSections" ], "summary": "Deletes the configurable section for the current tenant.", "description": "This endpoint deletes the configurable section associated with the tenant.

Required permissions:
Following permissions are required: DigitalAgentsAccess", "operationId": "DeleteConfigurableSections", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "204": { "description": "No Content. The command centre configuration has been deleted." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/feedback/clusters/{agentName}/{agentExecutionId}/promote-to-golden-dataset": { "post": { "tags": [ "Feedback" ], "summary": "Promotes a feedback cluster to the golden dataset by writing a draft test case to S3 and\nDynamoDB, then marking the originating cluster record as promoted.", "description": "

Required permissions:
Following permissions are required: AgentConfigurationAccess", "operationId": "PromoteFeedbackClusterToGoldenDataset", "parameters": [ { "name": "agentName", "in": "path", "description": "The name of the agent whose cluster is being promoted.", "required": true, "schema": { "type": "string" } }, { "name": "agentExecutionId", "in": "path", "description": "The execution ID of the feedback cluster to promote.", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The promotion payload including dataset version and quality threshold.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PromoteFeedbackClusterRequestServiceRequest" } ] } } } }, "responses": { "200": { "description": "Cluster promoted successfully. Returns the new golden dataset test case ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoteFeedbackClusterResponseServiceResponse" } } } }, "400": { "description": "Request payload failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/feedback": { "post": { "tags": [ "Feedback" ], "summary": "Records a human feedback signal (thumbs-up or thumbs-down) for an agent execution.", "description": "

Required permissions:
Following permissions are required: AgentConfigurationAccess", "operationId": "RecordFeedback", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The feedback payload.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/StoreFeedbackRequestServiceRequest" } ] } } } }, "responses": { "204": { "description": "Feedback recorded successfully." }, "400": { "description": "Request payload failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/scorecards": { "post": { "tags": [ "Scorecards" ], "summary": "Validates and stores a scorecard JSON payload.", "description": "

Required permissions:
Following permissions are required: AgentConfigurationAccess", "operationId": "StoreScorecard", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The scorecard JSON string to validate and persist.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/StringServiceRequest" } ] } } } }, "responses": { "200": { "description": "Scorecard stored successfully. Returns the scorecard ID and S3 URL.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreScorecardResponseDtoServiceResponse" } } } }, "400": { "description": "The scorecard payload failed schema validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/scorecards/{id}/approve": { "post": { "tags": [ "Scorecards" ], "summary": "Records approver sign-off on an existing scorecard.", "description": "

Required permissions:
Following permissions are required: AgentConfigurationAccess", "operationId": "ApproveScorecard", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the scorecard to approve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The approval request containing approver notes.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveScorecardRequestServiceRequest" } ] } } } }, "responses": { "200": { "description": "Scorecard approved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveScorecardResponseDtoServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/scorecards/{id}": { "delete": { "tags": [ "Scorecards" ], "summary": "Deletes a scorecard's S3 artefact and DynamoDB index record.\nIdempotent — returns 204 whether or not the scorecard exists.", "description": "

Required permissions:
Following permissions are required: AgentConfigurationAccess", "operationId": "DeleteScorecard", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the scorecard to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "204": { "description": "Scorecard deleted (or not found — deletion is idempotent)." }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/userdashboards": { "post": { "tags": [ "UserDashboards" ], "summary": "Creates a new personalised dashboard for the authenticated user.", "description": "

Required permissions:
Following permissions are required: ReportingAccess", "operationId": "CreateUserDashboard", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUserDashboardRequestDtoServiceRequest" } ] } } } }, "responses": { "201": { "description": "Created. Returns the new dashboard.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDashboardDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/userdashboards/{id}": { "put": { "tags": [ "UserDashboards" ], "summary": "Updates an existing personalised dashboard.", "description": "

Required permissions:
Following permissions are required: ReportingAccess", "operationId": "UpdateUserDashboard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateUserDashboardRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK. Returns the updated dashboard.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDashboardDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. The dashboard does not exist.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "UserDashboards" ], "summary": "Deletes a personalised dashboard.", "description": "

Required permissions:
Following permissions are required: ReportingAccess", "operationId": "DeleteUserDashboard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "204": { "description": "No Content. The dashboard was deleted." }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. The dashboard does not exist.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/userdashboards/fork": { "post": { "tags": [ "UserDashboards" ], "summary": "Forks a public dashboard into the caller's private dashboards.", "description": "

Required permissions:
Following permissions are required: ReportingAccess", "operationId": "ForkPublicDashboard", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkPublicDashboardRequestDtoServiceRequest" } ] } } } }, "responses": { "201": { "description": "Created. Returns the new forked dashboard.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDashboardDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. The source dashboard does not exist or is not public.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/userdashboards/reorder": { "post": { "tags": [ "UserDashboards" ], "summary": "Reorders personalised dashboards for the authenticated user.", "description": "

Required permissions:
Following permissions are required: ReportingAccess", "operationId": "ReorderUserDashboards", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReorderUserDashboardsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK. Returns the reordered dashboards.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDashboardsDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/userdashboards/{id}/persona": { "delete": { "tags": [ "UserDashboards" ], "summary": "Removes persona association from a dashboard (clears PersonaId and Description).", "description": "

Required permissions:
Following permissions are required: ReportingAccess", "operationId": "RemovePersonaFromDashboard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK. Returns the updated dashboard.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDashboardDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. The dashboard does not exist.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AgentCategory": { "enum": [ "KYC", "Compliance", "Reporting", "FenAI", "Decisioning", "Extraction", "Agentic" ], "type": "string", "description": "Represents the category of an agent in the digital agents system." }, "AgentRequestDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Gets or sets the agent identifier.", "nullable": true }, "name": { "type": "string", "description": "Gets or sets the name of the agent.", "nullable": true }, "description": { "type": "string", "description": "Gets or sets the description of the agent.", "nullable": true }, "agentType": { "type": "string", "description": "Gets or sets the agent type.", "nullable": true }, "configurationType": { "type": "string", "description": "Gets or sets the configuration type (instance or profile).", "nullable": true }, "agentAutonomy": { "type": "string", "description": "Gets or sets the agent autonomy.", "nullable": true }, "enabled": { "type": "boolean", "description": "Gets or sets agent enabled status." }, "journeyTypes": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Gets or sets the journey types", "nullable": true }, "extensionData": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Gets or sets the opt-in, domain-specific extension data bag (AB#549014). Populated only for\ndomains whose underlying `Agent` subclass implements `IHasAgentExtensionData`\n(e.g. Significance, DataSourcing); null/omitted for all other domains.", "nullable": true } }, "additionalProperties": false }, "AgentRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AgentRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "AgentRequestDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AgentRequestDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ApproveScorecardRequest": { "type": "object", "properties": { "approvalNotes": { "type": "string", "description": "Notes provided by the approver at sign-off.", "nullable": true } }, "additionalProperties": false, "description": "Request body for approving a scorecard." }, "ApproveScorecardRequestServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ApproveScorecardRequest" } ], "description": "Request body for approving a scorecard.", "nullable": true } }, "additionalProperties": false }, "ApproveScorecardResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "approvedBy": { "type": "string", "nullable": true }, "approvalDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApproveScorecardResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ApproveScorecardResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ConfigurableSectionDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/WidgetDto" }, "nullable": true } }, "additionalProperties": false }, "ConfigurableSectionsDashboardDto": { "type": "object", "properties": { "sections": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurableSectionDto" }, "nullable": true } }, "additionalProperties": false }, "ConfigurableSectionsDashboardDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ConfigurableSectionsDashboardDto" } ], "nullable": true } }, "additionalProperties": false }, "CreateUserDashboardRequestDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "tabColour": { "type": "string", "nullable": true }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalisedWidgetDto" }, "nullable": true }, "visibility": { "type": "string", "nullable": true }, "personaId": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "ownerDisplayName": { "type": "string", "nullable": true }, "visualOptions": { "nullable": true } }, "additionalProperties": false }, "CreateUserDashboardRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateUserDashboardRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "DatasourceConfigDto": { "type": "object", "properties": { "queryId": { "type": "string", "nullable": true }, "fieldMapping": { "type": "object", "additionalProperties": { }, "nullable": true }, "parameterValues": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "staleTTLMs": { "type": "integer", "format": "int32", "nullable": true }, "columnConfig": { "nullable": true }, "seriesConfig": { "nullable": true } }, "additionalProperties": false }, "FeedbackType": { "enum": [ "Positive", "Negative" ], "type": "string", "description": "Represents a human feedback signal on an agent response." }, "ForkPublicDashboardRequestDto": { "type": "object", "properties": { "sourceOwnerUserId": { "type": "string", "nullable": true }, "sourceDashboardId": { "type": "string", "nullable": true }, "desiredName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ForkPublicDashboardRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ForkPublicDashboardRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PersonalisedWidgetDto": { "type": "object", "properties": { "instanceId": { "type": "string", "nullable": true }, "widgetType": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "position": { "allOf": [ { "$ref": "#/components/schemas/WidgetPositionDto" } ], "nullable": true }, "datasourceConfig": { "allOf": [ { "$ref": "#/components/schemas/DatasourceConfigDto" } ], "nullable": true }, "visualOptions": { "nullable": true } }, "additionalProperties": false }, "PromoteFeedbackClusterRequest": { "type": "object", "properties": { "datasetVersion": { "type": "string", "nullable": true }, "minQualityScoreThreshold": { "type": "number", "format": "double" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PromoteFeedbackClusterRequestServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PromoteFeedbackClusterRequest" } ], "nullable": true } }, "additionalProperties": false }, "PromoteFeedbackClusterResponse": { "type": "object", "properties": { "testCaseId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "PromoteFeedbackClusterResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PromoteFeedbackClusterResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ReorderUserDashboardsRequestDto": { "type": "object", "properties": { "orderedIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ReorderUserDashboardsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ReorderUserDashboardsRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SloDefinition": { "required": [ "measureName" ], "type": "object", "properties": { "measureName": { "type": "string", "nullable": true }, "windowHours": { "type": "integer", "format": "int32" }, "p50Threshold": { "type": "number", "format": "double", "nullable": true }, "p95Threshold": { "type": "number", "format": "double", "nullable": true }, "thresholdDirection": { "allOf": [ { "$ref": "#/components/schemas/ThresholdDirection" } ], "description": "Direction in which an Fenergo.Nebula.DigitalAgents.Models.Abstraction.SloDefinition threshold is breached." }, "driftTolerancePct": { "type": "number", "format": "double" }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "SloDefinitionListServiceRequest": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SloDefinition" }, "nullable": true } }, "additionalProperties": false }, "StoreFeedbackRequest": { "type": "object", "properties": { "feedbackType": { "allOf": [ { "$ref": "#/components/schemas/FeedbackType" } ], "description": "Represents a human feedback signal on an agent response." }, "agentExecutionId": { "type": "string", "nullable": true }, "agentName": { "type": "string", "nullable": true }, "capability": { "type": "string", "nullable": true }, "agentClass": { "allOf": [ { "$ref": "#/components/schemas/AgentCategory" } ], "description": "Represents the category of an agent in the digital agents system." }, "modelId": { "type": "string", "nullable": true }, "inferenceProfileArn": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StoreFeedbackRequestServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/StoreFeedbackRequest" } ], "nullable": true } }, "additionalProperties": false }, "StoreScorecardResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "s3Url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StoreScorecardResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/StoreScorecardResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "StringServiceRequest": { "type": "object", "properties": { "data": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ThresholdDirection": { "enum": [ "Floor", "Ceiling" ], "type": "string", "description": "Direction in which an Fenergo.Nebula.DigitalAgents.Models.Abstraction.SloDefinition threshold is breached." }, "UpdateUserDashboardRequestDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "tabColour": { "type": "string", "nullable": true }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalisedWidgetDto" }, "nullable": true }, "visibility": { "type": "string", "nullable": true }, "personaId": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "ownerDisplayName": { "type": "string", "nullable": true }, "visualOptions": { "nullable": true } }, "additionalProperties": false }, "UpdateUserDashboardRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateUserDashboardRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "UserDashboardDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "tabColour": { "type": "string", "nullable": true }, "tabOrder": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalisedWidgetDto" }, "nullable": true }, "visibility": { "type": "string", "nullable": true }, "personaId": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "visualOptions": { "nullable": true } }, "additionalProperties": false }, "UserDashboardDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UserDashboardDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UserDashboardsDto": { "type": "object", "properties": { "dashboards": { "type": "array", "items": { "$ref": "#/components/schemas/UserDashboardDto" }, "nullable": true } }, "additionalProperties": false }, "UserDashboardsDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UserDashboardsDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "WidgetDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "groupBy": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "filters": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "WidgetPositionDto": { "type": "object", "properties": { "col": { "type": "integer", "format": "int32" }, "row": { "type": "integer", "format": "int32" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }