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


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


**Covenants & Conditions Command API provides**:
", "version": "1.0" }, "servers": [ { "url": "/covenantsconditionscommand" } ], "paths": { "/api/CovenantCondition": { "post": { "tags": [ "CovenantCondition" ], "summary": "Create a new Covenant Condition Set", "description": "\nCreates a new Covenant Condition Set for the parent.

Required permissions:
Following permissions are required: CovenantsConditionsEdit", "operationId": "CreateCovenantConditionSet", "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 Covenant Condition Set request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionSetDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionSetDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CovenantConditionSetDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Covenant Condition Set created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CovenantConditionSetDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionSetDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionSetDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/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/{setId}/version": { "post": { "tags": [ "CovenantCondition" ], "summary": "Create a new Covenant Condition Version", "description": "\nThis method creates a new Covenant Condition Version based on the previous completed version.

Required permissions:
Following permissions are required: CovenantsConditionsEdit", "operationId": "CreateCovenantConditionVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Covenant Condition Set 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" } ], "requestBody": { "description": "ServiceRequest with the schema snapshot data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Covenant Condition Set with given ID does not exists", "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/{setId}/version/{id}": { "put": { "tags": [ "CovenantCondition" ], "summary": "Update a Covenant Condition Version", "description": "\nThis method updates an existing Covenant Condition Version.\n\nOnly Covenant Condition Version with draft status can be updated.\n\nOnly Covenant Condition Version that satisfies non-mandatory validation rules can be updated.

Required permissions:
Following permissions are required: CovenantsConditionsEdit", "operationId": "UpdateCovenantConditionVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Covenant Condition Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Covenant Condition Version 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" } ], "requestBody": { "description": "Covenant Condition Version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Covenant Condition with given ID does not exists", "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/{setId}/version/{id}/status": { "put": { "tags": [ "CovenantCondition" ], "summary": "Update a Covenant Condition Version status", "description": "\nThis method updates an existing Covenant Condition Version status.\n\nOnly Covenant Condition Version with draft status can be updated.

Required permissions:
Following permissions are required: CovenantsConditionsEdit", "operationId": "UpdateCovenantConditionVersionStatus", "parameters": [ { "name": "setId", "in": "path", "description": "Covenant Condition Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Covenant Condition Version 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" } ], "requestBody": { "description": "Status body: Draft, Completed, Rejected, Verified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Covenant Condition Set with given ID does not exists", "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/journey/{journeyId}/verify": { "put": { "tags": [ "CovenantCondition" ], "summary": "Update a Covenant Condition Version status", "description": "\nThis method verify the completed Covenant Condition Versions for the journey.\n\nOnly Covenant Condition Version with Completed status can be verified.

Required permissions:
Following permissions are required: CovenantsConditionsEdit", "operationId": "VerifyCovenantConditionsForJourney", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey 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": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/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}/snapshot": { "post": { "tags": [ "CovenantCondition" ], "summary": "Take a policy snapshot for Covenant Condition", "description": "\nThis method take a policy snapshot for a Covenant Condition.

Required permissions:
Following permissions are required: CovenantsConditionsEdit", "operationId": "SnapshotCovenantConditionConfiguration", "parameters": [ { "name": "setId", "in": "path", "description": "Covenant Condition Set 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" } ], "requestBody": { "description": "Covenant Condition Policy Snapshot data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Covenant Condition Set with given ID does not exists", "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/batch/update": { "put": { "tags": [ "CovenantConditionBatch" ], "summary": "Update a batch of covenant condition version", "description": "\nThis method updates a batch of existing Covenant Condition Version.\n\nOnly Covenant Condition Version with \"Draft\" status can be updated.

Required permissions:
Following permissions are required: CovenantsConditionsEdit", "operationId": "UpdateBatch", "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": "Batch of Covenant Condition Version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoIEnumerableServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoIEnumerableServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CovenantConditionVersionDtoIEnumerableServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/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/batch/complete": { "put": { "tags": [ "CovenantConditionBatch" ], "summary": "Complete a batch of covenant condition version", "description": "\nThis method completes a batch of existing Covenant Condition Version.\n\nOnly Covenant Condition Version with \"Draft\" status can be updated.

Required permissions:
Following permissions are required: CovenantsConditionsEdit", "operationId": "CompleteBatch", "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": "Batch of Covenant Condition Version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchCompleteDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchCompleteDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BatchCompleteDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/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/batch/snapshot": { "post": { "tags": [ "CovenantConditionBatch" ], "summary": "Take a batch of snapshot for covenant condition version", "description": "\nThis method takes a batch of snapshot for existing Covenant Condition Version.

Required permissions:
Following permissions are required: CovenantsConditionsEdit", "operationId": "BatchSnapshot", "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": "Batch of Covenant Condition Version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetIEnumerableServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetIEnumerableServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SnapshotSetIEnumerableServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchSnapshotResultDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchSnapshotResultDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchSnapshotResultDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/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" } ] } } } } } } } }, "components": { "schemas": { "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatchCompleteDto": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/components/schemas/CompleteDto" }, "nullable": true } }, "additionalProperties": false }, "BatchCompleteDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchCompleteDto" } }, "additionalProperties": false }, "BatchErrorDto": { "type": "object", "properties": { "setId": { "type": "string", "format": "uuid" }, "versionId": { "type": "string", "format": "uuid" }, "error": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "BatchResultDto": { "type": "object", "properties": { "versions": { "type": "array", "items": { "$ref": "#/components/schemas/CovenantConditionVersionDto" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BatchErrorDto" }, "nullable": true } }, "additionalProperties": false }, "BatchResultDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchResultDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "BatchSnapshotResultDto": { "type": "object", "properties": { "snapshotSets": { "type": "array", "items": { "$ref": "#/components/schemas/SnapshotSet" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BatchErrorDto" }, "nullable": true } }, "additionalProperties": false }, "BatchSnapshotResultDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchSnapshotResultDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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 }, "CompleteDto": { "type": "object", "properties": { "setId": { "type": "string", "format": "uuid" }, "versionId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CovenantConditionAssociationDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sourceId": { "type": "string", "format": "uuid" }, "targetId": { "type": "string", "format": "uuid" }, "targetType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CovenantConditionGroupDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dataGroupId": { "type": "string", "format": "uuid" }, "dataGroupVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "covenantConditionItems": { "type": "array", "items": { "$ref": "#/components/schemas/CovenantConditionItemDto" }, "nullable": true } }, "additionalProperties": false }, "CovenantConditionItemDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dataKey": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto" }, "nullable": true }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/CovenantConditionAssociationDto" }, "nullable": true } }, "additionalProperties": false }, "CovenantConditionSetDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "format": "uuid" }, "parentType": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CovenantConditionSetDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CovenantConditionSetDto" } }, "additionalProperties": false }, "CovenantConditionSetDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CovenantConditionSetDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CovenantConditionVersionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "setId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "covenantConditionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/CovenantConditionGroupDto" }, "nullable": true }, "lastUpdatedDateTime": { "type": "string", "format": "date-time" }, "createdDateTime": { "type": "string", "format": "date-time" }, "vesionNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CovenantConditionVersionDtoIEnumerableServiceRequest": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CovenantConditionVersionDto" }, "nullable": true } }, "additionalProperties": false }, "CovenantConditionVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CovenantConditionVersionDto" } }, "additionalProperties": false }, "CovenantConditionVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CovenantConditionVersionDto" }, "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": { "$ref": "#/components/schemas/ValidationRuleDto" } }, "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": { "$ref": "#/components/schemas/ValidationRuleDto" } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "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": { "$ref": "#/components/schemas/PropertyType" }, "discriminator": { "$ref": "#/components/schemas/PropertyType" }, "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 }, "SnapshotSetIEnumerableServiceRequest": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SnapshotSet" }, "nullable": true } }, "additionalProperties": false }, "SnapshotSetServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SnapshotSet" } }, "additionalProperties": false }, "SnapshotSetServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SnapshotSet" }, "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 }, "StatusDto": { "type": "object", "properties": { "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StatusDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StatusDto" } }, "additionalProperties": false }, "StatusDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StatusDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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": { "$ref": "#/components/schemas/BasicRuleDto" }, "specialCharacters": { "$ref": "#/components/schemas/SpecialCharactersRuleDto" }, "noNumbers": { "$ref": "#/components/schemas/BasicRuleDto" }, "onlyInteger": { "$ref": "#/components/schemas/BasicRuleDto" }, "noNegative": { "$ref": "#/components/schemas/BasicRuleDto" }, "onlyDecimal": { "$ref": "#/components/schemas/BasicRuleDto" }, "regex": { "$ref": "#/components/schemas/RegexRuleDto" }, "characterLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" }, "numberLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" }, "noFutureDates": { "$ref": "#/components/schemas/BasicRuleDto" }, "noPastDates": { "$ref": "#/components/schemas/BasicRuleDto" }, "dateLimit": { "$ref": "#/components/schemas/DateLimitRuleDto" }, "multiSelectLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" }, "collectionMinimumCount": { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" }, "collectionMaximumCount": { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" }, "externalProvider": { "$ref": "#/components/schemas/ExternalProviderRuleDto" } }, "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": { "$ref": "#/components/schemas/ValidationDataDto" } }, "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": [ ] } ] }