{ "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\nAdditionally, version 3 of the Audit Query API facilitates the extraction of access logs concerning both the access of entities and the access of sensitive data fields associated with those entities. This provides a comprehensive overview of the audit trails, ensuring transparency and traceability within the system.\n\n
Version 3(Preferable)\n\nVersion 3 of the Audit Query API is organized into seven distinct sections:\n\n", "version": "3.0" }, "servers": [ { "url": "/auditquery" } ], "paths": { "/api/v3/advanced-dashboard/configuration": { "post": { "tags": [ "AdvancedDashboard" ], "summary": "Retrieve advanced dashboard configuration audit events.", "description": "\n\r\n This method accepts an Advanced Dashboard configuration version ID and returns relevant Audit Events related to the configuration\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetAdvancedDashboardConfigurationAuditEvents", "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": "Advanced Dashboard Configuration Audit Event Summaries Request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetAdvancedDashboardAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of summarized audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdvancedDashboardAuditEventsResultDtoServiceResponse" } } } }, "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/v3/auditevent/association/{direction}/related-parties": { "post": { "tags": [ "AssociationAudit v3" ], "summary": "Retrieve related parties associated with a given entity, grouped by related party with association summaries.", "description": "\n\r\n This method accepts an entity ID and a direction (Inbound or Outbound) and returns a paginated list of related parties\r\n with their association audit event history.\r\n \r\n\n\r\n Each related party includes a list of associations, each with its audit events sorted by most recent first.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetAssociationRelatedParties", "parameters": [ { "name": "direction", "in": "path", "description": "The association direction — Inbound or Outbound.", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/AssociationDirection" } ] } }, { "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": "The request containing the entity ID and paging options.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRelatedPartiesRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of related party summaries is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRelatedPartiesResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/v3/auditevent/resources": { "post": { "tags": [ "AuditEvent v3" ], "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": "GetAuditEventsForMultipleResourcesV3", "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/v3/auditevent/searchterm": { "post": { "tags": [ "AuditEvent v3" ], "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": "SearchByTermV3", "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/v3/auditevent/groupedEntityEvents": { "post": { "tags": [ "AuditEvent v3" ], "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": "GetGroupedEntityAuditEventsV3", "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/v3/auditevent/entityeventdetails": { "post": { "tags": [ "AuditEvent v3" ], "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": "GetEntityAuditEventsByFieldNameV3", "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/v3/auditevent/screeningEvents": { "post": { "tags": [ "AuditEvent v3" ], "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": "GetScreeningAuditEventsV3", "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/v3/auditevent/journeyEvents": { "post": { "tags": [ "AuditEvent v3" ], "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": "GetJourneyAuditEventsV3", "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/v3/auditevent/financialAnalysisEvents": { "post": { "tags": [ "AuditEvent v3" ], "summary": "Get Financial Analysis audit events", "description": "\nReturns list of financial analysis audit events.

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetFinancialAnalysisAuditEventsV3", "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/v3/authorization/users": { "post": { "tags": [ "Authorization" ], "summary": "Retrieve users audit events.", "description": "\n\r\n This method accepts a list of User IDs and returns relevant Audit Events related to the user about teams and access layers\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetUsersAuditEvents", "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": "Users Audit Event Summaries Request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetUsersAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of summarized audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersAuditEventsResultDtoServiceResponse" } } } }, "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/v3/authorization/teams": { "post": { "tags": [ "Authorization" ], "summary": "Retrieve teams audit events.", "description": "\n\r\n This method accepts a list of team IDs and returns relevant Audit Events related to the team about users and permissions\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetTeamsAuditEvents", "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": "Teams Audit Event Summaries Request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetTeamsAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of summarized audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTeamsAuditEventsResultDtoServiceResponse" } } } }, "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/v3/entity/{entityId}/audit-event-summaries": { "post": { "tags": [ "Entity" ], "summary": "Retrieve entity-specific audit events grouped and summarized by the fields that have been updated.", "description": "\n\r\n This method requires the primary EntityId and optionally a list of EntityDraftIds, and it returns a list of Audit Events grouped and summarized by field name. \r\n \r\n\n\r\n Each record in the returned list contains the original and last updated values. \r\n \r\n\n\r\n Note: To retrieve a complete list of updated fields for a particular Entity, include all EntityDraftIds in the request.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetAuditEventSummariesByFieldName", "parameters": [ { "name": "entityId", "in": "path", "description": "The Unique ID of the Entity.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Entity Audit Event Summaries Request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetAuditEventSummariesByFieldNameRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of summarized audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAuditEventSummariesByFieldNameResultDtoServiceResponse" } } } }, "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/v3/entity/{entityId}/{fieldName}/audit-events": { "post": { "tags": [ "Entity" ], "summary": "Retrieve entity-specific audit events for a particular field.", "description": "\n\r\n This method requires the primary EntityId, FieldName, and optionally a list of EntityDraftIds, and it returns a list of Audit Events for the specified FieldName. \r\n \r\n\n\r\n To retrieve a complete list of Audit Event entries for the specified field, ensure that both the Entity ID and all related Entity Draft IDs are included in the request.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetAuditEventsForField", "parameters": [ { "name": "entityId", "in": "path", "description": "The Unique ID of the Entity.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldName", "in": "path", "description": "The name of the field for which to retrieve Entity Audit Events.", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Entity Audit Event Request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetAuditEventsForFieldRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of entity-specific audit events for the given field is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAuditEventsForFieldQueryResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/v3/entity/{entityId}/{fieldName}/audit-events/reveal": { "post": { "tags": [ "Entity" ], "summary": "Reveal entity-specific audit events for a particular field that is marked as Sensitive Data.", "description": "\n\r\n This method requires the primary EntityId, FieldName, and optionally a list of EntityDraftIds, and it returns a list of Audit Events for the specified FieldName. \r\n \r\n\n\r\n This method will authorize the request and if the correct permissions are in place, will reveal the values if the field is marked as Sensitive Data\r\n \r\n\n\r\n To retrieve a complete list of Audit Event entries for the specified field, ensure that both the Entity ID and all related Entity Draft IDs are included in the request.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "RevealAuditEventsForField", "parameters": [ { "name": "entityId", "in": "path", "description": "The Unique ID of the Entity.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldName", "in": "path", "description": "The name of the field for which to retrieve Entity Audit Events.", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Entity Audit Event Request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RevealAuditEventsForFieldRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of entity-specific audit events for the given field is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevealAuditEventsForFieldQueryResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "403": { "description": "Forbidden. User has no access to reveal property" }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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/v3/narrative/narrativeEvents": { "post": { "tags": [ "Narrative" ], "summary": "Get Narratives audit events", "description": "\nReturns list of narrative audit events.

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetNarrativeAuditEventsV3", "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/GetNarrativeAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNarrativeAuditEventsResultDtoServiceResponse" } } } }, "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/v3/sensitive-data-access-log/{entityId}/users": { "post": { "tags": [ "SensitiveDataAccessLog" ], "summary": "Retrieve sensitive data access log events for given Entity.", "description": "\n\r\n This method requires EntityId and it returns a list of sensitive data access log events for the specified Entity. \r\n \r\n\n\r\n This method also accepts an optional 'searchTerm' parameter, which can be used to further filter entries based on either a field name or a username.\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetPiiAccessLogBySearchTerm", "parameters": [ { "name": "entityId", "in": "path", "description": "The Unique ID of the Entity.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Sensitive Data access log request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPiiAccessLogBySearchTermRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of sensitive data access log events for the given entity is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPiiAccessLogResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "403": { "description": "Forbidden. User has no access to retrieve access log data" }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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/v3/sensitive-data-access-log/{userId}/entities": { "post": { "tags": [ "SensitiveDataAccessLog" ], "summary": "Retrieve sensitive data access log events for given user id.", "description": "\n\r\n This method requires UserId and it returns a list of sensitive data access log events for the specified user id. \r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetPiiAccessLogByUserId", "parameters": [ { "name": "userId", "in": "path", "description": "The Unique ID of the Entity.", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Sensitive Data access log request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPiiAccessLogByUserIdRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of sensitive data access log events for the given user id is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPiiAccessLogResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "403": { "description": "Forbidden. User has no access to retrieve access log data" }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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/v3/sensitive-data-access-log/entities": { "post": { "tags": [ "SensitiveDataAccessLog" ], "summary": "Retrieve sensitive data access log events for list of entities.", "description": "\n\r\n This method requires list of EntityIds and it returns a list of sensitive data access log events for the specified entities. \r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetPiiAccessLogByresourceIds", "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": "Sensitive Data access log request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPiiAccessLogByResourceIdsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of sensitive data access log events for the entities and optionally fields is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPiiAccessLogResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "403": { "description": "Forbidden. User has no access to retrieve access log data" }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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/v3/auditevent/queryside/entityEvents": { "post": { "tags": [ "EntityAccessLogs v3" ], "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": "GetEntityQuerySideAuditEventsV3", "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" } ] } } } } } } }, "/api/v3/review-manager/configuration": { "post": { "tags": [ "ReviewManager" ], "summary": "Retrieve review manager configuration audit events.", "description": "\n\r\n This method accepts an Review Manager configuration version ID and returns relevant Audit Events related to the configuration\r\n

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetReviewManagerConfigurationAuditEvents", "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": "Review Manager Configuration Audit Event Summaries Request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetReviewManagerAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of summarized audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetReviewManagerAuditEventsResultDtoServiceResponse" } } } }, "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/v3/self-service-management/selfServiceUserManagementEvents": { "post": { "tags": [ "SelfServiceUserManagement" ], "summary": "Get self service user management audit events", "description": "\nReturns list of self service user management audit events.

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetSelfServiceUserManagementEventsV3", "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/GetSelfServiceUserManagementAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSelfServiceUserManagementAuditEventsResultDtoServiceResponse" } } } }, "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/v3/self-service-management/selfServiceClientSecretManagementEvents": { "post": { "tags": [ "SelfServiceClientManagement" ], "summary": "Get self service client secret management audit events", "description": "\nReturns list of self service client secret management audit events.

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetSelfServiceClientSecretManagementEventsV3", "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/GetSelfServiceClientSecretManagementAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSelfServiceClientSecretManagementAuditEventsResultDtoServiceResponse" } } } }, "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/v3/self-service-management/selfServiceClientManagementEvents": { "post": { "tags": [ "SelfServiceClientManagement" ], "summary": "Get self service client management audit events", "description": "\nReturns list of self service client management audit events.

Required permissions:
Following permissions are required: AuditAccessAndSearch", "operationId": "GetSelfServiceClientManagementEventsV3", "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/GetSelfServiceClientManagementAuditEventsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of audit events is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSelfServiceClientManagementAuditEventsResultDtoServiceResponse" } } } }, "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": { "AdvancedDashboardAuditResultDto": { "type": "object", "properties": { "configurationVersionId": { "type": "string", "description": "User id for which the change took place.", "nullable": true }, "changedBy": { "type": "string", "description": "User id who made the change.", "nullable": true }, "updatedOn": { "type": "string", "description": "Date when this event happened.", "format": "date-time" }, "eventName": { "type": "string", "description": "Event name that was performed (e.g. Dashboard Configuration Version Created).", "nullable": true }, "policyFieldUpdates": { "allOf": [ { "$ref": "#/components/schemas/PolicyFieldUpdatesDto" } ], "description": "Policy field updates including added and removed fields.", "nullable": true }, "viewUpdates": { "allOf": [ { "$ref": "#/components/schemas/ViewUpdatesDto" } ], "description": "View updates including added and removed fields.", "nullable": true } }, "additionalProperties": false }, "AdvancedDashboardFiltersDto": { "type": "object", "properties": { "eventType": { "enum": [ "DashboardConfigurationVersionCreated", "DashboardConfigurationVersionUpdated", "DashboardConfigurationVersionPolicyFieldsUpdated", "DashboardConfigurationVersionViewAdded", "DashboardConfigurationVersionViewUpdated", "DashboardConfigurationVersionViewDeleted", "DashboardConfigurationVersionSubmitted", "DashboardConfigurationVersionPublished", "DashboardConfigurationVersionFailed", "DashboardConfigurationVersionDeleted" ], "type": "string", "description": "EventType for the configuration version associated with the event", "nullable": true, "example": "DashboardConfigurationVersionPublished" }, "from": { "type": "string", "description": "Date from", "format": "date-time", "nullable": true, "example": "2022-08-10" }, "to": { "type": "string", "description": "Date to (must be greater than from date)", "format": "date-time", "nullable": true, "example": "2022-08-11" } }, "additionalProperties": false }, "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 }, "AssociationDirection": { "enum": [ "Inbound", "Outbound" ], "type": "string" }, "AssociationSummaryDto": { "type": "object", "properties": { "associationId": { "type": "string", "nullable": true }, "relationshipType": { "type": "string", "nullable": true }, "eventCount": { "type": "integer", "format": "int32" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true }, "isSoftDeleted": { "type": "boolean" } }, "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" }, "AuditEventsRequestBase": { "type": "object", "properties": { "entityDraftIds": { "type": "array", "items": { "type": "string" }, "description": "The list of EntityDraftIds you want to include as part of the query", "nullable": true }, "excludeDrafts": { "type": "boolean", "description": "Exclude draft values from search results" }, "excludeSystemFields": { "type": "boolean", "description": "Exclude system fields from search results" }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "Pager details", "nullable": true, "example": { "from": 0, "size": 10, "sortOrder": "Descending" } }, "journeyReferenceId": { "type": "string", "description": "Optional journey reference ID to scope entity-level events to the current journey.", "nullable": true }, "excludeEventTypes": { "type": "array", "items": { "type": "string" }, "description": "Optional list of event types to exclude from the results.", "nullable": true } }, "additionalProperties": false, "description": "The request object that contains the primary EntityId and, optionally, a list of EntityDraftIds for which to fetch entity specific audit events." }, "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 } ] }, "GetAdvancedDashboardAuditEventsRequestDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The configuration version id that you want to include as part of the query", "nullable": true }, "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" } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/AdvancedDashboardFiltersDto" } ], "description": "Request DTO to specify optional query filters\n", "nullable": true } }, "additionalProperties": false }, "GetAdvancedDashboardAuditEventsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetAdvancedDashboardAuditEventsRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetAdvancedDashboardAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedDashboardAuditResultDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false }, "GetAdvancedDashboardAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetAdvancedDashboardAuditEventsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetAuditEventSummariesByFieldNameRequestDto": { "allOf": [ { "$ref": "#/components/schemas/AuditEventsRequestBase" }, { "type": "object", "properties": { "searchPhrase": { "type": "string", "description": "An optional search phrase with which you can filter the results", "nullable": true, "example": "John" } }, "additionalProperties": false } ] }, "GetAuditEventSummariesByFieldNameRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetAuditEventSummariesByFieldNameRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetAuditEventSummariesByFieldNameResultDto": { "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 }, "GetAuditEventSummariesByFieldNameResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetAuditEventSummariesByFieldNameResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetAuditEventsForFieldQueryResultDto": { "allOf": [ { "$ref": "#/components/schemas/EntityEventDetailResultDto" }, { "type": "object", "additionalProperties": false } ] }, "GetAuditEventsForFieldQueryResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetAuditEventsForFieldQueryResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetAuditEventsForFieldRequestDto": { "allOf": [ { "$ref": "#/components/schemas/AuditEventsRequestBase" }, { "type": "object", "additionalProperties": false } ] }, "GetAuditEventsForFieldRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetAuditEventsForFieldRequestDto" } ], "nullable": true } }, "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 }, "GetJourneyDataAuditEventSummariesByFieldNameRequestDto": { "type": "object", "properties": { "journeyId": { "type": "string", "description": "The unique ID of the journey instance.", "nullable": true, "example": "ef3a5a85-c45b-4bef-96c4-17f166917d7a" }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "Required pagination for the field-summary list.\r\n`from` must be ≥ 0; `size` must be between 1 and 100; `sortOrder` is required.", "nullable": true, "example": { "from": 0, "size": 25, "sortOrder": "Descending" } }, "searchPhrase": { "type": "string", "description": "Optional phrase to filter matching Journey Level Data field names (e.g. `qcStatus`).", "nullable": true, "example": "qcStatus" }, "excludeSystemFields": { "type": "boolean", "description": "When `true`, hide rows where the last updater was `system`.\r\nDefaults to `false` (include full history).", "example": false } }, "additionalProperties": false, "description": "Request body for Journey Level Data field summaries.\r\nPut this object under the standard Nebula envelope: `{ \"data\": { ... } }`." }, "GetJourneyDataAuditEventSummariesByFieldNameRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetJourneyDataAuditEventSummariesByFieldNameRequestDto" } ], "description": "Request body for Journey Level Data field summaries.\r\nPut this object under the standard Nebula envelope: `{ \"data\": { ... } }`." } }, "additionalProperties": false }, "GetJourneyDataAuditEventSummariesByFieldNameResultDto": { "allOf": [ { "$ref": "#/components/schemas/GetAuditEventSummariesByFieldNameResultDto" }, { "type": "object", "additionalProperties": false } ], "description": "Journey Level Data field summaries for an entity and journey." }, "GetJourneyDataAuditEventSummariesByFieldNameResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetJourneyDataAuditEventSummariesByFieldNameResultDto" } ], "description": "Journey Level Data field summaries for an entity and journey.", "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." }, "GetJourneyDataAuditEventsForFieldQueryResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetJourneyDataAuditEventsForFieldQueryResultDto" } ], "description": "Journey Level Data change history for a single field on an entity and journey.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetJourneyDataAuditEventsForFieldRequestDto": { "type": "object", "properties": { "journeyId": { "type": "string", "description": "The unique ID of the journey instance.", "nullable": true, "example": "ef3a5a85-c45b-4bef-96c4-17f166917d7a" }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "Required pagination for the field history list.\r\n`from` must be ≥ 0; `size` must be between 1 and 100; `sortOrder` is required.", "nullable": true, "example": { "from": 0, "size": 25, "sortOrder": "Descending" } }, "excludeSystemFields": { "type": "boolean", "description": "When `true`, hide rows where the last updater was `system`.\r\nDefaults to `false` (include full history).", "example": false } }, "additionalProperties": false, "description": "Request body for Journey Level Data history for a single field.\r\nPut this object under the standard Nebula envelope: `{ \"data\": { ... } }`.\r\nThe field name itself comes from the route (`{fieldName}`), not this body." }, "GetJourneyDataAuditEventsForFieldRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetJourneyDataAuditEventsForFieldRequestDto" } ], "description": "Request body for Journey Level Data history for a single field.\r\nPut this object under the standard Nebula envelope: `{ \"data\": { ... } }`.\r\nThe field name itself comes from the route (`{fieldName}`), not this body." } }, "additionalProperties": false }, "GetNarrativeAuditEventsRequestDto": { "allOf": [ { "$ref": "#/components/schemas/SearchTermPagedDto" }, { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } ] }, "GetNarrativeAuditEventsRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetNarrativeAuditEventsRequestDto" } ] } }, "additionalProperties": false }, "GetNarrativeAuditEventsResultDto": { "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 }, "GetNarrativeAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetNarrativeAuditEventsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetPiiAccessLogBaseRequestDto": { "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 }, "GetPiiAccessLogByResourceIdsRequestDto": { "allOf": [ { "$ref": "#/components/schemas/GetPiiAccessLogBaseRequestDto" }, { "type": "object", "properties": { "entityIds": { "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" ] }, "fieldNames": { "type": "array", "items": { "type": "string" }, "description": "Optional list of field names for which to fetch Audit Events.", "nullable": true, "example": [ "passport", "dateOfBirth" ] } }, "additionalProperties": false } ] }, "GetPiiAccessLogByResourceIdsRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPiiAccessLogByResourceIdsRequestDto" } ] } }, "additionalProperties": false }, "GetPiiAccessLogBySearchTermRequestDto": { "allOf": [ { "$ref": "#/components/schemas/GetPiiAccessLogBaseRequestDto" }, { "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 Pii Audit Events, e.g. 'Username','Fieldname' etc.", "nullable": true, "example": "passport" } }, "additionalProperties": false } ] }, "GetPiiAccessLogBySearchTermRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPiiAccessLogBySearchTermRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetPiiAccessLogByUserIdRequestDto": { "allOf": [ { "$ref": "#/components/schemas/GetPiiAccessLogBaseRequestDto" }, { "type": "object", "additionalProperties": false } ] }, "GetPiiAccessLogByUserIdRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPiiAccessLogByUserIdRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetPiiAccessLogResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/QuerySideAuditEventDto" }, "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" }, "GetPiiAccessLogResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPiiAccessLogResultDto" } ], "description": "Response DTO representing get by resource ids results", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetRelatedPartiesRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "nullable": true }, "relatedPartyIds": { "maxItems": 500, "type": "array", "items": { "type": "string" }, "nullable": true }, "searchTerm": { "maxLength": 200, "type": "string", "nullable": true }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "nullable": true } }, "additionalProperties": false }, "GetRelatedPartiesRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRelatedPartiesRequestDto" } ] } }, "additionalProperties": false }, "GetRelatedPartiesResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartySummaryDto" }, "nullable": true }, "totalItems": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "GetRelatedPartiesResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRelatedPartiesResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetReviewManagerAuditEventsRequestDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The configuration version id that you want to include as part of the query", "nullable": true }, "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" } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/ReviewManagerFiltersDto" } ], "description": "Request DTO to specify optional query filters\n", "nullable": true } }, "additionalProperties": false }, "GetReviewManagerAuditEventsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetReviewManagerAuditEventsRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetReviewManagerAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewManagerAuditResultDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false }, "GetReviewManagerAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetReviewManagerAuditEventsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetSelfServiceClientManagementAuditEventsRequestDto": { "required": [ "pager" ], "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "eventTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "A pager object to specify pagination parameters", "example": { "size": 10, "from": 0, "sortBy": "date", "sortOrder": "Descending" } } }, "additionalProperties": false }, "GetSelfServiceClientManagementAuditEventsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetSelfServiceClientManagementAuditEventsRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetSelfServiceClientManagementAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SelfServiceClientManagementAuditEventsDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false }, "GetSelfServiceClientManagementAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetSelfServiceClientManagementAuditEventsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetSelfServiceClientSecretManagementAuditEventsRequestDto": { "required": [ "clientId", "pager" ], "type": "object", "properties": { "clientId": { "minLength": 1, "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "A pager object to specify pagination parameters", "example": { "size": 10, "from": 0, "sortBy": "date", "sortOrder": "Descending" } } }, "additionalProperties": false }, "GetSelfServiceClientSecretManagementAuditEventsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetSelfServiceClientSecretManagementAuditEventsRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetSelfServiceClientSecretManagementAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SelfServiceClientSecretManagementAuditEventsDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false }, "GetSelfServiceClientSecretManagementAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetSelfServiceClientSecretManagementAuditEventsResultDto" } ], "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 } ] }, "GetSelfServiceUserManagementAuditEventsRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetSelfServiceUserManagementAuditEventsRequestDto" } ] } }, "additionalProperties": false }, "GetSelfServiceUserManagementAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SelfServiceUserManagementAuditEventsDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false }, "GetSelfServiceUserManagementAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetSelfServiceUserManagementAuditEventsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetTeamsAuditEventsRequestDto": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "The list of TeamsIds you want to include as part of the query", "nullable": true, "example": [ "7304b842-769f-4c22-9499-7c5d069ffb8f", "ad6cf1b0-0925-4d65-98e7-a4e7901cce46", "abb80516-3914-4366-a061-2f10e018fdeb" ] }, "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" } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/TeamFiltersDto" } ], "description": "Request DTO to specify optional query filters\n", "nullable": true } }, "additionalProperties": false }, "GetTeamsAuditEventsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetTeamsAuditEventsRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetTeamsAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TeamsAuditResultDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false }, "GetTeamsAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetTeamsAuditEventsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetUsersAuditEventsRequestDto": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "The list of UserIds you want to include as part of the query", "nullable": true, "example": [ "7304b842-769f-4c22-9499-7c5d069ffb8f", "ad6cf1b0-0925-4d65-98e7-a4e7901cce46", "abb80516-3914-4366-a061-2f10e018fdeb" ] }, "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" } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/UserFiltersDto" } ], "description": "Request DTO to specify optional query filters\n", "nullable": true } }, "additionalProperties": false }, "GetUsersAuditEventsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetUsersAuditEventsRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetUsersAuditEventsResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UsersAuditResultDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false }, "GetUsersAuditEventsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetUsersAuditEventsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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." }, "ItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Team or Access Layer identifier.", "nullable": true } }, "additionalProperties": false }, "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" }, "PolicyFieldUpdatesDto": { "type": "object", "properties": { "policyFieldsAdded": { "type": "array", "items": { "type": "string" }, "description": "Array of policy field items added to the index.", "nullable": true }, "policyFieldsRemoved": { "type": "array", "items": { "type": "string" }, "description": "Array of policy field items removed from the index.", "nullable": true } }, "additionalProperties": false }, "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 }, "RelatedPartySummaryDto": { "type": "object", "properties": { "relatedPartyEntityId": { "type": "string", "nullable": true }, "associationCount": { "type": "integer", "format": "int32" }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true }, "allAssociationsDeleted": { "type": "boolean" }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationSummaryDto" }, "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 } ] }, "RevealAuditEventsForFieldQueryResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RevealAuditEventsForFieldQueryResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RevealAuditEventsForFieldRequestDto": { "allOf": [ { "$ref": "#/components/schemas/AuditEventsRequestBase" }, { "type": "object", "additionalProperties": false } ] }, "RevealAuditEventsForFieldRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RevealAuditEventsForFieldRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "ReviewManagerAuditResultDto": { "type": "object", "properties": { "configurationVersionId": { "type": "string", "description": "User id for which the change took place.", "nullable": true }, "changedBy": { "type": "string", "description": "User id who made the change.", "nullable": true }, "updatedOn": { "type": "string", "description": "Date when this event happened.", "format": "date-time" }, "eventName": { "type": "string", "description": "Event name that was performed (e.g. Configuration Version Created).", "nullable": true }, "policyFieldUpdates": { "allOf": [ { "$ref": "#/components/schemas/ReviewManagerPolicyFieldUpdatesDto" } ], "description": "Policy field updates including added and removed fields.", "nullable": true }, "viewUpdates": { "allOf": [ { "$ref": "#/components/schemas/ReviewManagerViewUpdatesDto" } ], "description": "View updates including added and removed fields.", "nullable": true } }, "additionalProperties": false }, "ReviewManagerFiltersDto": { "type": "object", "properties": { "eventType": { "enum": [ "ReviewManagerConfigurationCreated", "ReviewManagerConfigurationUpdated", "ReviewManagerConfigurationPublished", "ReviewManagerConfigurationDeleted" ], "type": "string", "description": "EventType for the configuration version associated with the event", "nullable": true, "example": "ReviewManagerConfigurationPublished" }, "from": { "type": "string", "description": "Date from", "format": "date-time", "nullable": true, "example": "2022-08-10" }, "to": { "type": "string", "description": "Date to (must be greater than from date)", "format": "date-time", "nullable": true, "example": "2022-08-11" } }, "additionalProperties": false }, "ReviewManagerPolicyFieldUpdatesDto": { "type": "object", "properties": { "policyFieldsAdded": { "type": "array", "items": { "type": "string" }, "description": "Array of policy field items added to the index.", "nullable": true }, "policyFieldsRemoved": { "type": "array", "items": { "type": "string" }, "description": "Array of policy field items removed from the index.", "nullable": true } }, "additionalProperties": false }, "ReviewManagerViewUpdatesDto": { "type": "object", "properties": { "viewFieldsAdded": { "type": "array", "items": { "type": "string" }, "description": "Array of view field items added to the index.", "nullable": true }, "viewFieldsRemoved": { "type": "array", "items": { "type": "string" }, "description": "Array of view field items removed from the index.", "nullable": true } }, "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 }, "SelfServiceClientManagementAuditEventsDto": { "type": "object", "properties": { "eventType": { "type": "string", "description": "Type of event", "nullable": true }, "changedBy": { "type": "string", "description": "Last updated by", "nullable": true }, "updatedOn": { "type": "string", "description": "Last Updated date", "nullable": true }, "itemChanges": { "type": "array", "items": { "$ref": "#/components/schemas/AuditFieldChangeDto" }, "description": "Summary of before and after values for fields", "nullable": true } }, "additionalProperties": false }, "SelfServiceClientSecretManagementAuditEventsDto": { "type": "object", "properties": { "eventType": { "type": "string", "description": "Type of event", "nullable": true }, "changedBy": { "type": "string", "description": "Last updated by", "nullable": true }, "updatedOn": { "type": "string", "description": "Last Updated date", "nullable": true }, "itemChanges": { "type": "array", "items": { "$ref": "#/components/schemas/AuditFieldChangeDto" }, "description": "Summary of before and after values for fields", "nullable": true } }, "additionalProperties": false }, "SelfServiceUserManagementAuditEventsDto": { "type": "object", "properties": { "userId": { "type": "string", "description": "User id", "nullable": true, "example": "f9bb19a8-07e7-4306-94c9-a00988eadb0f" }, "userEmail": { "type": "string", "description": "Email of the User", "nullable": true }, "eventType": { "type": "string", "description": "Type of event", "nullable": true }, "changedBy": { "type": "string", "description": "Last updated by", "nullable": true }, "updatedOn": { "type": "string", "description": "Last Updated date", "nullable": true }, "itemChanges": { "type": "array", "items": { "$ref": "#/components/schemas/AuditFieldChangeDto" }, "description": "Summary of before and after values for fields", "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "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 }, "TeamFiltersDto": { "type": "object", "properties": { "eventType": { "enum": [ "TeamCreated", "TeamUpdated", "TeamDeleted", "UserAdded", "UserRemoved" ], "type": "string", "description": "EventType for the team associated with the event", "nullable": true, "example": "TeamUpdated" }, "from": { "type": "string", "description": "Date from", "format": "date-time", "nullable": true, "example": "2022-08-10" }, "to": { "type": "string", "description": "Date to (must be greater than from date)", "format": "date-time", "nullable": true, "example": "2022-08-11" } }, "additionalProperties": false }, "TeamsAuditResultDto": { "type": "object", "properties": { "teamId": { "type": "string", "description": "User id for which the change took place.", "nullable": true }, "changedBy": { "type": "string", "description": "User id who made the change.", "nullable": true }, "updatedOn": { "type": "string", "description": "Date when this event happened.", "format": "date-time" }, "eventName": { "type": "string", "description": "Event name that was performed (e.g., Team Created, Team Updated).", "nullable": true }, "permissionsAdded": { "type": "array", "items": { "type": "string" }, "description": "Array of items added to permissions.", "nullable": true }, "permissionsRemoved": { "type": "array", "items": { "type": "string" }, "description": "Array of items removed from permissions.", "nullable": true }, "usersAdded": { "type": "array", "items": { "$ref": "#/components/schemas/UserItemDto" }, "description": "Array of items added to users.", "nullable": true }, "usersRemoved": { "type": "array", "items": { "$ref": "#/components/schemas/UserItemDto" }, "description": "Array of items removed from users.", "nullable": true }, "fieldsHistory": { "type": "array", "items": { "$ref": "#/components/schemas/AuditFieldChangeDto" }, "description": "Entity Before and After values for fields", "nullable": true } }, "additionalProperties": false }, "UserFiltersDto": { "type": "object", "properties": { "eventType": { "enum": [ "UserAdded", "UserRemoved", "UserUnassignedFromAccessLayer", "UserAssignedToAccessLayer" ], "type": "string", "description": "EventType for the user associated with the event", "nullable": true, "example": "UserAdded" }, "from": { "type": "string", "description": "Date from", "format": "date-time", "nullable": true, "example": "2022-08-10" }, "to": { "type": "string", "description": "Date to (must be greater than from date)", "format": "date-time", "nullable": true, "example": "2022-08-11" } }, "additionalProperties": false }, "UserItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "User identifier.", "nullable": true, "example": "ddad1d17-3788-4efc-aaa7-da15e2cb1367" }, "userName": { "type": "string", "description": "User name", "nullable": true, "example": "John Doe" } }, "additionalProperties": false }, "UsersAuditResultDto": { "type": "object", "properties": { "userId": { "type": "string", "description": "User id for which the change took place.", "nullable": true }, "changedBy": { "type": "string", "description": "User id who made the change.", "nullable": true }, "updatedOn": { "type": "string", "description": "Date when this event happened.", "format": "date-time" }, "eventName": { "type": "string", "description": "Event name that was performed (e.g., Team Added, Team Removed).", "nullable": true }, "accessLayersAdded": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDto" }, "description": "Array of items added to access layers.", "nullable": true }, "accessLayersRemoved": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDto" }, "description": "Array of items removed from access layers.", "nullable": true }, "teamsAdded": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDto" }, "description": "Array of teams added.", "nullable": true }, "teamsRemoved": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDto" }, "description": "Array of teams removed.", "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" } ] } }, "ViewUpdatesDto": { "type": "object", "properties": { "viewName": { "type": "string", "description": "Name of the view.", "nullable": true }, "viewFieldsAdded": { "type": "array", "items": { "type": "string" }, "description": "Array of view field items added to the index.", "nullable": true }, "viewFieldsRemoved": { "type": "array", "items": { "type": "string" }, "description": "Array of view field items removed from the index.", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }