{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Collateral Query", "description": "Collateral Query API is part of FenX eco-system to manage Collateral Data. All the operations require valid access token obtained from Identity service.", "version": "1.0" }, "servers": [ { "url": "/collateralquery" } ], "paths": { "/api/asset/{id}": { "get": { "tags": [ "Asset" ], "summary": "Get an Asset by Id", "description": "\nThis method returns the Asset of specified Id.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetAssetById", "parameters": [ { "name": "id", "in": "path", "description": "Asset Id", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDtoServiceResponse" } } } }, "400": { "description": "Asset Id is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "No Asset was found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "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": "Error Code" } ] } } } } } } }, "/api/asset/getAssetsList": { "post": { "tags": [ "Asset" ], "summary": "Get Assets with specified attributes", "description": "\nThis method returns Assets with attributes specified.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetAssetsList", "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/AssetQueryDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDtoListServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the request" }, "202": { "description": "Success. Assets are returned" }, "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": "Error Code" } ] } } } } } } }, "/api/asset/collateral/{collateralId}/journey/{journeyId}/task/{taskId}/snapshot": { "get": { "tags": [ "Asset" ], "summary": "Get Collateral Assets snapshot for the given Task", "description": "\nThis method retrieves an object containing lists of Assets and drafts from S3 for a given taskId

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetAssetsSnapShot", "parameters": [ { "name": "collateralId", "in": "path", "description": "The id of a Collateral that the Assets belong to", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The id of a Journey that the Assets belong to", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "The id of a Task that the Assets belong to", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetSnapshotDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the query" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "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": "Error Code" } ] } } } } } } }, "/api/asset/draft/{assetDraftId}": { "get": { "tags": [ "AssetDraft" ], "summary": "Get an Asset Draft by Id", "description": "\nThis method returns the Asset Draft of specified Id.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetAssetDraftById", "parameters": [ { "name": "assetDraftId", "in": "path", "description": "Asset 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": { "200": { "description": "Success. An Asset Draft is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDraftDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Asset/Asset 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" } ] } } } }, "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": "Error Code" } ] } } } } } } }, "/api/asset/draft/{assetId}/{assetDraftId}": { "get": { "tags": [ "AssetDraft" ], "summary": "Get an Asset Draft by Id and Asset Id", "description": "\nThis method returns the Asset Draft of specified Id and Asset Id.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetAssetDraftByAssetId", "parameters": [ { "name": "assetDraftId", "in": "path", "description": "Asset Draft Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetId", "in": "path", "description": "Asset Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. An Asset Draft is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDraftDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Asset/Asset 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" } ] } } } }, "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": "Error Code" } ] } } } } } } }, "/api/asset/draft/list": { "post": { "tags": [ "AssetDraft" ], "summary": "Get all Asset Drafts by Ids", "description": "\nThis method returns the list of Asset Drafts of specified Ids.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetAssetDraftByIds", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "List of Asset Draft Ids", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AssetDraftListQueryDtoServiceRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Success. Asset Drafts are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDraftDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/asset/draft/journey/{journeyId}": { "get": { "tags": [ "AssetDraft" ], "summary": "Get all Asset Drafts by Journey Id", "description": "\nThis method returns the list of Asset Drafts of specified Journey Id.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetAssetDraftsByJourney", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Asset Drafts are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDraftDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/collateral": { "get": { "tags": [ "Collateral" ], "summary": "Get all Collaterals for a Tenant Id", "description": "This endpoint is obsolete and was terminated on 2023-09-30. This endpoint is obsolete, use GetCollateralsList instead.
\nThis method returns the list of Collaterals for the Tenant.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetCollaterals", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/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", "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": "Error Code" } ] } } } } }, "deprecated": true } }, "/api/collateral/{id}": { "get": { "tags": [ "Collateral" ], "summary": "Get a Collateral by Id", "description": "\nThis method returns the Collateral of specified Id.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetCollateralById", "parameters": [ { "name": "id", "in": "path", "description": "Collateral Id", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralDtoServiceResponse" } } } }, "400": { "description": "Collateral Id is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "No Collateral was found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "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": "Error Code" } ] } } } } } } }, "/api/collateral/getCollateralsList": { "post": { "tags": [ "Collateral" ], "summary": "Get Collaterals with specified attributes", "description": "\nThis method returns Collaterals with attributes specified.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetCollateralsList", "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/CollateralQueryDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralDtoListServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the request" }, "202": { "description": "Success. Collaterals are returned" }, "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": "Error Code" } ] } } } } } } }, "/api/collateral/journey/{journeyId}/task/{taskId}/snapshot": { "get": { "tags": [ "Collateral" ], "summary": "Get Collaterals snapshot for the given Task", "description": "\nThis method retrieves an object containing lists of Collaterals and drafts from S3 for a given taskId

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetCollateralsSnapShot", "parameters": [ { "name": "journeyId", "in": "path", "description": "The id of a Journey that the Collaterals belong to", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "The id of a Task that the Collaterals belong to", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralSnapshotDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the query" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "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": "Error Code" } ] } } } } } } }, "/api/collateral/journey/{journeyId}/validateAllocation": { "post": { "tags": [ "Collateral" ], "summary": "Validate Deal Collateral Allocation", "description": "\nThis method validate collaterals allocations that attached to deals

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "ValidateDealCollateralAllocation", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Validate collateral allocation request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateDealCollateralAllocationRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateDealCollateralAllocationResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the query" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "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": "Error Code" } ] } } } } } } }, "/api/collateral/related-collateral/entity/{entityId}/journey/{journeyId}": { "get": { "tags": [ "Collateral" ], "summary": "Get Related Collaterals Data Source", "description": "\nThis method retrieves related collaterals data source for a journey

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetRelatedCollateralDataSource", "parameters": [ { "name": "entityId", "in": "path", "description": "The Id of the existing Entity", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The Id of the existing Journey", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourcesLambdaResponseServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the query" }, "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": "Error Code" } ] } } } } } } }, "/api/collateral/draft/{collateralDraftId}": { "get": { "tags": [ "CollateralDraft" ], "summary": "Get an Collateral Draft by Id", "description": "\nThis method returns the Collateral Draft of specified Id.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetCollateralDraftById", "parameters": [ { "name": "collateralDraftId", "in": "path", "description": "Collateral 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": { "200": { "description": "Success. A Collateral Draft is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralDraftDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Collateral/Collateral 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" } ] } } } }, "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": "Error Code" } ] } } } } } } }, "/api/collateral/draft/{collateralId}/{collateralDraftId}": { "get": { "tags": [ "CollateralDraft" ], "summary": "Get an Collateral Draft by Id and Collateral Id", "description": "\nThis method returns the Collateral Draft of specified Id and Collateral Id.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetCollateralDraftByCollateralId", "parameters": [ { "name": "collateralDraftId", "in": "path", "description": "Collateral Draft Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "collateralId", "in": "path", "description": "Collateral Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Collateral Draft is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralDraftDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Collateral/Collateral 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" } ] } } } }, "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": "Error Code" } ] } } } } } } }, "/api/collateral/draft/list": { "post": { "tags": [ "CollateralDraft" ], "summary": "Get all Collateral Drafts by Ids", "description": "\nThis method returns the list of Collateral Drafts of specified Ids.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetCollateralDraftByIds", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "List of Collateral Draft Ids", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CollateralDraftListQueryDtoServiceRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Success. Collateral Drafts are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralDraftDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/collateral/draft/journey/{journeyId}": { "get": { "tags": [ "CollateralDraft" ], "summary": "Get all Collateral Drafts by Journey Id", "description": "\nThis method returns the list of Collateral Drafts of specified Journey Id.

Required permissions:
Following permissions are required: CollateralAccessAndSearch", "operationId": "GetCollateralDraftsByJourney", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Collateral Drafts are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralDraftDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } } }, "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 }, "AllocationValidationResultDto": { "type": "object", "properties": { "collateralId": { "type": "string", "nullable": true }, "collateralType": { "type": "string", "nullable": true }, "isValid": { "type": "boolean" }, "errorMessages": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "nullable": true } }, "additionalProperties": false }, "AssetDraftDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Asset Draft Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "type": { "type": "string", "description": "The Asset Type", "nullable": true, "example": "Financial Asset" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "List of custom properties for an Asset separate from the standard\r\nout of the box properties.", "nullable": true }, "status": { "type": "string", "description": "The Asset Draft Status", "nullable": true, "example": "Active" }, "assetVersion": { "type": "integer", "description": "The Version of Asset that Draft was made for", "format": "int32", "example": 1 }, "assetId": { "type": "string", "description": "The Asset Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "Id of the related Journey", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "version": { "type": "integer", "description": "Version of the Asset Draft", "format": "int32" }, "createdDate": { "type": "string", "description": "DateTime of the created Asset", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "An Asset object. \r\nContains all properties needed to fill the metadata of the Asset." }, "AssetDraftDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetDraftDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AssetDraftDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssetDraftDto" } ], "description": "An Asset object. \r\nContains all properties needed to fill the metadata of the Asset.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AssetDraftListQueryDto": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "The list of Asset Draft Ids to fetch", "nullable": true } }, "additionalProperties": false }, "AssetDraftListQueryDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssetDraftListQueryDto" } ], "nullable": true } }, "additionalProperties": false }, "AssetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Asset Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "type": { "type": "string", "description": "The Asset Type", "nullable": true, "example": "Financial Asset" }, "alternateId": { "type": "string", "description": "Asset Id from data migration", "nullable": true }, "collateralId": { "type": "string", "description": "The id of a linked collateral", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "List of custom properties for an Asset separate from the standard\r\nout of the box properties.", "nullable": true }, "lifecycleStatus": { "type": "string", "description": "The lifecycle status of the Asset", "nullable": true } }, "additionalProperties": false, "description": "Class to represent the Asset uploaded. \r\nContains all properties needed to fill the metadata of the Asset being uploaded." }, "AssetDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AssetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssetDto" } ], "description": "Class to represent the Asset uploaded. \r\nContains all properties needed to fill the metadata of the Asset being uploaded.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AssetQueryDto": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "The list of Asset Ids to fetch", "nullable": true }, "attributes": { "type": "array", "items": { "type": "string" }, "description": "The list of attributes to fetch the data for", "nullable": true } }, "additionalProperties": false }, "AssetQueryDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssetQueryDto" } ], "nullable": true } }, "additionalProperties": false }, "AssetSnapshotDto": { "type": "object", "properties": { "assets": { "type": "array", "items": { "$ref": "#/components/schemas/AssetDto" }, "description": "List of Assets", "nullable": true }, "assetDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/AssetDraftDto" }, "description": "List of Asset drafts", "nullable": true } }, "additionalProperties": false, "description": "An Asset snapshot object" }, "AssetSnapshotDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssetSnapshotDto" } ], "description": "An Asset snapshot object", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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 }, "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/CollateralDto2" }, "nullable": true } }, "additionalProperties": false }, "CollateralDraftDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Collateral Draft Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "type": { "type": "string", "description": "The Collateral Type", "nullable": true, "example": "Financial Asset" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "List of custom properties for a collateral separate from the standard\r\nout of the box properties.", "nullable": true }, "status": { "type": "string", "description": "The Collateral Draft Status", "nullable": true, "example": "Active" }, "sourceCollateralVersion": { "type": "integer", "description": "The Version of Collateral that draft was made for", "format": "int32", "example": 1 }, "sourceCollateralId": { "type": "string", "description": "The Collateral Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "Id of the related Journey", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "version": { "type": "integer", "description": "Version of the Collateral Draft", "format": "int32" }, "createdDate": { "type": "string", "description": "DateTime of the created Collateral", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A Collateral object. \r\nContains all properties needed to fill the metadata of the collateral." }, "CollateralDraftDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDraftDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CollateralDraftDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CollateralDraftDto" } ], "description": "A Collateral object. \r\nContains all properties needed to fill the metadata of the collateral.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CollateralDraftListQueryDto": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "The list of Collateral Draft Ids to fetch", "nullable": true } }, "additionalProperties": false }, "CollateralDraftListQueryDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CollateralDraftListQueryDto" } ], "nullable": true } }, "additionalProperties": false }, "CollateralDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Collateral Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "type": { "type": "string", "description": "The Collateral Type", "nullable": true, "example": "Financial Asset" }, "alternateId": { "type": "string", "description": "Collateral Id from data migration", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "List of custom properties for a collateral separate from the standard\r\nout of the box properties.", "nullable": true }, "lifecycleStatus": { "type": "string", "description": "The lifecycle status of the collateral", "nullable": true }, "created": { "type": "string", "description": "The creation date of the Collateral", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Class to represent the collateral uploaded. \r\nContains all properties needed to fill the metadata of the collateral being uploaded." }, "CollateralDto2": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "CollateralDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CollateralDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CollateralDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CollateralDto" } ], "description": "Class to represent the collateral uploaded. \r\nContains all properties needed to fill the metadata of the collateral being uploaded.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CollateralQueryDto": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "The list of Collateral Ids to fetch", "nullable": true }, "attributes": { "type": "array", "items": { "type": "string" }, "description": "The list of attributes to fetch the data for", "nullable": true } }, "additionalProperties": false }, "CollateralQueryDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CollateralQueryDto" } ], "nullable": true } }, "additionalProperties": false }, "CollateralSnapshotDto": { "type": "object", "properties": { "collaterals": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" }, "description": "List of Collaterals", "nullable": true }, "collateralDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDraftDto" }, "description": "List of Collateral drafts", "nullable": true } }, "additionalProperties": false, "description": "A Collateral snapshot object" }, "CollateralSnapshotDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CollateralSnapshotDto" } ], "description": "A Collateral snapshot object", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "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 }, "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 }, "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 }, "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 }, "DataSourcesLambdaResponse": { "type": "object", "properties": { "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "nullable": true } }, "additionalProperties": false }, "DataSourcesLambdaResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesLambdaResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "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 }, "HttpValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "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 }, "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" }, "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 }, "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": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDto" } ], "nullable": true } }, "additionalProperties": false }, "SignificanceEngineDto": { "type": "object", "properties": { "singleFields": { "type": "array", "items": { "type": "string" }, "nullable": true }, "collections": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "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 }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidateDealCollateralAllocationRequestDto": { "type": "object", "properties": { "dealIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Deal Ids", "nullable": true }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Jurisdictions that apply to current entity", "nullable": true }, "entityType": { "type": "string", "description": "Entity type", "nullable": true, "example": "Individual" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Deal Collateral Categories", "nullable": true } }, "additionalProperties": false, "description": "Class to represent the collaterals allocations validations input" }, "ValidateDealCollateralAllocationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ValidateDealCollateralAllocationRequestDto" } ], "description": "Class to represent the collaterals allocations validations input", "nullable": true } }, "additionalProperties": false }, "ValidateDealCollateralAllocationResponseDto": { "type": "object", "properties": { "allocationValidationResult": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationValidationResultDto" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ValidateDealCollateralAllocationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ValidateDealCollateralAllocationResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationErrorDto": { "type": "object", "properties": { "property": { "type": "string", "nullable": true }, "validator": { "type": "string", "nullable": true }, "message": { "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" } ] } }, "VersionedJurisdictionDto": { "type": "object", "properties": { "Jurisdiction": { "type": "string", "nullable": true }, "VersionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }