{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Covenants & Conditions Query API", "description": "**Covenants & Conditions Query API**:


Covenants & Conditions Query API provides endpoints in order to retrieve all related models and their versions.


**Covenants & Conditions Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/covenantsconditionsquery" } ], "paths": { "/api/covenantcondition/set/{setId}": { "get": { "tags": [ "CovenantCondition" ], "summary": "Get a Covenant Condition Set of specified Id with all Version data", "description": "\nThis method returns the Covenant Condition Set of specified Id with all Covenant Condition Versions data.

Required permissions:
Following permissions are required: CovenantsConditionsAccess", "operationId": "GetCovenantConditionSetById", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the Covenant Condition Set", "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": { "200": { "description": "Success. A Covenant Condition Set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionSetDtoServiceResponse" } } } }, "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": "Not Found. Covenant Condition Set with given id does not exist", "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/covenantcondition/data/parent/{parentId}/journey/{journeyId}/task/{taskId}": { "get": { "tags": [ "CovenantCondition" ], "summary": "Get Covenant Condition Details for specified Parent Id, Journey and Task Id, with all and latest version.", "description": "\nThis method returns the Covenant Condition Details for specified Parent Id, Journey and TaskId, with all and latest version..

Required permissions:
Following permissions are required: CovenantsConditionsAccess", "operationId": "GetCovenantConditionDataByParentJourneyTaskId", "parameters": [ { "name": "parentId", "in": "path", "description": "The Parent Id of the Covenant Condition Set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task Id", "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": { "200": { "description": "Success. Covenant Condition Task Details is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionTaskDetailsDtoServiceResponse" } } } }, "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": "Not Found. Covenant Condition Set with given Parent id does not exist", "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/covenantcondition/version/{id}": { "get": { "tags": [ "CovenantCondition" ], "summary": "Get a full Covenant Condition Version of specified Id", "description": "\nThis method returns the full Covenant Condition Version of specified Id.

Required permissions:
Following permissions are required: CovenantsConditionsAccess", "operationId": "GetCovenantConditionVersionById", "parameters": [ { "name": "id", "in": "path", "description": "The id of the Covenant Condition Version to retrieve", "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": { "200": { "description": "Success. A Covenant Condition Version Dto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceResponse" } } } }, "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": "Not Found. Covenant Condition Version with given id does not exist", "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/covenantcondition/set/parent/{parentId}": { "get": { "tags": [ "CovenantCondition" ], "summary": "Get a Covenant Condition Set with all versions of specified Parent Id", "description": "\nThis method returns the Covenant Condition Set with all versions of specified Parent Id.

Required permissions:
Following permissions are required: CovenantsConditionsAccess", "operationId": "GetCovenantConditionSetByParentId", "parameters": [ { "name": "parentId", "in": "path", "description": "The Parent Id of the Covenant Condition Sets", "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": { "200": { "description": "Success. A Covenant Condition Set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionSetDtoServiceResponse" } } } }, "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": "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/covenantcondition/set/{setId}/version/{versionId}/snapshot": { "get": { "tags": [ "CovenantCondition" ], "summary": "Get a policy snapshot for Covenant Condition by version number", "description": "\nThis method returns the policy snapshot for Covenant Condition of specified set Id and Version.

Required permissions:
Following permissions are required: CovenantsConditionsAccess", "operationId": "GetCovenantConditionConfigurationSnapshotBySetVersionId", "parameters": [ { "name": "setId", "in": "path", "description": "The set id of the policy snapshot for Covenant Condition to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionId", "in": "path", "description": "The version Id of the policy snapshot for Covenant Condition to retrieve", "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": { "200": { "description": "Success. A Covenant Condition Policy Snapshot is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } } } }, "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": "Not Found. Covenant Condition Version with given id does not exist", "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" } ] } } } } } } } }, "components": { "schemas": { "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "nullable": true }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMinimumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "nullable": true }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CovenantConditionAssociationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Covenant Condition Association Guid", "format": "uuid", "example": "2db5d6e8-4f16-4c88-8b43-837f03d7b45f" }, "sourceId": { "type": "string", "description": "Association Source Id", "format": "uuid", "example": "a1f2c3e4-5678-49ab-9cde-0f1a2b3c4d5e" }, "targetId": { "type": "string", "description": "Association Target Id", "format": "uuid", "example": "f6e7d8c9-0a1b-2c3d-4e5f-6a7b8c9d0e1f" }, "targetType": { "type": "string", "description": "Association Target Type", "nullable": true, "example": "Entity" } }, "additionalProperties": false, "description": "Covenant Condition Association DTO" }, "CovenantConditionGroupDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Covenant Condition Group Id", "format": "uuid", "example": "51209731-77df-4e72-98e7-0d314b7a5151" }, "dataGroupId": { "type": "string", "description": "Data Group Id", "format": "uuid", "example": "e6af5a6d-1f91-49b2-ae75-8d299ebc613d" }, "dataGroupVersionNumber": { "type": "integer", "description": "Data Group Version Number.", "format": "int32", "nullable": true, "example": 1 }, "name": { "type": "string", "description": "Covenant Condition Group Name", "nullable": true, "example": "Financial Covenants 1" }, "type": { "type": "string", "description": "Covenant Condition Group Type", "nullable": true, "example": "Financial Covenants" }, "covenantConditionItems": { "type": "array", "items": { "$ref": "#/components/schemas/CovenantConditionItemDto" }, "description": "List of Covenant Condition Items", "nullable": true } }, "additionalProperties": false, "description": "Covenant Condition Group" }, "CovenantConditionItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Covenant Condition Item GUiD", "format": "uuid", "example": "88009731-77df-4e72-98e7-0d314b7a5151" }, "dataKey": { "type": "string", "nullable": true }, "value": { "type": "string", "description": "Covenant Condition Item Value", "nullable": true, "example": "Covenant 1" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto" }, "description": "Properties of a Covenant Condition Item", "nullable": true }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/CovenantConditionAssociationDto" }, "description": "List of Covenant Condition Associations", "nullable": true } }, "additionalProperties": false, "description": "Covenant Condition Item" }, "CovenantConditionSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Covenant Condition Set GUiD", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "parentId": { "type": "string", "description": "Parent Id which Covenant Condition belongs", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "parentType": { "type": "string", "description": "Parent Type which Covenant Condition belongs", "nullable": true, "example": "Deal" }, "status": { "type": "string", "description": "Covenant Condition Set Status", "nullable": true, "example": "Draft" }, "covenantConditionVersions": { "type": "array", "items": { "$ref": "#/components/schemas/CovenantConditionVersionDto" }, "description": "List of Covenant Condition Versions", "nullable": true } }, "additionalProperties": false }, "CovenantConditionSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CovenantConditionSetDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CovenantConditionTaskDetailsDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Covenant Condition Set Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "parentId": { "type": "string", "description": "Parent Id which Covenant Condition belongs", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "parentType": { "type": "string", "description": "Parent Type which Covenant Condition belongs", "nullable": true, "example": "Deal" }, "status": { "type": "string", "description": "Covenant Condition Set Status", "nullable": true, "example": "Draft" }, "covenantConditionVersions": { "type": "array", "items": { "$ref": "#/components/schemas/CovenantConditionVersionDto" }, "description": "List of All Covenant Condition Versions for Task", "nullable": true }, "latestVersion": { "allOf": [ { "$ref": "#/components/schemas/CovenantConditionVersionDto" } ], "description": "Latest Covenant Condition Version for TaskId", "nullable": true } }, "additionalProperties": false, "description": "Covenant Condition Details for ParentId, JourneyId and TaskId" }, "CovenantConditionTaskDetailsDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CovenantConditionTaskDetailsDto" } ], "description": "Covenant Condition Details for ParentId, JourneyId and TaskId", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CovenantConditionVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Covenant Condition Version GUiD", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "setId": { "type": "string", "description": "Covenant Condition Set GUiD", "format": "uuid", "example": "a4309731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "Journey Id which Covenant Condition version belongs", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "taskId": { "type": "string", "description": "Task Id which Covenant Condition version belongs", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "description": { "type": "string", "description": "Covenant Condition description", "nullable": true, "example": "Set 1 Version" }, "status": { "type": "string", "description": "Covenant Condition Status", "nullable": true, "example": "Draft" }, "covenantConditionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/CovenantConditionGroupDto" }, "nullable": true }, "lastUpdatedDateTime": { "type": "string", "description": "Last time it was updated (Read-only)", "format": "date-time", "example": "2022-12-12T15:55:00.000Z" }, "createdDateTime": { "type": "string", "description": "Date time it was created (Read-only)", "format": "date-time", "example": "2020-12-12T15:55:00.000Z" }, "versionNumber": { "type": "integer", "description": "Covenant Condition Version", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Covenant Condition Version representation" }, "CovenantConditionVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CovenantConditionVersionDto" } ], "description": "Covenant Condition Version representation", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ExternalProviderRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "GroupRequirement": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true }, "primaryDataGroupField": { "type": "string", "nullable": true }, "snapshotPropertyItems": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRequirementItem" }, "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "nullable": true } }, "additionalProperties": false }, "GroupRequirementItem": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "valueType": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "isAdditionalField": { "type": "boolean" }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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": { } }, "PropertyType": { "enum": [ "Single" ], "type": "string" }, "RegexRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "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 }, "SinglePropertyDto": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "discriminator": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SnapshotSet": { "type": "object", "properties": { "setId": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string", "format": "uuid" }, "versionId": { "type": "string", "format": "uuid" }, "snapshotGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRequirement" }, "nullable": true } }, "additionalProperties": false }, "SnapshotSetServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SnapshotSet" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "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 }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto" } ], "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" } ], "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto" } ], "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" } ] } }, "ValidationRuleDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "setId": { "type": "string", "format": "uuid" }, "propertyId": { "type": "string", "format": "uuid" }, "dataGroupId": { "type": "string", "format": "uuid", "nullable": true }, "isDataGroup": { "type": "boolean" }, "propertyName": { "type": "string", "nullable": true }, "friendlyName": { "type": "string", "nullable": true }, "validationType": { "type": "string", "nullable": true }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }