{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Audit Query", "description": "The Audit Query API enables the retrieval of audit event data related to various activities within the system. It currently supports data for Journeys, Entities, Screening Tasks, and Financial Analysis events.\n\n
Version 2\n\n
Version 2 builds upon Version 1 by introducing paging to the resource and search term APIs, providing the following additional features:\n\n", "version": "2.0" }, "servers": [ { "url": "/auditquery" } ], "paths": { "/api/v2/auditevent/resources": { "post": { "tags": [ "AuditEvent" ], "summary": "Get Audit Events for a specific list of resource IDs in a paged manner.", "description": "\n\r\n This method accepts a list of resource IDs and a pager object. \r\n \r\n\n\r\n The resource IDs indicate the records that are being sought, while the pager specifies the number of records to return in each page, the starting index of the first result, sorting field, and order (either \"Ascending\" or \"Descending\").\r\n \r\n\n\r\n The resource IDs can refer to entities, journeys, or any other record type. \r\n \r\n\n\r\n The method then returns a list of audit events for each resource ID and a field indicating the total number of results.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetAuditEventsForMultipleResources", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Resource request object", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResourceQueryPagedDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The relevant audit events are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetForMultipleResourcesResultDtoServiceResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal server error" }, "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/auditevent/searchterm": { "post": { "tags": [ "AuditEvent" ], "summary": "Get Audit Events for a specific search term in a paged manner.", "description": "\n\r\n This method takes in a list of resource IDs, a search term and a pager object.\r\n \r\n\n\r\n The resource IDs represent the identifiers of entities, journeys, or any other type of record, while the search term filters these records by either specifying a field name or a field value.\r\n The pager specifies the number of records to return in each page, the starting index of the first result, sorting field, and order (either \"Ascending\" or \"Descending\").\r\n \r\n\n\r\n The method then returns a list of audit events for each resource ID and a field indicating the total number of results.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "SearchByTerm", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Search term paged request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchTermPagedDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The relevant audit events are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBySearchTermResultDtoServiceResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal server error" }, "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/auditevent/groupedEntityEvents": { "post": { "tags": [ "AuditEvent" ], "summary": "Get Entity Specific Audit Events, grouped and summarized by the fields that have been updated in a paged manner.", "description": "\nThis method accepts a list of Entity specific resource IDs and returns a list of Audit Events grouped and summarized by field name.\r\n\nEach returned record contains the original value as well as the last updated value.\r\n\nTo retrieve a complete list of updated fields for an Entity, include all entity draft IDs in the request.

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetGroupedEntityAuditEvents", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Grouped entity events request object", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetGroupedEntityAuditEventsDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The relevant audit events are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupedEntityAuditEventsResultDtoServiceResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal server error" }, "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/auditevent/entityeventdetails": { "post": { "tags": [ "AuditEvent" ], "summary": "Get all Audit Events specific to an Entity, for a particular field.", "description": "\n\r\n This method accepts a list of resource IDs specific to an Entity and a field name, and returns relevant Audit Events filtered by the specified field in a paginated format.\r\n \r\n\n\r\n To retrieve a complete list of Audit Event entries for the specified field, make sure to include both the Entity ID and all its related Entity Draft IDs in your request.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetEntityAuditEventsByFieldName", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Entity Audit Events request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityEventDetailQueryPagedDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityEventDetailResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/auditevent/screeningEvents": { "post": { "tags": [ "AuditEvent" ], "summary": "Get Audit Events related to Screening for a group of Journey IDs in a paged manner", "description": "\n\r\n This method accepts a list of Journey IDs and returns relevant Audit Events related to the screening tasks within those journeys.\r\n \r\n\n\r\n It's advisable to send a single Journey ID at a time.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetScreeningAuditEvents", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Paged request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ScreeningAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreeningAuditEventsResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/auditevent/journeyEvents": { "post": { "tags": [ "AuditEvent" ], "summary": "Get Audit Events related to a Journey in a paged manner", "description": "\n\r\n This method accepts a list of Journey IDs and returns relevant Audit Events related to those Journeys\r\n \r\n\n\r\n It's advisable to send a single Journey ID at a time.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetJourneyAuditEvents", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Paged request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetJourneyAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetJourneyAuditEventsResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/auditevent/financialAnalysisEvents": { "post": { "tags": [ "AuditEvent" ], "summary": "Get Financial Analysis audit events", "description": "\nReturns list of financial analysis audit events.

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetFinancialAnalysisAuditEvents", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetFinancialAnalysisAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFinancialAnalysisAuditEventsResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/auditevent/productAuditSummaries": { "post": { "tags": [ "AuditEvent" ], "summary": "Get Product Audit Summaries for a list of product IDs.", "description": "\n\r\n This method accepts a list of product IDs and returns lightweight audit summaries for each product.\r\n \r\n\n\r\n The summary includes the product type, last updated by, and last updated date.\r\n This endpoint is optimized for fast initial load of product audit tables.\r\n \r\n\n\r\n For full audit details of a specific product, use the GetForMultipleResources endpoint with the product ID.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetProductAuditSummaries", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Request containing product IDs and optional pager.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetProductAuditSummariesRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The product audit summaries are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductAuditSummariesResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal server error" }, "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/auditevent/queryside/entityEvents": { "post": { "tags": [ "EntityAccessLogs" ], "summary": "Get Entity Access Logs in a paged manner.", "description": "\n\r\n This method accepts the Entity ID and filters, allowing for the retrieval of all Entity Access logs.\r\n \r\n\n\r\n The Entity Access Logs display a list of users who have accessed the specified Entity ID.\r\n \r\n\n\r\n The filters are optional and enable you to search for Entity Access logs by a specific user and/or within a specified date range.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetEntityQuerySideAuditEvents", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetEntityQuerySideAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEntityQuerySideAuditEventsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AggregatePagerDto": { "type": "object", "properties": { "size": { "minimum": 0, "exclusiveMinimum": true, "type": "integer", "format": "int32" }, "from": { "minimum": 0, "type": "integer", "format": "int32" }, "sortBy": { "type": "string", "nullable": true }, "sortOrder": { "allOf": [ { "$ref": "#/components/schemas/SortOrder" } ] } }, "additionalProperties": false }, "AuditEventDto": { "type": "object", "properties": { "eventId": { "type": "string", "description": "Event id", "nullable": true, "example": "f9bb19a8-07e7-4306-94c9-a00988eadb0f" }, "resourceId": { "type": "string", "description": "The unique identifier of the Resource that was updated", "nullable": true, "example": "31a7bd8b-753f-404e-a78b-ee84de61822e" }, "resourceType": { "type": "string", "description": "The type of resource this Audit Event relates to", "nullable": true, "example": "Entity" }, "entityReferenceId": { "type": "string", "description": "The underlying EntityId that is linked to this Audit Event", "nullable": true, "example": "4514d583-7114-4b49-a17e-b424495b9cc7" }, "journeyReferenceId": { "type": "string", "description": "The underlying JourneyInstanceId that is linked to this Audit Event", "nullable": true, "example": "5e61d26e-9f2f-4c03-99e7-bc823b55fefc" }, "eventType": { "type": "string", "description": "The type of event that initiated this Audit Event", "nullable": true, "example": "EntityCreated" }, "eventSubType": { "type": "string", "description": "The event sub type", "nullable": true, "example": "Created" }, "beforeValue": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Contains the complete object in its previous state.", "nullable": true }, "afterValue": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Contains the complete object in its current state.", "nullable": true, "example": { "Properties": { "Nationality": { "Value": "Spain", "Type": "Single", "Discriminator": "Single" } } } }, "version": { "type": "string", "description": "Version", "nullable": true, "example": "0" }, "date": { "type": "string", "description": "Date the Audit Event was logged", "format": "date-time", "nullable": true }, "userId": { "type": "string", "description": "The Id of the user that affected the change", "nullable": true, "example": "f3bdd83c-ac18-42a3-a904-ca3fefda3e5f" }, "clientId": { "type": "string", "description": "The underlying client identifier / system that affected the change", "nullable": true, "example": "111e07b2-915f-483f-8815-61e2e05b1351" }, "service": { "type": "string", "description": "Identifies the service that affected the change", "nullable": true, "example": "EntityData" }, "tenant": { "type": "string", "description": "Tenant id", "nullable": true, "example": "449de204-e9d2-4204-918d-1c3b86e91aa6" }, "correlationId": { "type": "string", "description": "Correlation id", "nullable": true, "example": "78ae8b73-24bc-4175-91a0-1326388a7de9" }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/AuditMetadata" } ], "nullable": true }, "eventMetadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional optional Audit Event Metadata", "nullable": true } }, "additionalProperties": false, "description": "An object representing a single Audit Event" }, "AuditFieldChangeDto": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Field name", "nullable": true }, "oldValue": { "type": "string", "description": "Field old value", "nullable": true }, "newValue": { "type": "string", "description": "Field new value", "nullable": true }, "itemOrdinal": { "type": "integer", "description": "1-based position of the collection item this change belongs to. Only set when the\r\nowning data group holds more than one item, so consumers can tell same-named\r\ncolumns apart without exposing the internal item identifier.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "DTO representing screening audit match field change" }, "AuditMetadata": { "type": "object", "properties": { "stages": { "type": "array", "items": { "type": "object", "additionalProperties": { } }, "nullable": true }, "userName": { "type": "string", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "journeyName": { "type": "string", "nullable": true }, "eventName": { "type": "string", "nullable": true }, "taskReassignedUserBefore": { "type": "string", "nullable": true }, "taskReassignedUserAfter": { "type": "string", "nullable": true }, "taskReassignedTeamNameBefore": { "type": "string", "nullable": true }, "taskReassignedTeamNameAfter": { "type": "string", "nullable": true }, "reopenedByNameBefore": { "type": "string", "nullable": true }, "reopenedByNameAfter": { "type": "string", "nullable": true }, "completedByNameBefore": { "type": "string", "nullable": true }, "completedByNameAfter": { "type": "string", "nullable": true }, "taskUnpausedByNameBefore": { "type": "string", "nullable": true }, "taskUnpausedByNameAfter": { "type": "string", "nullable": true }, "taskPausedByNameBefore": { "type": "string", "nullable": true }, "taskPausedByNameAfter": { "type": "string", "nullable": true }, "dateIsoFormat": { "type": "string", "nullable": true }, "journeyOwnerReassignedTeamNameBefore": { "type": "string", "nullable": true }, "journeyOwnerReassignedTeamNameAfter": { "type": "string", "nullable": true }, "journeyOwnerReassignedUserBefore": { "type": "string", "nullable": true }, "journeyOwnerReassignedUserAfter": { "type": "string", "nullable": true }, "originatedEventId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BaseAuditEvent": { "type": "object", "properties": { "eventType": { "type": "string", "description": "Type of an event", "nullable": true }, "changeType": { "type": "string", "description": "Type of an event", "nullable": true }, "changedBy": { "type": "string", "description": "Last updated by username", "nullable": true, "example": "john.doye@example.com" }, "updatedOn": { "type": "string", "description": "Last Updated date", "nullable": true }, "financialItemsChanges": { "type": "array", "items": { }, "description": "Summary of before and after values of the corresponding Financial Items", "nullable": true } }, "additionalProperties": false }, "EntityAuditEventDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique id", "nullable": true, "example": "9f14cdfb-845e-4ec6-803b-17f6b7477b36_lastName" }, "resourceId": { "type": "string", "description": "Resource id", "nullable": true, "example": "0bdfeb2c-8b19-4203-a70b-c28b73f392f0" }, "resourceType": { "type": "string", "description": "Resource Type", "nullable": true, "example": "Entity" }, "fieldName": { "type": "string", "description": "Field name", "nullable": true, "example": "fieldName" }, "fieldBeforeValue": { "type": "string", "description": "Field name value before", "nullable": true, "example": "Smith" }, "fieldAfterValue": { "type": "string", "description": "Field name value after", "nullable": true, "example": "Tucker" }, "fieldType": { "type": "string", "description": "Field type", "nullable": true, "example": "Single" }, "lastUpdated": { "type": "string", "nullable": true }, "lastUpdatedBy": { "type": "string", "description": "Last updated by username", "nullable": true, "example": "Entity data" }, "journeyName": { "type": "string", "description": "Journey name", "nullable": true, "example": "Screening Individual" }, "isSensitive": { "type": "boolean", "description": "Determines if the field holds sensitive PII data" } }, "additionalProperties": false, "description": "Response DTO representing entity audit event DTO" }, "EntityEventAggregatorDto": { "required": [ "fieldName", "sortings" ], "type": "object", "properties": { "fieldName": { "minLength": 1, "type": "string", "description": "Specifies the property to Group By", "example": "fieldName" }, "sortings": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SortDto" }, "description": "List of field properties to sort by, including the sort order.", "example": [ { "sortFieldName": "resourceType", "sortOrder": "Ascending" }, { "sortFieldName": "lastUpdated", "sortOrder": "Descending" } ] } }, "additionalProperties": false }, "EntityEventDetailModel": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Entity field name", "nullable": true, "example": "lastName" }, "valueType": { "type": "string", "description": "Entity field verified or draft value type", "nullable": true, "example": "Verified" }, "valueBefore": { "type": "string", "description": "Entity field before value", "nullable": true, "example": "Smith" }, "valueAfter": { "type": "string", "description": "Entity field after value", "nullable": true, "example": "Tucker" }, "dataGroupValues": { "type": "array", "items": { "$ref": "#/components/schemas/AuditFieldChangeDto" }, "description": "Entity Before and After values for data group type fields", "nullable": true }, "changedBy": { "type": "string", "description": "Entity field changed by user name", "nullable": true, "example": "test.user@fenergo.com" }, "updatedOn": { "type": "string", "description": "Entity field updated on date", "nullable": true, "example": "2021-10-10" }, "journeyReferenceId": { "type": "string", "description": "Journey id where filed was modified", "nullable": true, "example": "f9bb19a8-07e7-4306-94c9-a00988eadb0d" }, "journeyName": { "type": "string", "description": "Journey name where filed was modified", "nullable": true, "example": "Screening Individual" }, "fieldType": { "type": "string", "description": "Entity field type", "nullable": true, "example": "Single" }, "isSensitive": { "type": "boolean", "description": "Determines if the field holds sensitive PII data" } }, "additionalProperties": false, "description": "Response DTO representing get by field name entity details result" }, "EntityEventDetailQueryDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceQueryDto" }, { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Field name by which you want to search. Search field must be one from AuditDetailedESModel", "nullable": true, "example": "lastName" }, "excludeDrafts": { "type": "boolean", "description": "Exclude draft values from search results" }, "excludeSystemFields": { "type": "boolean", "description": "Exclude system fields from search results" } }, "additionalProperties": false } ], "description": "The request object that contains a list of resource IDs and other filters for which to fetch Audit Events." }, "EntityEventDetailQueryPagedDto": { "allOf": [ { "$ref": "#/components/schemas/EntityEventDetailQueryDto" }, { "type": "object", "properties": { "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "A pager object to specify pagination parameters", "nullable": true, "example": { "size": 10, "from": 0, "sortBy": "date", "sortOrder": "Descending" } } }, "additionalProperties": false } ], "description": "The request object that contains a list of resource IDs, a pager object and other filters for which to fetch Audit Events." }, "EntityEventDetailQueryPagedDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityEventDetailQueryPagedDto" } ], "description": "The request object that contains a list of resource IDs, a pager object and other filters for which to fetch Audit Events.", "nullable": true } }, "additionalProperties": false }, "EntityEventDetailResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityEventDetailModel" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing get by field name entity detail query" }, "EntityEventDetailResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityEventDetailResultDto" } ], "description": "Response DTO representing get by field name entity detail query", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FinancialAnalysisAuditEvents": { "allOf": [ { "$ref": "#/components/schemas/BaseAuditEvent" }, { "type": "object", "properties": { "id": { "type": "string", "description": "EntityReferenceId", "nullable": true, "example": "" }, "dataGroup": { "type": "string", "description": "FA Item Name", "nullable": true, "example": "FA Income" } }, "additionalProperties": false } ] }, "GetAuditEventsForFieldQueryResultDto": { "allOf": [ { "$ref": "#/components/schemas/EntityEventDetailResultDto" }, { "type": "object", "additionalProperties": false } ] }, "GetBySearchTermResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEventDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing get by search result" }, "GetBySearchTermResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetBySearchTermResultDto" } ], "description": "Response DTO representing get by search result", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetEntityQuerySideAuditEventsFiltersRequestDto": { "type": "object", "properties": { "userId": { "type": "string", "description": "UiD of the user associated with the event", "nullable": true, "example": "9f14cdfb-845e-4ec6-803b-17f6b7477b36" }, "from": { "type": "string", "description": "Date from", "format": "date-time", "nullable": true, "example": "2022-08-10T00:00:00+00:00" }, "to": { "type": "string", "description": "Date to (must be greater than from date)", "format": "date-time", "nullable": true, "example": "2022-08-11T00:00:00+00:00" } }, "additionalProperties": false, "description": "Request DTO to specify optional query filters" }, "GetEntityQuerySideAuditEventsRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "ID of the entity", "format": "uuid", "example": "9f14cdfb-845e-4ec6-803b-17f6b7477b36" }, "filters": { "allOf": [ { "$ref": "#/components/schemas/GetEntityQuerySideAuditEventsFiltersRequestDto" } ], "description": "Filters to the request (optional)", "nullable": true }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PaginationTokenPagerDto" } ], "description": "Options for setting up the results page", "nullable": true } }, "additionalProperties": false, "description": "The request object that is used to specify the Entity ID and filters for retrieving all Entity Access logs." }, "GetEntityQuerySideAuditEventsRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetEntityQuerySideAuditEventsRequestDto" } ], "description": "The request object that is used to specify the Entity ID and filters for retrieving all Entity Access logs." } }, "additionalProperties": false }, "GetEntityQuerySideAuditEventsResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/QuerySideAuditEventDto" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetEntityQuerySideAuditEventsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetEntityQuerySideAuditEventsResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetFinancialAnalysisAuditEventsRequestDto": { "allOf": [ { "$ref": "#/components/schemas/SearchTermPagedDto" }, { "type": "object", "additionalProperties": false } ], "description": "Request DTO to get financial analysis audit events within paged list of resources" }, "GetFinancialAnalysisAuditEventsRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetFinancialAnalysisAuditEventsRequestDto" } ], "description": "Request DTO to get financial analysis audit events within paged list of resources" } }, "additionalProperties": false }, "GetFinancialAnalysisAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BaseAuditEvent" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false }, "GetFinancialAnalysisAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetFinancialAnalysisAuditEventsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetForMultipleResourcesResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEventDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing get by search result" }, "GetForMultipleResourcesResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetForMultipleResourcesResultDto" } ], "description": "Response DTO representing get by search result", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetGroupedEntityAuditEventsDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceQueryDto" }, { "required": [ "aggregator" ], "type": "object", "properties": { "pager": { "allOf": [ { "$ref": "#/components/schemas/AggregatePagerDto" } ], "description": "Pager details", "nullable": true, "example": { "from": 0, "size": 10, "sortOrder": "Descending" } }, "aggregator": { "allOf": [ { "$ref": "#/components/schemas/EntityEventAggregatorDto" } ], "description": "Specifies how to aggregate the Entity Audit Data. (Mandatory)" }, "searchProperties": { "allOf": [ { "$ref": "#/components/schemas/SearchFieldsDto" } ], "description": "(Optional) Search object to filter returned fields", "nullable": true }, "excludeDrafts": { "type": "boolean", "description": "Exclude draft values from search results" }, "excludeSystemFields": { "type": "boolean", "description": "Exclude system fields from search results" } }, "additionalProperties": false } ], "description": "The request object that contains a list of entity IDs for which to fetch entity specific audit events." }, "GetGroupedEntityAuditEventsDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetGroupedEntityAuditEventsDto" } ], "description": "The request object that contains a list of entity IDs for which to fetch entity specific audit events." } }, "additionalProperties": false }, "GetJourneyAuditEventsRequestDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceQueryDto" }, { "type": "object", "properties": { "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "A pager object to specify pagination parameters", "nullable": true, "example": { "size": 10, "from": 0, "sortBy": "date", "sortOrder": "Descending" } }, "searchPhrase": { "type": "string", "description": "Phrase you want to search by", "nullable": true } }, "additionalProperties": false } ], "description": "The request object that contains a list of JourneyIDs, a pager object and other filters for which to fetch Journey related Audit Events" }, "GetJourneyAuditEventsRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetJourneyAuditEventsRequestDto" } ], "description": "The request object that contains a list of JourneyIDs, a pager object and other filters for which to fetch Journey related Audit Events" } }, "additionalProperties": false }, "GetJourneyAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyAuditEventsDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false }, "GetJourneyAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetJourneyAuditEventsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetJourneyDataAuditEventsForFieldQueryResultDto": { "allOf": [ { "$ref": "#/components/schemas/GetAuditEventsForFieldQueryResultDto" }, { "type": "object", "additionalProperties": false } ], "description": "Journey Level Data change history for a single field on an entity and journey." }, "GetNarrativeAuditEventsRequestDto": { "allOf": [ { "$ref": "#/components/schemas/SearchTermPagedDto" }, { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } ] }, "GetProductAuditSummariesRequestDto": { "type": "object", "properties": { "productIds": { "type": "array", "items": { "type": "string" }, "description": "List of product IDs to get audit summaries for.\r\nOptional when JourneyReferenceId is provided.", "nullable": true, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }, "journeyReferenceId": { "type": "string", "description": "When provided, filters audit events to this journey only.\r\nProductIds can be omitted when this is supplied.", "nullable": true }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "Optional pager for pagination support.", "nullable": true }, "searchTerm": { "type": "string", "description": "Optional search term to filter results. Must be at least 3 characters if provided.", "nullable": true, "example": "Treasury" }, "excludeEventTypes": { "type": "array", "items": { "type": "string" }, "description": "Optional list of event types to exclude from results.", "nullable": true } }, "additionalProperties": false, "description": "Request DTO to get product audit summaries for a list of product IDs." }, "GetProductAuditSummariesRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetProductAuditSummariesRequestDto" } ], "description": "Request DTO to get product audit summaries for a list of product IDs." } }, "additionalProperties": false }, "GetProductAuditSummariesResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductAuditSummaryDto" }, "description": "List of product audit summary items.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 10 } }, "additionalProperties": false, "description": "Result DTO containing product audit summaries." }, "GetProductAuditSummariesResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetProductAuditSummariesResultDto" } ], "description": "Result DTO containing product audit summaries.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetSelfServiceUserManagementAuditEventsRequestDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceQueryPagedDto" }, { "type": "object", "properties": { "eventTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "GroupedEntityAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityAuditEventDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false }, "GroupedEntityAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GroupedEntityAuditEventsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ImpactedClientChangeDto": { "type": "object", "properties": { "legalEntityId": { "type": "string", "description": "Legal entity ID of the impacted client.", "nullable": true, "example": "5db5a437-6854-4f07-a3f8-0d0c0cef0629" }, "isSelected": { "type": "boolean", "description": "Whether the compliance officer selected this client for a follow-up On-Demand Screening\r\n(ODS) journey.", "example": true }, "reasonForNoFollowUp": { "type": "string", "description": "Reason provided when the client was not selected for follow-up. Null when\r\nFenergo.Nebula.Audit.Query.Application.Dto.Screening.ImpactedClientChangeDto.IsSelected is `true`.", "nullable": true, "example": "Client is out of jurisdiction" } }, "additionalProperties": false, "description": "Per-client snapshot of an OGS impacted-client decision in the audit panel. One entry per\r\nclient that was assessed in the source `BatchEntityUpdated` event." }, "JourneyAuditEventsDto": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Resource type discriminator (e.g. JourneyInstance, EntityDraft, JourneyData)", "nullable": true, "example": "JourneyInstance" }, "eventId": { "type": "string", "description": "Event id", "nullable": true, "example": "f9bb19a8-07e7-4306-94c9-a00988eadb0f" }, "eventName": { "type": "string", "description": "Event name", "nullable": true, "example": "Journey Instance Created" }, "taskName": { "type": "string", "description": "Task name", "nullable": true, "example": "Basic Details" }, "taskId": { "type": "string", "description": "Task id", "nullable": true, "example": "f9bb19a8-07e7-4306-94c9-a00988eadb0f" }, "stageName": { "type": "string", "description": "Stage name", "nullable": true, "example": "KYC" }, "stageId": { "type": "string", "description": "Stage id", "nullable": true, "example": "f9bb19a8-07e7-4306-94c9-a00988eadb0f" }, "lastUpdated": { "type": "string", "description": "Last updated date", "nullable": true, "example": "2012-04-23T18:25:43.511Z" }, "journeyId": { "type": "string", "description": "Journey id", "nullable": true, "example": "f9bb19a8-07e7-4306-94c9-a00988eadb0f" }, "fieldsHistory": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyAuditFieldHistoryDto" }, "description": "History of fields changes.", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing journey audit event dto" }, "JourneyAuditFieldHistoryDto": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Field name", "nullable": true, "example": "TeamId" }, "newValue": { "type": "string", "description": "New field value", "nullable": true, "example": "Halley" }, "oldValue": { "type": "string", "description": "Old field value", "nullable": true, "example": "Andromeda" }, "changedBy": { "type": "string", "description": "Changed by user", "nullable": true, "example": "John@example.com" }, "updatedOn": { "type": "string", "description": "Updated date", "nullable": true, "example": "2012-04-23T18:25:43.511Z" }, "fieldType": { "type": "string", "description": "Field type (Single, Collection, Custom)", "nullable": true, "example": "Single" }, "subFields": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyAuditSubFieldDto" }, "description": "Sub-fields for Collection/Custom types", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing history of fields changes" }, "JourneyAuditSubFieldDto": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Sub-field name", "nullable": true, "example": "Address Line 1" }, "newValue": { "type": "string", "description": "New value", "nullable": true }, "oldValue": { "type": "string", "description": "Old value", "nullable": true } }, "additionalProperties": false, "description": "Sub-field within a Collection or Custom property" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PagerDto": { "type": "object", "properties": { "size": { "minimum": 0, "exclusiveMinimum": true, "type": "integer", "format": "int32" }, "from": { "minimum": 0, "type": "integer", "format": "int32" }, "sortBy": { "type": "string", "nullable": true }, "sortOrder": { "allOf": [ { "$ref": "#/components/schemas/SortOrder" } ] } }, "additionalProperties": false }, "PaginationTokenPagerDto": { "type": "object", "properties": { "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Size of the page (result set)", "format": "int32", "example": 10 }, "sortOrder": { "allOf": [ { "$ref": "#/components/schemas/SortOrder" } ], "description": "Sort Order (Ascending or Descending)", "nullable": true, "example": "Descending" }, "paginationToken": { "type": "string", "description": "Position token for the search results to start\r\n(leave empty to start from the 1st item)", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "Options for setting up the results page" }, "ProductAuditSummaryDto": { "type": "object", "properties": { "productId": { "type": "string", "description": "The product ID.", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "productType": { "type": "string", "description": "The product type name.", "nullable": true, "example": "US Treasury Bonds" }, "lastUpdatedBy": { "type": "string", "description": "The user who last updated the product.", "nullable": true, "example": "john.doe@example.com" }, "lastUpdatedOn": { "type": "string", "description": "The date/time when the product was last updated.", "format": "date-time", "nullable": true, "example": "2025-01-15T10:30:00Z" } }, "additionalProperties": false, "description": "Lightweight summary of product audit data.\r\nContains only the data needed for the main product audit table." }, "QuerySideAuditEventDto": { "type": "object", "properties": { "eventId": { "type": "string", "description": "Unique identifier for this event", "nullable": true }, "resourceId": { "type": "string", "description": "Id used if this audit event is related to one specific resource", "nullable": true }, "resourceType": { "type": "string", "description": "Resource type if this audit event is related to one specific resource", "nullable": true }, "entityReferenceId": { "type": "string", "description": "Entity Id if this audit event is related to one Entity", "nullable": true }, "propertyName": { "type": "string", "description": "Pii Property Name that has been revealed", "nullable": true }, "journeyReferenceId": { "type": "string", "description": "Journey Id if this audit event is related to one Journey", "nullable": true }, "eventType": { "type": "string", "description": "Event Type", "nullable": true }, "version": { "type": "integer", "description": "Version of resource if versioning is being used", "format": "int64" }, "date": { "type": "string", "description": "Date when this event happened", "format": "date-time" }, "userId": { "type": "string", "description": "User id who performed this event", "nullable": true }, "userName": { "type": "string", "description": "User id who performed this event", "nullable": true }, "clientId": { "type": "string", "description": "Client id which identifies the source of this event", "nullable": true }, "service": { "type": "string", "description": "Service where this event was created", "nullable": true }, "correlationId": { "type": "string", "description": "Correlation Id", "nullable": true } }, "additionalProperties": false }, "ResourceQueryDto": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "The list of resource IDs for which to fetch Audit Events.", "nullable": true, "example": [ "7304b842-769f-4c22-9499-7c5d069ffb8f", "ad6cf1b0-0925-4d65-98e7-a4e7901cce46", "abb80516-3914-4366-a061-2f10e018fdeb" ] } }, "additionalProperties": false, "description": "The request object that contains a list of resource IDs for which to fetch Audit Events." }, "ResourceQueryPagedDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceQueryDto" }, { "type": "object", "properties": { "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "A pager object to specify pagination parameters", "nullable": true, "example": { "size": 10, "from": 0, "sortBy": "date", "sortOrder": "Descending" } }, "excludeEventTypes": { "type": "array", "items": { "type": "string" }, "description": "Optional list of event types to exclude from results.\r\nWhen provided, audit events whose `eventType` matches any value in this list are omitted.", "nullable": true } }, "additionalProperties": false } ], "description": "The request object that contains a list of resource IDs for which to fetch Audit Events. Includes a pager object." }, "ResourceQueryPagedDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ResourceQueryPagedDto" } ], "description": "The request object that contains a list of resource IDs for which to fetch Audit Events. Includes a pager object." } }, "additionalProperties": false }, "RevealAuditEventsForFieldQueryResultDto": { "allOf": [ { "$ref": "#/components/schemas/EntityEventDetailResultDto" }, { "type": "object", "additionalProperties": false } ] }, "ScreeningAuditEventsDto": { "type": "object", "properties": { "legalEntityName": { "type": "string", "description": "Name of screened legal entity", "nullable": true }, "eventType": { "type": "string", "description": "Type of an event", "nullable": true }, "lastUpdatedBy": { "type": "string", "description": "Last updated by username", "nullable": true, "example": "john.doye@example.com" }, "lastUpdated": { "type": "string", "description": "Last Updated date", "nullable": true }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/ScreeningAuditMatchDto" }, "description": "List of matches", "nullable": true }, "materialityChanges": { "type": "array", "items": { "$ref": "#/components/schemas/AuditFieldChangeDto" }, "description": "Field-level changes for an entity-level materiality assessment update. Populated when\r\nthe source audit event is a `BatchEntityUpdated` that mutated\r\n`EntityMaterialityAssessment`. Mutually exclusive with Fenergo.Nebula.Audit.Query.Application.Dto.ScreeningAuditEventsDto.Matches in\r\npractice — a single screening audit row represents either match-level changes or\r\nmateriality changes, not both.", "nullable": true }, "impactedClientsChanges": { "type": "array", "items": { "$ref": "#/components/schemas/ImpactedClientChangeDto" }, "description": "Per-client OGS follow-up decisions. Populated when the source audit event is a\r\n`BatchEntityUpdated` on an OGS batch that recorded impacted-client decisions.\r\nEach entry is a snapshot of the after-state for one client.", "nullable": true }, "documentChanges": { "type": "array", "items": { "$ref": "#/components/schemas/AuditFieldChangeDto" }, "description": "Field-level changes for entity document lifecycle events\r\n(`EntityDocumentAdded`, `EntityDocumentRemoved`, `EntityDocumentStatusUpdated`,\r\n`EntityDocumentArchived`, `EntityDocumentUnarchived`).\r\nNull / empty for all other event types.", "nullable": true }, "matchDocumentChanges": { "type": "array", "items": { "$ref": "#/components/schemas/AuditFieldChangeDto" }, "description": "Field-level changes for match document lifecycle events\r\n(`MatchDocumentAdded`, `MatchDocumentRemoved`, `MatchDocumentStatusUpdated`,\r\n`MatchDocumentArchived`, `MatchDocumentUnarchived`).\r\nNull / empty for all other event types.", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing screening audit events" }, "ScreeningAuditEventsRequestDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceQueryDto" }, { "type": "object", "properties": { "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "A pager object to specify pagination parameters", "nullable": true, "example": { "size": 10, "from": 0, "sortBy": "date", "sortOrder": "Descending" } }, "searchProperties": { "allOf": [ { "$ref": "#/components/schemas/SearchFieldsDto" } ], "description": "(Optional) Search object to filter returned fields", "nullable": true } }, "additionalProperties": false } ], "description": "The request object that contains a list of Journey IDs, and a pager object and other filters for which to fetch Screening related Audit Events" }, "ScreeningAuditEventsRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ScreeningAuditEventsRequestDto" } ], "description": "The request object that contains a list of Journey IDs, and a pager object and other filters for which to fetch Screening related Audit Events" } }, "additionalProperties": false }, "ScreeningAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ScreeningAuditEventsDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing get by resource ids results" }, "ScreeningAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ScreeningAuditEventsResultDto" } ], "description": "Response DTO representing get by resource ids results", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ScreeningAuditMatchDto": { "type": "object", "properties": { "matchId": { "type": "string", "description": "Match Id", "nullable": true }, "entityName": { "type": "string", "description": "Entity name", "nullable": true }, "provider": { "type": "string", "description": "Provider name", "nullable": true }, "entityType": { "type": "string", "description": "Entity type", "nullable": true }, "dateOfBirth": { "type": "string", "description": "Entity Date of Birth", "nullable": true }, "nationality": { "type": "string", "description": "Nationality", "nullable": true }, "alias": { "type": "string", "description": "Alias", "nullable": true }, "fieldsChanges": { "type": "array", "items": { "$ref": "#/components/schemas/AuditFieldChangeDto" }, "description": "List of field changes history", "nullable": true } }, "additionalProperties": false, "description": "DTO representing screening audit match" }, "SearchFieldsDto": { "required": [ "searchPhrase" ], "type": "object", "properties": { "searchPhrase": { "minLength": 1, "type": "string", "description": "Phrase with which you want to search", "example": "FirstName" }, "fieldName": { "type": "string", "description": "Field name by which you want to search. Search field must be one from AuditDetailedESModel", "nullable": true, "example": "fieldName" } }, "additionalProperties": false, "description": "Request object used for searching in fields" }, "SearchTermDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceQueryDto" }, { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "A search term that can be used to further filter your results. Can be any data found in your Audit Events, e.g. 'EntityCreated','Ireland' etc.", "nullable": true, "example": "EntityCreated" } }, "additionalProperties": false } ], "description": "A search request object comprising a list of resource IDs and a search term to retrieve results." }, "SearchTermPagedDto": { "allOf": [ { "$ref": "#/components/schemas/SearchTermDto" }, { "type": "object", "properties": { "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "A pager object to specify pagination parameters", "nullable": true, "example": { "size": 10, "from": 0, "sortBy": "date", "sortOrder": "Descending" } } }, "additionalProperties": false } ], "description": "A search request object comprising a list of resource IDs, a search term, and a pager object to retrieve results." }, "SearchTermPagedDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchTermPagedDto" } ], "description": "A search request object comprising a list of resource IDs, a search term, and a pager object to retrieve results." } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SortDto": { "required": [ "sortFieldName" ], "type": "object", "properties": { "sortFieldName": { "minLength": 1, "type": "string" }, "sortOrder": { "allOf": [ { "$ref": "#/components/schemas/SortOrder" } ] } }, "additionalProperties": false }, "SortOrder": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }