{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Document Management Query", "description": "Query API to get the documents information to show in the UI.", "version": "1.0" }, "servers": [ { "url": "/documentmanagementquery" } ], "paths": { "/api/acceptabledocument/set/{setId}/version/{versionNumber}/acceptableDocument/{id}": { "get": { "tags": [ "AcceptableDocument" ], "summary": "Gets an Acceptable Document by Id", "description": "\nThis method returns an Acceptable Document model

Required permissions:
Following permissions are required: DocumentConfigurationAccess", "operationId": "GetAcceptableDocumentById", "parameters": [ { "name": "setId", "in": "path", "description": "The set id of the set where the acceptable document lives", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version the acceptable document lives", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "The ID of the Acceptable Document", "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": "AcceptableDocument model returned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "AcceptableDocument model not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument": { "get": { "tags": [ "AcceptableDocument" ], "summary": "Gets all Acceptable Documents", "description": "\nThis method returns the Acceptable Document models from the latest version of the Acceptable Document Set

Required permissions:
At least one of the following permissions is required: DocumentConfigurationAccess, DocumentManagementAccess, PolicyConfigurationAccess", "operationId": "GetLatestAcceptableDocuments", "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": "AcceptableDocument models returned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set": { "get": { "tags": [ "AcceptableDocument" ], "summary": "Gets the default Acceptable Document Set of the tenant", "description": "\nThis method returns an Acceptable Document set and it's versions

Required permissions:
Following permissions are required: DocumentConfigurationAccess", "operationId": "GetDefaultAcceptableDocumentSet", "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": "AcceptableDocumentSet model returned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentSetDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentSetDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentSetDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "AcceptableDocumentSet model not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set/metadata": { "get": { "tags": [ "AcceptableDocument" ], "summary": "Gets the default Acceptable Document Set Metadata of the tenant", "description": "\nThis method returns an Acceptable Document set

Required permissions:
Following permissions are required: DocumentConfigurationAccess", "operationId": "GetDefaultAcceptableDocumentSetMetadata", "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": "AcceptableDocumentSet model returned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentSetDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentSetDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentSetDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "AcceptableDocumentSet model not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set/{setId}/version/{versionNumber}": { "get": { "tags": [ "AcceptableDocument" ], "summary": "Gets an Acceptable Document Set Version by setId and version number", "description": "\nThis method returns an Acceptable Document set version and it's acceptable documents

Required permissions:
Following permissions are required: DocumentConfigurationAccess", "operationId": "GetAcceptableDocumentSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The ID of the Acceptable Document Set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "AcceptableDocumentSetVersion returned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentSetVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentSetVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentSetVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "AcceptableDocumentSet or AcceptableDocumentSetVersion not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set/paged": { "get": { "tags": [ "AcceptableDocument" ], "summary": "Gets paged default Acceptable Document Set of the tenant", "description": "\nThis method returns paged default Acceptable Document set and it's versions

Required permissions:
Following permissions are required: DocumentConfigurationAccess", "operationId": "GetPagedDefaultAcceptableDocumentSet", "parameters": [ { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "paginationToken", "in": "query", "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": "Paged AcceptableDocumentSet model returned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedAcceptableDocumentResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedAcceptableDocumentResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedAcceptableDocumentResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "AcceptableDocumentSet model not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/deal/{dealId}": { "get": { "tags": [ "DealDocumentModel" ], "summary": "Get all documents by deal id", "description": "\nThis method will get the document data for the deal id and a tenant ID.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllDealDocumentsByDealId", "parameters": [ { "name": "dealId", "in": "path", "description": "deal id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \r\n dealId, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/deal/paged": { "post": { "tags": [ "DealDocumentModel" ], "summary": "Retrieves paginated document models based on a specific deal ID and tenant ID", "description": "\nThis method fetches document models in a paginated manner for a given deal ID and tenant ID

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByDealId", "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": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/deal/paged/lite": { "post": { "tags": [ "DealDocumentModel" ], "summary": "Retrieves paginated lite document models based on a specific deal ID and tenant ID", "description": "\nThis method fetches lightened document models in a paginated manner for a given deal ID and tenant ID

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsLiteByDealId", "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": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsLiteResponseDto object representing the paginated list of lightened document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/deal/paged/status": { "post": { "tags": [ "DealDocumentModel" ], "summary": "Retrieves paginated document models based on a specific deal ID, tenant ID and status", "description": "\nThis method fetches document models in a paginated manner for a given deal ID, tenant ID and status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByDealIdAndStatus", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/deal/paged/status/lite": { "post": { "tags": [ "DealDocumentModel" ], "summary": "Retrieves lightened paginated document models based on a specific deal ID, tenant ID and status", "description": "\nThis method fetches lightened document models in a paginated manner for a given deal ID, tenant ID and status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByDealIdAndStatusLite", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/deal/paged/excludeStatus": { "post": { "tags": [ "DealDocumentModel" ], "summary": "Retrieves paginated document models based on a specific deal ID and tenant ID, excluding specific status", "description": "\nThis method fetches document models in a paginated manner for a given deal ID and tenant ID, excluding documents with the specified status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByDealIdExcludingStatus", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/deal/paged/excludeStatus/lite": { "post": { "tags": [ "DealDocumentModel" ], "summary": "Retrieves lightened paginated document models based on a specific deal ID and tenant ID, excluding specific status", "description": "\nThis method fetches lightened document models in a paginated manner for a given deal ID and tenant ID, excluding documents with the specified status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByDealIdExcludingStatusLite", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/deal/{dealId}/journey/{journeyId}": { "get": { "tags": [ "DealDocumentModel" ], "summary": "Gets all Document Models for an Deal Id and Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllModelsByDealIdAndJourneyId", "parameters": [ { "name": "dealId", "in": "path", "description": "The entity identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The journey identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document models if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/{id}": { "get": { "tags": [ "DealDocumentModel" ], "summary": "Get a document by id and tenant", "description": "\nThis method will get the document data for the document id and a tenant ID.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetDealDocumentModelById", "parameters": [ { "name": "id", "in": "path", "description": "Id of an existing document", "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": "An instance of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \r\n id, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document model with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/journey/{journeyId}": { "get": { "tags": [ "DealDocumentModel" ], "summary": "Get all documents by journey id", "description": "\nThis method will get the document data for the journey id and a tenant ID.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllDealDocumentsByJourneyId", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \r\n journeyId, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/signedurl/{id}": { "get": { "tags": [ "DealDocumentModel" ], "summary": "Method to get a signed URL from S3", "description": "\nThis method will generate a URL that will allow the user to open the document in the browser.\r\n\nThe URL is signed by the AWS S3 service and the token will expire in a short time.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetSignedUrlForDealDocument", "parameters": [ { "name": "id", "in": "path", "description": "Id of document", "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": "An url to access the file uploaded for the document with the specified \r\n id, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. If no signed url is found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentmanagement/mimeTypesAllowed": { "get": { "tags": [ "DealDocumentModel" ], "summary": "Get all supported mime types when uploading a file in the document requirements.", "description": "\nThis method will return a list of supported mime types when uploading a file in the document requirements.

Required permissions:
Following permissions are required: DocumentManagementCreate", "operationId": "GetMimeTypesAllowedForDeal", "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": "A list of string of mime types", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentrequirement/{journeyId}": { "get": { "tags": [ "DealDocumentRequirement" ], "summary": "Gets all requirements for a Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllDealRequirementModelsByJourneyId", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirements if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentrequirement/{journeyId}/{requirementId}": { "get": { "tags": [ "DealDocumentRequirement" ], "summary": "Gets a DocumentRequirementModel by Journey Id and Requirement Id", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetDealDocumentRequirementModelByJourneyIdAndRequirementId", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requirementId", "in": "path", "description": "The requirement identifier.", "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": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document requirement model with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentrequirement/journey/{journeyId}/dataKey/{documentDataKey}": { "get": { "tags": [ "DealDocumentRequirement" ], "summary": "Gets a DocumentRequirementModel by Journey Id and DocumentDataKey", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetDealDocumentRequirementModelByJourneyIdandDocumentDataKey", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "documentDataKey", "in": "path", "description": "The requirement identifier defined in policy configuration.", "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": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document requirement model with given id and datakey does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentrequirement/deal/{dealId}/journey/{journeyId}": { "get": { "tags": [ "DealDocumentRequirement" ], "summary": "Gets all Document Requirement Statuses for an Deal Id and Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllRequirementModelsByDealIdAndJourneyId", "parameters": [ { "name": "dealId", "in": "path", "description": "The deal identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The journey identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement statuses if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deal/documentrequirement/deal/{dealId}": { "get": { "tags": [ "DealDocumentRequirement" ], "summary": "Gets all Document Requirement Statuses for an Deal Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllRequirementModelsByDealId", "parameters": [ { "name": "dealId", "in": "path", "description": "The deal identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement statuses if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/configuration": { "get": { "tags": [ "DocumentConfiguration" ], "summary": "Get configuration", "description": "\nReturns configuration.", "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": "Success. The configuration options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentConfigurationResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/{id}": { "get": { "tags": [ "DocumentModel" ], "summary": "Get a document by id and tenant", "description": "\nThis method will get the document data for the document id and a tenant ID.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetDocumentModelById", "parameters": [ { "name": "id", "in": "path", "description": "Id of an existing document", "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": "An instance of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \r\n id, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document model with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/journey/{journeyId}": { "get": { "tags": [ "DocumentModel" ], "summary": "Get all documents by journey id", "description": "\nThis method will get the document data for the journey id and a tenant ID.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllDocumentsByJourneyId", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deduplicationEnabled", "in": "query", "description": "Indicates if the documents returned should be deduplicated.", "schema": { "type": "boolean", "default": false } }, { "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \r\n journeyId, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/entity/{entityId}": { "get": { "tags": [ "DocumentModel" ], "summary": "Get all documents by entity id", "description": "\nThis method will get the document data for the entity id and a tenant ID.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllDocumentsByEntityId", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deduplicationEnabled", "in": "query", "description": "Indicates if the documents returned should be deduplicated.", "schema": { "type": "boolean", "default": false } }, { "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \r\n entityId, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } }, "deprecated": true } }, "/api/documentmanagement/entity/paged": { "post": { "tags": [ "DocumentModel" ], "summary": "Retrieves paginated document models based on a specific entity ID and tenant ID", "description": "\nThis method fetches document models in a paginated manner for a given entity ID and tenant ID

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByEntityId", "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": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/entity/paged/status/lite": { "post": { "tags": [ "DocumentModel" ], "summary": "Retrieves lightened paginated document models based on a specific entity ID, tenant ID and status", "description": "\nThis method fetches lightened document models in a paginated manner for a given entity ID, tenant ID and status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByEntityIdAndStatusLite", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/entity/paged/lite/v2": { "post": { "tags": [ "DocumentModel" ], "summary": "Retrieves paginated documents by entity ID using cursor-based pagination with optional status filter.\r\nUses DynamoDB native pagination - fetches until pageSize filtered items are collected.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsLiteByEntityIdV2", "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": "Request with EntityId, PageSize, PaginationToken (for next page), and optional Status/ExcludeStatus filter", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsWithFilterRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsWithFilterRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsWithFilterRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsWithTokenResponseDto with Items and NextPageToken for the next page", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsWithTokenResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsWithTokenResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsWithTokenResponseDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/entity/paged/status": { "post": { "tags": [ "DocumentModel" ], "summary": "Retrieves paginated document models based on a specific entity ID, tenant ID and status", "description": "\nThis method fetches document models in a paginated manner for a given entity ID, tenant ID and status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByEntityIdAndStatus", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/entity/paged/excludeStatus/lite": { "post": { "tags": [ "DocumentModel" ], "summary": "Retrieves paginated lightened document models based on a specific entity ID and tenant ID, excluding specific status", "description": "\nThis method lightened fetches document models in a paginated manner for a given entity ID and tenant ID, excluding documents with the specified status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByEntityIdExcludingStatusLite", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/entity/paged/excludeStatus": { "post": { "tags": [ "DocumentModel" ], "summary": "Retrieves paginated document models based on a specific entity ID and tenant ID, excluding specific status", "description": "\nThis method fetches document models in a paginated manner for a given entity ID and tenant ID, excluding documents with the specified status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByEntityIdExcludingStatus", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/entity/paged/lite": { "post": { "tags": [ "DocumentModel" ], "summary": "Retrieves paginated lite document models based on a specific entity ID and tenant ID", "description": "\nThis method fetches lightened document models in a paginated manner for a given entity ID and tenant ID

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsLiteByEntityId", "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": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsLiteResponseDto object representing the paginated list of lightened document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsLiteResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsLiteResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsLiteResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/entity/{entityId}/journey/{journeyId}": { "get": { "tags": [ "DocumentModel" ], "summary": "Gets all Document Models for an Entity Id and Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllModelsByEntityIdAndJourneyId", "parameters": [ { "name": "entityId", "in": "path", "description": "The entity identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The journey identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deduplicationEnabled", "in": "query", "description": "Indicates if the documents returned should be deduplicated.", "schema": { "type": "boolean", "default": false } }, { "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document models if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/signedurl/{id}": { "get": { "tags": [ "DocumentModel" ], "summary": "Method to get a signed URL from S3", "description": "\nThis method will generate a URL that will allow the user to open the document in the browser.\r\n\nThe URL is signed by the AWS S3 service and the token will expire in a short time.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetSignedUrl", "parameters": [ { "name": "id", "in": "path", "description": "Id of document", "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": "An url to access the file uploaded for the document with the specified \r\n id, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. If no signed url is found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/mimeTypesAllowed": { "get": { "tags": [ "DocumentModel" ], "summary": "Get all supported mime types when uploading a file in the document requirements.", "description": "\nThis method will return a list of supported mime types when uploading a file in the document requirements.

Required permissions:
Following permissions are required: DocumentManagementCreate", "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": "A list of string of mime types", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/supportedFileExtensions": { "get": { "tags": [ "DocumentModel" ], "summary": "Get supported file extensions", "description": "\nReturns all supported file extensions that can be uploaded.", "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": "Success. The supported file extensions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringListServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirement/{journeyId}": { "get": { "tags": [ "DocumentRequirement" ], "summary": "Gets all requirements for a Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllRequirementModelsByJourneyId", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirements if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirement/{journeyId}/{requirementId}": { "get": { "tags": [ "DocumentRequirement" ], "summary": "Gets a DocumentRequirementModel by Journey Id and Requirement Id", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetDocumentRequirementModelById", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requirementId", "in": "path", "description": "The requirement identifier.", "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": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document requirement model with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirement/entity/{entityId}/journey/{journeyId}": { "get": { "tags": [ "DocumentRequirement" ], "summary": "Gets all Document Requirement Statuses for an Entity Id and Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllRequirementModelsByEntityIdAndJourneyId", "parameters": [ { "name": "entityId", "in": "path", "description": "The entity identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The journey identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement statuses if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirement/entity/{entityId}": { "get": { "tags": [ "DocumentRequirement" ], "summary": "Gets all Document Requirement Statuses for an Entity Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllRequirementModelsByEntityId", "parameters": [ { "name": "entityId", "in": "path", "description": "The entity identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement statuses if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirement/entity/paged/lite": { "post": { "tags": [ "DocumentRequirement" ], "summary": "Gets a paginated list of lightweight Document Requirement models for a given Entity Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocRequirementsLiteByEntityIdQuery", "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": "Pagination options including entity ID, start index and page size.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedDocumentRequirementsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedDocumentRequirementsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedDocumentRequirementsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedDocumentRequirementLiteResponseDto containing the paginated lightweight requirement models.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedDocumentRequirementLiteResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedDocumentRequirementLiteResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedDocumentRequirementLiteResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirement/journey/{journeyId}/dataKey/{documentDataKey}": { "get": { "tags": [ "DocumentRequirement" ], "summary": "Gets a DocumentRequirementModel by Journey Id and DocumentDataKey", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetDocumentRequirementModelByJourneyIdandDocumentDataKey", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "documentDataKey", "in": "path", "description": "The requirement identifier defined in policy configuration.", "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": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document requirement model with given id and datakey does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/documentRequirementMetadata/{id}": { "get": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Gets a Document Requirement Metadata by Id", "description": "\nThis method returns a Document Requirement Metadata model

Required permissions:
Following permissions are required: DocumentConfigurationAccess", "operationId": "GetDocumentRequirementMetadataById", "parameters": [ { "name": "setId", "in": "path", "description": "The set id of the set where the document requirement metadata lives", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version the document requirement metadata lives", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "The ID of the Document Requirement Metadata", "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": "DocumentRequirementMetadata model returned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "DocumentRequirementMetadata model not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata": { "get": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Gets all Document Requirement Metadata", "description": "\nThis method returns the Document Requirement Metadata models from the latest version of the Document Requirement Metadata Set

Required permissions:
At least one of the following permissions is required: DocumentConfigurationAccess, DocumentManagementAccess, PolicyConfigurationAccess", "operationId": "GetLatestDocumentRequirementMetadata", "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": "DocumentRequirementMetadata models returned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set": { "get": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Gets the default Document Requirement Metadata Set of the tenant", "description": "\nThis method returns a Document Requirement Metadata set and it's versions

Required permissions:
Following permissions are required: DocumentConfigurationAccess", "operationId": "GetDefaultDocumentRequirementMetadataSet", "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": "DocumentRequirementMetadataSet model returned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataSetDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataSetDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataSetDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "DocumentRequirementMetadataSet model not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set/{setId}/version/{versionNumber}": { "get": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Gets a Document Requirement Metadata Set Version by setId and version number", "description": "\nThis method returns a Document Requirement Metadata set version and it's document requirement metadata

Required permissions:
Following permissions are required: DocumentConfigurationAccess", "operationId": "GetDocumentRequirementMetadataSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The ID of the Document Requirement Metadata Set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "DocumentRequirementMetadataSetVersion returned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataSetVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataSetVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementMetadataSetVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "DocumentRequirementMetadataSet or DocumentRequirementMetadataSetVersion not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignatureconfiguration": { "get": { "tags": [ "ESignatureConfiguration" ], "summary": "Get Configuration", "description": "

Required permissions:
Following permissions are required: ESignatureConfigurationAccess", "operationId": "GetConfiguration", "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": "Instance of Fenergo.Nebula.DocumentManagement.Query.Application.Dto.eSignatureConfiguration.ConfigurationDto class containing configuration information.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConfigurationDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignatureconfiguration/provider/{providerId}": { "get": { "tags": [ "ESignatureConfiguration" ], "summary": "Get provider configuration", "description": "\nThis method returns specific eSignature provider

Required permissions:
Following permissions are required: ESignatureConfigurationAccess", "operationId": "GetProviderConfiguration", "parameters": [ { "name": "providerId", "in": "path", "description": "The ID of provider", "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": "Instance of Fenergo.Nebula.DocumentManagement.Query.Application.Dto.eSignatureConfiguration.ProviderConfigurationDto class containing provider configuration information.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There is no provider with given id", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignatureconfiguration/provider/{providerId}/refreshSignatureProviders": { "get": { "tags": [ "ESignatureConfiguration" ], "summary": "Refresh Signature Provider List", "description": "

Required permissions:
Following permissions are required: ESignatureConfigurationAccess", "parameters": [ { "name": "providerId", "in": "path", "description": "", "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. Provider added", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SignatureProviderRefreshResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignatureProviderRefreshResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignatureProviderRefreshResponseServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignaturedocumentrequirement/{journeyId}": { "get": { "tags": [ "ESignatureDocumentRequirement" ], "summary": "Gets all requirements for a Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllESignatureRequirementModelsByJourneyId", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.ESignatureDocumentRequirementModelDto class representing the document requirements if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignaturedocumentrequirement/{journeyId}/{requirementId}": { "get": { "tags": [ "ESignatureDocumentRequirement" ], "summary": "Gets a eSignatureDocumentRequirementModel by Journey Id and Requirement Id", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetESignatureDocumentRequirementModelById", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "required": true, "schema": { "type": "string" } }, { "name": "requirementId", "in": "path", "description": "The requirement identifier.", "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": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.ESignatureDocumentRequirementModelDto class representing the document requirement if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document requirement model with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignaturedocumentrequirement/entity/{entityId}/journey/{journeyId}": { "get": { "tags": [ "ESignatureDocumentRequirement" ], "summary": "Gets all eSignature Document Requirement Statuses for an Entity Id and Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllESignatureRequirementModelsByEntityIdAndJourneyId", "parameters": [ { "name": "entityId", "in": "path", "description": "The entity identifier.", "required": true, "schema": { "type": "string" } }, { "name": "journeyId", "in": "path", "description": "The journey identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.ESignatureDocumentRequirementModelDto class representing the document requirement statuses if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignaturedocumentrequirement/journey/{journeyId}/dataKey/{documentDataKey}": { "get": { "tags": [ "ESignatureDocumentRequirement" ], "summary": "Gets a eSignatureDocumentRequirementModel by Journey Id and DocumentDataKey", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetESignatureDocumentRequirementModelByJourneyIdAndDocumentDataKey", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "required": true, "schema": { "type": "string" } }, { "name": "documentDataKey", "in": "path", "description": "The requirement identifier defined in policy configuration.", "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": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.ESignatureDocumentRequirementModelDto class representing the document requirement if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document requirement model with given id and datakey does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignaturetypeconfiguration": { "get": { "tags": [ "ESignatureTypeConfiguration" ], "summary": "Get all Type Configurations", "description": "

Required permissions:
Following permissions are required: ESignatureConfigurationAccess", "operationId": "GetAllSignatureTypeConfigurations", "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": "List of Fenergo.Nebula.DocumentManagement.Query.Application.Dto.ESignatureTypeConfigurationDto class containing type configuration information.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ESignatureTypeConfigurationDtoListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureTypeConfigurationDtoListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ESignatureTypeConfigurationDtoListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignaturetypeconfiguration/{id}": { "get": { "tags": [ "ESignatureTypeConfiguration" ], "summary": "Get Type Configuration", "description": "

Required permissions:
Following permissions are required: ESignatureConfigurationAccess", "operationId": "GetSignatureTypeConfiguration", "parameters": [ { "name": "id", "in": "path", "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": "Instance of Fenergo.Nebula.DocumentManagement.Query.Application.Dto.ESignatureTypeConfigurationDto class containing type configuration information.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ESignatureTypeConfigurationDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureTypeConfigurationDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ESignatureTypeConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Signature type configuration not found.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignaturetypeconfiguration/entitySignatureType/{entityDraftId}": { "get": { "tags": [ "ESignatureTypeConfiguration" ], "summary": "Get Entity Signature Type", "description": "

Required permissions:
Following permissions are required: ESignatureConfigurationAccess", "operationId": "CalculateEntitySignatureType", "parameters": [ { "name": "entityDraftId", "in": "path", "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": "Instance of Fenergo.Nebula.DocumentManagement.Query.Application.Dto.EntitySignatureTypeDto class containing entity signature type information.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EntitySignatureTypeDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntitySignatureTypeDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntitySignatureTypeDtoServiceResponse" } } } }, "400": { "description": "Invalid request.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Entity draft or signature type configuration not found.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/product/{productId}": { "get": { "tags": [ "ProductDocumentModel" ], "summary": "Get all documents by entity id", "description": "\nThis method will get the document data for the entity id and a tenant ID.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllProductDocumentsByProductId", "parameters": [ { "name": "productId", "in": "path", "description": "product 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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \r\n productId, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/product/paged": { "post": { "tags": [ "ProductDocumentModel" ], "summary": "Retrieves paginated document models based on a specific product ID and tenant ID.", "description": "\nThis method fetches document models in a paginated manner for a given product ID and tenant ID.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByProductId", "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": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/product/paged/lite": { "post": { "tags": [ "ProductDocumentModel" ], "summary": "Retrieves paginated lite document models based on a specific product ID and tenant ID", "description": "\nThis method fetches lightened document models in a paginated manner for a given product ID and tenant ID

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsLiteByProductId", "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": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsLiteResponseDto object representing the paginated list of lightened document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/product/paged/status": { "post": { "tags": [ "ProductDocumentModel" ], "summary": "Retrieves paginated document models based on a specific product ID, tenant ID and status", "description": "\nThis method fetches document models in a paginated manner for a given product ID, tenant ID and status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByProductIdAndStatus", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/product/paged/status/lite": { "post": { "tags": [ "ProductDocumentModel" ], "summary": "Retrieves paginated lightened document models based on a specific product ID, tenant ID and status", "description": "\nThis method fetches lightened document models in a paginated manner for a given product ID, tenant ID and status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsLiteByEntityIdAndStatusQuery", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/product/paged/excludeStatus": { "post": { "tags": [ "ProductDocumentModel" ], "summary": "Retrieves paginated document models based on a specific product ID and tenant ID, excluding specific status", "description": "\nThis method fetches document models in a paginated manner for a given product ID and tenant ID, excluding documents with the specified status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByProductIdExcludingStatus", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/product/paged/excludeStatus/lite": { "post": { "tags": [ "ProductDocumentModel" ], "summary": "Retrieves paginated lightened document models based on a specific product ID and tenant ID, excluding specific status", "description": "\nThis method fetches lightened document models in a paginated manner for a given product ID and tenant ID, excluding documents with the specified status

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetPagedDocumentsByProductIdExcludingStatusLite", "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": "Paged entity documents request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request contains invalid values.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/product/{productId}/journey/{journeyId}": { "get": { "tags": [ "ProductDocumentModel" ], "summary": "Gets all Document Models for an Entity Id and Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllModelsByProductIdAndJourneyId", "parameters": [ { "name": "productId", "in": "path", "description": "The entity identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The journey identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document models if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/{id}": { "get": { "tags": [ "ProductDocumentModel" ], "summary": "Get a document by id and tenant", "description": "\nThis method will get the document data for the document id and a tenant ID.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetProductDocumentModelById", "parameters": [ { "name": "id", "in": "path", "description": "Id of an existing document", "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": "An instance of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \r\n id, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document model with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/journey/{journeyId}": { "get": { "tags": [ "ProductDocumentModel" ], "summary": "Get all documents by journey id", "description": "\nThis method will get the document data for the journey id and a tenant ID.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllProductDocumentsByJourneyId", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \r\n journeyId, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/signedurl/{id}": { "get": { "tags": [ "ProductDocumentModel" ], "summary": "Method to get a signed URL from S3", "description": "\nThis method will generate a URL that will allow the user to open the document in the browser.\r\n\nThe URL is signed by the AWS S3 service and the token will expire in a short time.

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetSignedUrlForProductDocument", "parameters": [ { "name": "id", "in": "path", "description": "Id of document", "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": "An url to access the file uploaded for the document with the specified \r\n id, if found; otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. If no signed url is found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentmanagement/mimeTypesAllowed": { "get": { "tags": [ "ProductDocumentModel" ], "summary": "Get all supported mime types when uploading a file in the document requirements.", "description": "\nThis method will return a list of supported mime types when uploading a file in the document requirements.

Required permissions:
Following permissions are required: DocumentManagementCreate", "operationId": "GetMimeTypesAllowedForProduct", "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": "A list of string of mime types", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentrequirement/{journeyId}": { "get": { "tags": [ "ProductDocumentRequirement" ], "summary": "Gets all requirements for a Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllProductRequirementModelsByJourneyId", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirements if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentrequirement/{journeyId}/{requirementId}": { "get": { "tags": [ "ProductDocumentRequirement" ], "summary": "Gets a DocumentRequirementModel by Journey Id and Requirement Id", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetProductDocumentRequirementModelById", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requirementId", "in": "path", "description": "The requirement identifier.", "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": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document requirement model with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentrequirement/journey/{journeyId}/dataKey/{documentDataKey}": { "get": { "tags": [ "ProductDocumentRequirement" ], "summary": "Gets a DocumentRequirementModel by Journey Id and DocumentDataKey", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetProductDocumentRequirementModelByJourneyIdandDocumentDataKey", "parameters": [ { "name": "journeyId", "in": "path", "description": "The journey identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "documentDataKey", "in": "path", "description": "The requirement identifier defined in policy configuration.", "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": "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document requirement model with given id and datakey does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentrequirement/product/{productId}/journey/{journeyId}": { "get": { "tags": [ "ProductDocumentRequirement" ], "summary": "Gets all Document Requirement Statuses for an Product Id and Journey Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllRequirementModelsByProductIdAndJourneyId", "parameters": [ { "name": "productId", "in": "path", "description": "The product identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The journey identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement statuses if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product/documentrequirement/product/{productId}": { "get": { "tags": [ "ProductDocumentRequirement" ], "summary": "Gets all Document Requirement Statuses for an Product Id.", "description": "

Required permissions:
Following permissions are required: DocumentManagementAccess", "operationId": "GetAllRequirementModelsByProductId", "parameters": [ { "name": "productId", "in": "path", "description": "The product identifier.", "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": "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement statuses if found; \r\n otherwise, `null`.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AcceptableDocumentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Acceptable Document Id", "format": "uuid" }, "type": { "type": "string", "description": "Acceptable Document Type", "nullable": true }, "description": { "type": "string", "description": "The description of the acceptable document", "nullable": true, "example": "A utility bill that has been issued in the last 6 months" }, "dataKey": { "type": "string", "description": "The datakey of the acceptable document", "nullable": true, "example": "utilityBill" }, "extractData": { "type": "boolean", "description": "The entity data will be extracted from the document", "example": true }, "extractRelatedParties": { "type": "boolean", "description": "Extract related party data from the document", "example": true }, "extractFromMostRecentVersionOnly": { "type": "boolean", "description": "When true, extraction runs only against the most recently uploaded version of this document type", "example": false }, "extractionCategories": { "type": "array", "items": { "type": "string" }, "description": "Policy Categories that will be used to extract data from the document", "nullable": true, "example": [ "Basic Details" ] } }, "additionalProperties": false, "description": "Response DTO representing Acceptable Document data" }, "AcceptableDocumentDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AcceptableDocumentDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AcceptableDocumentDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AcceptableDocumentDto" } ], "description": "Response DTO representing Acceptable Document data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AcceptableDocumentSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the Acceptable Document Set", "format": "uuid", "example": "cd1b619f-be96-45e2-ab6a-0f7597c4b811" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/AcceptableDocumentSetVersionDto" }, "description": "Versions associated to this Acceptable Document Set", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing Acceptable Document Set data" }, "AcceptableDocumentSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AcceptableDocumentSetDto" } ], "description": "Response DTO representing Acceptable Document Set data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AcceptableDocumentSetVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the Acceptable Document Set Version", "format": "uuid", "example": "93878e7f-6a29-4660-a8f3-2bf7128ff1ac" }, "setId": { "type": "string", "description": "The UiD of the Acceptable Document Set that the version belongs to", "format": "uuid", "example": "3e1c5137-453a-48df-8d26-c70ee8059b4a" }, "versionNumber": { "type": "integer", "description": "The version number", "format": "int32", "example": 2 }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Published" }, "acceptableDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/AcceptableDocumentDto" }, "description": "List of Acceptable Documents", "nullable": true }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "nullable": true, "example": "2023-01-01T14:48:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2023-02-02T14:48:00.000Z" }, "publicationDate": { "type": "string", "description": "The date that the version was published", "format": "date-time", "nullable": true, "readOnly": true, "example": "2023-03-03T14:48:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's latest version\r\nat the time of the query (not necessarily published)", "example": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "notes": { "type": "string", "description": "Version Notes", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "Response DTO representing Acceptable Document Set Version data" }, "AcceptableDocumentSetVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AcceptableDocumentSetVersionDto" } ], "description": "Response DTO representing Acceptable Document Set Version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AccessLayerDto": { "type": "object", "properties": { "geographic": { "type": "array", "items": { "type": "string" }, "description": "Collection of geographic access layers", "nullable": true, "example": [ "Global" ] }, "businessRelated": { "type": "array", "items": { "type": "string" }, "description": "Collection of business related access layers", "nullable": true, "example": [ "Enterprise" ] } }, "additionalProperties": false, "description": "DTO representing access layers attached" }, "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 }, "AlertAssessmentDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/AlertAssessmentDto" }, "nullable": true }, "lastAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDto" } ], "nullable": true }, "lastAssessmentOutcome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertAssessmentDto": { "type": "object", "properties": { "category": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "source": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "attribute": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Approver": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AssignmentDto": { "type": "object", "properties": { "sourceEntityId": { "type": "string", "description": "Entity Id from where documents will be sourced.", "format": "uuid", "example": "d9d626fa-e3d0-4809-be94-d712493e1c8e" }, "targetEntityId": { "type": "string", "description": "Entity Id where documents will be placed", "format": "uuid", "example": "73f5a5d0-885e-4bf0-b6bb-810d96e97c39" }, "documentId": { "type": "string", "description": "Document Id", "format": "uuid", "example": "53aec85d-7015-458e-8fd8-1b04de244d9f" } }, "additionalProperties": false, "description": "Response DTO representing Assignment data" }, "AssociationSnapshotDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the existing Association", "format": "uuid", "example": "23aec85d-7015-458e-8fd8-1b04de244d9f" }, "sourceId": { "type": "string", "description": "The unique identifier of source Entity", "format": "uuid", "example": "05fe8079-5db7-4732-832c-addb614c37ff" }, "targetId": { "type": "string", "description": "The unique identifier of target Entity", "format": "uuid", "example": "05fe8079-5db7-4732-832c-addb614c37ff" }, "type": { "type": "string", "description": "Association type", "nullable": true, "example": "Shareholder" } }, "additionalProperties": false, "description": "Association snapshot" }, "AutoCreditAssessmentDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "autoCreditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditAssessmentDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditAssessmentDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "assessmentOutcome": { "type": "string", "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" } }, "additionalProperties": false, "description": "Request DTO representing basic validation rule metadata" }, "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 }, "Citations": { "required": [ "location" ], "type": "object", "properties": { "location": { "allOf": [ { "$ref": "#/components/schemas/Location" } ], "nullable": true } }, "additionalProperties": false }, "CitationsContent": { "type": "object", "properties": { "citations": { "type": "array", "items": { "$ref": "#/components/schemas/Citations" }, "nullable": true } }, "additionalProperties": false }, "CollateralDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "collaterals": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" }, "nullable": true } }, "additionalProperties": false }, "CollateralDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionItemDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionPropertyDto": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionItemDto" }, "nullable": true }, "collectionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CompletedAssignmentDto": { "type": "object", "properties": { "sourceEntityId": { "type": "string", "description": "Entity Id from where documents will be sourced.", "format": "uuid", "example": "d9d626fa-e3d0-4809-be94-d712493e1c8e" }, "targetEntityId": { "type": "string", "description": "Entity Id where documents will be placed.", "format": "uuid", "example": "73f5a5d0-885e-4bf0-b6bb-810d96e97c39" }, "documentId": { "type": "string", "description": "Document Id", "format": "uuid", "example": "53aec85d-7015-458e-8fd8-1b04de244d9f" } }, "additionalProperties": false }, "ConfigurationDto": { "type": "object", "properties": { "providersConfiguration": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderConfigurationDto" }, "description": "Collection of configured providers", "nullable": true } }, "additionalProperties": false, "description": "Class which representing configuration providers" }, "ConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationDto" } ], "description": "Class which representing configuration providers", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ConversationChatMessage": { "required": [ "content", "role" ], "type": "object", "properties": { "role": { "allOf": [ { "$ref": "#/components/schemas/ConversationRole" } ] }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/MessageContent" }, "nullable": true } }, "additionalProperties": false }, "ConversationRole": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "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 }, "CurrentProductMetadataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "isAgency": { "type": "string", "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentUserDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "teamIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "isSystemUser": { "type": "boolean" } }, "additionalProperties": false }, "CustomPropertyDto": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto" }, "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 }, "reviewAndApproval": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalDataSource" } ], "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 }, "investmentAccountFund": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountFundDataSource" } ], "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 }, "alert": { "allOf": [ { "$ref": "#/components/schemas/AlertDataSource" } ], "nullable": true }, "relatedFCRs": { "allOf": [ { "$ref": "#/components/schemas/RelatedFCRsDataSource" } ], "nullable": true }, "relatedInvestmentManager": { "allOf": [ { "$ref": "#/components/schemas/RelatedInvestmentManagerDataSource" } ], "nullable": true }, "relatedUnderlyingPrincipalOwner": { "allOf": [ { "$ref": "#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource" } ], "nullable": true }, "alertAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDataSource" } ], "nullable": true }, "currentProductMetadata": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductMetadataDataSource" } ], "nullable": true }, "currentUser": { "allOf": [ { "$ref": "#/components/schemas/CurrentUserDataSource" } ], "nullable": true }, "relatedDocuments": { "allOf": [ { "$ref": "#/components/schemas/RelatedDocumentsDataSource" } ], "nullable": true }, "screeningMateriality": { "allOf": [ { "$ref": "#/components/schemas/ScreeningMaterialityDataSource" } ], "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "minDate": { "type": "string", "description": "Minimum date", "format": "date-time", "nullable": true, "example": "2020-01-01T14:48:00.000Z" }, "maxDate": { "type": "string", "description": "Maximum date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" } }, "additionalProperties": false, "description": "Request DTO representing date limit rule metadata" }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "DocuSignGenericProviderDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentAssignmentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of document assignment.", "format": "uuid", "example": "44018bcd-a88c-45ae-9bd8-04087a1fef6d" }, "entityId": { "type": "string", "description": "Entity Id containing documents", "format": "uuid", "example": "73f5a5d0-885e-4bf0-b6bb-810d96e97c39" }, "journeyId": { "type": "string", "description": "Journey Id where document assignment id performed.", "format": "uuid", "example": "fa4ae2af-eb80-410c-b0ce-b97be8cfbe5e" }, "taskId": { "type": "string", "description": "Task Id of document assignment", "format": "uuid", "example": "625cbe82-7f6b-4c3c-a159-ac8fbfe42e48" }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentDto" }, "description": "Assignments for document from main entity", "nullable": true }, "completedAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/CompletedAssignmentDto" }, "description": "List of Completed document Assignment", "nullable": true }, "status": { "type": "string", "description": "Status of assignment.", "nullable": true, "example": "In Progress" }, "snapshot": { "allOf": [ { "$ref": "#/components/schemas/SnapshotDto" } ], "description": "Current state of document, entities and associations.", "nullable": true } }, "additionalProperties": false, "description": "Dto representing model of document assignation. One document assignation per entity, journey and task." }, "DocumentAssignmentDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentAssignmentDto" } ], "description": "Dto representing model of document assignation. One document assignation per entity, journey and task.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentAssignmentSetDto": { "type": "object", "properties": { "journeyId": { "type": "string", "description": "Journey id", "format": "uuid", "example": "fa4ae2af-eb80-410c-b0ce-b97be8cfbe5e" }, "documentAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentAssignmentDto" }, "description": "List of Dto representing models of document assignations for Journey", "nullable": true } }, "additionalProperties": false, "description": "Dto representing all document assignations for a journey." }, "DocumentAssignmentSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentAssignmentSetDto" } ], "description": "Dto representing all document assignations for a journey.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentContent": { "required": [ "format", "name", "source" ], "type": "object", "properties": { "format": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "source": { "allOf": [ { "$ref": "#/components/schemas/DocumentData" } ], "nullable": true } }, "additionalProperties": false }, "DocumentData": { "required": [ "bytes" ], "type": "object", "properties": { "bytes": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "DocumentEntityType": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "DocumentInsightsConnectorRequestDto": { "required": [ "message", "scope" ], "type": "object", "properties": { "scope": { "allOf": [ { "$ref": "#/components/schemas/DocumentInsightsScopeDto" } ], "description": "The insights scope defining context level, parameters, and data types to include" }, "message": { "minLength": 1, "type": "string", "description": "The user's natural language query", "example": "What documents are currently uploaded for this journey?" }, "conversationHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationChatMessage" }, "description": "Previous conversation messages to maintain context (optional)", "nullable": true } }, "additionalProperties": false, "description": "Request to get document insights using natural language" }, "DocumentInsightsConnectorRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentInsightsConnectorRequestDto" } ], "description": "Request to get document insights using natural language", "nullable": true } }, "additionalProperties": false }, "DocumentInsightsContext": { "required": [ "contextId", "contextLevel" ], "type": "object", "properties": { "contextLevel": { "allOf": [ { "$ref": "#/components/schemas/DocumentInsightsContextLevel" } ], "description": "The context level (Journey or Entity)", "example": "Journey" }, "contextId": { "type": "string", "description": "The ID of the journey or entity to get insights for", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" } }, "additionalProperties": false, "description": "Defines the context for insights (Journey or Entity scope)" }, "DocumentInsightsContextLevel": { "enum": [ "Journey", "Entity" ], "type": "string", "description": "Defines the context level for document insights" }, "DocumentInsightsRequestDto": { "required": [ "message", "scope", "sessionId" ], "type": "object", "properties": { "sessionId": { "minLength": 1, "type": "string", "description": "Session Id to direct the request to the correct conversation session" }, "scope": { "allOf": [ { "$ref": "#/components/schemas/DocumentInsightsScopeDto" } ], "description": "The insights scope defining context level, parameters, and data types to include" }, "message": { "minLength": 1, "type": "string", "description": "The user's natural language query", "example": "What documents are currently uploaded for this journey?" }, "conversationHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationChatMessage" }, "description": "Previous conversation messages to maintain context (optional)", "nullable": true } }, "additionalProperties": false, "description": "Request to get document insights using natural language" }, "DocumentInsightsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentInsightsRequestDto" } ], "description": "Request to get document insights using natural language", "nullable": true } }, "additionalProperties": false }, "DocumentInsightsScopeDto": { "type": "object", "properties": { "documentContext": { "allOf": [ { "$ref": "#/components/schemas/DocumentInsightsContext" } ], "description": "Context for getting document insights.", "nullable": true }, "documentRequirementContext": { "allOf": [ { "$ref": "#/components/schemas/DocumentInsightsContext" } ], "description": "Context for getting document requirement insights.", "nullable": true } }, "additionalProperties": false, "description": "Defines the scope of the document insights.\r\nAt least one context (DocumentContext or DocumentRequirementContext) must be provided.\r\nBoth contexts can be provided to get insights for documents and requirements together." }, "DocumentModelDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the document", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "fileName": { "type": "string", "description": "File name", "nullable": true }, "documentRequirementIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "List of Document Requirement Ids that the document is linked to", "nullable": true }, "documentDataKey": { "type": "string", "description": "The unique identifier of the document requirement that the document is linked to", "nullable": true, "example": "identificationDocuments" }, "documentType": { "type": "string", "description": "Document type", "nullable": true, "example": "Driver license" }, "documentKey": { "type": "string", "description": "The Reference key for the physical File", "nullable": true, "example": "18036e2d-9cd9-4f00-bce0-094fa5611e6d/11b4c7f6-32b9-4025-a57f-f003a9d93262_testFile.png" }, "status": { "type": "string", "description": "The status of the uploaded document", "nullable": true, "example": "Complete" }, "errorCode": { "type": "string", "description": "The Error Code associated with an Error Status\r\nFenergo.Nebula.DocumentManagement.Domain.Enum.DocumentErrorCodeINVALID_MIME_TYPE", "nullable": true }, "errorMessage": { "type": "string", "description": "An Error message to be associated with an Error Status", "nullable": true }, "journeyId": { "type": "string", "description": "The Id of the journey the Document is uploaded against", "nullable": true, "example": "69f0009b-d80d-4469-997f-708147190e1d" }, "entityId": { "type": "string", "description": "The Id of the entity the Document is uploaded against", "nullable": true, "example": "69f0009b-d80d-4469-997f-708147190e1d" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "description": "Custom document properties.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers", "nullable": true }, "policyEnforcedAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Access layers enforced by policy. The minimal set of access layers. The property is immutable", "nullable": true }, "hasRequiredAccessLayers": { "type": "boolean", "description": "Flag indicating if current user has required access layers to access document model\r\nIf false, the sensitive properties with be masked by replacing with null or empty values" }, "documentEntityType": { "allOf": [ { "$ref": "#/components/schemas/DocumentEntityType" } ], "description": "The type of the Entity.", "nullable": true }, "uploadedBy": { "type": "string", "description": "Identifier of user who uploaded the document", "nullable": true, "example": "9dee5f0c-08a3-4cb2-83bf-514c75d324ef" }, "uploadedByUserName": { "type": "string", "description": "UserName of user who uploaded the document", "nullable": true, "example": "user@fenergo.com" }, "uploadedOn": { "type": "string", "description": "Date and time the document was uploaded on", "format": "date-time", "nullable": true, "example": "2023-04-03T14:30:00.000Z" }, "lastUpdatedOn": { "type": "string", "description": "Date and time the document was last updated on", "format": "date-time", "nullable": true, "example": "2023-04-03T14:30:00.000Z" }, "lastUpdatedBy": { "type": "string", "description": "Identifier of user who last updated the document", "nullable": true, "example": "9dee5f0c-08a3-4cb2-83bf-514c75d324ef" }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional Metadata in key-value form", "nullable": true }, "explanation": { "type": "string", "description": "Explains why given category has been assigned to document", "nullable": true }, "documentURL": { "type": "string", "description": "URL of the virtual file", "nullable": true }, "isVirtual": { "type": "boolean", "description": "Flag indicating whether the document is virtual", "readOnly": true }, "archivalReason": { "type": "string", "description": "The reason of the archival", "nullable": true }, "preArchivalStatus": { "type": "string", "description": "The status before the archival", "nullable": true }, "deletionRequestedBy": { "type": "string", "description": "Identifier of user who requested deletion", "nullable": true }, "deletionRequestedReason": { "type": "string", "description": "Reason provided when deletion was requested", "nullable": true }, "deletionRequestedOn": { "type": "string", "description": "Date and time when deletion was requested", "format": "date-time", "nullable": true }, "isCloned": { "type": "boolean", "description": "Indicates whether the document was brought forward (cloned) from a prior journey" }, "clonedFromDocumentModelId": { "type": "string", "description": "The Id of the document model this was cloned from, if applicable", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Document metadata" }, "DocumentModelDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentModelDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentModelDto" } ], "description": "Document metadata", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentModelLiteDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the document", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "fileName": { "type": "string", "description": "File name", "nullable": true }, "documentRequirementIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "List of Document Requirement Ids that the document is linked to", "nullable": true }, "documentDataKey": { "type": "string", "description": "The unique identifier of the document requirement that the document is linked to", "nullable": true, "example": "identificationDocuments" }, "documentType": { "type": "string", "description": "Document type", "nullable": true, "example": "Driver license" }, "documentKey": { "type": "string", "description": "The Reference key for the physical File", "nullable": true, "example": "18036e2d-9cd9-4f00-bce0-094fa5611e6d/11b4c7f6-32b9-4025-a57f-f003a9d93262_testFile.png" }, "status": { "type": "string", "description": "The status of the uploaded document", "nullable": true, "example": "Complete" }, "errorCode": { "type": "string", "description": "The Error Code associated with an Error Status\r\nFenergo.Nebula.DocumentManagement.Domain.Enum.DocumentErrorCodeINVALID_MIME_TYPE", "nullable": true }, "errorMessage": { "type": "string", "description": "An Error message to be associated with an Error Status", "nullable": true }, "journeyId": { "type": "string", "description": "The Id of the journey the Document is uploaded against", "nullable": true, "example": "69f0009b-d80d-4469-997f-708147190e1d" }, "entityId": { "type": "string", "description": "The Id of the entity the Document is uploaded against", "nullable": true, "example": "69f0009b-d80d-4469-997f-708147190e1d" }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers", "nullable": true }, "policyEnforcedAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Access layers enforced by policy. The minimal set of access layers. The property is immutable", "nullable": true }, "hasRequiredAccessLayers": { "type": "boolean", "description": "Flag indicating if current user has required access layers to access document model\r\nIf false, the sensitive properties with be masked by replacing with null or empty values" }, "uploadedBy": { "type": "string", "description": "Identifier of user who uploaded the document", "nullable": true, "example": "9dee5f0c-08a3-4cb2-83bf-514c75d324ef" }, "uploadedByUserName": { "type": "string", "description": "UserName of user who uploaded the document", "nullable": true, "example": "user@fenergo.com" }, "uploadedOn": { "type": "string", "description": "Date and time the document was uploaded on", "format": "date-time", "nullable": true, "example": "2023-04-03T14:30:00.000Z" }, "lastUpdatedOn": { "type": "string", "description": "Date and time the document was last updated on", "format": "date-time", "nullable": true, "example": "2023-04-03T14:30:00.000Z" }, "lastUpdatedBy": { "type": "string", "description": "Identifier of user who last updated the document", "nullable": true, "example": "9dee5f0c-08a3-4cb2-83bf-514c75d324ef" }, "documentURL": { "type": "string", "description": "URL of the virtual file", "nullable": true }, "isVirtual": { "type": "boolean", "description": "Flag indicating whether the document is virtual", "readOnly": true }, "additionalDocumentMetadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional document metadata columns with their values\r\nList of tuples containing column name and its value", "nullable": true }, "archivalReason": { "type": "string", "description": "The reason of the archival", "nullable": true }, "preArchivalStatus": { "type": "string", "description": "The status before the archival", "nullable": true }, "deletionRequestedBy": { "type": "string", "description": "Identifier of user who requested deletion", "nullable": true }, "deletionRequestedReason": { "type": "string", "description": "Reason provided when deletion was requested", "nullable": true }, "deletionRequestedOn": { "type": "string", "description": "Date and time when deletion was requested", "format": "date-time", "nullable": true }, "expiredDate": { "type": "string", "description": "The document expiration date", "format": "date-time", "nullable": true }, "explanation": { "type": "string", "description": "The explanation", "nullable": true } }, "additionalProperties": false, "description": "Represents a simplified version of document model data transfer object" }, "DocumentRequirementHistoryDto": { "type": "object", "properties": { "status": { "type": "string", "description": "The Status of the Document Requirement", "nullable": true, "example": "Approved" }, "lastUpdated": { "type": "string", "description": "The date that the Document Requirement was last updated", "format": "date-time" }, "comment": { "type": "string", "description": "A comment relating to the Document Requirement Status change", "nullable": true }, "deferUntil": { "type": "string", "description": "The deferral date of the requirement. This is only set if Status is \"Defer Requested\"", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Document Requirement History" }, "DocumentRequirementMetadataDto": { "type": "object", "properties": { "setId": { "type": "string", "description": "The UiD of the parent set", "format": "uuid", "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "versionNumber": { "type": "integer", "description": "The version number of the parent set", "format": "int32", "example": 1 }, "id": { "type": "string", "description": "The Id of the property", "format": "uuid", "example": "Pre-Status" }, "name": { "type": "string", "description": "The name of the property", "nullable": true, "example": "Pre-Status" }, "databaseFieldName": { "type": "string", "description": "The database field name of the property", "nullable": true, "example": "preStatus" }, "type": { "type": "string", "description": "The type of the property", "nullable": true, "example": "text" }, "lookup": { "type": "string", "description": "The Lookup name if the property type is a dropdown", "nullable": true, "example": "PreStatusList" }, "defaultValue": { "type": "string", "description": "The default value of the property", "nullable": true, "example": "Pending" }, "value": { "type": "string", "description": "The value of the property", "nullable": true, "example": "Approved" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Document requirement metadata validation data", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing Document Requirement Metadata data" }, "DocumentRequirementMetadataDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequirementMetadataDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentRequirementMetadataDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementMetadataDto" } ], "description": "Response DTO representing Document Requirement Metadata data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentRequirementMetadataSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the Document Requirement Metadata Set", "format": "uuid", "example": "cd1b619f-be96-45e2-ab6a-0f7597c4b811" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequirementMetadataSetVersionDto" }, "description": "Versions associated to this Document Requirement Metadata Set", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing Document Requirement Metadata Set data" }, "DocumentRequirementMetadataSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementMetadataSetDto" } ], "description": "Response DTO representing Document Requirement Metadata Set data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentRequirementMetadataSetVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the Document Requirement Metadata Set Version", "format": "uuid", "example": "93878e7f-6a29-4660-a8f3-2bf7128ff1ac" }, "setId": { "type": "string", "description": "The UiD of the Document Requirement Metadata Set that the version belongs to", "format": "uuid", "example": "3e1c5137-453a-48df-8d26-c70ee8059b4a" }, "versionNumber": { "type": "integer", "description": "The version number", "format": "int32", "example": 2 }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Published" }, "documentRequirementMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequirementMetadataDto" }, "description": "List of Document Requirement Metadata", "nullable": true }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "nullable": true, "example": "2023-01-01T14:48:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2023-02-02T14:48:00.000Z" }, "publicationDate": { "type": "string", "description": "The date that the version was published", "format": "date-time", "nullable": true, "readOnly": true, "example": "2023-03-03T14:48:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's latest version\r\nat the time of the query (not necessarily published)", "example": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "notes": { "type": "string", "description": "Version Notes", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "Response DTO representing Document Requirement Metadata Set Version data" }, "DocumentRequirementMetadataSetVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementMetadataSetVersionDto" } ], "description": "Response DTO representing Document Requirement Metadata Set Version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentRequirementModelDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the document requirement status", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "requirementId": { "type": "string", "description": "The Id of the requirement the document requirement status belongs to", "nullable": true, "example": "86581ed9-3ebc-4e7c-b26d-16c1849fa43e" }, "requirementName": { "type": "string", "description": "The Name of the document requirement defined in policy configuration", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "The unique identifier of the document requirement defined in policy configuration", "nullable": true, "example": "identificationDocuments" }, "journeyId": { "type": "string", "description": "The Id of the journey the document requirement belongs to", "nullable": true, "example": "742ac1df-1296-4620-aa44-a34e09e859f4" }, "entityId": { "type": "string", "description": "The Id of the entity the document requirement status belongs to", "nullable": true, "example": "742ac1df-1296-4620-aa44-a34e09e859f4" }, "isMandatory": { "type": "boolean", "description": "IsMandatory attribute of the document requirement defined in policy configuration", "example": false }, "targetEntity": { "type": "string", "description": "The target entity of the requirement", "nullable": true, "example": "Client" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequirementHistoryDto" }, "description": "The history of the requirement containing all updates to the status", "nullable": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document requirement access layers", "nullable": true }, "hasRequiredAccessLayers": { "type": "boolean", "description": "Flag indicating if current user has required access layers to access document requirement model\r\nIf false, the sensitive properties with be masked by replacing with null or empty values" }, "linkedDocumentCount": { "allOf": [ { "$ref": "#/components/schemas/LinkedDocumentCountDto" } ], "description": "Overall count and count by type of documents uploaded against this requirement", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DocumentRequirementProperty" }, "description": "Custom document requirement properties", "nullable": true } }, "additionalProperties": false, "description": "Document Requirement data" }, "DocumentRequirementModelDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequirementModelDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentRequirementModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementModelDto" } ], "description": "Document Requirement data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentRequirementModelLiteDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the document requirement status", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "requirementId": { "type": "string", "description": "The Id of the requirement the document requirement status belongs to", "nullable": true, "example": "86581ed9-3ebc-4e7c-b26d-16c1849fa43e" }, "requirementName": { "type": "string", "description": "The Name of the document requirement defined in policy configuration", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "The unique identifier of the document requirement defined in policy configuration", "nullable": true, "example": "identificationDocuments" }, "journeyId": { "type": "string", "description": "The Id of the journey the document requirement belongs to", "nullable": true, "example": "742ac1df-1296-4620-aa44-a34e09e859f4" }, "entityId": { "type": "string", "description": "The Id of the entity the document requirement status belongs to", "nullable": true, "example": "742ac1df-1296-4620-aa44-a34e09e859f4" }, "isMandatory": { "type": "boolean", "description": "IsMandatory attribute of the document requirement defined in policy configuration", "example": false }, "targetEntity": { "type": "string", "description": "The target entity of the requirement", "nullable": true, "example": "Client" }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document requirement access layers", "nullable": true }, "hasRequiredAccessLayers": { "type": "boolean", "description": "Flag indicating if current user has required access layers to access document requirement model\r\nIf false, the sensitive properties with be masked by replacing with null or empty values" }, "linkedDocumentCount": { "allOf": [ { "$ref": "#/components/schemas/LinkedDocumentCountDto" } ], "description": "Overall count and count by type of documents uploaded against this requirement", "nullable": true } }, "additionalProperties": false, "description": "Document Requirement data" }, "DocumentRequirementProperty": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentSnapshotDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Document Id", "format": "uuid", "example": "53aec85d-7015-458e-8fd8-1b04de244d9f" }, "name": { "type": "string", "description": "Document name", "nullable": true }, "documentType": { "type": "string", "description": "The type of the document", "nullable": true, "example": "Driver license" }, "uploadedBy": { "type": "string", "description": "User who created document", "nullable": true }, "uploadedOn": { "type": "string", "description": "Date and time when document was uploaded", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Dto representing document information at the time of document assignment creation." }, "ESignatureDocumentRequirementModelDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the document requirement status", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "requirementId": { "type": "string", "description": "The Id of the requirement the document requirement status belongs to", "nullable": true, "example": "86581ed9-3ebc-4e7c-b26d-16c1849fa43e" }, "requirementName": { "type": "string", "description": "The Name of the document requirement defined in policy configuration", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "The unique identifier of the document requirement defined in policy configuration", "nullable": true, "example": "identificationDocuments" }, "journeyId": { "type": "string", "description": "The Id of the journey the document requirement belongs to", "nullable": true, "example": "742ac1df-1296-4620-aa44-a34e09e859f4" }, "entityId": { "type": "string", "description": "The Id of the entity the document requirement status belongs to", "nullable": true, "example": "742ac1df-1296-4620-aa44-a34e09e859f4" }, "isMandatory": { "type": "boolean", "description": "IsMandatory attribute of the document requirement defined in policy configuration", "example": false }, "targetEntity": { "type": "string", "description": "The target entity of the requirement", "nullable": true, "example": "Client" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequirementHistoryDto" }, "description": "The history of the requirement containing all updates to the status", "nullable": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document requirement access layers", "nullable": true }, "hasRequiredAccessLayers": { "type": "boolean", "description": "Flag indicating if current user has required access layers to access document requirement model\r\nIf false, the sensitive properties with be masked by replacing with null or empty values" }, "linkedDocumentCount": { "allOf": [ { "$ref": "#/components/schemas/LinkedDocumentCountDto" } ], "description": "Overall count and count by type of documents uploaded against this requirement", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DocumentRequirementProperty" }, "description": "Custom document requirement properties", "nullable": true }, "envelopeId": { "type": "string", "description": "The ID of request from external eSignature service", "nullable": true }, "dateSent": { "type": "string", "description": "The sent date to external eSignature service", "format": "date-time", "nullable": true }, "lastNotificationDate": { "type": "string", "description": "The last notification date from external eSignature service", "format": "date-time", "nullable": true }, "signers": { "type": "array", "items": { "$ref": "#/components/schemas/SignerDto" }, "description": "List of persons needed to sign off", "nullable": true } }, "additionalProperties": false, "description": "Document Requirement data for ESignature" }, "ESignatureDocumentRequirementModelDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ESignatureDocumentRequirementModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ESignatureDocumentRequirementModelDto" } ], "description": "Document Requirement data for ESignature", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ESignatureLookup": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureLookupValue" }, "nullable": true } }, "additionalProperties": false }, "ESignatureLookupDetails": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureLookupValueDetails" }, "nullable": true } }, "additionalProperties": false }, "ESignatureLookupValue": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "ESignatureLookupValueDetails": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ESignatureTypeConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "signatureType": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureLookupDetails" }, "nullable": true }, "defaultSignatureType": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureLookupDetails" }, "nullable": true }, "conditions": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "DTO representing signature type configuration" }, "ESignatureTypeConfigurationDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureTypeConfigurationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ESignatureTypeConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ESignatureTypeConfigurationDto" } ], "description": "DTO representing signature type configuration", "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 }, "EntitySignatureTypeDto": { "type": "object", "properties": { "isDefaultSignatureType": { "type": "boolean" }, "signatureTypeDetails": { "allOf": [ { "$ref": "#/components/schemas/ESignatureLookupValueDetails" } ], "nullable": true } }, "additionalProperties": false, "description": "DTO representing eSignature task signature type configuration" }, "EntitySignatureTypeDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntitySignatureTypeDto" } ], "description": "DTO representing eSignature task signature type configuration", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EntitySnapshotDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Entity Id", "format": "uuid", "example": "53aec85d-7015-458e-8fd8-1b04de244d9f" }, "fullName": { "type": "string", "description": "Name of entity", "nullable": true }, "type": { "type": "string", "description": "Entity type", "nullable": true }, "role": { "type": "string", "description": "Entity Role", "nullable": true }, "created": { "type": "string", "description": "Entity creation date", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Entity snapshot" }, "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 }, "GetDocumentConfigurationResponseDto": { "type": "object", "properties": { "isWaiveCommentMandatory": { "type": "boolean", "description": "Flag indicating if inheritance is enabled or disabled" }, "isDeferCommentMandatory": { "type": "boolean", "description": "Flag indicating if inheritance is enabled or disabled for defer comment" }, "additionalDocumentMetadataColumnsDataKeys": { "type": "array", "items": { "type": "string" }, "description": "Array of data keys for additional document metadata columns that can be configured and displayed", "nullable": true }, "expiryDateDataKeys": { "type": "array", "items": { "type": "string" }, "description": "List of data keys for expiry date fields in document metadata", "nullable": true }, "restrictedDocumentFileTypes": { "type": "array", "items": { "type": "string" }, "description": "List of restricted document file type extensions that are blocked from upload", "nullable": true }, "maximumFileSizeMb": { "type": "integer", "description": "Maximum allowed file size in megabytes. Null means no limit.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing current status of document configuration for waive comment" }, "GetDocumentConfigurationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetDocumentConfigurationResponseDto" } ], "description": "Request DTO representing current status of document configuration for waive comment", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetRelatedDocumentDataSourceResponse": { "type": "object", "properties": { "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "nullable": true } }, "additionalProperties": false }, "GetRelatedDocumentDataSourceResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRelatedDocumentDataSourceResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ImageContent": { "required": [ "format", "source" ], "type": "object", "properties": { "format": { "type": "string", "nullable": true }, "source": { "allOf": [ { "$ref": "#/components/schemas/ImageData" } ], "nullable": true } }, "additionalProperties": false }, "ImageData": { "required": [ "bytes" ], "type": "object", "properties": { "bytes": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "InvestmentAccountFundDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "JourneyLevelDataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "LinkedDocumentCountDto": { "type": "object", "properties": { "overallCount": { "type": "integer", "description": "Total count of documents linked", "format": "int32" }, "countByType": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Count of documents attached by document type", "nullable": true } }, "additionalProperties": false }, "Location": { "required": [ "web" ], "type": "object", "properties": { "web": { "allOf": [ { "$ref": "#/components/schemas/Web" } ], "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 }, "MessageContent": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "image": { "allOf": [ { "$ref": "#/components/schemas/ImageContent" } ], "nullable": true }, "document": { "allOf": [ { "$ref": "#/components/schemas/DocumentContent" } ], "nullable": true }, "citationsContent": { "allOf": [ { "$ref": "#/components/schemas/CitationsContent" } ], "nullable": true }, "toolUse": { "allOf": [ { "$ref": "#/components/schemas/ToolUseContent" } ], "nullable": true }, "toolResult": { "allOf": [ { "$ref": "#/components/schemas/ToolResultContent" } ], "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PagedAcceptableDocumentResponseDto": { "type": "object", "properties": { "items": { "allOf": [ { "$ref": "#/components/schemas/AcceptableDocumentSetDto" } ], "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "Indicates if there is any more items to retrieve", "nullable": true } }, "additionalProperties": false }, "PagedAcceptableDocumentResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PagedAcceptableDocumentResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PagedDocumentRequirementLiteResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequirementModelLiteDto" }, "description": "Gets or sets the collection of lightweight document requirement models", "nullable": true }, "itemsCount": { "type": "integer", "description": "Gets or sets the number of items in the current page", "format": "int32" }, "totalPagedItemsReturned": { "type": "integer", "description": "Gets or sets the total number of paged items returned so far (startIndex + pageSize)", "format": "int32" }, "hasMoreItems": { "type": "boolean", "description": "Gets or sets a value indicating whether there are more items available beyond the current page" } }, "additionalProperties": false, "description": "Represents a paginated response containing lightweight document requirement models for an entity" }, "PagedDocumentRequirementLiteResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PagedDocumentRequirementLiteResponseDto" } ], "description": "Represents a paginated response containing lightweight document requirement models for an entity", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PagedDocumentRequirementsRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Gets or sets the entity ID that the document requirements are associated with", "format": "uuid", "example": "8e7c1e5d-3875-2c81-a2ae-5506f9a98b75" }, "startIndex": { "type": "integer", "description": "Gets or sets the starting index for pagination", "format": "int32", "example": 0 }, "pageSize": { "type": "integer", "description": "Gets or sets the size of the page (result set)", "format": "int32", "example": 50 } }, "additionalProperties": false, "description": "Represents options for setting up the paginated results for document requirements" }, "PagedDocumentRequirementsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PagedDocumentRequirementsRequestDto" } ], "description": "Represents options for setting up the paginated results for document requirements", "nullable": true } }, "additionalProperties": false }, "PagedEntityDocumentsLiteResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentModelLiteDto" }, "description": "Gets or sets the collection of simplified document models", "nullable": true }, "itemsCount": { "type": "integer", "description": "Gets or sets the number of items in the current page", "format": "int32" }, "totalPagedItemsReturned": { "type": "integer", "description": "Gets or sets the total number of paged items returned", "format": "int32" }, "hasMoreItems": { "type": "boolean", "description": "Gets or sets a value indicating whether there are more items available" } }, "additionalProperties": false, "description": "Represents a paginated response containing simplified document models for an entity" }, "PagedEntityDocumentsLiteResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsLiteResponseDto" } ], "description": "Represents a paginated response containing simplified document models for an entity", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PagedEntityDocumentsRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Gets or sets the entity ID that the documents are associated with", "format": "uuid", "example": "8e7c1e5d-3875-2c81-a2ae-5506f9a98b75" }, "startIndex": { "type": "integer", "description": "Gets or sets the starting index for pagination or sublist operations", "format": "int32", "example": 0 }, "pageSize": { "type": "integer", "description": "Gets or sets the size of the page (result set)", "format": "int32", "example": 1000 }, "deduplicationEnabled": { "type": "boolean", "description": "Gets or sets a flag indicating whether deduplication of document models is to be applied", "example": false } }, "additionalProperties": false, "description": "Represents options for setting up the results page" }, "PagedEntityDocumentsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsRequestDto" } ], "description": "Represents options for setting up the results page", "nullable": true } }, "additionalProperties": false }, "PagedEntityDocumentsResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentModelDto" }, "description": "The items result set", "nullable": true }, "itemsCount": { "type": "integer", "description": "The count of the items result set", "format": "int32" }, "totalPagedItemsReturned": { "type": "integer", "description": "The number of items returned collectively", "format": "int32" }, "hasMoreItems": { "type": "boolean", "description": "Indicates if there is any more items to retrieve" } }, "additionalProperties": false }, "PagedEntityDocumentsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PagedEntityDocumentsStatusRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Gets or sets the entity ID that the documents are associated with", "format": "uuid", "example": "8e7c1e5d-3875-2c81-a2ae-5506f9a98b75" }, "startIndex": { "type": "integer", "description": "Gets or sets the starting index for pagination or sublist operations", "format": "int32", "example": 0 }, "pageSize": { "type": "integer", "description": "Gets or sets the size of the page (result set)", "format": "int32", "example": 1000 }, "deduplicationEnabled": { "type": "boolean", "description": "Gets or sets a flag indicating whether deduplication of document models is to be applied", "example": false }, "status": { "type": "string", "description": "Gets or sets a document status to be either excluded or included based on the query type", "nullable": true, "example": "Processing | Completed | Auto Classifying" } }, "additionalProperties": false, "description": "Represents options for setting up the results page" }, "PagedEntityDocumentsStatusRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsStatusRequestDto" } ], "description": "Represents options for setting up the results page", "nullable": true } }, "additionalProperties": false }, "PagedEntityDocumentsWithFilterRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "The entity ID that the documents are associated with", "format": "uuid" }, "pageSize": { "type": "integer", "description": "The size of the page (number of items to return)", "format": "int32" }, "paginationToken": { "type": "string", "description": "The pagination token from the previous response. Omit for the first page.", "nullable": true }, "additionalColumns": { "type": "array", "items": { "type": "string" }, "description": "Additional columns to be fetched. When omitted from the request body, defaults to an empty list.\r\nAn explicit JSON `null` value is treated as empty by the query handler.\r\nThese are merged (case-insensitive, deduplicated) with the tenant-level\r\nAdditionalDocumentMetadataColumnsDataKeys from DocumentConfiguration.", "nullable": true } }, "additionalProperties": false, "description": "Request DTO for paginated documents by entity ID with optional status filter.\r\nUses DynamoDB cursor-based pagination via PaginationToken." }, "PagedEntityDocumentsWithFilterRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsWithFilterRequestDto" } ], "description": "Request DTO for paginated documents by entity ID with optional status filter.\r\nUses DynamoDB cursor-based pagination via PaginationToken.", "nullable": true } }, "additionalProperties": false }, "PagedEntityDocumentsWithTokenResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentModelLiteDto" }, "description": "The items result set", "nullable": true }, "itemsCount": { "type": "integer", "description": "The count of items in this page", "format": "int32" }, "nextPageToken": { "type": "string", "description": "Token to use for requesting the next page. Null when no more pages available.", "nullable": true }, "hasMoreItems": { "type": "boolean", "description": "Indicates if there are more items to retrieve", "readOnly": true }, "errorMessage": { "type": "string", "description": "Error message if the query failed. Null when successful.", "nullable": true } }, "additionalProperties": false, "description": "Response DTO for cursor-based paginated document results" }, "PagedEntityDocumentsWithTokenResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PagedEntityDocumentsWithTokenResponseDto" } ], "description": "Response DTO for cursor-based paginated document results", "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/SinglePropertyDto" }, "nullable": true }, "collectionProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyDto" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto" }, "nullable": true } }, "additionalProperties": false }, "Property": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "customTypeId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } } }, "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 }, "PropertyMetadata": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "string" }, "nullable": true }, "rights": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "ProviderConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the provider", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "name": { "type": "string", "description": "The name of the provider", "nullable": true, "example": "DocuSign" }, "status": { "type": "string", "description": "The status of the provider", "nullable": true, "example": "Active" }, "enabled": { "type": "boolean", "description": "The flag which indicates if provider has been enabled" }, "localConfiguration": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaEntry" }, "description": "Collection of local configuration parameters", "nullable": true }, "globalConfiguration": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Collection of global configuration parameters", "nullable": true }, "lookups": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureLookup" }, "nullable": true } }, "additionalProperties": false, "description": "DTO representing provider configuration" }, "ProviderConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationDto" } ], "description": "DTO representing provider configuration", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RecipientIdentityInputOption": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phoneNumberList": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientIdentityPhoneNumber" }, "nullable": true }, "valueType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RecipientIdentityPhoneNumber": { "type": "object", "properties": { "countryCode": { "type": "string", "nullable": true }, "countryCodeLock": { "type": "string", "nullable": true }, "countryCodeMetadata": { "allOf": [ { "$ref": "#/components/schemas/PropertyMetadata" } ], "nullable": true }, "extension": { "type": "string", "nullable": true }, "extensionMetadata": { "allOf": [ { "$ref": "#/components/schemas/PropertyMetadata" } ], "nullable": true }, "number": { "type": "string", "nullable": true }, "numberMetadata": { "allOf": [ { "$ref": "#/components/schemas/PropertyMetadata" } ], "nullable": true } }, "additionalProperties": false }, "RecipientIdentityVerification": { "type": "object", "properties": { "inputOptions": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientIdentityInputOption" }, "nullable": true }, "workflowId": { "type": "string", "nullable": true }, "workflowIdMetadata": { "allOf": [ { "$ref": "#/components/schemas/PropertyMetadata" } ], "nullable": true }, "workflowLabel": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "isCaseSensitive": { "type": "boolean", "description": "Flag that indicate if regex is case sensitive", "example": false }, "regexValue": { "type": "string", "description": "Regex expression", "nullable": true, "example": "^[\\\\w-\\\\.]+@([\\\\w-]+\\\\.)+[\\\\w-]{2,4}$" } }, "additionalProperties": false, "description": "Request DTO representing regex rule metadata" }, "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 }, "RelatedDocumentDto": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/RelatedDocumentVersionedDto" } ], "nullable": true } }, "additionalProperties": false }, "RelatedDocumentVersionedDto": { "type": "object", "properties": { "documentKey": { "type": "string", "nullable": true }, "documentType": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedDocumentsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDocumentDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedFCRDto": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "submittedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "RelatedFCRsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "fcRs": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedFCRDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedInvestmentManagerDataSource": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true }, "dataSource": { "type": "string", "nullable": true, "readOnly": 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 }, "RelatedUnderlyingPrincipalOwnerDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "ReviewAndApprovalDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "reviewAndApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewAndApprovalDto" }, "nullable": true } }, "additionalProperties": false }, "ReviewAndApprovalDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "approvalOutcome": { "type": "string", "nullable": true }, "approvalReason": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "taskDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SchemaEntry": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "friendlyName": { "type": "string", "nullable": true }, "value": { "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/ValueType" } ] }, "masked": { "type": "boolean" }, "nullable": { "type": "boolean" }, "mandatory": { "type": "boolean" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false }, "ScreeningMaterialityAssessmentDto": { "type": "object", "properties": { "mainEntity": { "type": "boolean" }, "materialityOutcome": { "type": "string", "nullable": true }, "pepMaterialityStatus": { "type": "string", "nullable": true }, "sanctionsMaterialityStatus": { "type": "string", "nullable": true }, "adverseMediaMaterialityStatus": { "type": "string", "nullable": true }, "enforcementsMaterialityStatus": { "type": "string", "nullable": true }, "otherMaterialityStatus": { "type": "string", "nullable": true }, "pepJurisdictions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "sanctionsJurisdictions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "adverseMediaJurisdictions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enforcementsJurisdictions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "otherJurisdictions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "sanctionsProceedDecision": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScreeningMaterialityDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/ScreeningMaterialityAssessmentDto" }, "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 }, "SignatureProviderRefreshResponse": { "type": "object", "properties": { "providers": { "type": "array", "items": { "$ref": "#/components/schemas/DocuSignGenericProviderDto" }, "nullable": true } }, "additionalProperties": false }, "SignatureProviderRefreshResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SignatureProviderRefreshResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "Signee": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SignerDto": { "type": "object", "properties": { "signerType": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "relationship": { "type": "string", "nullable": true }, "hasSigned": { "type": "boolean", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "accessCode": { "type": "string", "nullable": true }, "recipientIdentityVerification": { "allOf": [ { "$ref": "#/components/schemas/RecipientIdentityVerification" } ], "nullable": true }, "signatureType": { "type": "string", "nullable": true }, "smsNumber": { "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": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SnapshotDto": { "type": "object", "properties": { "associationsSnapshots": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationSnapshotDto" }, "description": "List of associations", "nullable": true }, "documentSnapshots": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSnapshotDto" }, "description": "List of documents", "nullable": true }, "entitiesSnapshots": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySnapshotDto" }, "description": "List of entities", "nullable": true } }, "additionalProperties": false, "description": "Snapshots of entities, documents and associations at the time when assignments are created.\r\nThis data will be presented on completed task." }, "SpecialCharactersRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "description": "Array of special characters, which will be ignored by validation e.g. [\"!\",\"@\",\"#\"]", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing special characters rule metadata" }, "StringIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "StringListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ToolResultContent": { "required": [ "toolUseId" ], "type": "object", "properties": { "toolUseId": { "type": "string", "nullable": true }, "isError": { "type": "boolean" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ToolResultContentBlock" }, "nullable": true } }, "additionalProperties": false }, "ToolResultContentBlock": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "json": { "type": "string", "nullable": true }, "image": { "allOf": [ { "$ref": "#/components/schemas/ImageContent" } ], "nullable": true } }, "additionalProperties": false }, "ToolUseContent": { "required": [ "id", "input", "name" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "input": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto" } ], "description": "Special characters validation rule - does not allow special characters,\r\nbut allows define array of characters which can be ignored by the validation", "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow numbers", "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that allows only integers", "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow negative numbers", "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that allows numbers up to two decimal places", "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "description": "Validation rule that validates the value against provided regex", "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Validation rule that allows to set minimum and maximum count of characters", "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Validation rule that allows to set number range", "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow future dates", "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow past dates", "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto" } ], "description": "Validation rule that allows to set date range", "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Validation rule that allows to set selection range", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "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" } ] } }, "ValueLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "minValue": { "type": "integer", "description": "Minimum value", "format": "int32", "nullable": true, "example": 1 }, "maxValue": { "type": "integer", "description": "Maximum value", "format": "int32", "nullable": true, "example": 10 } }, "additionalProperties": false, "description": "Request DTO representing value limit rule metadata" }, "ValueType": { "enum": [ "StringMultiline", "String", "Number", "Boolean", "List", "MultiSelect" ], "type": "string" }, "VersionStatus": { "enum": [ "Draft", "Pending", "Rejected", "Published", "Archived", "Deleted" ], "type": "string" }, "Web": { "required": [ "domain", "url" ], "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "domain": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }