{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Collateral Command", "description": "Collateral Command 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": "/collateralcommand" } ], "paths": { "/api/asset": { "post": { "tags": [ "Asset" ], "summary": "Create a new Asset", "description": "\nCreates a new Asset\r\n\nThe returned Id can be used in the Query API to retrieve this Asset.

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Create Asset request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AssetDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Asset created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/{id}": { "delete": { "tags": [ "Asset" ], "summary": "Delete an Asset", "description": "\nDeletes an Asset and its drafts\r\n\nOnly Assets with the draft status can be deleted.

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "id", "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": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/{assetId}/draft/journey/{journeyId}": { "post": { "tags": [ "AssetDraft" ], "summary": "Create a new Asset Draft", "description": "\nCreates a new Asset Draft for given Asset Id\r\n\nThe returned Id can be used in the Query API to retrieve this Asset Draft.

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "assetId", "in": "path", "description": "Asset Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Asset Draft created", "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/ServiceResponse" } } } }, "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/{assetId}/draft/{id}": { "put": { "tags": [ "AssetDraft" ], "summary": "Update an Asset Draft", "description": "\nUpdates an Asset Draft

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "assetId", "in": "path", "description": "Asset Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "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" } ], "requestBody": { "description": "Update Asset Draft request. Must contain Asset Draft properties", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAssetDraftDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Asset Draft updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDraftUpdatedDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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. 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" } ] } } } } } }, "delete": { "tags": [ "AssetDraft" ], "summary": "Delete an Asset Draft", "description": "

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "assetId", "in": "path", "description": "Asset Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "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": { "202": { "description": "Accepted for processing" }, "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", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Asset Draft not found" }, "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/{assetId}/draft/{id}/verify": { "put": { "tags": [ "AssetDraft" ], "summary": "Verify an Asset Draft", "description": "\nVerifies an Asset Draft

Required permissions:
Following permissions are required: CollateralApprove", "parameters": [ { "name": "id", "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": { "202": { "description": "Success. Asset Draft verified" }, "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" } ] } } } }, "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/collateral": { "post": { "tags": [ "Collateral" ], "summary": "Create a new Collateral", "description": "\nCreates a new Collateral\r\n\nThe returned Id can be used in the Query API to retrieve this Collateral.

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Create Collateral request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CollateralDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Asset created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/{id}": { "delete": { "tags": [ "Collateral" ], "summary": "Delete a Collateral", "description": "\nDeletes a Collateral and its drafts with any connected Assets and their drafts\r\n\nOnly Collaterals with the draft status can be deleted.

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "id", "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": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/journey/{journeyId}/task/{taskId}/entity/{entityId}/snapshot": { "post": { "tags": [ "Collateral" ], "summary": "Save Collaterals snapshot in a given task", "description": "\nThis method saves an object containing lists of Collaterals and drafts in S3 for a given taskId

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entityId", "in": "path", "description": "Entity 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. Collaterals snapshot saved" }, "500": { "description": "Internal server error" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/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" } ] } } } }, "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/{collateralId}/draft/journey/{journeyId}": { "post": { "tags": [ "CollateralDraft" ], "summary": "Create a new Collateral Draft", "description": "\nCreates a new Collateral Draft for given Collateral Id\r\n\nThe returned Id can be used in the Query API to retrieve this Collateral Draft.

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "collateralId", "in": "path", "description": "Collateral Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Asset Draft created", "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/ServiceResponse" } } } }, "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/{collateralId}/draft/{id}": { "put": { "tags": [ "CollateralDraft" ], "summary": "Update a Collateral Draft", "description": "\nUpdates a Collateral Draft

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "collateralId", "in": "path", "description": "Collateral Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "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" } ], "requestBody": { "description": "Update Collateral Draft request. Must contain collateral draft properties", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCollateralDraftDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Collateral Draft updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollateralDraftUpdatedDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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. 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" } ] } } } } } }, "delete": { "tags": [ "CollateralDraft" ], "summary": "Delete a Collateral Draft", "description": "

Required permissions:
Following permissions are required: CollateralEdit", "parameters": [ { "name": "collateralId", "in": "path", "description": "Collateral Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "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": { "202": { "description": "Accepted for processing" }, "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", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Collateral Draft not found" }, "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/{collateralId}/draft/{id}/verify": { "put": { "tags": [ "CollateralDraft" ], "summary": "Verify a Collateral Draft", "description": "\nVerifies a Collateral Draft

Required permissions:
Following permissions are required: CollateralApprove", "parameters": [ { "name": "id", "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": { "202": { "description": "Success. Collateral Draft verified" }, "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" } ] } } } }, "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" } ] } } } } } } } }, "components": { "schemas": { "AssetDraftDataSourcesDto": { "type": "object", "properties": { "collateral": { "allOf": [ { "$ref": "#/components/schemas/CollateralDataSource" } ], "description": "Asset Draft's Collateral Data Source", "nullable": true } }, "additionalProperties": false, "description": "DataSources relates to Asset Draft" }, "AssetDraftDto": { "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" }, "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, "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" } } } } } }, "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": "AssetId for Asset Draft", "format": "uuid" }, "journeyId": { "type": "string", "description": "JourneyId for Asset Draft", "format": "uuid" }, "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": "Class to represent the Asset uploaded. \r\nContains all properties needed to fill the metadata of the Asset being uploaded." }, "AssetDraftDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssetDraftDto" } ], "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 }, "AssetDraftUpdatedDto": { "type": "object", "properties": { "version": { "type": "integer", "description": "Version of Asset Draft after update", "format": "int32", "example": 4 } }, "additionalProperties": false, "description": "Response DTO representing updated Asset Draft" }, "AssetDraftUpdatedDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssetDraftUpdatedDto" } ], "description": "Response DTO representing updated Asset Draft", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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 }, "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, "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" } } } } } }, "collateralId": { "type": "string", "description": "The Collateral Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "The Journey Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" } }, "additionalProperties": false, "description": "Class to represent the Asset uploaded. \r\nContains all properties needed to fill the metadata of the Asset being uploaded." }, "AssetDtoServiceRequest": { "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 } }, "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 }, "CollateralDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "collaterals": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" }, "nullable": true } }, "additionalProperties": false }, "CollateralDraftDto": { "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" }, "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, "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" } } } } } }, "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": "CollateralId for Collateral Draft", "format": "uuid" }, "journeyId": { "type": "string", "description": "JourneyId for Collateral Draft", "format": "uuid" }, "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": "Class to represent the collateral uploaded. \r\nContains all properties needed to fill the metadata of the collateral being uploaded." }, "CollateralDraftDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CollateralDraftDto" } ], "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 }, "CollateralDraftUpdatedDto": { "type": "object", "properties": { "version": { "type": "integer", "description": "Version of collateral draft after update", "format": "int32", "example": 4 } }, "additionalProperties": false, "description": "Response DTO representing updated collateral draft" }, "CollateralDraftUpdatedDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CollateralDraftUpdatedDto" } ], "description": "Response DTO representing updated collateral draft", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CollateralDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "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 }, "CollateralDto2": { "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, "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" } } } } } }, "entityId": { "type": "string", "description": "The Entity Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "The Journey Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "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." }, "CollateralDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CollateralDto2" } ], "description": "Class to represent the collateral uploaded. \r\nContains all properties needed to fill the metadata of the collateral being uploaded.", "nullable": true } }, "additionalProperties": false }, "CollateralDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CollateralDto2" } ], "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 }, "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 }, "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 } ] }, "CollectionPropertyInfoDto": { "type": "object", "properties": { "valueId": { "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, "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 } ] }, "HttpValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } } ] }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "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": { } }, "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" }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SinglePropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "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 }, "UpdateAssetDraftDto": { "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" }, "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, "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" } } } } } }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/AssetDraftDataSourcesDto" } ], "description": "DataSources relates to Asset Draft", "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 }, "version": { "type": "integer", "description": "The version of the updated draft", "format": "int32" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Collection of policy jurisdictions", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Collection of categories of passed properties, if null then use all", "nullable": true }, "entityType": { "type": "string", "description": "The type of the entity (Individual, Company, Other, All)", "nullable": true, "example": "Individual" }, "entityProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "EntityData properties used for rules evaluation", "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, "description": "Class to represent the Asset uploaded. \r\nContains all properties needed to fill the metadata of the Asset being uploaded." }, "UpdateAssetDraftDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateAssetDraftDto" } ], "description": "Class to represent the Asset uploaded. \r\nContains all properties needed to fill the metadata of the Asset being uploaded.", "nullable": true } }, "additionalProperties": false }, "UpdateCollateralDraftDto": { "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" }, "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, "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" } } } } } }, "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 }, "version": { "type": "integer", "description": "The version of the updated draft", "format": "int32" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Collection of policy jurisdictions", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Collection of categories of passed properties, if null then use all", "nullable": true }, "entityType": { "type": "string", "description": "The type of the entity (Individual, Company, Other, All)", "nullable": true, "example": "Individual" }, "entityProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "EntityData properties used for rules evaluation", "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" } } } } } }, "entityId": { "type": "string", "description": "The Entity id this Collateral belongs to", "nullable": true, "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "Journey Id this Collateral belongs to", "nullable": true, "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "taskId": { "type": "string", "description": "Task Id this Collateral belongs to", "nullable": true, "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "isCompleting": { "type": "boolean", "description": "Is current Task completing" } }, "additionalProperties": false, "description": "Class to represent the collateral uploaded. \r\nContains all properties needed to fill the metadata of the collateral being uploaded." }, "UpdateCollateralDraftDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateCollateralDraftDto" } ], "description": "Class to represent the collateral uploaded. \r\nContains all properties needed to fill the metadata of the collateral being uploaded.", "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", "description": "Jurisdiction Name", "nullable": true, "example": "Global" }, "versionId": { "type": "string", "description": "Jurisdiction Version Id", "format": "uuid", "example": "7c4bc3ff-9d5b-4ccd-839b-637c227b1c65" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }