{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula EntityData Query", "description": "Entity Data Query API is part of FenX eco-system to manage Entity Data. All of the operations require valid access token obtained from Identity service.", "version": "1.0" }, "servers": [ { "url": "/entitydataquery" } ], "paths": { "/api/entity/getentitieslist": { "post": { "tags": [ "Entity" ], "summary": "Get entities by attributes", "description": "\nReturns the list of entities with only the data specified in the attributes.

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetEntitiesList", "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": "Query entities request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityQueryDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. The list of entities is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDtoListServiceResponse" } } } }, "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/entity/getentitiespagedlist": { "post": { "tags": [ "Entity" ], "summary": "Get paged list of entities", "description": "\nReturns paged list of entities, these are sorted based on the pagerDto

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetEntitiesPagedList", "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": "Query entities request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityQueryPagedDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. The list of entities is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchEntityDtoListServiceResponse" } } } }, "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/entity/{id}": { "get": { "tags": [ "Entity" ], "summary": "Get entity by id", "description": "\nReturns entity for given id.

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetEntityById", "parameters": [ { "name": "id", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. An instance of entity is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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/entity/searchforduplicates": { "post": { "tags": [ "Entity" ], "summary": "Search for entity duplicates", "description": "\nReturns possible duplicated entities for given search criteria.

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "SearchForDuplicates", "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 for duplicates request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchForDuplicatesDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. The list of entities is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchEntityDtoListServiceResponse" } } } }, "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/entity/entityadvancedsearch": { "post": { "tags": [ "Entity" ], "summary": "Advanced search for entities", "description": "\nReturns entities for given search criteria.

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "EntityAdvancedSearch", "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 for entities request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityAdvancedSearchDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. The list of entities is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchResultDtoServiceResponse" } } } }, "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/entity/entityadvancedsearch/file": { "post": { "tags": [ "Entity" ], "summary": "Entity advanced search results file", "description": "\nReturns entities for given search criteria as a link to file.

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "EntityAdvancedSearchFile", "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 for entities file request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityAdvancedSearchFileDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. Response represents file search result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchFileResultDtoServiceResponse" } } } }, "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/entity/multisearchforduplicates": { "post": { "tags": [ "Entity" ], "summary": "Multi-search for entity duplicates", "description": "\nReturns set of possible duplicated entities for each search criteria specify in the request.

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "MultiSearchForDuplicates", "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": "Multi-search for duplicates request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MultiSearchForDuplicatesDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. Set of possible duplicated entities returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringSearchEntityDtoListDictionaryServiceResponse" } } } }, "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/entity/searchbyname": { "post": { "tags": [ "Entity" ], "summary": "Search entities by name", "description": "\nReturns list of possible duplicated entities by provided name.

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "SearchByName", "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 entities by name request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntitySearchByNameDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. The list of entities is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchEntityDtoListServiceResponse" } } } }, "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/entity/journey/{journeyId}/task/{taskId}": { "get": { "tags": [ "Entity" ], "summary": "Get entities snapshot by Journey Id and Task Id", "description": "\nReturns a list of entities for a given Journey Id and Task Id.

Required permissions:
Following permissions are required: EntityDataAccessAndSearch", "operationId": "GetEntitiesSnapshotByTaskId", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey Id id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of entities is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySnapshotDtoIEnumerableServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entities snapshot with given Journey Id and Task Id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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/entity/{entityId}/journey/{journeyId}/task/{taskId}": { "get": { "tags": [ "Entity" ], "summary": "Get entity snapshot by Journey Id, Task Id and Entity Id", "description": "\nReturns a list of entities for a given Journey Id and Task Id.

Required permissions:
Following permissions are required: EntityDataAccessAndSearch", "operationId": "GetEntitySnapshotByIdAndTaskId", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entityId", "in": "path", "description": "Entity Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of entities is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySnapshotDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entities snapshot with given Journey Id and Task Id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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/entity/{entityId}/version/{entityVersion}": { "get": { "tags": [ "Entity" ], "summary": "Get entity in specified version", "description": "\nGets the entity for the requested version

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetEntityVersion", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entityVersion", "in": "path", "description": "Version", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "202": { "description": "Success. Entity version retrieved" }, "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/entity/{entityId}/property/{propertyName}": { "get": { "tags": [ "Entity" ], "summary": "Get revealed PII property value from Entity", "description": "\nReturns unmasked value of requested property name

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetEntityPIIPropertyValue", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "propertyName", "in": "path", "description": "Property Name", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Instance of property is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyDtoServiceResponse" } } } }, "403": { "description": "Forbidden. User has no access to reveal property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity or PropertyName with given id/name does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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" } } } }, "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/entity/{entityId}/pre-sign-urls": { "post": { "tags": [ "Entity" ], "summary": "Get pre-sign URLs for a file identifiers\nThis endpoint is intended for use with the new DataField type - RichTextEditor.", "description": "\nReturns URLs for each file identifier

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetPreSignUrlForFileIdentifiers", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "File identifiers request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPreSignUrlsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. Instance of property is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPreSignUrlsResponseDtoServiceResponse" } } } }, "403": { "description": "Forbidden. User has no access to reveal property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity or PropertyName with given id/name does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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" } } } }, "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/entity/report-pre-sign-url": { "post": { "tags": [ "Entity" ], "summary": "Get pre-sign URL for specified report type", "description": "\nReturns URL with report file

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetReportPreSignUrl", "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": "Get report request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetReportPreSignUrlRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. Instance of property is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetReportPreSignUrlResponseDtoServiceResponse" } } } }, "403": { "description": "Forbidden. User has no access to reveal property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity or PropertyName with given id/name does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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" } } } }, "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/entity/{entityId}/draft": { "get": { "tags": [ "EntityDraft" ], "summary": "Get entity drafts", "description": "\nReturns list of entity drafts for an existing entity.

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetEntityDrafts", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of entity drafts is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDraftDtoIEnumerableServiceResponse" } } } }, "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" } ] } } } } }, "deprecated": true } }, "/api/entity/{entityId}/draft/{id}": { "get": { "tags": [ "EntityDraft" ], "summary": "Get entity draft by id", "description": "\nReturns entity draft for a given entity id and draft id.

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetEntityDraftById", "parameters": [ { "name": "id", "in": "path", "description": "Entity draft id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Entity draft is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDraftDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity/entity draft with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/entity/proposedchanges/draft/{entityDraftId}": { "get": { "tags": [ "EntityDraft" ], "summary": "Get proposed changes between an entity draft and the verified entity the draft was created from", "description": "\nReturn proposed changes between entity draft and entity

Required permissions:
Following permissions are required: ProposedChangesAccess", "operationId": "GetEntityDraftProposedChanges", "parameters": [ { "name": "entityDraftId", "in": "path", "description": "Entity Draft Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataChangesDtoListServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity draft with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "202": { "description": "Success. Entity proposed changes retrieved" }, "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/entity/{entityId}/draft/{entityDraftId}/property/{propertyName}": { "get": { "tags": [ "EntityDraft" ], "summary": "Get revealed PII property value from EntityDraft", "description": "\nReturns unmasked value of requested property name

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetDraftPIIPropertyValue", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entityDraftId", "in": "path", "description": "Entity draft id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "propertyName", "in": "path", "description": "Property Name", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Instance of property is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyDtoServiceResponse" } } } }, "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", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity Draft or PropertyName with given id/name does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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/entity/{draftId}/parent-jurisdictions-snapshot": { "get": { "tags": [ "EntityDraft" ], "summary": "Get entity draft previous parent jurisdictions, it is meant to be used only for task \"ParentDataSyncTask\"", "description": "\nReturns entity draft previous parent jurisdictions

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "GetParentJurisdictionsSnapshot", "parameters": [ { "name": "draftId", "in": "path", "description": "Entity draft id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Entity draft previous parent jurisdictions is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetParentJurisdictionsSnapshotDtoServiceResponse" } } } }, "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/drafts-in-scope/searchentitydrafts": { "post": { "tags": [ "EntityDraftsInScope" ], "summary": "Search entity drafts", "description": "\nReturns list of entity draft for a given search criteria.

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch", "operationId": "SearchEntityDrafts", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Request with search criteria", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityDraftsDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. The list of entity draft is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDraftDtoIEnumerableServiceResponse" } } } }, "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/entity-index-configuration": { "get": { "tags": [ "EntityIndexConfiguration" ], "summary": "Get indexed entity properties", "description": "\nReturns list of all indexed entity properties.

Required permissions:
Following permissions are required: EntityDataAccessAndSearch", "operationId": "GetIndexedEntityProperties", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of indexed entity properties is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityIndexConfigurationDtoIEnumerableServiceResponse" } } } }, "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/match-and-merge-configuration/{entityType}": { "get": { "tags": [ "MatchAndMergeConfiguration" ], "summary": "Get Match and Merge configuration", "description": "\nReturns the current Match and Merge field configuration for the given entity type.\n\nReturns an empty configuration (no fields, version 0) if none has been saved yet.

Required permissions:
Following permissions are required: EntityDataAccessAndSearch", "operationId": "GetMatchAndMergeConfiguration", "parameters": [ { "name": "entityType", "in": "path", "description": "The entity type (e.g. Individual, Company)", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The configuration is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchAndMergeConfigurationDtoServiceResponse" } } } }, "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": { "AccessLayerDetailsDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Access layer data key", "nullable": true, "example": "Global" }, "inheritedFrom": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of entity ids that access layer is inherited from", "nullable": true }, "isInherited": { "type": "boolean", "description": "Flag indicating if access layer is inherited by default" } }, "additionalProperties": false }, "AccessLayerDto": { "type": "object", "properties": { "geographic": { "type": "array", "items": { "type": "string" }, "description": "Collection of geographic access layers", "nullable": true }, "businessRelated": { "type": "array", "items": { "type": "string" }, "description": "Collection of business related access layers", "nullable": true }, "geographicDetails": { "type": "array", "items": { "$ref": "#/components/schemas/AccessLayerDetailsDto" }, "description": "Collection of geographic access layers with details about inheritance", "nullable": true }, "businessRelatedDetails": { "type": "array", "items": { "$ref": "#/components/schemas/AccessLayerDetailsDto" }, "description": "Collection of business related access layers with details about inheritance", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing associated access layers" }, "AdvancedSearchFileResultDto": { "type": "object", "properties": { "searchResultFileUrl": { "type": "string", "description": "Search result file URL", "nullable": true, "example": "https://fenergo.com/report.csv" }, "count": { "type": "integer", "description": "Items count", "format": "int32", "example": 23 } }, "additionalProperties": false, "description": "Response representing file search result" }, "AdvancedSearchFileResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AdvancedSearchFileResultDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "AdvancedSearchPropertyDto": { "type": "object", "properties": { "propertyType": { "type": "string", "description": "Property type.", "nullable": true, "example": "Single" }, "value": { "type": "string", "description": "The value.", "nullable": true, "example": "Tom" }, "boost": { "type": "number", "description": "Elastic Search Boost", "format": "double", "nullable": true, "example": 100 }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvancedSearchPropertyDto" }, "description": "Nested properties to search by.", "nullable": true, "example": { "firstName": { "value": "Tom", "boost": 20 }, "numberOfDependents": { "value": "30", "boost": 20 } } } }, "additionalProperties": false }, "AdvancedSearchResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SearchEntityDto" }, "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 advanced search result" }, "AdvancedSearchResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AdvancedSearchResultDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "AssociatedVersionedJurisdictionDto": { "type": "object", "properties": { "jurisdiction": { "type": "string", "description": "Jurisdiction Name", "nullable": true, "example": "Global" }, "versionId": { "type": "string", "description": "Jurisdiction Version Id", "format": "uuid", "example": "7c4bc3ff-9d5b-4ccd-839b-637c227b1c65" }, "isOffboarded": { "type": "boolean", "description": "Flag to determine if previously associated jurisdiction is now offboarded", "example": false } }, "additionalProperties": false }, "CollectionDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Data Group properties", "nullable": true }, "propertiesInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyInfoDto" }, "nullable": true } }, "additionalProperties": false, "description": "Contains Data Group object which have specified properties" }, "CollectionItemDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "CollectionPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "description": "Data Group Id", "format": "uuid" }, "dataGroupVersionNumber": { "type": "integer", "description": "Data Group version number.", "format": "int32", "nullable": true }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionDto" }, "description": "The collections of Data Groups", "nullable": true } }, "additionalProperties": false } ], "description": "Contains Data Group objects which are a collection of specific type" }, "CollectionPropertyDto2": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionItemDto" }, "nullable": true }, "collectionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CollectionPropertyInfoDto": { "type": "object", "properties": { "valueId": { "type": "string", "description": "value id linked to a properties value, such as in the case of reference data having an Id attached to a value.", "nullable": true } }, "additionalProperties": false, "description": "Contains info for Data Group objects fields" }, "CustomPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "customTypeId": { "type": "string", "format": "uuid" }, "value": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CustomPropertyDto2": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "DataChangesDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Property Datakey", "nullable": true }, "existingValue": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" } ], "description": "Existing value", "nullable": true }, "newValue": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" } ], "description": "New value", "nullable": true }, "changeType": { "type": "string", "description": "Type of change \nOne of Add, Delete, Edit, Indentical", "nullable": true } }, "additionalProperties": false, "description": "Class to represent data conflicts" }, "DataChangesDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangesDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntityAdvancedSearchDto": { "required": [ "discriminator", "pager", "properties", "type" ], "type": "object", "properties": { "discriminator": { "type": "string" }, "minScore": { "type": "number", "description": "Elastic Search Min score to match", "format": "double", "nullable": true, "example": 10 }, "type": { "minLength": 1, "type": "string", "description": "Entity type", "example": "Individual" }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "Specification of search result page" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvancedSearchPropertyDto" }, "description": "Entity properties to check for duplicates", "example": { "firstName": { "value": "Tom", "boost": 20 }, "numberOfDependents": { "value": "30", "boost": 20 } } } }, "additionalProperties": false, "description": "Request DTO to query for entity duplicates", "discriminator": { "propertyName": "discriminator", "mapping": { "EntityAdvancedSearchDto": "#/components/schemas/EntityAdvancedSearchDto", "EntityAdvancedSearchInEntityIdsDto": "#/components/schemas/EntityAdvancedSearchInEntityIdsDto" } } }, "EntityAdvancedSearchDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityAdvancedSearchDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "EntityAdvancedSearchFileDto": { "type": "object", "properties": { "minScore": { "type": "number", "description": "Elastic Search Min score to match", "format": "double", "nullable": true, "example": 10 }, "type": { "type": "string", "description": "Entity type", "nullable": true, "example": "Individual" }, "totalItems": { "type": "integer", "description": "Total items to get", "format": "int32", "example": 20 }, "headers": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Headers visible in the file", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvancedSearchPropertyDto" }, "description": "Filters based on property values", "nullable": true, "example": { "firstName": { "value": "Tom", "boost": 20 }, "numberOfDependents": { "value": "30", "boost": 20 } } } }, "additionalProperties": false, "description": "Request DTO to query for entity duplicates" }, "EntityAdvancedSearchFileDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityAdvancedSearchFileDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "EntityAdvancedSearchInEntityIdsDto": { "allOf": [ { "$ref": "#/components/schemas/EntityAdvancedSearchDto" }, { "type": "object", "properties": { "filterByLegalEntityIds": { "type": "array", "items": { "type": "string" }, "description": "Filter By List Of Legal Entity Id", "nullable": true }, "mustNotProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvancedSearchPropertyDto" }, "description": "Record's properties should not match what is included in MustNotProperties list", "nullable": true, "example": { "firstName": { "value": "Tom", "boost": 20 }, "numberOfDependents": { "value": "30", "boost": 20 } } } }, "additionalProperties": false } ], "description": "Request DTO to query for entities using Search Criteria and List of Legal Entity Ids to filter the result" }, "EntityDraftDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Entity draft id", "format": "uuid", "example": "8d631fde-505e-4101-a7cd-83ab6c054a5a" }, "sourceEntityId": { "type": "string", "description": "Source entity id", "format": "uuid", "example": "bb88430f-48ec-46de-92dc-905876e0e8eb" }, "parentDraftId": { "type": "string", "description": "Parent draft Id", "format": "uuid", "nullable": true, "example": "cb88430f-55ed-64bb-97dc-905876e0e8ec" }, "sourceEntityVersion": { "type": "integer", "description": "Source entity version", "format": "int32", "example": 1 }, "sourcePropertiesVersion": { "type": "integer", "description": "The version of the source entity properties when the draft was created", "format": "int32", "example": 5 }, "conflictsResolvedSourceEntityVersion": { "type": "integer", "description": "Conflicts resolved aggregate version", "format": "int32", "example": 5 }, "conflictsResolvedPropertiesVersion": { "type": "integer", "description": "Conflicts resolved properties version", "format": "int32", "example": 2 }, "journeyId": { "type": "string", "description": "Journey id", "format": "uuid", "example": "7c4bc3ff-9d5b-4ccd-839b-637c227b1c65" }, "type": { "type": "string", "description": "Entity draft type", "nullable": true, "example": "Individual" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Main entity draft properties", "nullable": true }, "draftProperties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Draft Only properties", "nullable": true }, "risk": { "allOf": [ { "$ref": "#/components/schemas/EntityRiskDto" } ], "description": "Entity draft risk", "nullable": true }, "role": { "allOf": [ { "$ref": "#/components/schemas/EntityRoleDto" } ], "description": "Entity draft role", "nullable": true }, "status": { "type": "string", "description": "Status", "nullable": true, "example": "InProgress" }, "created": { "type": "string", "description": "Created date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of Jurisdictions associated with EntityDraft", "nullable": true }, "associatedJurisdictionsFromParents": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatedVersionedJurisdictionDto" }, "nullable": true }, "description": "Jurisdictions associated from parents", "nullable": true }, "evaluatedJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of evaluated jurisdictions", "nullable": true }, "riskVersion": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationVersionDto" } ], "description": "List of Risk Configurations associated with EntityDraft", "nullable": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Entity access layers determining the access to the entity Draft", "nullable": true }, "version": { "type": "integer", "description": "Version number for given EntityDraft", "format": "int32", "example": 1 }, "sharedDataTemplate": { "allOf": [ { "$ref": "#/components/schemas/SharedDataTemplateDto" } ], "description": "A Shared Data Template VersionId - used on Groups", "nullable": true }, "maskedProperties": { "allOf": [ { "$ref": "#/components/schemas/MaskedPropertiesDto" } ], "description": "Property name list of sensitive data requirements with masked value", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing entity draft data" }, "EntityDraftDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDraftDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntityDraftDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityDraftDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntityDto": { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "type": "string" }, "id": { "type": "string", "description": "Entity id", "format": "uuid", "example": "8d631fde-505e-4101-a7cd-83ab6c054a5a" }, "type": { "type": "string", "description": "Entity type", "nullable": true, "example": "Individual" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Entity properties", "nullable": true }, "risk": { "allOf": [ { "$ref": "#/components/schemas/EntityRiskDto" } ], "description": "Entity risk", "nullable": true }, "role": { "allOf": [ { "$ref": "#/components/schemas/EntityRoleDto" } ], "description": "Entity role", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/EntityStatus" } ], "description": "Entity status", "deprecated": true }, "lifecycleStatus": { "allOf": [ { "$ref": "#/components/schemas/LifecycleStatusDto" } ], "description": "Lifecycle status", "example": "OnboardingInProgress" }, "userId": { "type": "string", "description": "User id\nDeprecated - not to use in new code", "nullable": true, "deprecated": true }, "created": { "type": "string", "description": "Created date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "deleted": { "type": "string", "description": "Deleted date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "alternateId": { "type": "string", "description": "Id from external system to migrate data", "nullable": true, "example": "1124efd2-3423-40f5-9bdb-fae66c7fa88a" }, "journeys": { "type": "array", "items": { "$ref": "#/components/schemas/EntityJourneyDto" }, "description": "List of Journeys for given entity", "nullable": true, "deprecated": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Entity access layers determining the access to the entity", "nullable": true }, "inScopeJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of jurisdictions entity is in scope for", "nullable": true }, "offboardedJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/OffboardedJurisdictionDto" }, "description": "List of offboarded jurisdictions", "nullable": true }, "associatedJurisdictionsFromParents": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AssociatedVersionedJurisdictionDto" }, "nullable": true }, "description": "Associated jurisdictions from parent entities", "nullable": true }, "evaluatedJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of evaluated jurisdictions", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Entity", "format": "int32", "example": 1 }, "propertiesVersion": { "type": "integer", "description": "Current version of the properties which increments on each merge of a draft", "format": "int32", "example": 5 }, "sharedDataTemplate": { "allOf": [ { "$ref": "#/components/schemas/SharedDataTemplateDto" } ], "description": "A Shared Data Template used on Groups", "nullable": true }, "maskedProperties": { "allOf": [ { "$ref": "#/components/schemas/MaskedPropertiesDto" } ], "description": "Property name list of sensitive data requirements with masked value", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing entity data", "discriminator": { "propertyName": "discriminator", "mapping": { "EntityDto": "#/components/schemas/EntityDto", "ExtendedEntityDto": "#/components/schemas/ExtendedEntityDto" } } }, "EntityDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntityDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntityIndexConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Indexed Entity Property id", "format": "uuid", "example": "8d631fde-505e-4101-a7cd-83ab6c054a5a" }, "entityType": { "type": "string", "description": "Entity type", "nullable": true, "example": "Individual" }, "propertyName": { "type": "string", "description": "Indexed Entity Property name", "nullable": true, "example": "lastName" }, "reindexingStatus": { "allOf": [ { "$ref": "#/components/schemas/PropertyReindexingStatus" } ], "description": "Indexed Entity Property operation status (InProgress, Complete)", "example": "Complete" }, "jurisdiction": { "type": "string", "description": "Jurisdiction name", "nullable": true, "example": "Global" } }, "additionalProperties": false, "description": "Response DTO representing entity index configuration" }, "EntityIndexConfigurationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityIndexConfigurationDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntityJourneyDto": { "type": "object", "properties": { "journeyType": { "type": "string", "description": "Type of Journey", "nullable": true, "example": "Client Onboarding" }, "journeyId": { "type": "string", "description": "Journey id", "format": "uuid", "example": "e51b9087-7565-4d8d-864d-fa57177a8bea" }, "journeyStatus": { "type": "string", "description": "Entity status", "nullable": true, "example": "In Progress" } }, "additionalProperties": false, "description": "Response DTO representing entity journey data" }, "EntityQueryDto": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "List of entity ids to fetch", "nullable": true }, "attributes": { "type": "array", "items": { "type": "string" }, "description": "List of entity attributes to fetch the data for", "nullable": true, "deprecated": true } }, "additionalProperties": false, "description": "Request DTO to query for a list of entities" }, "EntityQueryDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityQueryDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "EntityQueryPagedDto": { "type": "object", "properties": { "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "Specification of search result page", "nullable": true }, "searchAfter": { "type": "string", "description": "Search after parameter", "nullable": true, "example": "2020-12-28T16:45:53" }, "attributes": { "type": "array", "items": { "type": "string" }, "description": "List of entity attributes to fetch the data for", "nullable": true, "deprecated": true } }, "additionalProperties": false, "description": "Request DTO to query for a paged list of entities" }, "EntityQueryPagedDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityQueryPagedDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "EntityRiskDto": { "type": "object", "properties": { "riskCategory": { "type": "string", "description": "Risk category", "nullable": true, "example": "Low" }, "riskLevel": { "type": "number", "description": "Risk level", "format": "double", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing the entity risk data" }, "EntityRoleDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Role of the entity", "nullable": true, "example": "Client" } }, "additionalProperties": false, "description": "Response DTO representing the entity role data" }, "EntitySearchByNameDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Entity name for search", "nullable": true, "example": "Test" }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "Specification of search result page", "nullable": true } }, "additionalProperties": false, "description": "Request DTO to query for a list of entities by name" }, "EntitySearchByNameDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntitySearchByNameDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "EntitySnapshotDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Entity id", "format": "uuid", "example": "8d631fde-505e-4101-a7cd-83ab6c054a5a" }, "type": { "type": "string", "description": "Entity type", "nullable": true, "example": "Individual" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Entity properties", "nullable": true }, "role": { "allOf": [ { "$ref": "#/components/schemas/EntityRoleDto" } ], "description": "Entity role", "nullable": true }, "created": { "type": "string", "description": "Created date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "deleted": { "type": "string", "description": "Deleted date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Entity access layers determining the access to the entity", "nullable": true }, "sharedDataTemplate": { "allOf": [ { "$ref": "#/components/schemas/SharedDataTemplateDto" } ], "description": "Entity shared data template id that determines this entities shared data template", "nullable": true }, "maskedProperties": { "allOf": [ { "$ref": "#/components/schemas/MaskedPropertiesDto" } ], "description": "Property name list of sensitive data requirements with masked value", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing core entity data at a specific time" }, "EntitySnapshotDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySnapshotDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntitySnapshotDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntitySnapshotDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "EntityStatus": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "ExtendedEntityDto": { "allOf": [ { "$ref": "#/components/schemas/EntityDto" }, { "type": "object", "properties": { "isClientOffboarded": { "type": "boolean", "description": "Flag indicating if entity was a Client and had full offboarding completed" } }, "additionalProperties": false } ] }, "GetParentJurisdictionsSnapshotDto": { "type": "object", "properties": { "associatedJurisdictionsFromParents": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatedVersionedJurisdictionDto" }, "nullable": true }, "description": "List of Associated Jurisdictions From Parents", "nullable": true }, "hasAssociatedJurisdictionsChanged": { "type": "boolean", "description": "Information whether associated jurisdiction changed" } }, "additionalProperties": false, "description": "Request DTO representing entity jurisdictions snapshot for Parent Data Sync Task" }, "GetParentJurisdictionsSnapshotDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetParentJurisdictionsSnapshotDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "GetPreSignUrlsRequestDto": { "type": "object", "properties": { "isRootContent": { "type": "boolean" }, "dataKey": { "type": "string", "nullable": true }, "fileIdentifiers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "entityDraftId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "GetPreSignUrlsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPreSignUrlsRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "GetPreSignUrlsResponseDto": { "type": "object", "properties": { "isRootContent": { "type": "boolean" }, "urls": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "GetPreSignUrlsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPreSignUrlsResponseDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "GetReportPreSignUrlRequestDto": { "type": "object", "properties": { "reportType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetReportPreSignUrlRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetReportPreSignUrlRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "GetReportPreSignUrlResponseDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetReportPreSignUrlResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetReportPreSignUrlResponseDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "HttpValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } } ] }, "LifecycleStatusDto": { "enum": [ "Unknown", "OnboardingInProgress", "MaintenanceInProgress", "Compliant", "ReviewInProgress", "PendingOffboarding", "ClientOffboarded" ], "type": "string" }, "MaskedPropertiesDto": { "type": "object", "properties": { "singleProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Masked single data requirement properties", "nullable": true, "example": [ "property1" ] } }, "additionalProperties": false, "description": "Property name list of sensitive data requirements with masked value" }, "MatchAndMergeConfigurationDto": { "type": "object", "properties": { "entityType": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/MatchAndMergeFieldDto" }, "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true }, "configurationVersion": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MatchAndMergeConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MatchAndMergeConfigurationDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "MatchAndMergeFieldDto": { "type": "object", "properties": { "policyFieldDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MultiSearchForDuplicatesDto": { "type": "object", "properties": { "searchForDuplicatesDict": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SearchForDuplicatesDto" }, "description": "Dictionary of search of entity duplicates criteria", "nullable": true } }, "additionalProperties": false, "description": "Request DTO to multi-search for entity duplicates" }, "MultiSearchForDuplicatesDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MultiSearchForDuplicatesDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "OffboardedJurisdictionDto": { "type": "object", "properties": { "jurisdiction": { "type": "string", "description": "Offboarded jurisdiction", "nullable": true, "example": "Canada" }, "offboardedOn": { "type": "string", "description": "Date when jurisdiction was offboarded", "format": "date-time", "example": "2022-04-01T14:48:00.000Z" } }, "additionalProperties": false, "description": "Response DTO representing offboarded jurisdiction" }, "PagerDto": { "type": "object", "properties": { "size": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Size of the page (result set)", "format": "int32", "example": 5 }, "from": { "minimum": 0, "type": "integer", "description": "Position for the search results to start", "format": "int32", "example": 0 }, "sortBy": { "type": "string", "description": "Column to sort by", "nullable": true, "example": "created" }, "sortOrder": { "allOf": [ { "$ref": "#/components/schemas/SortOrder" } ], "description": "Sort Order (Ascending or Descending)" } }, "additionalProperties": false, "description": "Specification of search result page" }, "ProblemDetails": { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "type": "string" }, "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { }, "discriminator": { "propertyName": "discriminator", "mapping": { "ProblemDetails": "#/components/schemas/ProblemDetails", "HttpValidationProblemDetails": "#/components/schemas/HttpValidationProblemDetails" } } }, "PropertiesDto": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "collectionProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "PropertyDto": { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "description": "Property is not used in generated models. We need it to deserialize correctly to specific type in generated DotNet Client.", "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "description": "Type of properties.", "readOnly": true } }, "additionalProperties": false, "description": "Abstraction that represents properties", "discriminator": { "propertyName": "discriminator", "mapping": { "Collection": "#/components/schemas/CollectionPropertyDto", "Custom": "#/components/schemas/CustomPropertyDto", "Single": "#/components/schemas/SinglePropertyDto" } } }, "PropertyDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "PropertyReindexingStatus": { "enum": [ "InProgress", "Complete" ], "type": "string" }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "RiskConfigurationVersionDto": { "type": "object", "properties": { "riskModel": { "type": "array", "items": { "$ref": "#/components/schemas/RiskVersionDto" }, "description": "The list of Risk Models and their versions used in the Entity Draft", "nullable": true }, "riskConfigurationModel": { "type": "array", "items": { "$ref": "#/components/schemas/RiskVersionDto" }, "description": "The list of Risk Configuration Models and their versions used in the Entity Draft", "nullable": true }, "thresholdModel": { "type": "array", "items": { "$ref": "#/components/schemas/RiskVersionDto" }, "description": "The list of Threshold Models and their versions used in the Entity Draft", "nullable": true } }, "additionalProperties": false, "description": "Dto to store the risk configuration models and versions used in the Entity Draft" }, "RiskVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the risk model", "format": "uuid" }, "version": { "type": "integer", "description": "The version of the model", "format": "int32" } }, "additionalProperties": false, "description": "Stores the Id and the Version of a Risk Configuration Model" }, "SearchEntityDraftsDto": { "type": "object", "properties": { "journeyId": { "type": "string", "description": "Journey id", "format": "uuid", "example": "e51b9087-7565-4d8d-864d-fa57177a8bea" }, "entityId": { "type": "string", "description": "Entity id", "format": "uuid", "nullable": true, "example": "bb88430f-48ec-46de-92dc-905876e0e8eb", "deprecated": true }, "entityIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Entity ids", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing entity drafts search criteria" }, "SearchEntityDraftsDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchEntityDraftsDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "SearchEntityDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Entity id", "format": "uuid", "example": "8d631fde-505e-4101-a7cd-83ab6c054a5a" }, "type": { "type": "string", "description": "Entity type", "nullable": true, "example": "Individual" }, "risk": { "allOf": [ { "$ref": "#/components/schemas/EntityRiskDto" } ], "description": "Entity risk", "nullable": true }, "lifecycleStatus": { "allOf": [ { "$ref": "#/components/schemas/LifecycleStatusDto" } ], "description": "Lifecycle status", "example": "OnboardingInProgress" }, "created": { "type": "string", "description": "Created date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "deleted": { "type": "string", "description": "Deleted date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Entity access layers determining the access to the entity", "nullable": true }, "inScopeJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of jurisdictions entity is in scope for", "nullable": true }, "offboardedJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/OffboardedJurisdictionDto" }, "description": "List of offboarded jurisdictions", "nullable": true }, "evaluatedJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of evaluated jurisdictions", "nullable": true }, "sharedDataTemplate": { "allOf": [ { "$ref": "#/components/schemas/SharedDataTemplateDto" } ], "description": "A Shared Data Template used on Groups", "nullable": true }, "maskedProperties": { "allOf": [ { "$ref": "#/components/schemas/MaskedPropertiesDto" } ], "description": "Property name list of sensitive data requirements with masked value", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Entity properties", "nullable": true }, "associatedJurisdictionsFromParents": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AssociatedVersionedJurisdictionDto" }, "nullable": true }, "description": "Associated jurisdictions from parent entities", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/EntityStatus" } ], "description": "Entity status", "deprecated": true }, "userId": { "type": "string", "description": "User id\nDeprecated - not to use in new code", "nullable": true, "deprecated": true }, "journeys": { "type": "array", "items": { "$ref": "#/components/schemas/EntityJourneyDto" }, "description": "List of Journeys for given entity\nDeprecated - not to use in new code", "nullable": true, "deprecated": true }, "role": { "allOf": [ { "$ref": "#/components/schemas/EntityRoleDto" } ], "description": "Entity role", "nullable": true }, "alternateId": { "type": "string", "description": "Id from external system to migrate data", "nullable": true, "example": "1124efd2-3423-40f5-9bdb-fae66c7fa88a" }, "version": { "type": "integer", "description": "Version number for given Entity", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing entity data" }, "SearchEntityDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SearchEntityDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "SearchForDuplicatesDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "minLength": 1, "type": "string", "description": "Entity type", "example": "Individual" }, "excludeRole": { "type": "string", "description": "Entity role to be excluded, if any", "nullable": true, "example": "Client" }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Entity properties to check for duplicates", "nullable": true }, "dataGroupProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "description": "Data group properties to check for duplicates.\nOuter key is the collection name (data group), inner key is the field name, value is the search value.", "nullable": true, "example": { "taxIdentifiers": { "taxId": "123456", "taxCountry": "IE" } } }, "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "description": "Specification of search result page", "nullable": true } }, "additionalProperties": false, "description": "Request DTO to query for entity duplicates" }, "SearchForDuplicatesDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchForDuplicatesDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "description": "The message", "nullable": true, "example": "Success" }, "type": { "type": "string", "description": "Type of the message\nOne of Info, Warning, Error, Forbidden", "nullable": true, "example": "Info" }, "errorCode": { "type": "string", "description": "Error Code", "nullable": true, "example": "INTERNAL_SERVER_ERROR" } }, "additionalProperties": false, "description": "The message associated to the service response" }, "SharedDataTemplateDto": { "type": "object", "properties": { "sharedDataTemplateId": { "type": "string", "description": "The Shared Data Template Id", "format": "uuid" }, "versionNumber": { "type": "integer", "description": "The version of the shared data template linked to the entity", "format": "int32" } }, "additionalProperties": false, "description": "Request DTO to query for a shared data template linked to an entity group" }, "SinglePropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "SinglePropertyDto2": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SortOrder": { "enum": [ 0, 1 ], "type": "integer", "description": "Sort Order (Ascending or Descending)", "format": "int32" }, "StringSearchEntityDtoListDictionaryServiceResponse": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/SearchEntityDto" }, "nullable": true }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Name of the property", "nullable": true, "example": "data" }, "errorMessage": { "type": "string", "description": "User friendly error message", "nullable": true, "example": "Data is required" }, "attemptedValue": { "description": "Invalid value", "nullable": true }, "errorCode": { "type": "string", "description": "Internal error code", "nullable": true, "example": "NotNullValidator" } }, "additionalProperties": false, "description": "Represents the details of validation error" }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data", "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "VersionedJurisdictionDto": { "type": "object", "properties": { "jurisdiction": { "type": "string", "description": "Jurisdiction Name", "nullable": true, "example": "Global" }, "versionId": { "type": "string", "description": "Jurisdiction Version Id", "format": "uuid", "example": "7c4bc3ff-9d5b-4ccd-839b-637c227b1c65" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }