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


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

", "version": "1.0" }, "servers": [ { "url": "/dealscommand" } ], "paths": { "/api/deals/{dealId}/drafts": { "post": { "tags": [ "DealDrafts" ], "summary": "Create a Deal Draft", "description": "

Required permissions:
Following permissions are required: DealCreate", "operationId": "CreateDealDraft", "parameters": [ { "name": "dealId", "in": "path", "description": "Deal 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": "Update deal draft request. Must contain deal draft properties", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DealDraftDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DealDraftDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DealDraftDtoServiceRequest" } ] } } } }, "responses": { "201": { "description": "Success. Deal Draft created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateDealDraftResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDealDraftResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDealDraftResponseServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "403": { "description": "Forbidden. User doesn't have proper permissions" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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/deals/{dealId}/drafts/{draftId}": { "put": { "tags": [ "DealDrafts" ], "summary": "Update deal draft", "description": "\nUpdates an existing deal draft.

Required permissions:
Following permissions are required: DealEdit", "operationId": "UpdateDealDraft", "parameters": [ { "name": "dealId", "in": "path", "description": "Deal id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "draftId", "in": "path", "description": "Deal draft 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": "Update deal draft request. Must contain deal draft properties", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDealDraftRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDealDraftRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDealDraftRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Deal draft updated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateDealDraftResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDealDraftResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDealDraftResponseServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Deal/Deal draft with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "DealDrafts" ], "summary": "Deletes a deal draft", "description": "\nThis method deletes a deal draft record and all associated drafts.

Required permissions:
Following permissions are required: DealDelete", "operationId": "DeleteDealDraft", "parameters": [ { "name": "dealId", "in": "path", "description": "Deal id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "draftId", "in": "path", "description": "Deal draft 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": "Success. Deal Draft deleted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal Server Error" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Deal Draft 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" } ] } } } }, "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/deals/{dealId}/drafts/{draftId}/complete": { "post": { "tags": [ "DealDrafts" ], "summary": "Validate and Update deal draft", "description": "\nChecks that an update to an existing deal draft is valid. Updates the draft only if valid. Returns Validation Errors if not

Required permissions:
Following permissions are required: DealEdit", "operationId": "ValidateAndUpdateDealDraft", "parameters": [ { "name": "dealId", "in": "path", "description": "Deal id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "draftId", "in": "path", "description": "Deal draft 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": "Update deal draft request. Must contain deal draft properties", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDealDraftRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDealDraftRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDealDraftRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Deal draft updated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateDealDraftResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDealDraftResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDealDraftResponseServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Deal/Deal draft with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "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/deals": { "post": { "tags": [ "Deals" ], "summary": "Create a Deal", "description": "

Required permissions:
Following permissions are required: DealCreate", "operationId": "CreateDeal", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DealDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DealDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DealDtoServiceRequest" } ] } } } }, "responses": { "201": { "description": "Success. Deal created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateDealResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDealResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDealResponseServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "403": { "description": "Forbidden. User doesn't have proper permissions" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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/deals/{id}": { "delete": { "tags": [ "Deals" ], "summary": "Deletes a deal", "description": "\nThis method deletes a deal record and all associated drafts.

Required permissions:
Following permissions are required: DealDelete", "operationId": "DeleteDeal", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the deal", "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": "Success. Deal deleted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal Server Error" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Deal 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" } ] } } } }, "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/deals/{id}/create-url-to-upload-file": { "post": { "tags": [ "Deals" ], "summary": "Create url to upload file.\r\nThis endpoint is intended for use with the new DataField type - RichTextEditor.", "description": "

Required permissions:
At least one of the following permissions is required: DealEdit", "operationId": "CreateUrlToUploadFile", "parameters": [ { "name": "id", "in": "path", "description": "Deal 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": "Parameters to create url to upload", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUrlToUploadFileRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUrlToUploadFileRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUrlToUploadFileRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateUrlToUploadFileResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUrlToUploadFileResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUrlToUploadFileResponseDtoServiceResponse" } } } }, "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" } } } }, "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/deals/{id}/enable-editing": { "post": { "tags": [ "Deals" ], "summary": "Creates new draft entries for each entry required to make a verified deal editable.\r\nIf any draft creation fails, all created drafts are deleted\r\nto ensure the Deal remains in a working state.", "description": "

Required permissions:
At least one of the following permissions is required: DealEdit", "operationId": "EnableEditing", "parameters": [ { "name": "id", "in": "path", "description": "Deal 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": "Parameters required to create drafts of connected entities", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateDraftsForAllEntitiesInDealRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateDraftsForAllEntitiesInDealRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateDraftsForAllEntitiesInDealRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateDraftsForAllEntitiesInDealResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDraftsForAllEntitiesInDealResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDraftsForAllEntitiesInDealResponseServiceResponse" } } } }, "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" } } } }, "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/requirement-set": { "post": { "tags": [ "RequirementSet" ], "summary": "Create requirement set", "description": "

Required permissions:
Following permissions are required: DealConfigurationEdit", "operationId": "CreateRequirementSet", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDtoServiceRequest" } ] } } } }, "responses": { "201": { "description": "Success. Requirement set created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateRequirementSetResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateRequirementSetResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRequirementSetResponseServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "403": { "description": "Forbidden. User doesn't have proper permissions" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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/requirement-set/{requirementSetId}": { "post": { "tags": [ "RequirementSet" ], "summary": "Create requirement set version", "description": "\nCreates a new version of an existing requirement set.

Required permissions:
Following permissions are required: DealConfigurationEdit", "operationId": "CreateRequirementSetVersion", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement 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": "Create a new Version for existing Requirement Set", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDtoServiceRequest" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateRequirementSetVersionResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateRequirementSetVersionResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRequirementSetVersionResponseServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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" } } } }, "202": { "description": "Success. Requirement set version created" }, "403": { "description": "Forbidden. User doesn't have proper permissions" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "RequirementSet" ], "summary": "Delete requirement set", "description": "

Required permissions:
Following permissions are required: DealConfigurationDelete", "operationId": "DeleteRequirementSet", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement 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" } ], "responses": { "202": { "description": "Success. Requirement Set version deleted" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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" } } } }, "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/requirement-set/{requirementSetId}/version/{versionNumber}": { "put": { "tags": [ "RequirementSet" ], "summary": "Update requirement set version", "description": "\nUpdates an existing Deal requirement set version. Only draft and rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: DealConfigurationEdit", "operationId": "UpdateRequirementSetVersion", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to update", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "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": "Update requirement set version request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Requirement set version updated" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "403": { "description": "Forbidden. User doesn't have proper permissions" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "RequirementSet" ], "summary": "Delete requirement set version", "description": "

Required permissions:
Following permissions are required: DealConfigurationDelete", "operationId": "DeleteRequirementSetVersion", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to delete", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "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": "Success. Requirement Set version deleted" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set or Requirement set version with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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" } } } }, "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/requirement-set/{requirementSetId}/version/{versionNumber}/submit-for-approval": { "put": { "tags": [ "RequirementSet" ], "summary": "Submit requirement set version for approval", "description": "\nSubmits the selected version of an existing requirement set for approval.

Required permissions:
Following permissions are required: DealConfigurationEdit", "operationId": "SubmitRequirementSetVersion", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to submit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "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": "Success. Requirement version submitted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "403": { "description": "Forbidden. User doesn't have proper permissions" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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/requirement-set/{requirementSetId}/version/{versionNumber}/sign": { "put": { "tags": [ "RequirementSet" ], "summary": "Sign requirement set version", "description": "\nSigns the selected version of an existing requirements set and changes the version status accordingly to the action (Approve/Reject).

Required permissions:
Following permissions are required: DealConfigurationApprove", "operationId": "SignRequirementSetVersion", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to sign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "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": "Sign requirement set version request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Deals version signed" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement Set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "403": { "description": "Forbidden. User doesn't have proper permissions" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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/requirement-set/{requirementSetId}/version/{versionNumber}/draft": { "post": { "tags": [ "RequirementSet" ], "summary": "Create requirement set version from provided version number", "description": "

Required permissions:
Following permissions are required: DealConfigurationEdit", "operationId": "CreateRequirementSetVersionDraft", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number from which new draft will be created", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "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": { "201": { "description": "Success. Requirement set version created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateRequirementSetVersionDraftResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateRequirementSetVersionDraftResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRequirementSetVersionDraftResponseServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set with given id and version number does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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" } } } }, "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/requirement-set/{requirementSetId}/version/{versionNumber}/archive": { "put": { "tags": [ "RequirementSet" ], "summary": "Archive a Deal Requirement Set Version", "description": "\nArchives the selected version of an existing deal requirement set.

Required permissions:
Following permissions are required: DealConfigurationEdit", "operationId": "ArchiveRequirementSetVersion", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to archive", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "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": "Success. Requirement version archived" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement 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/requirement-set/{requirementSetId}/version/{versionNumber}/field": { "post": { "tags": [ "RequirementSet" ], "summary": "Add deal requirement", "description": "

Required permissions:
Following permissions are required: DealConfigurationEdit", "operationId": "AddRequirement", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Deal requirement set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Deal requirement set version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "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": "Add requirement request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementDtoServiceRequest" } ] } } } }, "responses": { "201": { "description": "Success. Requirement added", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateRequirementResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateRequirementResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRequirementResponseServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set or 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/requirement-set/{requirementSetId}/version/{versionNumber}/field/{requirementId}": { "put": { "tags": [ "RequirementSet" ], "summary": "Update a deal requirement", "description": "

Required permissions:
Following permissions are required: DealConfigurationEdit", "operationId": "UpdateRequirement", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement Set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "requirementId", "in": "path", "description": "Requirement 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": "Update requirement request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequirementDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Requirement updated" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set or 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" } ] } } } } } }, "delete": { "tags": [ "RequirementSet" ], "summary": "Delete a deal requirement", "description": "

Required permissions:
Following permissions are required: DealConfigurationDelete", "operationId": "DeleteRequirement", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement Set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "requirementId", "in": "path", "description": "Requirement 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": "Success. Requirement Deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set or 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": { "AccountRelatedFundDto": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "AccountRelatedFundsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "accountRelatedFunds": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelatedFundDto" }, "nullable": true } }, "additionalProperties": false }, "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ApproveActionServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true } }, "additionalProperties": false }, "AutoCreditAssessmentDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "autoCreditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditAssessmentDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditAssessmentDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "assessmentOutcome": { "type": "string", "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangedFieldDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangedFieldsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "changedFields": { "type": "array", "items": { "$ref": "#/components/schemas/ChangedFieldDto" }, "nullable": true } }, "additionalProperties": false }, "CollateralDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "collaterals": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" }, "nullable": true } }, "additionalProperties": false }, "CollateralDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "Collection": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "CollectionDto": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "propertiesInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyInfoDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionItemDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } ] }, "CollectionMinimumCountRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "CollectionProperty": { "allOf": [ { "$ref": "#/components/schemas/Property" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Collection" } } }, "additionalProperties": false } ] }, "CollectionPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "dataGroupVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CollectionPropertyDto2": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionItemDto" }, "nullable": true }, "collectionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CollectionPropertyInfoDto": { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConditionDefinitionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueType": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "operation": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "nullable": true } }, "additionalProperties": false }, "ConditionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true } }, "additionalProperties": false }, "ConditionalValueDto": { "allOf": [ { "$ref": "#/components/schemas/StringConditionalValueDto" }, { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "ConditionalValueDto`1": { "allOf": [ { "$ref": "#/components/schemas/ConditionDto" }, { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/T" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "CreateDealDraftResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dealId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "requirementSetId": { "type": "string", "format": "uuid" }, "requirementSetVersion": { "type": "integer", "format": "int32" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "description": "This is a generic property which must be replaced with either a `SingleProperty` or a `CollectionProperty`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false }, "CreateDealDraftResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateDealDraftResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateDealResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "requirementSetId": { "type": "string", "format": "uuid" }, "requirementSetVersion": { "type": "integer", "format": "int32" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "description": "This is a generic property which must be replaced with either a `SingleProperty` or a `CollectionProperty`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false }, "CreateDealResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateDealResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateDraftsForAllEntitiesInDealRequestDto": { "type": "object", "properties": { "journeyId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "productIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "CreateDraftsForAllEntitiesInDealRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateDraftsForAllEntitiesInDealRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "CreateDraftsForAllEntitiesInDealResponse": { "type": "object", "properties": { "dealDraftId": { "type": "string", "format": "uuid" }, "productIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "associationIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "covenantsConditionsId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateDraftsForAllEntitiesInDealResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateDraftsForAllEntitiesInDealResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateRequirementResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateRequirementResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateRequirementResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateRequirementSetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateRequirementSetResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateRequirementSetResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateRequirementSetVersionDraftResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateRequirementSetVersionDraftResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateRequirementSetVersionDraftResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateRequirementSetVersionResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" }, "requirementSetId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "requirements": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementDto" }, "nullable": true } }, "additionalProperties": false }, "CreateRequirementSetVersionResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateRequirementSetVersionResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateUrlToUploadFileRequestDto": { "type": "object", "properties": { "fileName": { "type": "string" }, "dataKey": { "type": "string" }, "isRootContent": { "type": "boolean" }, "dealDraftId": { "type": "string", "format": "uuid" }, "contentSize": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "CreateUrlToUploadFileRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateUrlToUploadFileRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "CreateUrlToUploadFileResponseDto": { "type": "object", "properties": { "url": { "type": "string" }, "fileIdentifier": { "type": "string" } }, "additionalProperties": false }, "CreateUrlToUploadFileResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateUrlToUploadFileResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditAssessmentDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "assessmentOutcome": { "type": "string", "nullable": true }, "assessmentComment": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "taskDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentDataGroupItemDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CurrentFieldDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "currentField": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentJourneysDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "inProgressJourneyTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CurrentProductDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "customTypeId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CustomPropertyDto2": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "CustomProviderResponseDto": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DataFieldDto": { "type": "object", "properties": { "propertyName": { "type": "string" }, "propertyType": { "type": "string" }, "propertyTypeId": { "type": "string", "format": "uuid", "nullable": true }, "linkChildFieldPropertyName": { "type": "string", "nullable": true }, "formulaSchema": { "allOf": [ { "$ref": "#/components/schemas/FormulaSchemaDto" } ], "nullable": true } }, "additionalProperties": false }, "DataSourcesDto": { "type": "object", "properties": { "entityDataMetadata": { "allOf": [ { "$ref": "#/components/schemas/EntityDataMetadataDataSource" } ], "nullable": true }, "eventIngress": { "allOf": [ { "$ref": "#/components/schemas/EventIngressDataSource" } ], "nullable": true }, "changedFields": { "allOf": [ { "$ref": "#/components/schemas/ChangedFieldsDataSource" } ], "nullable": true }, "relatedClient": { "allOf": [ { "$ref": "#/components/schemas/RelatedClientDataSource" } ], "nullable": true }, "relatedProducts": { "allOf": [ { "$ref": "#/components/schemas/RelatedProductsDataSource" } ], "nullable": true }, "currentDataGroupItem": { "allOf": [ { "$ref": "#/components/schemas/CurrentDataGroupItemDataSource" } ], "nullable": true }, "externalDataAdapter": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataAdapterDataSource" } ], "nullable": true }, "entityAssociation": { "allOf": [ { "$ref": "#/components/schemas/EntityAssociationDataSource" } ], "nullable": true }, "manualCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditAssessmentV2DataSource" } ], "nullable": true }, "autoCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditAssessmentDataSource" } ], "nullable": true }, "manualCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditScreeningDataSource" } ], "nullable": true }, "collateral": { "allOf": [ { "$ref": "#/components/schemas/CollateralDataSource" } ], "nullable": true }, "currentJourneys": { "allOf": [ { "$ref": "#/components/schemas/CurrentJourneysDataSource" } ], "nullable": true }, "autoCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditScreeningDataSource" } ], "nullable": true }, "currentProduct": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductDataSource" } ], "nullable": true }, "relatedDeals": { "allOf": [ { "$ref": "#/components/schemas/RelatedDealsDataSource" } ], "nullable": true }, "mainEntity": { "allOf": [ { "$ref": "#/components/schemas/MainEntityDataSource" } ], "nullable": true }, "relatedAssets": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssetsDataSource" } ], "nullable": true }, "relatedAssociations": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssociationsDataSource" } ], "nullable": true }, "accountRelatedFunds": { "allOf": [ { "$ref": "#/components/schemas/AccountRelatedFundsDataSource" } ], "nullable": true }, "journeyLevelData": { "allOf": [ { "$ref": "#/components/schemas/JourneyLevelDataDataSource" } ], "nullable": true }, "relatedParties": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartiesDataSource" } ], "nullable": true }, "currentField": { "allOf": [ { "$ref": "#/components/schemas/CurrentFieldDataSource" } ], "nullable": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDataSource" } ], "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false } ] }, "DealDraftDto": { "type": "object", "properties": { "journeyId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "description": "This is a generic property which must be replaced with either a `SingleProperty` or a `CollectionProperty`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "categoriesInScope": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "isDocumentEnabled": { "type": "boolean" }, "customProviderResponse": { "allOf": [ { "$ref": "#/components/schemas/CustomProviderResponseDto" } ], "nullable": true } }, "additionalProperties": false }, "DealDraftDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DealDraftDto" } ], "nullable": true } }, "additionalProperties": false }, "DealDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "requirementSetId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "description": "This is a generic property which must be replaced with either a `SingleProperty` or a `CollectionProperty`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false }, "DealDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DealDto" } ], "nullable": true } }, "additionalProperties": false }, "DealPropertyType": { "enum": [ "Single", "Group", "Collection" ], "type": "string" }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "EntityAssociationDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "associationType": { "type": "string", "nullable": true }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "type": "string", "nullable": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "EntityDataMetadataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "entityType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventIngressDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "type": "string", "nullable": true }, "eventSubtype": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalDataAdapterDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "type": "string", "nullable": true }, "eventSubtype": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FilterConditionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true } }, "additionalProperties": false }, "FormulaSchemaDto": { "type": "object", "properties": { "formulaSetId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32", "nullable": true }, "formulaString": { "type": "string" }, "formulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FormulaVariableDto" }, "nullable": true } }, "additionalProperties": false }, "FormulaVariableDto": { "type": "object", "properties": { "dataSource": { "type": "string" }, "propertyName": { "type": "string" }, "filterConditions": { "type": "array", "items": { "$ref": "#/components/schemas/FilterConditionDto" }, "nullable": true } }, "additionalProperties": false }, "GroupProperty": { "allOf": [ { "$ref": "#/components/schemas/Property" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } ] }, "HttpValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "additionalProperties": { } } ] }, "JourneyLevelDataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "MainEntityDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "ManualCreditAssessmentV2DataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/CreditAssessmentDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" }, "nullable": true }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningDto": { "type": "object", "properties": { "taskDataKey": { "type": "string", "nullable": true }, "taskId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "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": { } }, "PropertiesDto": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "collectionProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "Property": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/DealPropertyType" } ], "readOnly": true }, "discriminator": { "allOf": [ { "$ref": "#/components/schemas/DealPropertyType" } ], "readOnly": true } }, "additionalProperties": false }, "PropertyDto": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "discriminator": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "isValid": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "RegexRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string" } }, "additionalProperties": false } ] }, "RelatedAssetDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedAssetsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssetDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedAssociationDto": { "type": "object", "properties": { "associationType": { "type": "string", "nullable": true }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "type": "string", "nullable": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "RelatedAssociationsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssociationDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedClientDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedDealDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedDealsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedDeals": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDealDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedPartiesDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedParties": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedPartyDto": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RelatedProductDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true }, "relationshipTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RelatedProductsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedProductDto" }, "nullable": true } }, "additionalProperties": false }, "RequirementDto": { "type": "object", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "classification": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "dataField": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "nullable": true }, "order": { "type": "number", "format": "double", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "isSecondaryIdentifier": { "type": "boolean" }, "secondaryIdentifierOrder": { "type": "number", "format": "double", "nullable": true }, "isReadOnly": { "type": "boolean" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true }, "conditionalValues": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalValueDto" }, "nullable": true }, "documentDescription": { "type": "string", "nullable": true }, "documentDataKey": { "type": "string", "nullable": true }, "isMandatory": { "type": "boolean" }, "defaultDateType": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "uiDecoration": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RequirementDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementDto" } ], "nullable": true } }, "additionalProperties": false }, "RequirementSetDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string" }, "effectiveFrom": { "type": "string", "format": "date-time" }, "notes": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32", "nullable": true }, "requirements": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementDto" }, "nullable": true } }, "additionalProperties": false }, "RequirementSetDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDto" } ], "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 }, "SignificanceEngineDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "significanceEngine": { "type": "array", "items": { "$ref": "#/components/schemas/SignificanceEngineDto" }, "nullable": true } }, "additionalProperties": false }, "SignificanceEngineDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SingleProperty": { "allOf": [ { "$ref": "#/components/schemas/Property" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "SinglePropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "SinglePropertyDto2": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "excludedCharacters": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "StringConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "T": { "type": "object", "additionalProperties": false }, "UpdateDealDraftRequestDto": { "type": "object", "properties": { "dealDraft": { "allOf": [ { "$ref": "#/components/schemas/DealDraftDto" } ] }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ] } }, "additionalProperties": false }, "UpdateDealDraftRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDealDraftRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "UpdateDealDraftResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dealId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "requirementSetId": { "type": "string", "format": "uuid" }, "requirementSetVersion": { "type": "integer", "format": "int32" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "description": "This is a generic property which must be replaced with either a `SingleProperty` or a `CollectionProperty`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false }, "UpdateDealDraftResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDealDraftResponse" } ], "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 }, "disallowTodaysDate": { "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 }, "timeZoneId": { "type": "string", "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": { "propertyName": { "type": "string" }, "friendlyName": { "type": "string", "nullable": true }, "validationType": { "type": "string", "nullable": true }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "nullable": true } }, "additionalProperties": false }, "ValueField": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "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": [ ] } ] }