{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Policy Query", "description": "Policy Query API is part of FenX eco-system to query for Requirement Sets, Requirements, Data Groups and Data Group Fields Instances. All the operations require valid access token obtained from Identity service.", "version": "4.0" }, "servers": [ { "url": "/policyquery" } ], "paths": { "/api/v4/policies/{entityPolicyId}/document-requirements/{documentRequirementId}": { "get": { "tags": [ "DocumentRequirement" ], "summary": "Get document requirement from specific policy", "description": "\nReturns document requirement.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetDocumentRequirement", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "documentRequirementId", "in": "path", "description": "ID of the document requirement", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, the default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Document requirement is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not Found", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/document-requirements/{documentRequirementId}": { "get": { "tags": [ "DocumentRequirement" ], "summary": "Get document requirement from specific version of the policy", "description": "\nReturns document requirement.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetHistoricDocumentRequirement", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "documentRequirementId", "in": "path", "description": "ID of the document requirement", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "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": "Success. Document requirement is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not Found", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/document-requirements": { "post": { "tags": [ "DocumentRequirement" ], "summary": "Get document requirements from the current version of the policy", "description": "\nReturns document requirements.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListDocumentRequirements", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, the default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Defines pagination, sorting and filtering", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityDocumentRequirementsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. List of document requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/document-requirements": { "post": { "tags": [ "DocumentRequirement" ], "summary": "Get document requirements from the current version of the policy", "description": "\nReturns document requirements.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListHistoricDocumentRequirements", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Defines pagination, sorting and filtering", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityDocumentRequirementsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. List of document requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/e-signature-document-requirements/{eSignatureDocumentRequirementId}": { "get": { "tags": [ "ESignatureDocumentRequirement" ], "summary": "Get e-signature e-signature document requirement from specific policy", "description": "\nReturns e-signature document requirement.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetESignatureDocumentRequirement", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "eSignatureDocumentRequirementId", "in": "path", "description": "ID of the e-signature document requirement", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, the default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. E-Signature E-Signature Document requirement is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not Found", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/e-signature-document-requirements/{eSignatureDocumentRequirementId}": { "get": { "tags": [ "ESignatureDocumentRequirement" ], "summary": "Get e-signature document requirement from specific version of the policy", "description": "\nReturns e-signature document requirement.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetHistoricESignatureDocumentRequirement", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "eSignatureDocumentRequirementId", "in": "path", "description": "ID of the e-signature document requirement", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "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": "Success. E-Signature Document requirement is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not Found", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/e-signature-document-requirements": { "post": { "tags": [ "ESignatureDocumentRequirement" ], "summary": "Get e-signature document requirements from the current version of the policy", "description": "\nReturns e-signature document requirements.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListESignatureDocumentRequirements", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, the default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Defines pagination, sorting and filtering", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityESignatureDocumentRequirementsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. List of e-signature document requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/e-signature-document-requirements": { "post": { "tags": [ "ESignatureDocumentRequirement" ], "summary": "Get e-signature document requirements from the current version of the policy", "description": "\nReturns e-signature document requirements.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListHistoricESignatureDocumentRequirements", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Defines pagination, sorting and filtering", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityESignatureDocumentRequirementsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. List of e-signature document requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/fields/{fieldId}": { "get": { "tags": [ "Field" ], "summary": "Get specific field from a specific version of the policy", "description": "\nReturns field.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetField", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldId", "in": "path", "description": "ID of the field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Field is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyFieldViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not Found", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/fields/{fieldId}": { "get": { "tags": [ "Field" ], "summary": "Get specific field from a specific version of the policy", "description": "\nReturns field.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetHistoricField", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldId", "in": "path", "description": "ID of the field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "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": "Success. Field is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyFieldViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not Found", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/fields": { "post": { "tags": [ "Field" ], "summary": "Get fields from the current version of the policy", "description": "\nReturns fields.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListFields", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Defines pagination, sorting and filtering", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityPolicyFieldsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. List of fields is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyFieldSearchViewModelDtoItemsPageWithTotalServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/fields": { "post": { "tags": [ "Field" ], "summary": "Get fields from the current version of the policy", "description": "\nReturns fields.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListHistoricFields", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Defines pagination, sorting and filtering", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityPolicyFieldsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. List of fields is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyFieldSearchViewModelDtoItemsPageWithTotalServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/fields/summary": { "post": { "tags": [ "Field" ], "summary": "Get fields' summary from the current version of the policy.\nReturns summary from a most-recently published version of the policy. If workspace ID is provided, it will\nadditionally return fields from the specified workspace.", "description": "\nReturns fields summary.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListFieldsSummary", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace.", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Request object that defines filters.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListFieldsSummaryRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. List of fields is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFieldsSummaryResponseDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/fields/evaluate": { "post": { "tags": [ "Field" ], "summary": "Evaluate fields for a specific policy version", "description": "\nEvaluates fields based on provided filters and data sources.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "EvaluateFields", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Evaluation request with filters and data sources", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateFieldsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. Evaluated fields are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateFieldsResponseDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/fields/{entityType}/indexable": { "get": { "tags": [ "Field" ], "summary": "Returns all indexable fields for the given entity type as two collections:\nsingle fields and collection (data-group) fields. Each collection is\ndeduplicated case-insensitively by data key. Collection fields include\ntheir column definitions resolved from the latest DataGroup record (empty when not found).\nOptionally filtered by search terms (case-insensitive match on data key).", "description": "

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetIndexableFields", "parameters": [ { "name": "entityType", "in": "path", "description": "Entity type (e.g. \"Individual\", \"Company\")", "required": true, "schema": { "type": "string" } }, { "name": "searchTerms", "in": "query", "description": "Optional list of search terms — fields whose data key contains any term (case-insensitive) are included", "schema": { "type": "array", "items": { "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": "Success. Indexable fields returned as single and collection field lists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIndexedDataFieldsResponseServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "No policy found for the given entity type", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/jurisdictions": { "get": { "tags": [ "Jurisdiction" ], "summary": "Get jurisdictions from the current version of the policy", "description": "\nReturns jurisdictions.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListJurisdictions", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "PageSize", "in": "query", "description": "Page size", "schema": { "maximum": 200, "minimum": 0, "exclusiveMinimum": true, "type": "integer", "description": "Page size", "format": "int32", "example": 100 }, "example": 100 }, { "name": "PaginationToken", "in": "query", "description": "Pagination token", "schema": { "type": "string", "description": "Pagination token", "nullable": true } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of jurisdictions is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JurisdictionListItemViewModelDtoItemsPageServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/jurisdictions": { "get": { "tags": [ "Jurisdiction" ], "summary": "Get jurisdictions from a specific version of the policy", "description": "\nReturns jurisdictions.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListHistoricJurisdictions", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "description": "Page size", "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "PaginationToken", "in": "query", "description": "Pagination token", "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": "Success. List of jurisdictions is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JurisdictionListItemViewModelDtoItemsPageServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/jurisdictions/{jurisdictionId}": { "get": { "tags": [ "Jurisdiction" ], "summary": "Get specific jurisdiction from a specific version of the policy", "description": "\nReturns jurisdiction.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetJurisdiction", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "jurisdictionId", "in": "path", "description": "ID of the jurisdiction", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Jurisdiction is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JurisdictionViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not Found", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/jurisdictions/{jurisdictionId}": { "get": { "tags": [ "Jurisdiction" ], "summary": "Get specific jurisdiction from a specific version of the policy", "description": "\nReturns jurisdiction.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetHistoricJurisdiction", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "jurisdictionId", "in": "path", "description": "ID of the jurisdiction", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "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": "Success. Jurisdiction is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JurisdictionViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not Found", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/jurisdictions/available": { "get": { "tags": [ "Jurisdiction" ], "summary": "Get all current jurisdictions for a given policy", "description": "\nReturns jurisdiction.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListAvailableJurisdictions", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "Optional workspaceId. If provided, changes from this workspace will be included", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Jurisdictions are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JurisdictionNameViewModelDtoItemsPageServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies": { "get": { "tags": [ "Policy" ], "summary": "Get policies", "description": "\nReturns policies.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListPolicies", "parameters": [ { "name": "PageSize", "in": "query", "description": "Page size", "schema": { "maximum": 100, "minimum": 0, "exclusiveMinimum": true, "type": "integer", "description": "Page size", "format": "int32", "example": 100 }, "example": 100 }, { "name": "PaginationToken", "in": "query", "description": "Pagination token", "schema": { "type": "string", "description": "Pagination token", "nullable": true } }, { "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. List of policies is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityPolicyListItemViewModelDtoItemsPageServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/summary": { "get": { "tags": [ "Policy" ], "summary": "Get policy by ID", "description": "\nReturns policy by its unique identifier.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetPolicy", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Policy is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityPolicyViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not found. The specified policy does not exist", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/versions": { "get": { "tags": [ "Policy" ], "summary": "Get policy versions", "description": "\nReturns list of policy versions.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListPolicyVersions", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "PageSize", "in": "query", "description": "Page size", "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "PaginationToken", "in": "query", "description": "Pagination token", "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": "Success. List of policy versions is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityPolicyVersionListItemViewModelDtoItemsPageServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}": { "get": { "tags": [ "Policy" ], "summary": "Get latest policy version", "description": "\nReturns policy version.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetCurrentPolicyVersion", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, the default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of policy versions is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityPolicyVersionViewModelDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not found. The specified ID/versionNumber combination does not exist", "status": 404 } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/versions/{versionNumber}": { "get": { "tags": [ "Policy" ], "summary": "Get specified policy version", "description": "\nReturns policy version.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetHistoricPolicyVersion", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "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": "Success. List of policy versions is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityPolicyVersionViewModelDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not found. The specified ID/versionNumber combination does not exist", "status": 404 } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/workspaces": { "get": { "tags": [ "Workspace" ], "summary": "Get available workspaces", "description": "\nReturns non-deleted and used workspaces grouped by change type

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListAvailableWorkspaces", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of workspaces is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableWorkspaceItemResponseDtoListServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/changes": { "get": { "tags": [ "Workspace" ], "summary": "Get workspace changes", "description": "\nReturns page of changes made to current policy in workspace context

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListWorkspaceChanges", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "PageSize", "in": "query", "description": "Page size", "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "PaginationToken", "in": "query", "description": "Pagination token", "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of workspaces is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceChangeListItemViewModelDtoItemsPageServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/changes-summary": { "get": { "tags": [ "Policy" ], "summary": "Get workspace change summary", "description": "\nReturns a summary of changes for a specific workspace in the policy.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetWorkspaceChangeSummary", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace to get changes for", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Workspace change summary is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkspaceChangeSummaryResponseDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not found. The specified workspace does not exist", "status": 404 } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/tags/suggestions": { "get": { "tags": [ "Policy" ], "summary": "Get tag suggestions", "description": "\nReturns a list of suggested tags for the policy.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListTagSuggestions", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, the default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of tag suggestions is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagSuggestionResponseDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/migration-status": { "get": { "tags": [ "Policy" ], "description": "

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetMigrationStatus", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMigrationStatusResponseServiceResponse" } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/related-party-requirements/{relatedPartyRequirementId}": { "get": { "tags": [ "RelatedPartyRequirement" ], "summary": "Get related party requirement from specific policy", "description": "\nReturns related party requirement.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetRelatedPartyRequirement", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "relatedPartyRequirementId", "in": "path", "description": "ID of the related party requirement", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, the default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Related party requirement is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelatedPartyRequirementViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not Found", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/related-party-requirements/{relatedPartyRequirementId}": { "get": { "tags": [ "RelatedPartyRequirement" ], "summary": "Get related party requirement from specific version of the policy", "description": "\nReturns related party requirement.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetHistoricRelatedPartyRequirement", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "relatedPartyRequirementId", "in": "path", "description": "ID of the related party requirement", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "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": "Success. Related party requirement is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelatedPartyRequirementViewModelDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4", "title": "Resource not found", "detail": "Not Found", "status": 404 } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/related-party-requirements": { "post": { "tags": [ "RelatedPartyRequirement" ], "summary": "Get related party requirements from the current version of the policy", "description": "\nReturns related party requirements.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListRelatedPartyRequirements", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workspaceId", "in": "query", "description": "ID of the workspace. If not provided, the default workspace will be used", "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Defines pagination, sorting and filtering", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityRelatedPartyRequirementsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. List of related party requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelatedPartyRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/policies/{entityPolicyId}/version/{versionNumber}/related-party-requirements": { "post": { "tags": [ "RelatedPartyRequirement" ], "summary": "Get related party requirements from the current version of the policy", "description": "\nReturns related party requirements.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ListHistoricRelatedPartyRequirements", "parameters": [ { "name": "entityPolicyId", "in": "path", "description": "ID of the policy", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the policy", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Defines pagination, sorting and filtering", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityRelatedPartyRequirementsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. List of related party requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelatedPartyRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/workspaces": { "get": { "tags": [ "Workspace" ], "summary": "Get workspaces", "description": "\nReturns workspaces.

Required permissions:
Following permissions are required: PolicyWorkspaceConfigurationAccess", "operationId": "ListActiveWorkspaces", "parameters": [ { "name": "PageSize", "in": "query", "description": "Page size", "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "PaginationToken", "in": "query", "description": "Pagination token", "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": "Success. List of workspaces is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkspaceViewModelDtoItemsPageServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/v4/workspaces/current": { "get": { "tags": [ "Workspace" ], "summary": "Get the user's current workspace", "description": "\nReturns a user's current workspace.", "operationId": "GetCurrentWorkspace", "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. User's current workspace is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCurrentWorkspaceResponseDtoServiceResponse" } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } } }, "components": { "schemas": { "AccessLayerDto": { "type": "object", "properties": { "geographic": { "type": "array", "items": { "type": "string" }, "nullable": true }, "businessRelated": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AccountRelatedFundDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Generic properties" } }, "additionalProperties": false }, "AccountRelatedFundsDataSource": { "required": [ "accountRelatedFunds" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "accountRelatedFunds": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelatedFundDto" } } }, "additionalProperties": false }, "ActiveWorkspaceViewModelDto": { "type": "object", "properties": { "workspaceId": { "type": "string", "description": "Unique identifier of Workspace", "format": "uuid", "example": "46b34a29-d426-407e-b1cc-98d727ed4883" }, "name": { "type": "string", "description": "Name of Workspace", "nullable": true, "example": "Global configurators" }, "description": { "type": "string", "description": "Description of Workspace", "nullable": true, "example": "Workspace for global configurators." } }, "additionalProperties": false, "description": "Workspace DTO" }, "ActiveWorkspaceViewModelDtoItemsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveWorkspaceViewModelDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true } }, "additionalProperties": false, "description": "Query Result Page" }, "ActiveWorkspaceViewModelDtoItemsPageServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ActiveWorkspaceViewModelDtoItemsPage" } ], "description": "Query Result Page", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "AlertAssessmentDataSource": { "required": [ "assessments", "lastAssessment" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assessments": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/AlertAssessmentDto" } }, "lastAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDto" } ] }, "lastAssessmentOutcome": { "type": "string", "nullable": true }, "lastAssessmentDisposition": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertAssessmentDto": { "required": [ "category" ], "type": "object", "properties": { "category": { "type": "string" } }, "additionalProperties": false }, "AlertDataSource": { "required": [ "attribute", "source", "type" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "source": { "type": "string" }, "type": { "type": "string" }, "attribute": { "type": "string" } }, "additionalProperties": false }, "AutoCreditAssessmentDataSource": { "required": [ "autoCreditAssessments" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "autoCreditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditAssessmentDto" } } }, "additionalProperties": false }, "AutoCreditAssessmentDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy for manual credit assessment", "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" } } } } } }, "assessmentOutcome": { "type": "string", "description": "Assessment Outcome of this manual credit assessment", "nullable": true }, "providerInternalIdentifier": { "type": "string", "description": "Provider Internal Identifier", "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDataSource": { "required": [ "creditScreenings" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" } }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDto": { "required": [ "properties" ], "type": "object", "properties": { "entityId": { "type": "string", "description": "Entity Id", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "description": "The outcome recorded for a manual screening task.", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy for auto credit screening", "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" } } } } } }, "providerInternalIdentifier": { "type": "string", "description": "Provider Internal Identifier", "nullable": true } }, "additionalProperties": false }, "AvailableWorkspaceGroup": { "enum": [ "NoChanges", "PendingRemoval", "ContainsChanges", "LockedPendingReview" ], "type": "string" }, "AvailableWorkspaceItemResponseDto": { "type": "object", "properties": { "workspaceId": { "type": "string", "description": "Unique identifier of Workspace", "format": "uuid", "example": "46b34a29-d426-407e-b1cc-98d727ed4883" }, "name": { "type": "string", "description": "Name of Workspace", "nullable": true, "example": "Global configurators" }, "description": { "type": "string", "description": "Description of Workspace", "nullable": true, "example": "Workspace created to implement Commercial Banking features" }, "group": { "allOf": [ { "$ref": "#/components/schemas/AvailableWorkspaceGroup" } ], "description": "Group of Workspace", "example": "ContainsChanges" } }, "additionalProperties": false, "description": "Workspace DTO" }, "AvailableWorkspaceItemResponseDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableWorkspaceItemResponseDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "BaseEvaluatedFieldDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data key for the field", "nullable": true, "example": "firstName" }, "fieldType": { "type": "string", "description": "Type of the field", "nullable": true, "example": "text" }, "fieldTypeId": { "type": "string", "description": "ID of the field type", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "linkChildFieldDataKey": { "type": "string", "description": "Key of the child field linked to this field", "nullable": true, "example": "childField" }, "linkedParentFieldDataKey": { "type": "string", "description": "Key of the parent field linked to this field", "nullable": true, "example": "parentField" }, "externalSearchApiProviderId": { "type": "string", "description": "External search API Provider ID", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "First Name" }, "description": { "type": "string", "description": "Description of the field", "nullable": true, "example": "Client's first name" }, "hasEvaluatedDefaultValue": { "type": "boolean", "description": "Does this field has evaluated default value?" }, "defaultValue": { "type": "string", "description": "Default value for the field", "nullable": true, "example": "John" }, "isReadOnly": { "type": "boolean", "description": "Whether the field is read-only", "example": false }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Request DTO representing validation data metadata", "nullable": true }, "isRequired": { "type": "boolean", "description": "Is the field value mandatory?" }, "order": { "type": "number", "description": "Order in which the field appears", "format": "double", "nullable": true, "example": 1 }, "hasEvaluatedConditionalValue": { "type": "boolean", "description": "Does this field has evaluated conditional value?" }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "evaluatedConditionalValueId": { "type": "string", "description": "Evaluated conditional value Id", "nullable": true }, "isMasked": { "type": "boolean", "description": "Flag indicating if field is masked due to missing Sensitive Data Access layers", "example": false }, "isConditional": { "type": "boolean", "description": "Is requirement conditional", "example": false }, "isSensitiveData": { "type": "boolean", "description": "Requirement sensitive data flag", "example": true }, "fieldAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Field Access Layers", "nullable": true }, "uiDecoration": { "type": "string", "description": "Determines how the requirement should be rendered", "nullable": true }, "uiDecorationColor": { "type": "string", "description": "Determines with what colour requirement should be rendered", "nullable": true }, "hasCalculatedValue": { "type": "boolean", "description": "Does this field has calculated value?" }, "calculatedFieldResult": { "allOf": [ { "$ref": "#/components/schemas/CalculatedResultDto" } ], "description": "Calculation value", "nullable": true }, "timeZoneId": { "type": "string", "description": "Time zone id used for date values validation to determine exact Today time range", "nullable": true, "example": "Europe/Warsaw" }, "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValidationErrorDto" }, "description": "Evaluated validation errors for this field", "nullable": true }, "shouldClearValue": { "type": "boolean", "description": "Whether the field value should be cleared to null because all trigger conditions are not met", "example": false } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" } }, "additionalProperties": false, "description": "Request DTO representing basic validation rule metadata" }, "BasicRuleDto2": { "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" }, "BasicRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/BasicRuleDtoConditionalValueDto" }, "description": "Conditional validation rules", "nullable": true } }, "additionalProperties": false }, "BasicRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Request DTO representing basic validation rule metadata", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false }, "BasicRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false }, "CalculatedResultDto": { "type": "object", "properties": { "result": { "type": "string", "description": "Calculation result", "nullable": true, "example": "42.5" }, "error": { "type": "string", "description": "Calculation error", "nullable": true, "example": "Division by zero" } }, "additionalProperties": false }, "ChangedFieldDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangedFieldsDataSource": { "required": [ "changedFields" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "changedFields": { "type": "array", "items": { "$ref": "#/components/schemas/ChangedFieldDto" } } }, "additionalProperties": false }, "CollateralDataSource": { "required": [ "collaterals" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "collaterals": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" } } }, "additionalProperties": false }, "CollateralDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy", "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 }, "CollectionDto": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "propertiesInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyInfoDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionItemDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with maximum count", "nullable": true, "example": { "Registered": 1 } }, "overallMaximumCount": { "type": "integer", "description": "Overall maximum count", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection maximum count validation rule metadata" }, "CollectionMaximumCountRuleDto2": { "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" }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with maximum count", "nullable": true, "example": { "Registered": 1 } }, "overallMaximumCount": { "type": "integer", "description": "Overall maximum count", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection maximum count validation rule metadata" }, "CollectionMaximumCountRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false }, "CollectionMinimumCountRuleDto": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with minimum count", "nullable": true, "example": { "Registered": 1 } }, "overallMinimumCount": { "type": "integer", "description": "Overall minimum count", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection minimum count validation rule metadata" }, "CollectionMinimumCountRuleDto2": { "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" }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with minimum count", "nullable": true, "example": { "Registered": 1 } }, "overallMinimumCount": { "type": "integer", "description": "Overall minimum count", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection minimum count validation rule metadata" }, "CollectionMinimumCountRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false }, "CollectionPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "dataGroupVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CollectionPropertyDto2": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionItemDto" }, "nullable": true }, "collectionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CollectionPropertyInfoDto": { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConditionDefinitionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Name of the field to evaluate", "nullable": true, "example": "EntityType" }, "value": { "type": "array", "items": { "type": "string" }, "description": "List of values", "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "description": "List of value ids", "nullable": true }, "valueType": { "type": "string", "description": "Type of the value", "nullable": true, "example": "text" }, "dataSource": { "type": "string", "description": "Data source from which field is retrieved. If empty then Entity Data properties will be used.", "nullable": true, "example": "entityDataMetadata" }, "operation": { "type": "string", "description": "Logical operation to be performed to match the values", "nullable": true, "example": "equal" }, "logicalOperation": { "type": "string", "description": "Logical operation to be performed on the operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "description": "Field value used for conditional limit validation", "nullable": true } }, "additionalProperties": false, "description": "Represents condition" }, "ConditionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true } }, "additionalProperties": false, "description": "Represents condition root" }, "ConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "type": "string", "description": "Value that should be returned when conditions are met", "nullable": true, "example": "Relationship Manager" }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 }, "valueId": { "type": "string", "description": "Value Id that should be returned when conditions are met", "nullable": true, "example": "RM" } }, "additionalProperties": false }, "CreditAssessmentDto": { "required": [ "properties", "taskId" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy for manual credit assessment", "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" } } } } } }, "assessmentOutcome": { "type": "string", "description": "Assessment Outcome of this manual credit assessment", "nullable": true }, "assessmentComment": { "type": "string", "description": "Assessment Comment of this credit assessment", "nullable": true }, "taskId": { "type": "string", "description": "Task Id" }, "taskDataKey": { "type": "string", "description": "Task Data Key", "nullable": true } }, "additionalProperties": false }, "CurrentDataGroupItemDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } } }, "additionalProperties": false }, "CurrentFieldDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "currentField": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentJourneysDataSource": { "required": [ "inProgressJourneyTypes" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "inProgressJourneyTypes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "CurrentProductDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in product policy", "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" } } } } } }, "lifecycleStatus": { "type": "string", "description": "System field used in backend for status of a product in lifecycle", "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": { "required": [ "teamIds" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "teamIds": { "type": "array", "items": { "minLength": 1, "type": "string", "format": "uuid" } }, "isSystemUser": { "type": "boolean" } }, "additionalProperties": false }, "CustomPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "customTypeId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "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 } ] }, "CustomPropertyDto2": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "DataSourcesDto": { "type": "object", "properties": { "entityDataMetadata": { "allOf": [ { "$ref": "#/components/schemas/EntityDataMetadataDataSource" } ], "description": "DataSource for EntityDraft information beside generic properties", "nullable": true }, "eventIngress": { "allOf": [ { "$ref": "#/components/schemas/EventIngressDataSource" } ], "description": "DataSource for EventIngress event details", "nullable": true }, "changedFields": { "allOf": [ { "$ref": "#/components/schemas/ChangedFieldsDataSource" } ], "description": "DataSource for detecting changed EntityDraft properties in comparasion with verified Entity", "nullable": true }, "relatedClient": { "allOf": [ { "$ref": "#/components/schemas/RelatedClientDataSource" } ], "description": "DataSource for new Related Client properties added in Association task", "nullable": true }, "relatedProducts": { "allOf": [ { "$ref": "#/components/schemas/RelatedProductsDataSource" } ], "description": "DataSource for new Related Product properties added in Manage Product task", "nullable": true }, "currentDataGroupItem": { "allOf": [ { "$ref": "#/components/schemas/CurrentDataGroupItemDataSource" } ], "description": "DataSource for single, current data group row item. Can be used only for Data Group field conditions.", "nullable": true }, "externalDataAdapter": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataAdapterDataSource" } ], "description": "DataSource for External Data Adapter (Ongoing Monitoring) event details", "nullable": true }, "entityAssociation": { "allOf": [ { "$ref": "#/components/schemas/EntityAssociationDataSource" } ], "description": "DataSource for entity association details", "nullable": true }, "manualCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditAssessmentV2DataSource" } ], "description": "DataSource for manual credit assessment", "nullable": true }, "reviewAndApproval": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalDataSource" } ], "description": "DataSource for review and approval", "nullable": true }, "autoCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditAssessmentDataSource" } ], "description": "DataSource for auto credit assessment", "nullable": true }, "manualCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditScreeningDataSource" } ], "nullable": true }, "collateral": { "allOf": [ { "$ref": "#/components/schemas/CollateralDataSource" } ], "nullable": true }, "currentJourneys": { "allOf": [ { "$ref": "#/components/schemas/CurrentJourneysDataSource" } ], "description": "DataSource for entity current journeys", "nullable": true }, "autoCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditScreeningDataSource" } ], "description": "DataSource for auto credit screening", "nullable": true }, "currentProduct": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductDataSource" } ], "description": "DataSource for product scoping", "nullable": true }, "relatedDeals": { "allOf": [ { "$ref": "#/components/schemas/RelatedDealsDataSource" } ], "description": "DataSource for related deals", "nullable": true }, "mainEntity": { "allOf": [ { "$ref": "#/components/schemas/MainEntityDataSource" } ], "description": "DataSource for main entity properties used for condition evaluation", "nullable": true }, "relatedAssets": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssetsDataSource" } ], "description": "DataSource for related assets", "nullable": true }, "relatedAssociations": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssociationsDataSource" } ], "description": "DataSource for related associations", "nullable": true }, "accountRelatedFunds": { "allOf": [ { "$ref": "#/components/schemas/AccountRelatedFundsDataSource" } ], "description": "DataSource for account related funds", "nullable": true }, "investmentAccountFund": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountFundDataSource" } ], "description": "DataSource for investment account fund", "nullable": true }, "investmentAccountRelatedFundShareClass": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountRelatedFundShareClassDataSource" } ], "description": "DataSource for investment account related fund share class", "nullable": true }, "investmentAccount": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountDataSource" } ], "description": "DataSource for in-scope investment accounts, evaluated across all accounts on the entity", "nullable": true }, "journeyLevelData": { "allOf": [ { "$ref": "#/components/schemas/JourneyLevelDataDataSource" } ], "description": "DataSource for draft properties using journey level data requirements used for journey scoping", "nullable": true }, "relatedParties": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartiesDataSource" } ], "description": "DataSource for related parties entity properties", "nullable": true }, "currentField": { "allOf": [ { "$ref": "#/components/schemas/CurrentFieldDataSource" } ], "description": "DataSource for condtional limit validation", "nullable": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDataSource" } ], "description": "DataSource for significance engine", "nullable": true }, "alert": { "allOf": [ { "$ref": "#/components/schemas/AlertDataSource" } ], "description": "DataSource for Transaction Monitoring Alert", "nullable": true }, "relatedFCRs": { "allOf": [ { "$ref": "#/components/schemas/RelatedFCRsDataSource" } ], "description": "DataSource for related FCRs in product domain", "nullable": true }, "relatedInvestmentManager": { "allOf": [ { "$ref": "#/components/schemas/RelatedInvestmentManagerDataSource" } ], "description": "Related Investment Manager data source for product domain", "nullable": true }, "relatedUnderlyingPrincipalOwner": { "allOf": [ { "$ref": "#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource" } ], "description": "Data Source for Related UP Owners", "nullable": true }, "alertAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDataSource" } ], "description": "DataSource for Transaction Monitoring Alert assessment outcomes", "nullable": true }, "currentProductMetadata": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductMetadataDataSource" } ], "description": "DataSource for Product Metadata", "nullable": true }, "currentUser": { "allOf": [ { "$ref": "#/components/schemas/CurrentUserDataSource" } ], "description": "DataSource for current user", "nullable": true }, "relatedDocuments": { "allOf": [ { "$ref": "#/components/schemas/RelatedDocumentsDataSource" } ], "description": "DataSource for related documents", "nullable": true }, "screeningMateriality": { "allOf": [ { "$ref": "#/components/schemas/ScreeningMaterialityDataSource" } ], "description": "DataSource for Screening Materiality Assessment outcomes for the entity being evaluated (main entity or a specific related party).", "nullable": true } }, "additionalProperties": false }, "DataValidationRulesDto": { "type": "object", "properties": { "mandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto" } ], "description": "Special characters validation rule - does not allow special characters,\nbut allows define array of characters which can be ignored by the validation", "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that does not allow numbers", "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows only integers", "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that does not allow negative numbers", "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows numbers up to two decimal places", "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that validates the value against provided regex", "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to set minimum and maximum count of characters", "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to set number range", "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that does not allow future dates", "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that does not allow past dates", "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that allows to set date range", "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that allows to set selection range", "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to set minimum count requirements for collection", "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to set maximum count requirements for collection", "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to use external provider for validation", "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to use external provider for validation of one field with other fields as context", "nullable": true }, "readOnly": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that allows to set if field should be read only", "nullable": true }, "conditionalLimit": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that validates the dynamic value against provided condition", "nullable": true }, "timeZoneId": { "type": "string", "description": "Time zone id used for date values validation in order to determine exact Today time range", "nullable": true, "example": "Europe/Warsaw" } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "DateLimitRuleDto": { "type": "object", "properties": { "errorMessage": { "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" }, "DateLimitRuleDto2": { "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" }, "DateLimitRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValueDto" }, "description": "Conditional validation rules", "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto" } ], "description": "Request DTO representing date limit rule metadata", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false }, "DateTimePeriodFormulaSchemaDto": { "type": "object", "properties": { "formulaSetId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32", "nullable": true }, "formulaString": { "type": "string", "nullable": true }, "dateTimePeriodFormulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DateTimePeriodFormulaVariableDto" }, "nullable": true } }, "additionalProperties": false }, "DateTimePeriodFormulaVariableDto": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "timePeriodKind": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "timeZoneId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentRequirementSearchViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "description": "Unique identifier of policy", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "versionNumber": { "type": "integer", "description": "Version number of the policy", "format": "int32", "example": 1 }, "documentRequirementId": { "type": "string", "description": "Unique identifier of document requirement", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "documentRequirementVersion": { "type": "integer", "description": "Version number of the document requirement", "format": "int32", "example": 2 }, "changeType": { "enum": [ "Unchanged", "Added", "Updated", "Deleted", "Locked" ], "type": "string", "description": "Change type of the document requirement", "nullable": true, "example": "Unchanged" }, "lockDetails": { "allOf": [ { "$ref": "#/components/schemas/LockDetailsDto" } ], "description": "Details of the lock. Null if the ChangeType is not Locked.", "nullable": true }, "mandatoryType": { "enum": [ "Optional", "Required", "Conditional" ], "type": "string", "description": "Mandatory type of the document requirement", "nullable": true, "example": "Required" }, "name": { "type": "string", "description": "Name of the document requirement", "nullable": true, "example": "First Name" }, "dataKey": { "type": "string", "description": "Data key for the document requirement", "nullable": true, "example": "firstName" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categories the document requirement belongs to. Sorted alphabetically.", "nullable": true, "example": [ "Basic Details", "Personal Information" ] }, "targetEntities": { "type": "array", "items": { "type": "string" }, "description": "Target entities for the document requirement. Sorted alphabetically.", "nullable": true, "example": [ "Client" ] }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/JurisdictionNameViewModelDto" }, "description": "Jurisdictions the document requirement applies to. Sorted alphabetically by jurisdiction name.", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags for the document requirement. Sorted alphabetically.", "nullable": true, "example": [ "Required", "Personal" ] } }, "additionalProperties": false, "description": "Represents an object for searching policy document requirements, containing document requirements metadata,\ncategorization, and associated policy information." }, "DocumentRequirementSearchViewModelDtoItemsPageWithTotal": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequirementSearchViewModelDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true }, "totalCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "DocumentRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementSearchViewModelDtoItemsPageWithTotal" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "DocumentRequirementValidationRulesDto": { "type": "object", "properties": { "mandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation data for document requirements" }, "DocumentRequirementViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" }, "documentRequirementId": { "type": "string", "format": "uuid" }, "documentRequirementVersion": { "type": "integer", "format": "int32" }, "changeType": { "enum": [ "Unchanged", "Added", "Updated", "Deleted", "Locked" ], "type": "string", "nullable": true }, "lockDetails": { "allOf": [ { "$ref": "#/components/schemas/LockDetailsDto" } ], "nullable": true }, "name": { "type": "string", "nullable": true }, "dataKey": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tooltipDescription": { "type": "string", "nullable": true }, "classification": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "targetEntities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "nullable": true }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceDto" }, "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true }, "validationRules": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementValidationRulesDto" } ], "description": "Request DTO representing validation data for document requirements", "nullable": true }, "acceptableDocumentTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "jurisdictionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "dataProtectionJurisdictionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "DocumentRequirementViewModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementViewModelDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ESignatureDocumentRequirementSearchViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "description": "Unique identifier of policy", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "versionNumber": { "type": "integer", "description": "Version number of the policy", "format": "int32", "example": 1 }, "eSignatureDocumentRequirementId": { "type": "string", "description": "Unique identifier of e-signature document requirement", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "eSignatureDocumentRequirementVersion": { "type": "integer", "description": "Version number of the e-signature document requirement", "format": "int32", "example": 2 }, "changeType": { "enum": [ "Unchanged", "Added", "Updated", "Deleted", "Locked" ], "type": "string", "description": "Change type of the e-signature document requirement", "nullable": true, "example": "Unchanged" }, "lockDetails": { "allOf": [ { "$ref": "#/components/schemas/LockDetailsDto" } ], "description": "Details of the lock. Null if the ChangeType is not Locked.", "nullable": true }, "mandatoryType": { "enum": [ "Optional", "Required", "Conditional" ], "type": "string", "description": "Mandatory type of the e-signature document requirement", "nullable": true, "example": "Required" }, "name": { "type": "string", "description": "Name of the e-signature document requirement", "nullable": true, "example": "First Name" }, "dataKey": { "type": "string", "description": "Data key for the e-signature document requirement", "nullable": true, "example": "firstName" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categories the e-signature document requirement belongs to. Sorted alphabetically.", "nullable": true, "example": [ "Basic Details", "Personal Information" ] }, "targetEntities": { "type": "array", "items": { "type": "string" }, "description": "Target entities for the e-signature document requirement. Sorted alphabetically.", "nullable": true, "example": [ "Client" ] }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/JurisdictionNameViewModelDto" }, "description": "Jurisdictions the e-signature document requirement applies to. Sorted alphabetically by jurisdiction name.", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags for the e-signature document requirement. Sorted alphabetically.", "nullable": true, "example": [ "Required", "Personal" ] } }, "additionalProperties": false, "description": "Represents an object for searching policy e-signature document requirements, containing e-signature document requirements metadata,\ncategorization, and associated policy information." }, "ESignatureDocumentRequirementSearchViewModelDtoItemsPageWithTotal": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureDocumentRequirementSearchViewModelDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true }, "totalCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ESignatureDocumentRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ESignatureDocumentRequirementSearchViewModelDtoItemsPageWithTotal" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ESignatureDocumentRequirementValidationRulesDto": { "type": "object", "properties": { "mandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation data for e-signature document requirements" }, "ESignatureDocumentRequirementViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" }, "eSignatureDocumentRequirementId": { "type": "string", "format": "uuid" }, "eSignatureDocumentRequirementVersion": { "type": "integer", "format": "int32" }, "changeType": { "enum": [ "Unchanged", "Added", "Updated", "Deleted", "Locked" ], "type": "string", "nullable": true }, "lockDetails": { "allOf": [ { "$ref": "#/components/schemas/LockDetailsDto" } ], "nullable": true }, "name": { "type": "string", "nullable": true }, "dataKey": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tooltipDescription": { "type": "string", "nullable": true }, "classification": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "targetEntities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "nullable": true }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceDto" }, "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true }, "validationRules": { "allOf": [ { "$ref": "#/components/schemas/ESignatureDocumentRequirementValidationRulesDto" } ], "description": "Request DTO representing validation data for e-signature document requirements", "nullable": true }, "acceptableDocumentTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "jurisdictionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "dataProtectionJurisdictionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ESignatureDocumentRequirementViewModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ESignatureDocumentRequirementViewModelDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EmptyRuleDto": { "type": "object", "additionalProperties": false, "description": "Request DTO representing rule with no parameters" }, "EmptyRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValueDto" }, "description": "Conditional validation rules", "nullable": true } }, "additionalProperties": false }, "EmptyRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDto" } ], "description": "Request DTO representing rule with no parameters", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false }, "EntityAssociationDataSource": { "required": [ "associationToClient", "associationType" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "associationType": { "minLength": 1, "type": "string" }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "minLength": 1, "type": "string" }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Generic properties", "nullable": true } }, "additionalProperties": false }, "EntityDataMetadataDataSource": { "required": [ "entityType" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "entityType": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "EntityPolicyListItemViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "description": "Unique identifier of policy", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "entityType": { "enum": [ "Individual", "Company", "Other", "Entity Group", "Managed Relationship", "Financial Crime Report", "Team Metadata", "Transaction Monitoring Case" ], "type": "string", "description": "Type of the entity that the policy is applied to", "nullable": true, "example": "Company" }, "status": { "enum": [ "Draft", "Published", "Archived" ], "type": "string", "description": "Status of the policy", "nullable": true, "example": "Published" }, "versionNumber": { "type": "integer", "description": "Version of the policy", "format": "int32", "example": 1 }, "publishedVersionNumber": { "type": "integer", "description": "Published version of the policy", "format": "int32", "nullable": true, "example": 1 }, "lastPublishedOn": { "type": "string", "description": "Date when the policy was last published", "format": "date-time", "nullable": true, "example": "2025-02-12T14:49:20.979Z" }, "archiveReason": { "type": "string", "description": "The reason provided for archiving the entity policy version", "nullable": true, "example": "Archived due to invalid KYC field configuration." }, "versionNotes": { "type": "string", "description": "Version notes for the policy. Available for published policies only", "nullable": true, "example": "Updated Date Of Birth field" } }, "additionalProperties": false, "description": "Entity Policy List Item" }, "EntityPolicyListItemViewModelDtoItemsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityPolicyListItemViewModelDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true } }, "additionalProperties": false, "description": "Query Result Page" }, "EntityPolicyListItemViewModelDtoItemsPageServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityPolicyListItemViewModelDtoItemsPage" } ], "description": "Query Result Page", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntityPolicyVersionListItemViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "description": "Unique identifier of policy", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "entityType": { "enum": [ "Individual", "Company", "Other", "Entity Group", "Managed Relationship", "Financial Crime Report", "Team Metadata", "Transaction Monitoring Case" ], "type": "string", "description": "Type of the entity that the policy is applied to", "nullable": true, "example": "Company" }, "status": { "enum": [ "Draft", "Published", "Archived" ], "type": "string", "description": "Status of the policy", "nullable": true, "example": "Published" }, "versionNumber": { "type": "integer", "description": "Version of the policy", "format": "int32", "example": 1 }, "created": { "type": "string", "description": "Date when the policy was created", "format": "date-time", "example": "2025-02-12T14:49:20.979Z" }, "published": { "type": "string", "description": "Date when the policy was published", "format": "date-time", "nullable": true, "example": "2025-02-12T14:49:20.979Z" }, "archived": { "type": "string", "description": "Date when the policy was archived", "format": "date-time", "nullable": true, "example": "2025-02-12T14:49:20.979Z" }, "archiveReason": { "type": "string", "description": "The reason provided for archiving the entity policy version", "nullable": true, "example": "Archived due to invalid KYC field configuration." }, "versionNotes": { "type": "string", "description": "Version notes for the policy. Available for published policies only", "nullable": true, "example": "Updated Date Of Birth field" } }, "additionalProperties": false, "description": "Entity Policy Version" }, "EntityPolicyVersionListItemViewModelDtoItemsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityPolicyVersionListItemViewModelDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true } }, "additionalProperties": false, "description": "Query Result Page" }, "EntityPolicyVersionListItemViewModelDtoItemsPageServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityPolicyVersionListItemViewModelDtoItemsPage" } ], "description": "Query Result Page", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntityPolicyVersionViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "description": "Unique identifier of policy", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "entityType": { "enum": [ "Individual", "Company", "Other", "Entity Group", "Managed Relationship", "Financial Crime Report", "Team Metadata", "Transaction Monitoring Case" ], "type": "string", "description": "Type of the entity that the policy is applied to", "nullable": true, "example": "Company" }, "status": { "enum": [ "Draft", "Published", "Archived" ], "type": "string", "description": "Status of the policy", "nullable": true, "example": "Published" }, "versionNumber": { "type": "integer", "description": "Version of the policy", "format": "int32", "example": 1 }, "created": { "type": "string", "description": "Date when the policy was created", "format": "date-time", "example": "2025-02-12T14:49:20.979Z" }, "createdBy": { "type": "string", "description": "ID of the user who created the policy", "nullable": true, "example": "c89b3c95-ec0a-4a4f-9acb-9563431c7a1f" }, "published": { "type": "string", "description": "Date when the policy was published", "format": "date-time", "nullable": true, "example": "2025-02-12T14:49:20.979Z" }, "publishedBy": { "type": "string", "description": "ID of the user who published the policy", "nullable": true, "example": "c89b3c95-ec0a-4a4f-9acb-9563431c7a1f" }, "archived": { "type": "string", "description": "Date when the policy was archived", "format": "date-time", "nullable": true, "example": "2025-02-12T14:49:20.979Z" }, "archivedBy": { "type": "string", "description": "ID of the user who archived the policy", "nullable": true, "example": "c89b3c95-ec0a-4a4f-9acb-9563431c7a1f" }, "versionNotes": { "type": "string", "description": "Version notes for the policy. Available for published policies only", "nullable": true, "example": "Updated Date Of Birth field" }, "archiveReason": { "type": "string", "description": "The reason provided for archiving the entity policy version", "nullable": true, "example": "Archived due to invalid KYC field configuration." }, "isLocked": { "type": "boolean", "description": "True if the policy is locked by a workspace", "example": false } }, "additionalProperties": false, "description": "Entity Policy Version" }, "EntityPolicyVersionViewModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityPolicyVersionViewModelDto" } ], "description": "Entity Policy Version", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntityPolicyViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "description": "Unique identifier of policy", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "entityType": { "enum": [ "Individual", "Company", "Other", "Entity Group", "Managed Relationship", "Financial Crime Report", "Team Metadata", "Transaction Monitoring Case" ], "type": "string", "description": "Type of the entity that the policy is applied to", "nullable": true, "example": "Company" }, "status": { "enum": [ "Draft", "Published", "Archived" ], "type": "string", "description": "Status of the policy", "nullable": true, "example": "Published" }, "versionNumber": { "type": "integer", "description": "Version of the policy", "format": "int32", "example": 1 }, "publishedVersionNumber": { "type": "integer", "description": "Published version of the policy", "format": "int32", "nullable": true, "example": 1 }, "lastPublishedOn": { "type": "string", "description": "Date when the policy was last published", "format": "date-time", "nullable": true, "example": "2025-02-12T14:49:20.979Z" } }, "additionalProperties": false, "description": "Entity Policy" }, "EntityPolicyViewModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityPolicyViewModelDto" } ], "description": "Entity Policy", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EvaluateFieldsRequestDto": { "type": "object", "properties": { "journeyId": { "type": "string", "description": "Unique identifier for the journey", "format": "uuid", "nullable": true, "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "targetEntity": { "enum": [ "Client", "Related Party" ], "type": "string", "description": "Target entities for the field", "nullable": true, "example": "Client" }, "evaluateJurisdictions": { "type": "boolean", "description": "Whether to evaluate jurisdictions automatically", "example": false }, "jurisdictions": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A collection of unique identifiers that represent jurisdictions\nassociated with the policy field", "nullable": true, "example": [ "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" ] }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categories the field belongs to", "nullable": true, "example": [ "Basic Details", "Personal Information" ] }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "description": "Data sources for field evaluation", "nullable": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Properties for field evaluation", "nullable": true }, "disableFilteringForConditionalValues": { "type": "boolean", "description": "Whether to disable filtering for conditional values", "example": false }, "enableAccessLayersFiltering": { "type": "boolean", "description": "Whether to enable access layers filtering", "example": true }, "returnValidationErrors": { "type": "boolean", "description": "Whether to return validation errors", "example": true }, "journeyLevelDataOnly": { "type": "boolean", "description": "Whether to return only journey level data", "example": false }, "skipValuesEvaluation": { "type": "boolean", "description": "Skip evaluation of default value, conditional value and calculated fields if value is true.\nUse 'true' for readonly/completed tasks. The default value will be false.", "example": false } }, "additionalProperties": false }, "EvaluateFieldsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateFieldsRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "EvaluateFieldsResponseDto": { "type": "object", "properties": { "evaluatedFields": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedFieldDto" }, "description": "Evaluated single data fields", "nullable": true }, "evaluatedCollectionDataGroups": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedCollectionDataGroupDto" }, "description": "Evaluated data group fields", "nullable": true }, "evaluatedCustomDataGroups": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedCustomDataGroupDto" }, "description": "Evaluated legacy custom data group fields", "nullable": true }, "evaluatedJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/JurisdictionNameViewModelDto" }, "description": "Evaluated jurisdictions", "nullable": true } }, "additionalProperties": false }, "EvaluateFieldsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateFieldsResponseDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EvaluatedCollectionDataGroupDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data key for the field", "nullable": true, "example": "firstName" }, "dataGroupId": { "type": "string", "description": "The UiD of the data group", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "dataGroupVersionNumber": { "type": "integer", "description": "The version number of the data group", "format": "int32", "example": 1 }, "dataGroupName": { "type": "string", "description": "Data group name", "nullable": true, "example": "Addresses" }, "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "Mailing addresses" }, "description": { "type": "string", "description": "Description of the field", "nullable": true, "example": "Client's first name" }, "isReadOnly": { "type": "boolean", "description": "Whether the field is read-only", "example": false }, "category": { "type": "string", "description": "Categories the field belongs to", "nullable": true, "example": "Basic Details" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Request DTO representing validation data metadata", "nullable": true }, "order": { "type": "number", "description": "Order in which the field appears", "format": "double", "nullable": true, "example": 1 }, "primaryDataGroupField": { "type": "string", "description": "Property name of primary data group field", "nullable": true, "example": "addressType" }, "disableMultiselectPrimaryFieldOnAdd": { "type": "boolean", "description": "When this field toggle is enabled, users will not be able to add multiple entries to a Data Group at once" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDataGroupColumnDto" }, "description": "All data group columns", "nullable": true }, "evaluatedItems": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EvaluatedDataGroupItemV2Dto" }, "description": "Evaluated data group items", "nullable": true, "example": { "itemId": { } } }, "isConditional": { "type": "boolean", "description": "Whether the field is conditional", "example": false } }, "additionalProperties": false }, "EvaluatedCustomDataGroupDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data key for the field", "nullable": true, "example": "product" }, "dataGroupId": { "type": "string", "description": "The UiD of the data group", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "dataGroupVersionNumber": { "type": "integer", "description": "The version number of the data group", "format": "int32", "example": 1 }, "dataGroupName": { "type": "string", "description": "Data group name", "nullable": true, "example": "Products" }, "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "Product" }, "description": { "type": "string", "description": "Description of the field", "nullable": true, "example": "This is the product object" }, "order": { "type": "number", "description": "Order in which the field appears", "format": "double", "nullable": true, "example": 1 }, "isConditional": { "type": "boolean", "description": "Is requirement conditional", "example": false }, "category": { "type": "string", "description": "Categories the field belongs to", "nullable": true, "example": "Basic Details" }, "singleFields": { "type": "array", "items": { "$ref": "#/components/schemas/BaseEvaluatedFieldDto" }, "description": "Single custom data group fields", "nullable": true }, "customNestedFields": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedCustomDataGroupDto" }, "description": "Nested custom data group fields", "nullable": true } }, "additionalProperties": false }, "EvaluatedDataGroupColumnDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data key for the field", "nullable": true, "example": "firstName" }, "fieldType": { "type": "string", "description": "Type of the field", "nullable": true, "example": "text" }, "fieldTypeId": { "type": "string", "description": "ID of the field type", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "Product Type" }, "description": { "type": "string", "description": "Description of the field", "nullable": true, "example": "Client's first name" }, "order": { "type": "number", "description": "Order in which the field appears", "format": "double", "nullable": true, "example": 2 }, "isConditional": { "type": "boolean", "description": "Is data group field conditional?", "example": false } }, "additionalProperties": false }, "EvaluatedDataGroupFieldV2Dto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data key for the field", "nullable": true, "example": "firstName" }, "fieldType": { "type": "string", "description": "Type of the field", "nullable": true, "example": "text" }, "fieldTypeId": { "type": "string", "description": "ID of the field type", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "linkChildFieldDataKey": { "type": "string", "description": "Key of the child field linked to this field", "nullable": true, "example": "childField" }, "linkedParentFieldDataKey": { "type": "string", "description": "Key of the parent field linked to this field", "nullable": true, "example": "parentField" }, "externalSearchApiProviderId": { "type": "string", "description": "External search API Provider ID", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "First Name" }, "description": { "type": "string", "description": "Description of the field", "nullable": true, "example": "Client's first name" }, "hasEvaluatedDefaultValue": { "type": "boolean", "description": "Does this field has evaluated default value?" }, "defaultValue": { "type": "string", "description": "Default value for the field", "nullable": true, "example": "John" }, "isReadOnly": { "type": "boolean", "description": "Whether the field is read-only", "example": false }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Request DTO representing validation data metadata", "nullable": true }, "isRequired": { "type": "boolean", "description": "Is the field value mandatory?" }, "order": { "type": "number", "description": "Order in which the field appears", "format": "double", "nullable": true, "example": 1 }, "hasEvaluatedConditionalValue": { "type": "boolean", "description": "Does this field has evaluated conditional value?" }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "evaluatedConditionalValueId": { "type": "string", "description": "Evaluated conditional value Id", "nullable": true }, "isMasked": { "type": "boolean", "description": "Flag indicating if field is masked due to missing Sensitive Data Access layers", "example": false }, "isConditional": { "type": "boolean", "description": "Is requirement conditional", "example": false }, "isSensitiveData": { "type": "boolean", "description": "Requirement sensitive data flag", "example": true }, "fieldAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Field Access Layers", "nullable": true }, "uiDecoration": { "type": "string", "description": "Determines how the requirement should be rendered", "nullable": true }, "uiDecorationColor": { "type": "string", "description": "Determines with what colour requirement should be rendered", "nullable": true }, "hasCalculatedValue": { "type": "boolean", "description": "Does this field has calculated value?" }, "calculatedFieldResult": { "allOf": [ { "$ref": "#/components/schemas/CalculatedResultDto" } ], "description": "Calculation value", "nullable": true }, "timeZoneId": { "type": "string", "description": "Time zone id used for date values validation to determine exact Today time range", "nullable": true, "example": "Europe/Warsaw" }, "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValidationErrorDto" }, "description": "Evaluated validation errors for this field", "nullable": true }, "shouldClearValue": { "type": "boolean", "description": "Whether the field value should be cleared to null because all trigger conditions are not met", "example": false } }, "additionalProperties": false }, "EvaluatedDataGroupItemV2Dto": { "type": "object", "properties": { "evaluatedFields": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDataGroupFieldV2Dto" }, "description": "Evaluated data group fields", "nullable": true } }, "additionalProperties": false }, "EvaluatedFieldDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data key for the field", "nullable": true, "example": "firstName" }, "fieldType": { "type": "string", "description": "Type of the field", "nullable": true, "example": "text" }, "fieldTypeId": { "type": "string", "description": "ID of the field type", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "linkChildFieldDataKey": { "type": "string", "description": "Key of the child field linked to this field", "nullable": true, "example": "childField" }, "linkedParentFieldDataKey": { "type": "string", "description": "Key of the parent field linked to this field", "nullable": true, "example": "parentField" }, "externalSearchApiProviderId": { "type": "string", "description": "External search API Provider ID", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "First Name" }, "description": { "type": "string", "description": "Description of the field", "nullable": true, "example": "Client's first name" }, "hasEvaluatedDefaultValue": { "type": "boolean", "description": "Does this field has evaluated default value?" }, "defaultValue": { "type": "string", "description": "Default value for the field", "nullable": true, "example": "John" }, "isReadOnly": { "type": "boolean", "description": "Whether the field is read-only", "example": false }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Request DTO representing validation data metadata", "nullable": true }, "isRequired": { "type": "boolean", "description": "Is the field value mandatory?" }, "order": { "type": "number", "description": "Order in which the field appears", "format": "double", "nullable": true, "example": 1 }, "hasEvaluatedConditionalValue": { "type": "boolean", "description": "Does this field has evaluated conditional value?" }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "evaluatedConditionalValueId": { "type": "string", "description": "Evaluated conditional value Id", "nullable": true }, "isMasked": { "type": "boolean", "description": "Flag indicating if field is masked due to missing Sensitive Data Access layers", "example": false }, "isConditional": { "type": "boolean", "description": "Is requirement conditional", "example": false }, "isSensitiveData": { "type": "boolean", "description": "Requirement sensitive data flag", "example": true }, "fieldAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Field Access Layers", "nullable": true }, "uiDecoration": { "type": "string", "description": "Determines how the requirement should be rendered", "nullable": true }, "uiDecorationColor": { "type": "string", "description": "Determines with what colour requirement should be rendered", "nullable": true }, "hasCalculatedValue": { "type": "boolean", "description": "Does this field has calculated value?" }, "calculatedFieldResult": { "allOf": [ { "$ref": "#/components/schemas/CalculatedResultDto" } ], "description": "Calculation value", "nullable": true }, "timeZoneId": { "type": "string", "description": "Time zone id used for date values validation to determine exact Today time range", "nullable": true, "example": "Europe/Warsaw" }, "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValidationErrorDto" }, "description": "Evaluated validation errors for this field", "nullable": true }, "shouldClearValue": { "type": "boolean", "description": "Whether the field value should be cleared to null because all trigger conditions are not met", "example": false }, "category": { "type": "string", "description": "Requirement business category", "nullable": true, "example": "Basic Details" }, "isIndexable": { "type": "boolean", "description": "Requirement is indexed for search", "example": true }, "isMaterialData": { "type": "boolean", "description": "Requirement material data flag", "example": true } }, "additionalProperties": false }, "EventIngressDataSource": { "required": [ "eventSubtype", "eventType" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "minLength": 1, "type": "string" }, "eventSubtype": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ExternalDataAdapterDataSource": { "required": [ "eventSubtype", "eventType" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "minLength": 1, "type": "string" }, "eventSubtype": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ExternalProviderRuleDto": { "type": "object", "properties": { "providerId": { "type": "string", "description": "Id of external provider.", "format": "uuid" } }, "additionalProperties": false, "description": "Request DTO representing external provider rule metadata" }, "ExternalProviderRuleDto2": { "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" }, "providerId": { "type": "string", "description": "Id of external provider.", "format": "uuid" } }, "additionalProperties": false, "description": "Request DTO representing external provider rule metadata" }, "ExternalProviderRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false }, "FieldSummaryDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Field name", "nullable": true, "example": "First Name" }, "names": { "type": "array", "items": { "type": "string" }, "description": "Requirement names in case of different duplicates", "nullable": true, "example": [ "First Name", "Name" ] }, "description": { "type": "string", "description": "Requirement description", "nullable": true, "example": "This is the client first name" }, "fieldType": { "type": "string", "description": "Field type", "nullable": true, "example": "text" }, "fieldTypeId": { "type": "string", "description": "Field type ID", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "All business categories for the field", "nullable": true, "example": [ "Basic Details" ] }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/JurisdictionNameViewModelDto" }, "description": "All jurisdictions for the field", "nullable": true }, "isSensitiveData": { "type": "boolean", "description": "Field sensitive data flag", "example": true }, "linkChildFieldDataKey": { "type": "string", "description": "Linked child field data key", "nullable": true, "example": "productCategory" }, "linkedParentFieldDataKey": { "type": "string", "description": "Linked Parent field data key", "nullable": true, "example": "productCategory" }, "externalSearchApiProviderId": { "type": "string", "description": "External Search API Provider ID", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" } }, "additionalProperties": false }, "FieldValidationErrorDto": { "type": "object", "properties": { "validator": { "type": "string", "description": "Type of the validator that returned error message", "nullable": true, "example": "mandatory" }, "message": { "type": "string", "description": "Error message configured by the user in the Policy", "nullable": true, "example": "This field is required" } }, "additionalProperties": false }, "FilterConditionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Field name for the filter condition", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions applied to the field", "nullable": true } }, "additionalProperties": false }, "GetCurrentWorkspaceResponseDto": { "required": [ "workspaceId" ], "type": "object", "properties": { "workspaceId": { "type": "string", "description": "Unique identifier of Workspace", "format": "uuid", "example": "46b34a29-d426-407e-b1cc-98d727ed4883" } }, "additionalProperties": false, "description": "Represents user preferred workspace" }, "GetCurrentWorkspaceResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetCurrentWorkspaceResponseDto" } ], "description": "Represents user preferred workspace", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "GetIndexedDataFieldsResponse": { "required": [ "collectionFields", "singleFields" ], "type": "object", "properties": { "singleFields": { "type": "array", "items": { "$ref": "#/components/schemas/IndexedFieldDto" }, "nullable": true }, "collectionFields": { "type": "array", "items": { "$ref": "#/components/schemas/IndexedCollectionFieldDto" }, "nullable": true } }, "additionalProperties": false }, "GetIndexedDataFieldsResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetIndexedDataFieldsResponse" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "GetMigrationStatusResponse": { "required": [ "direction", "status" ], "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "direction": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetMigrationStatusResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetMigrationStatusResponse" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "GetWorkspaceChangeSummaryResponseDto": { "type": "object", "properties": { "containsChanges": { "type": "boolean" }, "changedResources": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceChangedResourceDto" }, "nullable": true } }, "additionalProperties": false }, "GetWorkspaceChangeSummaryResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetWorkspaceChangeSummaryResponseDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "IndexedCollectionFieldDto": { "required": [ "columns", "dataKey", "name" ], "type": "object", "properties": { "dataKey": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/IndexedFieldDto" }, "nullable": true } }, "additionalProperties": false }, "IndexedFieldDto": { "required": [ "dataKey", "fieldType", "name" ], "type": "object", "properties": { "dataKey": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "fieldType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvestmentAccountDataSource": { "required": [ "investmentAccount" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "investmentAccount": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentAccountDto" } } }, "additionalProperties": false }, "InvestmentAccountDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Generic properties of a single in-scope investment account" } }, "additionalProperties": false }, "InvestmentAccountFundDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Properties of the single investment account fund" } }, "additionalProperties": false }, "InvestmentAccountRelatedFundShareClassDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Properties of the investment account related fund share class" } }, "additionalProperties": false }, "JourneyLevelDataDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] } }, "additionalProperties": false }, "JurisdictionListItemViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "description": "Unique identifier of policy", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "versionNumber": { "type": "integer", "description": "Version number of the policy", "format": "int32", "example": 1 }, "jurisdictionId": { "type": "string", "description": "Unique identifier of jurisdiction", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "changeType": { "enum": [ "Unchanged", "Added", "Updated", "Deleted", "Locked" ], "type": "string", "description": "Change type of the jurisdiction", "nullable": true, "example": "Unchanged" }, "lockDetails": { "allOf": [ { "$ref": "#/components/schemas/LockDetailsDto" } ], "description": "Details of the lock. Null if the ChangeType is not Locked.", "nullable": true }, "name": { "type": "string", "description": "Name of the jurisdiction", "nullable": true, "example": "Global" }, "description": { "type": "string", "description": "Description of the jurisdiction", "nullable": true, "example": "Global" } }, "additionalProperties": false, "description": "Jurisdiction" }, "JurisdictionListItemViewModelDtoItemsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/JurisdictionListItemViewModelDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true } }, "additionalProperties": false, "description": "Query Result Page" }, "JurisdictionListItemViewModelDtoItemsPageServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JurisdictionListItemViewModelDtoItemsPage" } ], "description": "Query Result Page", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "JurisdictionNameViewModelDto": { "type": "object", "properties": { "jurisdictionId": { "type": "string", "description": "Unique identifier of jurisdiction", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "name": { "type": "string", "description": "Name of Jurisdiction", "nullable": true, "example": "Global" } }, "additionalProperties": false, "description": "Jurisdiction DTO" }, "JurisdictionNameViewModelDtoItemsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/JurisdictionNameViewModelDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true } }, "additionalProperties": false, "description": "Query Result Page" }, "JurisdictionNameViewModelDtoItemsPageServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JurisdictionNameViewModelDtoItemsPage" } ], "description": "Query Result Page", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "JurisdictionViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" }, "jurisdictionId": { "type": "string", "format": "uuid" }, "changeType": { "enum": [ "Unchanged", "Added", "Updated", "Deleted", "Locked" ], "type": "string", "nullable": true }, "lockDetails": { "allOf": [ { "$ref": "#/components/schemas/LockDetailsDto" } ], "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true } }, "additionalProperties": false }, "JurisdictionViewModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JurisdictionViewModelDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ListFieldsSummaryFilters": { "required": [ "categories" ], "type": "object", "properties": { "journeyLevelDataOnly": { "type": "boolean" }, "categories": { "uniqueItems": true, "type": "array", "items": { "maxLength": 250, "minLength": 1, "type": "string" }, "nullable": true }, "targetEntities": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ListFieldsSummaryRequestDto": { "type": "object", "properties": { "filters": { "allOf": [ { "$ref": "#/components/schemas/ListFieldsSummaryFilters" } ], "nullable": true } }, "additionalProperties": false }, "ListFieldsSummaryRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ListFieldsSummaryRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "ListFieldsSummaryResponseDto": { "type": "object", "properties": { "fieldsByDataKey": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldSummaryDto" }, "description": "Fields summary grouped by dataKey", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing fields summary grouped by DataKey" }, "ListFieldsSummaryResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ListFieldsSummaryResponseDto" } ], "description": "Response DTO representing fields summary grouped by DataKey", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "LockDetailsDto": { "type": "object", "properties": { "lockedByWorkspaceId": { "type": "string", "format": "uuid" }, "lockedByWorkspaceName": { "type": "string", "nullable": true }, "lockChangeType": { "enum": [ "Updated", "Deleted" ], "type": "string", "nullable": true } }, "additionalProperties": false }, "MainEntityDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] } }, "additionalProperties": false }, "ManualCreditAssessmentV2DataSource": { "required": [ "creditAssessments" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/CreditAssessmentDto" } } }, "additionalProperties": false }, "ManualCreditScreeningDataSource": { "required": [ "creditScreenings" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" } }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningDto": { "required": [ "properties" ], "type": "object", "properties": { "taskDataKey": { "type": "string", "description": "Task Data Key", "nullable": true }, "taskId": { "type": "string", "description": "Task Id", "format": "uuid" }, "entityId": { "type": "string", "description": "Entity Id", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "description": "The outcome recorded for a manual screening task.", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy for manual credit screening", "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 }, "NumberFormulaSchemaDto": { "type": "object", "properties": { "formulaSetId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32", "nullable": true }, "formulaString": { "type": "string", "nullable": true }, "formulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NumberFormulaVariableDto" }, "nullable": true } }, "additionalProperties": false }, "NumberFormulaVariableDto": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "propertyName": { "type": "string", "nullable": true }, "filterConditions": { "type": "array", "items": { "$ref": "#/components/schemas/FilterConditionDto" }, "nullable": true } }, "additionalProperties": false }, "PolicyFieldSearchViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "description": "Unique identifier of policy", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "versionNumber": { "type": "integer", "description": "Version number of the policy", "format": "int32", "example": 1 }, "fieldId": { "type": "string", "description": "Unique identifier of field", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "fieldType": { "type": "string", "description": "Type of the field", "nullable": true, "example": "text" }, "fieldVersion": { "type": "integer", "description": "Version number of the field", "format": "int32", "example": 2 }, "changeType": { "enum": [ "Unchanged", "Added", "Updated", "Deleted", "Locked" ], "type": "string", "description": "Change type of the field", "nullable": true, "example": "Unchanged" }, "lockDetails": { "allOf": [ { "$ref": "#/components/schemas/LockDetailsDto" } ], "description": "Details of the lock. Null if the ChangeType is not Locked.", "nullable": true }, "mandatoryType": { "enum": [ "Optional", "Required", "Conditional" ], "type": "string", "description": "Mandatory type of the field", "nullable": true, "example": "Required" }, "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "First Name" }, "dataKey": { "type": "string", "description": "Data key for the field", "nullable": true, "example": "firstName" }, "order": { "type": "number", "description": "Order in which the field appears", "format": "double", "nullable": true, "example": 1 }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categories the field belongs to. Sorted alphabetically.", "nullable": true, "example": [ "Basic Details", "Personal Information" ] }, "targetEntities": { "type": "array", "items": { "type": "string" }, "description": "Target entities for the field. Sorted alphabetically.", "nullable": true, "example": [ "Client" ] }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/JurisdictionNameViewModelDto" }, "description": "Jurisdictions the field applies to. Sorted alphabetically by jurisdiction name.", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags for the field. Sorted alphabetically.", "nullable": true, "example": [ "Required", "Personal" ] } }, "additionalProperties": false, "description": "Represents an object for searching policy field entities, containing field metadata,\ncategorization, and associated policy information." }, "PolicyFieldSearchViewModelDtoItemsPageWithTotal": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyFieldSearchViewModelDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true }, "totalCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "PolicyFieldSearchViewModelDtoItemsPageWithTotalServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PolicyFieldSearchViewModelDtoItemsPageWithTotal" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "PolicyFieldViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" }, "fieldId": { "type": "string", "format": "uuid" }, "fieldVersion": { "type": "integer", "format": "int32" }, "changeType": { "enum": [ "Unchanged", "Added", "Updated", "Deleted", "Locked" ], "type": "string", "nullable": true }, "lockDetails": { "allOf": [ { "$ref": "#/components/schemas/LockDetailsDto" } ], "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "dataKey": { "type": "string", "nullable": true }, "fieldType": { "type": "string", "nullable": true }, "fieldTypeId": { "type": "string", "format": "uuid", "nullable": true }, "linkChildFieldDataKey": { "type": "string", "nullable": true }, "linkedParentFieldDataKey": { "type": "string", "nullable": true }, "externalSearchApiProviderId": { "type": "string", "format": "uuid", "nullable": true }, "formulaSchema": { "allOf": [ { "$ref": "#/components/schemas/NumberFormulaSchemaDto" } ], "nullable": true }, "dateTimePeriodFormulaSchema": { "allOf": [ { "$ref": "#/components/schemas/DateTimePeriodFormulaSchemaDto" } ], "nullable": true }, "order": { "type": "number", "format": "double", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "classification": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "targetEntities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isReadOnly": { "type": "boolean" }, "isJourneyLevelData": { "type": "boolean" }, "isIndexable": { "type": "boolean" }, "isSensitiveData": { "type": "boolean" }, "isMaterialData": { "type": "boolean" }, "uiDecoration": { "type": "string", "nullable": true }, "uiDecorationColor": { "type": "string", "nullable": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "nullable": true }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceDto" }, "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true }, "conditionalValues": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalValueDto" }, "nullable": true }, "validationRules": { "allOf": [ { "$ref": "#/components/schemas/DataValidationRulesDto" } ], "description": "Request DTO representing validation data metadata", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "clearValueIfTriggerConditionNotMet": { "type": "boolean" }, "jurisdictionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "dataProtectionJurisdictionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "PolicyFieldViewModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PolicyFieldViewModelDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "PropertiesDto": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "collectionProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "PropertyDto": { "required": [ "type" ], "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, "discriminator": { "propertyName": "type", "mapping": { "Collection": "#/components/schemas/CollectionPropertyDto", "Custom": "#/components/schemas/CustomPropertyDto", "Single": "#/components/schemas/SinglePropertyDto" } } }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "ReferenceDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRuleDto": { "type": "object", "properties": { "errorMessage": { "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" }, "RegexRuleDto2": { "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" }, "RegexRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/RegexRuleDtoConditionalValueDto" }, "description": "Conditional validation rules", "nullable": true } }, "additionalProperties": false }, "RegexRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "description": "Request DTO representing regex rule metadata", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false }, "RelatedAssetDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy", "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 }, "RelatedAssetsDataSource": { "required": [ "assets" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssetDto" } } }, "additionalProperties": false }, "RelatedAssociationDto": { "required": [ "properties" ], "type": "object", "properties": { "associationType": { "type": "string", "description": "Type of this association", "nullable": true, "example": "Employee of " }, "ownershipPercentage": { "type": "number", "description": "Ownership Percentage of this association", "format": "double", "nullable": true, "example": 0.5 }, "associationToClient": { "type": "string", "description": "Association To Client", "nullable": true, "example": "Direct/Indirect" }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Generic properties" } }, "additionalProperties": false }, "RelatedAssociationsDataSource": { "required": [ "relatedAssociations" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssociationDto" } } }, "additionalProperties": false }, "RelatedClientDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "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 }, "RelatedDealDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy", "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 }, "RelatedDealsDataSource": { "required": [ "relatedDeals" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedDeals": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDealDto" } } }, "additionalProperties": false }, "RelatedDocumentDto": { "required": [ "document" ], "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/RelatedDocumentVersionedDto" } ] } }, "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, "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 }, "RelatedDocumentsDataSource": { "required": [ "documents" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDocumentDto" } } }, "additionalProperties": false }, "RelatedFCRDto": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string", "description": "The status of the FCR." }, "createdDate": { "type": "string", "description": "The date the FCR was created.", "format": "date-time" }, "submittedDate": { "type": "string", "description": "The date the FCR was submitted.", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "RelatedFCRsDataSource": { "required": [ "fcRs" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "fcRs": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedFCRDto" } } }, "additionalProperties": false }, "RelatedInvestmentManagerDataSource": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] }, "dataSource": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "RelatedPartiesDataSource": { "required": [ "relatedParties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedParties": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyDto" } } }, "additionalProperties": false }, "RelatedPartyDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Generic properties setup in policy" }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "The properties from the actual relationship", "nullable": true } }, "additionalProperties": false }, "RelatedPartyRequirementIdvValidationRulesDto": { "type": "object", "properties": { "idvMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Mandatory ID&V", "nullable": true }, "idvPartyCount": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "description": "The minimum number of relationships that need to be ID&Vd in order for this requirement to be fulfilled", "nullable": true }, "idvAllParties": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "All entities that meet the criteria of this requirement need to be ID&Vd", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing ID&V validation data for related party requirements" }, "RelatedPartyRequirementSearchViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "description": "Unique identifier of policy", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "versionNumber": { "type": "integer", "description": "Version number of the policy", "format": "int32", "example": 1 }, "relatedPartyRequirementId": { "type": "string", "description": "Unique identifier of related party requirement", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "relatedPartyRequirementVersion": { "type": "integer", "description": "Version number of the related party requirement", "format": "int32", "example": 2 }, "changeType": { "enum": [ "Unchanged", "Added", "Updated", "Deleted", "Locked" ], "type": "string", "description": "Change type of the related party requirement", "nullable": true, "example": "Unchanged" }, "lockDetails": { "allOf": [ { "$ref": "#/components/schemas/LockDetailsDto" } ], "description": "Details of the lock. Null if the ChangeType is not Locked.", "nullable": true }, "mandatoryType": { "enum": [ "Optional", "Required", "Conditional" ], "type": "string", "description": "Mandatory type of the related party requirement", "nullable": true, "example": "Required" }, "name": { "type": "string", "description": "Name of the related party requirement", "nullable": true, "example": "First Name" }, "dataKey": { "type": "string", "description": "Data key for the related party requirement", "nullable": true, "example": "firstName" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categories the related party requirement belongs to. Sorted alphabetically.", "nullable": true, "example": [ "Basic Details", "Personal Information" ] }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/JurisdictionNameViewModelDto" }, "description": "Jurisdictions the related party requirement applies to. Sorted alphabetically by jurisdiction name.", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags for the related party requirement. Sorted alphabetically.", "nullable": true, "example": [ "Required", "Personal" ] } }, "additionalProperties": false, "description": "Represents an object for searching policy related party requirements, containing related party requirements metadata,\ncategorization, and associated policy information." }, "RelatedPartyRequirementSearchViewModelDtoItemsPageWithTotal": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRequirementSearchViewModelDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true }, "totalCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "RelatedPartyRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartyRequirementSearchViewModelDtoItemsPageWithTotal" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "RelatedPartyRequirementValidationRulesDto": { "type": "object", "properties": { "mandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Mandatory requirement", "nullable": true }, "partyCount": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "description": "The minimum number of relationships that need to be added in order for this requirement to be fulfilled", "nullable": true }, "allParties": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "All entities that meet the criteria of this requirement", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation data for related party requirements" }, "RelatedPartyRequirementViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" }, "relatedPartyRequirementId": { "type": "string", "format": "uuid" }, "relatedPartyRequirementVersion": { "type": "integer", "format": "int32" }, "changeType": { "enum": [ "Unchanged", "Added", "Updated", "Deleted", "Locked" ], "type": "string", "nullable": true }, "lockDetails": { "allOf": [ { "$ref": "#/components/schemas/LockDetailsDto" } ], "nullable": true }, "name": { "type": "string", "nullable": true }, "dataKey": { "type": "string", "nullable": true }, "tooltipDescription": { "type": "string", "nullable": true }, "classification": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceDto" }, "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true }, "validationRules": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartyRequirementValidationRulesDto" } ], "description": "Request DTO representing validation data for related party requirements", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "portalGuidance": { "type": "string", "nullable": true }, "partyTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "relatedPartyEntityTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "uboThreshold": { "type": "number", "format": "double", "nullable": true }, "directAssociationsOnly": { "type": "boolean" }, "idvOn": { "type": "boolean" }, "idvName": { "type": "string", "nullable": true }, "idvTooltip": { "type": "string", "nullable": true }, "idvValidationRules": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartyRequirementIdvValidationRulesDto" } ], "description": "Request DTO representing ID&V validation data for related party requirements", "nullable": true }, "jurisdictionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "dataProtectionJurisdictionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "RelatedPartyRequirementViewModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartyRequirementViewModelDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "RelatedProductDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in product policy", "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" } } } } } }, "lifecycleStatus": { "type": "string", "description": "System field used in backend for status of a product in lifecycle", "nullable": true }, "relationshipTypes": { "type": "array", "items": { "type": "string" }, "description": "System field used in backend for product of a product relationship", "nullable": true } }, "additionalProperties": false }, "RelatedProductsDataSource": { "required": [ "products" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedProductDto" } } }, "additionalProperties": false }, "RelatedUnderlyingPrincipalOwnerDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] } }, "additionalProperties": false }, "ReviewAndApprovalDataSource": { "required": [ "reviewAndApprovals" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "reviewAndApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewAndApprovalDto" } } }, "additionalProperties": false }, "ReviewAndApprovalDto": { "required": [ "approvalOutcome" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy for review and approval task", "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" } } } } } }, "approvalOutcome": { "type": "string", "description": "The Approval Outcome of the task" }, "approvalReason": { "type": "string", "description": "The Reason of the approval decision.", "nullable": true }, "taskId": { "type": "string", "description": "Task Id", "nullable": true }, "taskDataKey": { "type": "string", "description": "Task Data Key", "nullable": true } }, "additionalProperties": false }, "ScreeningMaterialityAssessmentDto": { "required": [ "adverseMediaJurisdictions", "enforcementsJurisdictions", "otherJurisdictions", "pepJurisdictions", "sanctionsJurisdictions" ], "type": "object", "properties": { "mainEntity": { "type": "boolean", "description": "Whether this assessment is for the main entity (true) or a related party (false)." }, "materialityOutcome": { "type": "string", "description": "Overall materiality outcome of the screening assessment (e.g. \"Material\", \"Non-Material\").", "nullable": true }, "pepMaterialityStatus": { "type": "string", "description": "PEP (Politically Exposed Person) materiality status.", "nullable": true }, "sanctionsMaterialityStatus": { "type": "string", "description": "Sanctions materiality status.", "nullable": true }, "adverseMediaMaterialityStatus": { "type": "string", "description": "Adverse media materiality status.", "nullable": true }, "enforcementsMaterialityStatus": { "type": "string", "description": "Enforcements materiality status.", "nullable": true }, "otherMaterialityStatus": { "type": "string", "description": "Other (non-categorised) materiality status.", "nullable": true }, "pepJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "PEP jurisdictions associated with this assessment." }, "sanctionsJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Sanctions jurisdictions associated with this assessment." }, "adverseMediaJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Adverse media jurisdictions associated with this assessment." }, "enforcementsJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Enforcements jurisdictions associated with this assessment." }, "otherJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Other jurisdictions associated with this assessment." }, "sanctionsProceedDecision": { "type": "string", "description": "Sanctions ok-to-proceed decision text returned by Screening (e.g. \"Ok to proceed\", \"Not to proceed\").", "nullable": true } }, "additionalProperties": false }, "ScreeningMaterialityDataSource": { "required": [ "assessments" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/ScreeningMaterialityAssessmentDto" } } }, "additionalProperties": false, "description": "Data source for Screening Materiality Assessment outcomes.\nContains a list of assessments — one per entity in the batch (main entity and related parties)." }, "SearchEntityDocumentRequirementsFiltersDto": { "type": "object", "properties": { "filterText": { "type": "string", "description": "Name of the resource or entity to be filtered.\nIt searches in the Name, DataKey, Jurisdictions and Categories.\nRequires at least 2 characters. Leave as null to ignore this filter.", "nullable": true, "example": "Driving Licence" }, "changeTypes": { "type": "array", "items": { "type": "string" }, "description": "Change type of the resource. Leave as null to ignore this filter.", "nullable": true, "example": [ "Unchanged" ] }, "mandatoryTypes": { "type": "array", "items": { "type": "string" }, "description": "Mandatory type of the document requirement. Leave as null to ignore this filter.", "nullable": true, "example": [ "Required" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "List of jurisdictions to be filtered. Leave as null to ignore this filter.", "nullable": true, "example": [ "Global" ] }, "targetEntities": { "type": "array", "items": { "type": "string" }, "description": "List of target entities to be filtered. Leave as null to ignore this filter.", "nullable": true, "example": [ "Client" ] }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categories the document requirement belongs to. Leave as null to ignore this filter.", "nullable": true, "example": [ "Basic Details", "Personal Information" ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Field tags. Leave as null to ignore this filter.", "nullable": true, "example": [ "PII" ] } }, "additionalProperties": false, "description": "Represents a data transfer object used for filtering document requirements in a policy." }, "SearchEntityDocumentRequirementsRequestDto": { "type": "object", "properties": { "sortBy": { "enum": [ "Name", "DataKey", "ChangeType", "MandatoryType", "TargetEntities", "Categories", "Jurisdictions", "Tags" ], "type": "string", "description": "The column by which the results should be sorted.", "nullable": true, "example": "Name" }, "sortDirection": { "enum": [ "Ascending", "Descending" ], "type": "string", "description": "The direction in which the results should be sorted (e.g., Ascending or Descending).", "nullable": true, "example": "Ascending" }, "pageSize": { "maximum": 100, "minimum": 0, "exclusiveMinimum": true, "type": "integer", "description": "The maximum number of records to be returned in a single page of the query result.", "format": "int32", "example": 100 }, "paginationToken": { "type": "string", "description": "A token used to represent the current position in a paginated result set.\nIt is utilized primarily to fetch the next set of results in a query or search operation.", "nullable": true }, "filters": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityDocumentRequirementsFiltersDto" } ], "description": "Filters applied to narrow down the search results for document requirements.", "nullable": true } }, "additionalProperties": false, "description": "Represents a request DTO for searching document requirements" }, "SearchEntityDocumentRequirementsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityDocumentRequirementsRequestDto" } ], "description": "Represents a request DTO for searching document requirements", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "SearchEntityESignatureDocumentRequirementsFiltersDto": { "type": "object", "properties": { "filterText": { "type": "string", "description": "Name of the resource or entity to be filtered.\nIt searches in the Name, DataKey, Jurisdictions and Categories.\nRequires at least 2 characters. Leave as null to ignore this filter.", "nullable": true, "example": "Driving Licence" }, "changeTypes": { "type": "array", "items": { "type": "string" }, "description": "Change type of the resource. Leave as null to ignore this filter.", "nullable": true, "example": [ "Unchanged" ] }, "mandatoryTypes": { "type": "array", "items": { "type": "string" }, "description": "Mandatory type of the e-signature document requirement. Leave as null to ignore this filter.", "nullable": true, "example": [ "Required" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "List of jurisdictions to be filtered. Leave as null to ignore this filter.", "nullable": true, "example": [ "Global" ] }, "targetEntities": { "type": "array", "items": { "type": "string" }, "description": "List of target entities to be filtered. Leave as null to ignore this filter.", "nullable": true, "example": [ "Client" ] }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categories the e-signature document requirement belongs to. Leave as null to ignore this filter.", "nullable": true, "example": [ "Basic Details", "Personal Information" ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Field tags. Leave as null to ignore this filter.", "nullable": true, "example": [ "PII" ] } }, "additionalProperties": false, "description": "Represents a data transfer object used for filtering e-signature document requirements in a policy." }, "SearchEntityESignatureDocumentRequirementsRequestDto": { "type": "object", "properties": { "sortBy": { "enum": [ "Name", "DataKey", "ChangeType", "MandatoryType", "TargetEntities", "Categories", "Jurisdictions", "Tags" ], "type": "string", "description": "The column by which the results should be sorted.", "nullable": true, "example": "Name" }, "sortDirection": { "enum": [ "Ascending", "Descending" ], "type": "string", "description": "The direction in which the results should be sorted (e.g., Ascending or Descending).", "nullable": true, "example": "Ascending" }, "pageSize": { "maximum": 100, "minimum": 0, "exclusiveMinimum": true, "type": "integer", "description": "The maximum number of records to be returned in a single page of the query result.", "format": "int32", "example": 100 }, "paginationToken": { "type": "string", "description": "A token used to represent the current position in a paginated result set.\nIt is utilized primarily to fetch the next set of results in a query or search operation.", "nullable": true }, "filters": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityESignatureDocumentRequirementsFiltersDto" } ], "description": "Filters applied to narrow down the search results for e-signature document requirements.", "nullable": true } }, "additionalProperties": false, "description": "Represents a request DTO for searching e-signature document requirements" }, "SearchEntityESignatureDocumentRequirementsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityESignatureDocumentRequirementsRequestDto" } ], "description": "Represents a request DTO for searching e-signature document requirements", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "SearchEntityPolicyFieldsFiltersDto": { "type": "object", "properties": { "filterText": { "type": "string", "description": "Name of the resource or entity to be filtered.\nIt searches in the name, Data Key, Field Type, Jurisdictions and Categories.\nRequires at least 2 characters. Leave as null to ignore this filter.", "nullable": true, "example": "First Name" }, "changeTypes": { "type": "array", "items": { "type": "string" }, "description": "Change type of the resource. Leave as null to ignore this filter.", "nullable": true, "example": [ "Unchanged" ] }, "mandatoryTypes": { "type": "array", "items": { "type": "string" }, "description": "Mandatory type of the field. Leave as null to ignore this filter.", "nullable": true, "example": [ "Required" ] }, "fieldTypes": { "type": "array", "items": { "type": "string" }, "description": "Specifies the list of field types used in the search policy fields filters. Leave as null to ignore this filter.", "nullable": true, "example": [ "multiselect", "select" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "List of jurisdictions to be filtered. Leave as null to ignore this filter.", "nullable": true, "example": [ "Global" ] }, "targetEntities": { "type": "array", "items": { "type": "string" }, "description": "List of target entities to be filtered. Leave as null to ignore this filter.", "nullable": true, "example": [ "Client" ] }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categories the field belongs to. Leave as null to ignore this filter.", "nullable": true, "example": [ "Basic Details", "Personal Information" ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Field tags. Leave as null to ignore this filter.", "nullable": true, "example": [ "PII" ] } }, "additionalProperties": false, "description": "Represents a data transfer object used for filtering fields in a policy." }, "SearchEntityPolicyFieldsRequestDto": { "type": "object", "properties": { "sortBy": { "enum": [ "Name", "DataKey", "FieldType", "ChangeType", "MandatoryType", "TargetEntities", "Categories", "Jurisdictions", "Tags", "Order" ], "type": "string", "description": "The column by which the results should be sorted.", "nullable": true, "example": "Name" }, "sortDirection": { "enum": [ "Ascending", "Descending" ], "type": "string", "description": "The direction in which the results should be sorted (e.g., Ascending or Descending).", "nullable": true, "example": "Ascending" }, "pageSize": { "maximum": 100, "minimum": 0, "exclusiveMinimum": true, "type": "integer", "description": "The maximum number of records to be returned in a single page of the query result.", "format": "int32", "example": 100 }, "paginationToken": { "type": "string", "description": "A token used to represent the current position in a paginated result set.\nIt is used primarily to fetch the next set of results in a query or search operation.", "nullable": true }, "filters": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityPolicyFieldsFiltersDto" } ], "description": "Filters applied to narrow down the search results for policy fields.", "nullable": true } }, "additionalProperties": false, "description": "Represents a request DTO for searching fields" }, "SearchEntityPolicyFieldsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityPolicyFieldsRequestDto" } ], "description": "Represents a request DTO for searching fields", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "SearchEntityRelatedPartyRequirementsFiltersDto": { "type": "object", "properties": { "filterText": { "type": "string", "description": "Name of the resource or entity to be filtered.\nIt searches in the Name, DataKey, Jurisdictions and Categories.\nRequires at least 2 characters. Leave as null to ignore this filter.", "nullable": true, "example": "Driving Licence" }, "changeTypes": { "type": "array", "items": { "type": "string" }, "description": "Change type of the resource. Leave as null to ignore this filter.", "nullable": true, "example": [ "Unchanged" ] }, "mandatoryTypes": { "type": "array", "items": { "type": "string" }, "description": "Mandatory type of the related party requirement. Leave as null to ignore this filter.", "nullable": true, "example": [ "Required" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "List of jurisdictions to be filtered. Leave as null to ignore this filter.", "nullable": true, "example": [ "Global" ] }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categories the related party requirement belongs to. Leave as null to ignore this filter.", "nullable": true, "example": [ "Basic Details", "Personal Information" ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Field tags. Leave as null to ignore this filter.", "nullable": true, "example": [ "PII" ] } }, "additionalProperties": false, "description": "Represents a data transfer object used for filtering related party requirements in a policy." }, "SearchEntityRelatedPartyRequirementsRequestDto": { "type": "object", "properties": { "sortBy": { "enum": [ "Name", "DataKey", "ChangeType", "MandatoryType", "Categories", "Jurisdictions", "Tags" ], "type": "string", "description": "The column by which the results should be sorted.", "nullable": true, "example": "Name" }, "sortDirection": { "enum": [ "Ascending", "Descending" ], "type": "string", "description": "The direction in which the results should be sorted (e.g., Ascending or Descending).", "nullable": true, "example": "Ascending" }, "pageSize": { "maximum": 100, "minimum": 0, "exclusiveMinimum": true, "type": "integer", "description": "The maximum number of records to be returned in a single page of the query result.", "format": "int32", "example": 100 }, "paginationToken": { "type": "string", "description": "A token used to represent the current position in a paginated result set.\nIt is utilized primarily to fetch the next set of results in a query or search operation.", "nullable": true }, "filters": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityRelatedPartyRequirementsFiltersDto" } ], "description": "Filters applied to narrow down the search results for related party requirements.", "nullable": true } }, "additionalProperties": false, "description": "Represents a request DTO for searching related party requirements" }, "SearchEntityRelatedPartyRequirementsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityRelatedPartyRequirementsRequestDto" } ], "description": "Represents a request DTO for searching related party requirements", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "description": "The message", "nullable": true, "example": "Success" }, "type": { "type": "string", "description": "Type of the message\nOne of Info, Warning, Error, Forbidden", "nullable": true, "example": "Info" }, "errorCode": { "type": "string", "description": "Error Code", "nullable": true, "example": "INTERNAL_SERVER_ERROR" } }, "additionalProperties": false, "description": "The message associated to the service response" }, "SignificanceEngineDataSource": { "required": [ "significanceEngine" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDto" } ] } }, "additionalProperties": false }, "SignificanceEngineDto": { "type": "object", "properties": { "singleFields": { "type": "array", "items": { "type": "string" }, "nullable": true }, "collections": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "SinglePropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "SinglePropertyDto2": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto": { "type": "object", "properties": { "errorMessage": { "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" }, "SpecialCharactersRuleDto2": { "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" }, "SpecialCharactersRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false }, "TagSuggestionResponseDto": { "type": "object", "properties": { "tags": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "List of suggested tags", "nullable": true, "example": [ "PII" ] } }, "additionalProperties": false, "description": "Tag suggestion response" }, "TagSuggestionResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/TagSuggestionResponseDto" } ], "description": "Tag suggestion response", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto2" } ], "description": "Special characters validation rule - does not allow special characters,\nbut allows define array of characters which can be ignored by the validation", "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that does not allow numbers", "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that allows only integers", "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that does not allow negative numbers", "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that allows numbers up to two decimal places", "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto2" } ], "description": "Validation rule that validates the value against provided regex", "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "description": "Validation rule that allows to set minimum and maximum count of characters", "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "description": "Validation rule that allows to set number range", "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that does not allow future dates", "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that does not allow past dates", "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto2" } ], "description": "Validation rule that allows to set date range", "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "description": "Validation rule that allows to set selection range", "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto2" } ], "description": "Validation rule that allows to set minimum count requirements for collection", "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto2" } ], "description": "Validation rule that allows to set maximum count requirements for collection", "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto2" } ], "description": "Validation rule that allows to use external provider for validation", "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto2" } ], "description": "Validation rule that allows to use external provider for validating all fields of a DataGroup as a collection", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "ValueField": { "type": "object", "properties": { "dataSource": { "type": "string", "description": "Value of DataSource used to filter field values", "nullable": true }, "field": { "type": "string", "description": "Field value used to validate conditional value", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDto": { "type": "object", "properties": { "errorMessage": { "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" }, "ValueLimitRuleDto2": { "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" }, "ValueLimitRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValueDto" }, "description": "Conditional validation rules", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Request DTO representing value limit rule metadata", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false }, "ValueLimitRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false }, "WorkspaceChangeListItemViewModelDto": { "type": "object", "properties": { "entityPolicyId": { "type": "string", "description": "Unique identifier of policy", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "resourceType": { "enum": [ "Jurisdiction", "Field", "Document", "eSignature Document", "Related Party" ], "type": "string", "description": "Type of the entity that the policy is applied to", "nullable": true, "example": "Jurisdiction" }, "resourceId": { "type": "string", "description": "ID of the resource", "format": "uuid", "example": "80e92251-db0c-47e0-8e50-490d4bd1db6e" }, "name": { "type": "string", "description": "Name of the resource", "nullable": true, "example": "Global" }, "changeType": { "enum": [ "Added", "Updated", "Deleted" ], "type": "string", "description": "Change Type of the resource", "nullable": true, "example": "Unchanged" }, "lastUpdatedBy": { "type": "string", "description": "Identifier of the user who last updated the resource", "nullable": true }, "lastUpdatedOn": { "type": "string", "description": "The date and time when the policy or resource was last updated.", "format": "date-time", "example": "2023-10-05T14:30:00Z" } }, "additionalProperties": false, "description": "Represents a change in the workspace" }, "WorkspaceChangeListItemViewModelDtoItemsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceChangeListItemViewModelDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true } }, "additionalProperties": false, "description": "Query Result Page" }, "WorkspaceChangeListItemViewModelDtoItemsPageServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/WorkspaceChangeListItemViewModelDtoItemsPage" } ], "description": "Query Result Page", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "WorkspaceChangedResourceDto": { "type": "object", "properties": { "resourceType": { "enum": [ "Jurisdiction", "Field", "Document", "eSignature Document", "Related Party" ], "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }