{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Reports Command", "description": "**Reports Command API**:


Reports Command API provides endpoints in order to manage and configure all related models and their versions.


**Reports Command API provides**:
", "version": "1.0" }, "servers": [ { "url": "/reportscommand" } ], "paths": { "/api/Debug/schedule/trigger-cron": { "post": { "tags": [ "Debug", "v1" ], "summary": "Manually trigger the cron scan (local dev only)", "operationId": "TriggerScheduleCron", "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": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" } } } }, "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" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "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/Debug/last-dispatch/{scheduleId}": { "get": { "tags": [ "Debug", "v1" ], "summary": "Returns the most-recently captured dispatch artifact for a schedule (local dev only).", "description": "Returns 404 in all production environments.", "operationId": "GetLastDispatchArtifact", "parameters": [ { "name": "scheduleId", "in": "path", "description": "The schedule identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tenant", "in": "query", "description": "The tenant identifier (required to look up the schedule).", "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", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "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/Debug/last-email/{scheduleId}": { "get": { "tags": [ "Debug", "v1" ], "summary": "Returns the most-recently captured email payload for a schedule (local dev only).", "description": "Returns 404 in all production environments.", "operationId": "GetLastDispatchEmail", "parameters": [ { "name": "scheduleId", "in": "path", "description": "The schedule identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tenant", "in": "query", "description": "The tenant identifier (required to look up the schedule).", "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", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "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/Query": { "post": { "tags": [ "Query", "v1" ], "summary": "Create a new Query definition", "description": "

Required permissions:
Following permissions are required: ReportingEdit", "operationId": "CreateSqlQueryDefinition", "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": "Create query request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSqlQueryDefinitionDtoServiceRequest" } ] } } } }, "responses": { "201": { "description": "Created. Query definition created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedSqlQueryDefinitionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal Server Error" }, "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" } ] } } } } } }, "put": { "tags": [ "Query", "v1" ], "summary": "Update a Query definition", "description": "

Required permissions:
Following permissions are required: ReportingEdit", "operationId": "UpdateSqlQueryDefinition", "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": "Create query request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateSqlQueryDefinitionDtoServiceRequest" } ] } } } }, "responses": { "204": { "description": "NoContent. Query definition updated" }, "400": { "description": "Bad request. The request has missing/invalid values", "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": "NotFound. The resource was not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal Server Error" }, "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/Query/{Id}": { "delete": { "tags": [ "Query", "v1" ], "summary": "Delete a Query definition", "description": "

Required permissions:
Following permissions are required: ReportingDelete", "operationId": "DeleteSqlQueryDefinition", "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the existing Query definition model 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": "NoContent. Query definition deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "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": "NotFound. The resource was not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal Server Error" }, "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/Report": { "post": { "tags": [ "Report", "v1" ], "summary": "Create report", "description": "

Required permissions:
Following permissions are required: ReportingExecute", "operationId": "CreateReport", "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": "Create report request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateReportV1DtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Report created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "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" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "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/Report/Preview": { "post": { "tags": [ "Report", "v1" ], "summary": "Preview report", "description": "

Required permissions:
At least one of the following permissions is required: ReportingEdit, ReportingExecute", "operationId": "Preview", "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": "Create report request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PreviewReportDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Report created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "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" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "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": { "CreateReportV1Dto": { "type": "object", "properties": { "sqlQuery": { "type": "string", "description": "SQL query of the report", "nullable": true, "example": "Select * from entitydata where category='Retail'" }, "description": { "type": "string", "description": "Short description of the report", "nullable": true, "example": "My Monthly report for active retail clients" } }, "additionalProperties": false, "description": "A report model to run a simple query" }, "CreateReportV1DtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateReportV1Dto" } ], "description": "A report model to run a simple query", "nullable": true } }, "additionalProperties": false }, "CreateSqlQueryDefinitionDto": { "required": [ "name", "sqlQuery" ], "type": "object", "properties": { "sqlQuery": { "minLength": 1, "type": "string", "description": "Query definition Sql Query", "example": "Select Id From entitydata" }, "name": { "minLength": 1, "type": "string", "description": "Query definition name", "example": "GetAllEntityDataIds" }, "description": { "type": "string", "description": "Query definition description", "nullable": true, "example": "Get all entitydata Ids" }, "id": { "type": "string", "description": "Query ID", "format": "uuid", "nullable": true, "example": "33e5b6f5-1b95-49fb-a616-413b390ff8a8" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/QueryParameterDto" }, "description": "Parameter definitions for placeholders in the SQL query", "nullable": true }, "categoryId": { "type": "string", "description": "Optional category to assign this query to", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "A new query definition item" }, "CreateSqlQueryDefinitionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateSqlQueryDefinitionDto" } ], "description": "A new query definition item", "nullable": true } }, "additionalProperties": false }, "CreatedSqlQueryDefinitionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Created query unique Id", "format": "uuid", "example": "7e57cfd6-881c-4587-ada8-24a23b76464e" } }, "additionalProperties": false, "description": "Response representing created query" }, "CreatedSqlQueryDefinitionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreatedSqlQueryDefinitionDto" } ], "description": "Response representing created query", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GuidServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "format": "uuid" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "HttpValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } } ] }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PreviewParameterDefinitionDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Parameter name, matching the {{placeholder}} in the SQL template", "nullable": true }, "type": { "type": "string", "description": "Parameter type: String | Date | Number | Boolean | Select", "nullable": true } }, "additionalProperties": false, "description": "Carries the type metadata for a single parameter in a preview request." }, "PreviewReportDto": { "type": "object", "properties": { "sqlQuery": { "type": "string", "description": "SQL query of the report", "nullable": true, "example": "Select * from entitydata where category='Retail' limit 5" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Parameter values to substitute into the SQL query placeholders", "nullable": true }, "parameterDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/PreviewParameterDefinitionDto" }, "description": "Parameter type definitions for type-aware substitution (e.g. Date → DATE 'yyyy-MM-dd')", "nullable": true } }, "additionalProperties": false, "description": "A report model to run a simple query" }, "PreviewReportDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PreviewReportDto" } ], "description": "A report model to run a simple query", "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "QueryParameterDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "displayLabel": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "defaultValue": { "type": "string", "nullable": true }, "options": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "API contract DTO for a query parameter definition" }, "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 }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateSqlQueryDefinitionDto": { "required": [ "name", "sqlQuery" ], "type": "object", "properties": { "id": { "type": "string", "description": "Query definition Id", "format": "uuid", "example": "7e57cfd6-881c-4587-ada8-24a23b76464e" }, "sqlQuery": { "minLength": 1, "type": "string", "description": "New Query definition Sql Query", "example": "Select Id From entitydata" }, "name": { "minLength": 1, "type": "string", "description": "New Query definition name", "example": "GetAllEntityDataIds" }, "description": { "type": "string", "description": "Description for the Query Definition", "nullable": true, "example": "The List of the client Names" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/QueryParameterDto" }, "description": "Parameter definitions for placeholders in the SQL query", "nullable": true }, "categoryId": { "type": "string", "description": "Optional category to assign this query to", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "A update query definition item" }, "UpdateSqlQueryDefinitionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateSqlQueryDefinitionDto" } ], "description": "A update query definition item", "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" } ] } } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }