openapi: 3.2.0 info: title: Fenergo Entity Draft API version: '1.0' description: 'Operations tagged EntityDraft across 5 of this provider''s published API definitions: fenergo-entitydatacommand-v1-0-openapi.json, fenergo-entitydatacommand-v2-0-openapi.json, fenergo-entitydatacommand-v3-0-openapi.json, fenergo-entitydataquery-v1-0-openapi.json, fenergo-entitydataquery-v2-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /entitydatacommand - url: /entitydataquery security: - Bearer: [] tags: - name: EntityDraft paths: /api/entity/{entityId}/draft: post: tags: - EntityDraft summary: Create entity draft description: 'Creates a new entity draft record for an existing entity. Returns the id of the created entity draft. Required permissions: At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit' operationId: CreateEntityDraft 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Create entity draft request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateEntityDraftDtoServiceRequest' responses: '202': description: Success. Entity draft created content: application/json: schema: $ref: '#/components/schemas/EntityDraftCreatedDtoServiceResponse' '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 does not exist or has been deleted 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 get: tags: - EntityDraft summary: Get entity drafts description: 'Returns 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_2' '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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT deprecated: true servers: - url: /entitydatacommand /api/entity/{entityId}/draft/{id}: put: tags: - EntityDraft summary: Update entity draft description: 'Updates an existing entity draft. Required permissions: At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit' operationId: UpdateEntityDraftRecord parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft request. Must contain Policy jurisdiction(s) and entity draft properties content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateEntityDraftRequestDtoServiceRequest' responses: '202': description: Success. Entity draft updated content: application/json: schema: $ref: '#/components/schemas/EntityDraftUpdatedDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 deprecated: true get: tags: - EntityDraft summary: Get entity draft by id description: 'Returns 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_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' 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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /entitydatacommand /api/entity/{entityId}/draft/{id}/verify: put: tags: - EntityDraft summary: Verify entity draft description: 'Verifies an entity draft record. Required permissions: Following permissions are required: EntityDataApprove' operationId: VerifyEntityDraft parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Conflict Resolutions request content: application/json: schema: allOf: - $ref: '#/components/schemas/ConflictResolutionsDtoServiceRequest' responses: '202': description: Success. No conflicts were found for the Entity Draft Record '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 servers: - url: /entitydatacommand /api/entity/{entityId}/draft/{id}/reject: put: tags: - EntityDraft summary: Reject entity draft description: 'Updates the status property of an entity draft to rejected. Rejected drafts cannot be updated or merged. Required permissions: Following permissions are required: EntityDataApprove' operationId: RejectEntityDraft parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Reject Entity Draft request content: application/json: schema: allOf: - $ref: '#/components/schemas/RejectEntityDraftDtoServiceRequest' responses: '202': description: Success. Entity draft rejected '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 servers: - url: /entitydatacommand /api/entity/{entityId}/draft/{id}/risk: put: tags: - EntityDraft summary: Update risk of entity draft description: 'Updates the risk properties of an entity draft. Required permissions: Following permissions are required: EntityDataEdit' operationId: UpdateEntityDraftRisk parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft risk request content: application/json: schema: allOf: - $ref: '#/components/schemas/EntityRiskDtoServiceRequest' responses: '202': description: Success. Entity draft risk updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 servers: - url: /entitydatacommand /api/entity/{entityId}/draft/{id}/role: put: tags: - EntityDraft summary: Update the role of entity draft description: 'Updates the role property of an entity draft. Required permissions: Following permissions are required: EntityDataEdit' operationId: UpdateEntityDraftRole parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft role request content: application/json: schema: allOf: - $ref: '#/components/schemas/EntityRoleDtoServiceRequest' responses: '202': description: Success. Entity draft role updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 servers: - url: /entitydatacommand /api/entity/{entityId}/draft/{id}/access-layers: put: tags: - EntityDraft summary: Update the access layers of the entity draft. description: 'Required permissions: Following permissions are required: EntityDataChangeEntityDraftAccessLayers' operationId: UpdateEntityDraftAccessLayers parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft role request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDraftAccessLayersDtoServiceRequest' responses: '202': description: Success. Entity draft role updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft/{id}: put: tags: - EntityDraft summary: Update entity draft description: 'Updates an existing entity draft. Required permissions: At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit' operationId: UpdateEntityDraftRecordV2 parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft request. Must contain Policy jurisdiction(s) and entity draft properties content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateEntityDraftRequestV3DtoServiceRequest' responses: '202': description: Success. Entity draft updated content: application/json: schema: $ref: '#/components/schemas/EntityDraftUpdatedDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 get: tags: - EntityDraft summary: Get entity draft by id description: 'Returns entity draft for a given entity id and draft id. Required permissions: At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch' operationId: getApiV2EntityByEntityIdDraftById 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_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetEntityDraftById servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft/{id}/shared-data-template: put: tags: - EntityDraft summary: Update entity draft and adds shared data template to it description: 'Updates an existing groups entity draft to include a shared data template. Required permissions: Following permissions are required: EntityGroupManagementEdit' operationId: UpdateSharedDataTemplate parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: update shared data template request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateSharedDataTemplateRequestDtoServiceRequest' responses: '202': description: Success. Entity draft updated content: application/json: schema: $ref: '#/components/schemas/EntityDraftUpdatedDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values 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/entity draft with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft/{id}/shared-data-template/clear: put: tags: - EntityDraft summary: Clears the shared data template from a entity draft description: 'Updates an existing groups entity draft to remove a shared data template. Required permissions: Following permissions are required: EntityGroupManagementEdit' operationId: ClearSharedDataTemplate parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Entity draft updated '400': description: Bad request. The request has missing/invalid values 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/entity draft with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft/{id}/update-child-from-group: put: tags: - EntityDraft summary: Manually update entity draft from entity group description: 'Updates a child entity draft using an entity group. Required permissions: Following permissions are required: EntityDataEdit' operationId: UpdateChildFromGroup parameters: - name: entityId in: path required: true schema: type: string - name: id in: path 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Manual update group child request content: application/json: schema: allOf: - $ref: '#/components/schemas/ManualUpdateGroupChildRequestDtoServiceRequest' responses: '202': description: Success. Entity draft updated content: application/json: schema: $ref: '#/components/schemas/EntityDraftUpdatedDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values 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/entity draft with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft/{id}/conflicts: put: tags: - EntityDraft summary: Manage conflicts for Entity Draft Record description: 'Used to check and resolve conflicts for an Entity Draft compared to the latest Verified Record. Required permissions: At least one of the following permissions is required: ConflictResolutionEdit, ConflictResolutionAccess' operationId: EntityDraftConflicts parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Conflict Resolutions request content: application/json: schema: allOf: - $ref: '#/components/schemas/DraftConflictDtoServiceRequest' responses: '202': description: Success. No conflicts were found for the Entity Draft Record '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft: post: tags: - EntityDraft summary: Create entity draft description: 'Creates a new entity draft record for an existing entity. Returns the id of the created entity draft. Required permissions: At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit' operationId: postApiV2EntityByEntityIdDraft 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Create entity draft request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateEntityDraftDtoServiceRequest' responses: '202': description: Success. Entity draft created content: application/json: schema: $ref: '#/components/schemas/EntityDraftCreatedDtoServiceResponse' '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 does not exist or has been deleted 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 x-operation-id-source: normalized x-operation-id-original: CreateEntityDraft servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft/{id}/verify: put: tags: - EntityDraft summary: Verify entity draft description: 'Verifies an entity draft record. Required permissions: Following permissions are required: EntityDataApprove' operationId: putApiV2EntityByEntityIdDraftByIdVerify parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Conflict Resolutions request content: application/json: schema: allOf: - $ref: '#/components/schemas/ConflictResolutionsDtoServiceRequest' responses: '202': description: Success. No conflicts were found for the Entity Draft Record '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: VerifyEntityDraft servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft/{id}/reject: put: tags: - EntityDraft summary: Reject entity draft description: 'Updates the status property of an entity draft to rejected. Rejected drafts cannot be updated or merged. Required permissions: Following permissions are required: EntityDataApprove' operationId: putApiV2EntityByEntityIdDraftByIdReject parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Reject Entity Draft request content: application/json: schema: allOf: - $ref: '#/components/schemas/RejectEntityDraftDtoServiceRequest' responses: '202': description: Success. Entity draft rejected '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: RejectEntityDraft servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft/{id}/risk: put: tags: - EntityDraft summary: Update risk of entity draft description: 'Updates the risk properties of an entity draft. Required permissions: Following permissions are required: EntityDataEdit' operationId: putApiV2EntityByEntityIdDraftByIdRisk parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft risk request content: application/json: schema: allOf: - $ref: '#/components/schemas/EntityRiskDtoServiceRequest' responses: '202': description: Success. Entity draft risk updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: UpdateEntityDraftRisk servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft/{id}/role: put: tags: - EntityDraft summary: Update the role of entity draft description: 'Updates the role property of an entity draft. Required permissions: Following permissions are required: EntityDataEdit' operationId: putApiV2EntityByEntityIdDraftByIdRole parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft role request content: application/json: schema: allOf: - $ref: '#/components/schemas/EntityRoleDtoServiceRequest' responses: '202': description: Success. Entity draft role updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: UpdateEntityDraftRole servers: - url: /entitydatacommand /api/v2/entity/{entityId}/draft/{id}/access-layers: put: tags: - EntityDraft summary: Update the access layers of the entity draft. description: 'Required permissions: Following permissions are required: EntityDataChangeEntityDraftAccessLayers' operationId: putApiV2EntityByEntityIdDraftByIdAccessLayers parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft role request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDraftAccessLayersDtoServiceRequest' responses: '202': description: Success. Entity draft role updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: UpdateEntityDraftAccessLayers servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft/{id}: put: tags: - EntityDraft summary: Update entity draft description: 'Updates an existing entity draft. Required permissions: At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit' operationId: UpdateEntityDraftV3 parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft request. Must contain Policy jurisdiction(s) and entity draft properties content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateEntityDraftRequestV3DtoServiceRequest' responses: '202': description: Success. Entity draft updated. Validation errors will be returned for invalid properties content: application/json: schema: $ref: '#/components/schemas/EntityDraftUpdatedDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft/{id}/shared-data-template: put: tags: - EntityDraft summary: Update entity draft and adds shared data template to it description: 'Updates an existing groups entity draft to include a shared data template. Required permissions: Following permissions are required: EntityGroupManagementEdit' operationId: putApiV3EntityByEntityIdDraftByIdSharedDataTemplate parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: update shared data template request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateSharedDataTemplateRequestDtoServiceRequest' responses: '202': description: Success. Entity draft updated content: application/json: schema: $ref: '#/components/schemas/EntityDraftUpdatedDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values 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/entity draft with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: UpdateSharedDataTemplate servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft/{id}/shared-data-template/clear: put: tags: - EntityDraft summary: Clears the shared data template from a entity draft description: 'Updates an existing groups entity draft to remove a shared data template. Required permissions: Following permissions are required: EntityGroupManagementEdit' operationId: putApiV3EntityByEntityIdDraftByIdSharedDataTemplateClear parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Entity draft updated '400': description: Bad request. The request has missing/invalid values 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/entity draft with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: ClearSharedDataTemplate servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft/{id}/update-child-from-group: put: tags: - EntityDraft summary: Manually update entity draft from entity group description: 'Updates a child entity draft using an entity group. Required permissions: Following permissions are required: EntityDataEdit' operationId: putApiV3EntityByEntityIdDraftByIdUpdateChildFromGroup parameters: - name: entityId in: path required: true schema: type: string - name: id in: path 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Manual update group child request content: application/json: schema: allOf: - $ref: '#/components/schemas/ManualUpdateGroupChildRequestDtoServiceRequest' responses: '202': description: Success. Entity draft updated content: application/json: schema: $ref: '#/components/schemas/EntityDraftUpdatedDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values 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/entity draft with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: UpdateChildFromGroup servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft/{id}/conflicts: put: tags: - EntityDraft summary: Manage conflicts for Entity Draft Record description: 'Used to check and resolve conflicts for an Entity Draft compared to the latest Verified Record. Required permissions: At least one of the following permissions is required: ConflictResolutionEdit, ConflictResolutionAccess' operationId: putApiV3EntityByEntityIdDraftByIdConflicts parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Conflict Resolutions request content: application/json: schema: allOf: - $ref: '#/components/schemas/DraftConflictDtoServiceRequest' responses: '202': description: Success. No conflicts were found for the Entity Draft Record '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: EntityDraftConflicts servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft: post: tags: - EntityDraft summary: Create entity draft description: 'Creates a new entity draft record for an existing entity. Returns the id of the created entity draft. Required permissions: At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit' operationId: postApiV3EntityByEntityIdDraft 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Create entity draft request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateEntityDraftDtoServiceRequest' responses: '202': description: Success. Entity draft created content: application/json: schema: $ref: '#/components/schemas/EntityDraftCreatedDtoServiceResponse' '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 does not exist or has been deleted 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 x-operation-id-source: normalized x-operation-id-original: CreateEntityDraft servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft/{id}/verify: put: tags: - EntityDraft summary: Verify entity draft description: 'Verifies an entity draft record. Required permissions: Following permissions are required: EntityDataApprove' operationId: putApiV3EntityByEntityIdDraftByIdVerify parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Conflict Resolutions request content: application/json: schema: allOf: - $ref: '#/components/schemas/ConflictResolutionsDtoServiceRequest' responses: '202': description: Success. No conflicts were found for the Entity Draft Record '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: VerifyEntityDraft servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft/{id}/reject: put: tags: - EntityDraft summary: Reject entity draft description: 'Updates the status property of an entity draft to rejected. Rejected drafts cannot be updated or merged. Required permissions: Following permissions are required: EntityDataApprove' operationId: putApiV3EntityByEntityIdDraftByIdReject parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Reject Entity Draft request content: application/json: schema: allOf: - $ref: '#/components/schemas/RejectEntityDraftDtoServiceRequest' responses: '202': description: Success. Entity draft rejected '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: RejectEntityDraft servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft/{id}/risk: put: tags: - EntityDraft summary: Update risk of entity draft description: 'Updates the risk properties of an entity draft. Required permissions: Following permissions are required: EntityDataEdit' operationId: putApiV3EntityByEntityIdDraftByIdRisk parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft risk request content: application/json: schema: allOf: - $ref: '#/components/schemas/EntityRiskDtoServiceRequest' responses: '202': description: Success. Entity draft risk updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: UpdateEntityDraftRisk servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft/{id}/role: put: tags: - EntityDraft summary: Update the role of entity draft description: 'Updates the role property of an entity draft. Required permissions: Following permissions are required: EntityDataEdit' operationId: putApiV3EntityByEntityIdDraftByIdRole parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft role request content: application/json: schema: allOf: - $ref: '#/components/schemas/EntityRoleDtoServiceRequest' responses: '202': description: Success. Entity draft role updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: UpdateEntityDraftRole servers: - url: /entitydatacommand /api/v3/entity/{entityId}/draft/{id}/access-layers: put: tags: - EntityDraft summary: Update the access layers of the entity draft. description: 'Required permissions: Following permissions are required: EntityDataChangeEntityDraftAccessLayers' operationId: putApiV3EntityByEntityIdDraftByIdAccessLayers parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: id 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 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update entity draft role request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDraftAccessLayersDtoServiceRequest' responses: '202': description: Success. Entity draft role updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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 x-operation-id-source: normalized x-operation-id-original: UpdateEntityDraftAccessLayers servers: - url: /entitydatacommand /api/entity/proposedchanges/draft/{entityDraftId}: get: tags: - EntityDraft summary: Get proposed changes between an entity draft and the verified entity the draft… description: 'Return 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_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' 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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /entitydataquery /api/entity/{entityId}/draft/{entityDraftId}/property/{propertyName}: get: tags: - EntityDraft summary: Get revealed PII property value from EntityDraft description: 'Returns 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_2' '403': description: Forbidden. User has no access to reveal property content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /entitydataquery /api/entity/{draftId}/parent-jurisdictions-snapshot: get: tags: - EntityDraft summary: Get entity draft previous parent jurisdictions, it is meant to be used only for… description: 'Returns 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_2' '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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /entitydataquery /api/v2/entity/{entityId}/drafts-ids: get: tags: - EntityDraft summary: Get entity drafts ids description: 'Returns list of entity drafts ids for an existing entity. Required permissions: At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch' operationId: GetEntityDraftsIds 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 ids is returned content: application/json: schema: $ref: '#/components/schemas/EntityDraftsIdsDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /entitydataquery /api/v2/entity/proposedchanges/draft/{entityDraftId}: get: tags: - EntityDraft summary: Get proposed changes between an entity draft and the verified entity the draft… description: 'Return proposed changes between entity draft and entity Required permissions: Following permissions are required: ProposedChangesAccess' operationId: getApiV2EntityProposedchangesDraftByEntityDraftId 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_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetEntityDraftProposedChanges servers: - url: /entitydataquery /api/v2/entity/{entityId}/draft/{entityDraftId}/property/{propertyName}: get: tags: - EntityDraft summary: Get revealed PII property value from EntityDraft description: 'Returns unmasked value of requested property name Required permissions: At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch' operationId: getApiV2EntityByEntityIdDraftByEntityDraftIdPropertyByPropertyName 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_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '403': description: Forbidden. User has no access to reveal property content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetDraftPIIPropertyValue servers: - url: /entitydataquery /api/v2/entity/search-entity-drafts: post: tags: - EntityDraft summary: Search entity drafts with 'Entity' access layer verification description: 'Returns list of accessible and list of inaccessible entity drafts due to ''Entity'' access layer constraint. Required permissions: At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch' operationId: SearchEntityDraftsV2 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 entity drafts request 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/SearchEntityDraftsV2ResponseServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /entitydataquery /api/v2/entity/drafts/names: post: tags: - EntityDraft summary: Get entity draft names within a journey by entity IDs. description: 'Required permissions: At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch' operationId: GetEntityDraftNamesByIds 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: Journey id + entity ids to resolve names for content: application/json: schema: allOf: - $ref: '#/components/schemas/GetEntityDraftNamesByIdsRequestDtoServiceRequest' description: Service request data responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetEntityDraftNamesByIdsResponseServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /entitydataquery /api/v2/entity/drafts/partial-properties: post: tags: - EntityDraft summary: Get a filtered subset of Properties for up to 10 entity drafts by id. description: 'Required permissions: At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch' operationId: GetEntityDraftPartialProperties 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: Draft ids plus the top-level Properties keys to include per draft content: application/json: schema: allOf: - $ref: '#/components/schemas/GetEntityDraftPartialPropertiesRequestDtoServiceRequest' description: Service request data responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EntityDraftPartialPropertiesResponseServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /entitydataquery /api/v2/entity/{draftId}/parent-jurisdictions-snapshot: get: tags: - EntityDraft summary: Get entity draft previous parent jurisdictions, it is meant to be used only for… description: 'Returns entity draft previous parent jurisdictions Required permissions: At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch' operationId: getApiV2EntityByDraftIdParentJurisdictionsSnapshot 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_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetParentJurisdictionsSnapshot servers: - url: /entitydataquery components: schemas: EntityRiskDto: type: object properties: riskLevel: type: - number - 'null' description: Risk level format: double example: 1 riskCategory: type: - string - 'null' description: Risk category example: Low version: type: integer description: "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 additionalProperties: false description: Request DTO representing the entity risk data EntityAssociationDataSource: required: - associationToClient - associationType type: object properties: dataSource: type: - string - 'null' readOnly: true associationType: minLength: 1 type: string ownershipPercentage: type: - number - 'null' format: double associationToClient: minLength: 1 type: string properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false UpdateEntityDraftRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateEntityDraftRequestDto' description: Request DTO to update entity draft additionalProperties: false EntityDataMetadataDataSource: required: - entityType type: object properties: dataSource: type: - string - 'null' readOnly: true entityType: minLength: 1 type: string additionalProperties: false ManualCreditScreeningDto: required: - properties type: object properties: taskDataKey: type: - string - 'null' taskId: type: string format: uuid entityId: type: string format: uuid creditScreeningOutcome: type: - string - 'null' properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona additionalProperties: false RelatedPartyDto: required: - properties type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' metadata: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false ReviewAndApprovalDto: required: - approvalOutcome type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona approvalOutcome: type: string approvalReason: type: - string - 'null' taskId: type: - string - 'null' taskDataKey: type: - string - 'null' additionalProperties: false ChangedFieldsDataSource: required: - changedFields type: object properties: dataSource: type: - string - 'null' readOnly: true changedFields: type: array items: $ref: '#/components/schemas/ChangedFieldDto' additionalProperties: false RejectEntityDraftDto: type: object properties: version: type: integer description: "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 additionalProperties: false description: Request DTO representing the entity risk data RelatedAssetDto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona additionalProperties: false CreateEntityDraftDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateEntityDraftDto' description: 'Request DTO to create new entity draft Contains required Journey id to define entity draft' additionalProperties: false ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false EntityRoleDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityRoleDto' description: Request DTO representing the entity role data additionalProperties: false EntityRiskDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityRiskDto' description: Request DTO representing the entity risk data additionalProperties: false CurrentFieldDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true currentField: type: - string - 'null' additionalProperties: false AutoCreditScreeningDataSource: required: - creditScreenings type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: array items: $ref: '#/components/schemas/AutoCreditScreeningDto' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto' additionalProperties: false SignificanceEngineDataSource: required: - significanceEngine type: object properties: dataSource: type: - string - 'null' readOnly: true significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDto' additionalProperties: false AccessLayerDto: type: object properties: geographic: type: - array - 'null' items: type: string description: Collection of geographic access layers example: - Global businessRelated: type: - array - 'null' items: type: string description: Collection of business related access layers example: - Enterprise geographicDetails: type: - array - 'null' items: $ref: '#/components/schemas/AccessLayerDetailsDto' description: Collection of geographic access layers with details about inheritance businessRelatedDetails: type: - array - 'null' items: $ref: '#/components/schemas/AccessLayerDetailsDto' description: Collection of business related access layers with details about inheritance additionalProperties: false description: Response DTO representing associated access layers PropertyDto: type: object properties: type: allOf: - $ref: '#/components/schemas/PropertyType' readOnly: true discriminator: allOf: - $ref: '#/components/schemas/PropertyType' readOnly: true isValid: type: - boolean - 'null' additionalProperties: false EntityDraftCreatedDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityDraftCreatedDto' description: Response DTO representing created entity draft messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false JourneyLevelDataDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false AutoCreditAssessmentDataSource: required: - autoCreditAssessments type: object properties: dataSource: type: - string - 'null' readOnly: true autoCreditAssessments: type: array items: $ref: '#/components/schemas/AutoCreditAssessmentDto' additionalProperties: false RelatedDocumentVersionedDto: type: object properties: documentKey: type: - string - 'null' documentType: type: - string - 'null' properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona additionalProperties: false EntityDraftCreatedDto: type: object properties: id: type: string description: Entity Draft id format: uuid example: bb88430f-48ec-46de-92dc-905876e0e8eb sourceEntityId: type: string description: Source entity id format: uuid example: bb88430f-48ec-46de-92dc-905876e0e8eb sourceEntityVersion: type: integer description: Source entity version format: int32 example: 1 conflictsResolvedSourceEntityVersion: type: integer description: Conflict Resolved 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 journeyId: type: string description: Journey id format: uuid example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65 type: type: - string - 'null' description: Entity draft type example: Individual properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona risk: allOf: - $ref: '#/components/schemas/EntityRiskDto' description: Entity draft risk role: allOf: - $ref: '#/components/schemas/EntityRoleDto' description: Entity draft role status: type: - string - 'null' description: Status example: InProgress created: type: - string - 'null' description: Created date format: date-time example: '2021-01-01T14:48:00.000Z' jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: List of Jurisdictions associated with EntityDraft associatedJurisdictionsFromParents: type: - object - 'null' additionalProperties: type: - array - 'null' items: $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto' description: Jurisdictions associated from parents evaluatedJurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: List of evaluated jurisdictions riskVersion: allOf: - $ref: '#/components/schemas/RiskConfigurationVersionDto' description: List of Risk Configurations associated with EntityDraft accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Entity access layers determining the access to the entity Draft version: type: integer description: Version number for given EntityDraft format: int32 example: 1 maskedProperties: allOf: - $ref: '#/components/schemas/MaskedPropertiesDto' description: Property name list of sensitive data requirements with masked value additionalProperties: false description: Response DTO representing created entity draft UpdateDraftAccessLayersDto: type: object properties: accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Entity access layers determining the access to the entity draft and related entity version: type: integer description: "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 additionalProperties: false description: Request DTO representing the entity draft access layers data CollectionItemDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto2' additionalProperties: false CollectionPropertyDto2: type: object properties: items: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CollectionItemDto' collectionId: type: - string - 'null' format: uuid additionalProperties: false MainEntityDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false VersionedJurisdictionDto: required: - jurisdiction type: object properties: jurisdiction: minLength: 1 type: string description: Jurisdiction Name example: Global versionId: type: string description: Jurisdiction Version Id format: uuid example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65 additionalProperties: false RelatedFCRDto: required: - status type: object properties: status: type: string createdDate: type: string format: date-time submittedDate: type: - string - 'null' format: date-time additionalProperties: false CustomPropertyDto2: type: object properties: singleProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto2' customProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CustomPropertyDto2' additionalProperties: false MaskedPropertiesDto: type: object properties: singleProperties: uniqueItems: true type: - array - 'null' items: type: string description: Masked single data requirement properties example: - property1 additionalProperties: false description: Property name list of sensitive data requirements with masked value RelatedDocumentsDataSource: required: - documents type: object properties: dataSource: type: - string - 'null' readOnly: true documents: type: array items: $ref: '#/components/schemas/RelatedDocumentDto' additionalProperties: false ExternalDataAdapterDataSource: required: - eventSubtype - eventType type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: minLength: 1 type: string eventSubtype: minLength: 1 type: string additionalProperties: false RelatedAssetsDataSource: required: - assets type: object properties: dataSource: type: - string - 'null' readOnly: true assets: type: array items: $ref: '#/components/schemas/RelatedAssetDto' additionalProperties: false EntityDraftUpdatedDto: type: object properties: version: type: integer description: Version of entity draft after update format: int32 example: 4 hasValidationErrors: type: boolean description: Returned some validation errors for invalid properties example: false additionalProperties: false description: Response DTO representing updated entity draft CurrentDataGroupItemDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: object additionalProperties: type: - string - 'null' additionalProperties: false ScreeningMaterialityDataSource: required: - assessments type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: type: array items: $ref: '#/components/schemas/ScreeningMaterialityAssessmentDto' additionalProperties: false InvestmentAccountFundDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false DataSourcesDto: type: object properties: entityDataMetadata: allOf: - $ref: '#/components/schemas/EntityDataMetadataDataSource' eventIngress: allOf: - $ref: '#/components/schemas/EventIngressDataSource' changedFields: allOf: - $ref: '#/components/schemas/ChangedFieldsDataSource' relatedClient: allOf: - $ref: '#/components/schemas/RelatedClientDataSource' relatedProducts: allOf: - $ref: '#/components/schemas/RelatedProductsDataSource' currentDataGroupItem: allOf: - $ref: '#/components/schemas/CurrentDataGroupItemDataSource' externalDataAdapter: allOf: - $ref: '#/components/schemas/ExternalDataAdapterDataSource' entityAssociation: allOf: - $ref: '#/components/schemas/EntityAssociationDataSource' manualCreditAssessment: allOf: - $ref: '#/components/schemas/ManualCreditAssessmentV2DataSource' reviewAndApproval: allOf: - $ref: '#/components/schemas/ReviewAndApprovalDataSource' autoCreditAssessment: allOf: - $ref: '#/components/schemas/AutoCreditAssessmentDataSource' manualCreditScreening: allOf: - $ref: '#/components/schemas/ManualCreditScreeningDataSource' collateral: allOf: - $ref: '#/components/schemas/CollateralDataSource' currentJourneys: allOf: - $ref: '#/components/schemas/CurrentJourneysDataSource' autoCreditScreening: allOf: - $ref: '#/components/schemas/AutoCreditScreeningDataSource' currentProduct: allOf: - $ref: '#/components/schemas/CurrentProductDataSource' relatedDeals: allOf: - $ref: '#/components/schemas/RelatedDealsDataSource' mainEntity: allOf: - $ref: '#/components/schemas/MainEntityDataSource' relatedAssets: allOf: - $ref: '#/components/schemas/RelatedAssetsDataSource' relatedAssociations: allOf: - $ref: '#/components/schemas/RelatedAssociationsDataSource' accountRelatedFunds: allOf: - $ref: '#/components/schemas/AccountRelatedFundsDataSource' investmentAccountFund: allOf: - $ref: '#/components/schemas/InvestmentAccountFundDataSource' investmentAccountRelatedFundShareClass: allOf: - $ref: '#/components/schemas/InvestmentAccountRelatedFundShareClassDataSource' journeyLevelData: allOf: - $ref: '#/components/schemas/JourneyLevelDataDataSource' relatedParties: allOf: - $ref: '#/components/schemas/RelatedPartiesDataSource' currentField: allOf: - $ref: '#/components/schemas/CurrentFieldDataSource' significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDataSource' alert: allOf: - $ref: '#/components/schemas/AlertDataSource' relatedFCRs: allOf: - $ref: '#/components/schemas/RelatedFCRsDataSource' relatedInvestmentManager: allOf: - $ref: '#/components/schemas/RelatedInvestmentManagerDataSource' relatedUnderlyingPrincipalOwner: allOf: - $ref: '#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource' alertAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDataSource' currentProductMetadata: allOf: - $ref: '#/components/schemas/CurrentProductMetadataDataSource' currentUser: allOf: - $ref: '#/components/schemas/CurrentUserDataSource' relatedDocuments: allOf: - $ref: '#/components/schemas/RelatedDocumentsDataSource' screeningMateriality: allOf: - $ref: '#/components/schemas/ScreeningMaterialityDataSource' additionalProperties: false AlertDataSource: required: - attribute - source - type type: object properties: dataSource: type: - string - 'null' readOnly: true source: type: string type: type: string attribute: type: string additionalProperties: false RelatedInvestmentManagerDataSource: required: - properties type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' dataSource: type: - string - 'null' readOnly: true additionalProperties: false RelatedProductDto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona lifecycleStatus: type: - string - 'null' relationshipTypes: type: - array - 'null' items: type: string additionalProperties: false UpdateEntityDraftRequestDto: type: object properties: jurisdictions: type: - array - 'null' items: type: string description: Collection of policy jurisdictions entityType: type: - string - 'null' description: The type of the entity example: Individual category: type: - array - 'null' items: type: string description: List of requirement category e.g. ["Basic Details", "Enrich Details"] properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona version: type: integer description: "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 additionalProperties: false description: Request DTO to update entity draft UpdateDraftAccessLayersDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateDraftAccessLayersDto' description: Request DTO representing the entity draft access layers data additionalProperties: false AutoCreditScreeningDto: required: - properties type: object properties: entityId: type: string format: uuid creditScreeningOutcome: type: - string - 'null' properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona providerInternalIdentifier: type: - string - 'null' additionalProperties: false EntityRoleDto: type: object properties: name: type: - string - 'null' description: Role of the entity example: Client version: type: integer description: "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 additionalProperties: false description: Request DTO representing the entity role data RelatedAssociationsDataSource: required: - relatedAssociations type: object properties: dataSource: type: - string - 'null' readOnly: true relatedAssociations: type: array items: $ref: '#/components/schemas/RelatedAssociationDto' additionalProperties: false ConflictResolutionsDto: type: object properties: dataConflictResolutions: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona version: type: integer description: "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 additionalProperties: false description: Request DTO representing the conflict resolution data RelatedClientDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona additionalProperties: false CurrentUserDataSource: required: - teamIds type: object properties: dataSource: type: - string - 'null' readOnly: true teamIds: type: array items: minLength: 1 type: string format: uuid isSystemUser: type: boolean additionalProperties: false EntityDraftUpdatedDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityDraftUpdatedDto' description: Response DTO representing updated entity draft messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CollateralDto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona additionalProperties: false RelatedDealsDataSource: required: - relatedDeals type: object properties: dataSource: type: - string - 'null' readOnly: true relatedDeals: type: array items: $ref: '#/components/schemas/RelatedDealDto' additionalProperties: false ConflictResolutionsDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ConflictResolutionsDto' description: Request DTO representing the conflict resolution data additionalProperties: false CreateEntityDraftDto: type: object properties: journeyId: type: string description: Journey id format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 parentDraftId: type: - string - 'null' description: Optional parent draft id (jurisdictions are taken from parent if defined) format: uuid example: 4fd71919-b072-44be-a520-ab66009f1171 dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources additionalProperties: false description: 'Request DTO to create new entity draft Contains required Journey id to define entity draft' CurrentProductMetadataDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true isAgency: type: - string - 'null' lifecycleStatus: type: - string - 'null' additionalProperties: false SinglePropertyDto2: type: object properties: value: type: - string - 'null' valueId: type: - string - 'null' additionalProperties: false ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ScreeningMaterialityAssessmentDto: required: - adverseMediaJurisdictions - enforcementsJurisdictions - otherJurisdictions - pepJurisdictions - sanctionsJurisdictions type: object properties: mainEntity: type: boolean materialityOutcome: type: - string - 'null' pepMaterialityStatus: type: - string - 'null' sanctionsMaterialityStatus: type: - string - 'null' adverseMediaMaterialityStatus: type: - string - 'null' enforcementsMaterialityStatus: type: - string - 'null' otherMaterialityStatus: type: - string - 'null' pepJurisdictions: type: array items: type: string sanctionsJurisdictions: type: array items: type: string adverseMediaJurisdictions: type: array items: type: string enforcementsJurisdictions: type: array items: type: string otherJurisdictions: type: array items: type: string sanctionsProceedDecision: type: - string - 'null' additionalProperties: false EventIngressDataSource: required: - eventSubtype - eventType type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: minLength: 1 type: string eventSubtype: minLength: 1 type: string additionalProperties: false ChangedFieldDto: type: object properties: key: type: - string - 'null' additionalProperties: false AssociatedVersionedJurisdictionDto: allOf: - $ref: '#/components/schemas/VersionedJurisdictionDto' - type: object properties: isOffboarded: type: boolean description: Flag to determine if previously associated jurisdiction is now offboarded example: false additionalProperties: false RelatedPartiesDataSource: required: - relatedParties type: object properties: dataSource: type: - string - 'null' readOnly: true relatedParties: type: array items: $ref: '#/components/schemas/RelatedPartyDto' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false InvestmentAccountRelatedFundShareClassDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false AlertAssessmentDataSource: required: - assessments - lastAssessment type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: minItems: 1 type: array items: $ref: '#/components/schemas/AlertAssessmentDto' lastAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDto' lastAssessmentOutcome: type: - string - 'null' additionalProperties: false 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 PropertiesDto: type: object properties: singleProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto2' collectionProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CollectionPropertyDto2' customProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CustomPropertyDto2' additionalProperties: false CurrentJourneysDataSource: required: - inProgressJourneyTypes type: object properties: dataSource: type: - string - 'null' readOnly: true inProgressJourneyTypes: type: array items: type: string additionalProperties: false SignificanceEngineDto: type: object properties: singleFields: type: - array - 'null' items: type: string collections: type: - object - 'null' additionalProperties: type: - object - 'null' additionalProperties: type: array items: type: string additionalProperties: false RiskConfigurationVersionDto: type: object properties: riskModel: type: - array - 'null' items: $ref: '#/components/schemas/RiskVersionDto' description: The list of Risk Models and their versions used in the Entity Draft riskConfigurationModel: type: - array - 'null' items: $ref: '#/components/schemas/RiskVersionDto' description: The list of Risk Configuration Models and their versions used in the Entity Draft thresholdModel: type: - array - 'null' items: $ref: '#/components/schemas/RiskVersionDto' description: The list of Threshold Models and their versions used in the Entity Draft additionalProperties: false description: Dto to store the risk configuration models and versions used in the Entity Draft RelatedUnderlyingPrincipalOwnerDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false ManualCreditAssessmentV2DataSource: required: - creditAssessments type: object properties: dataSource: type: - string - 'null' readOnly: true creditAssessments: type: array items: $ref: '#/components/schemas/CreditAssessmentDto' additionalProperties: false RejectEntityDraftDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/RejectEntityDraftDto' description: Request DTO representing the entity risk data additionalProperties: false RelatedFCRsDataSource: required: - fcRs type: object properties: dataSource: type: - string - 'null' readOnly: true fcRs: type: array items: $ref: '#/components/schemas/RelatedFCRDto' additionalProperties: false AlertAssessmentDto: required: - category type: object properties: category: type: string additionalProperties: false AccountRelatedFundDto: required: - properties type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false ReviewAndApprovalDataSource: required: - reviewAndApprovals type: object properties: dataSource: type: - string - 'null' readOnly: true reviewAndApprovals: type: array items: $ref: '#/components/schemas/ReviewAndApprovalDto' additionalProperties: false CreditAssessmentDto: required: - properties - taskId type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona assessmentOutcome: type: - string - 'null' assessmentComment: type: - string - 'null' taskId: type: string taskDataKey: type: - string - 'null' additionalProperties: false RelatedDocumentDto: required: - document type: object properties: document: allOf: - $ref: '#/components/schemas/RelatedDocumentVersionedDto' additionalProperties: false CollateralDataSource: required: - collaterals type: object properties: dataSource: type: - string - 'null' readOnly: true collaterals: type: array items: $ref: '#/components/schemas/CollateralDto' additionalProperties: false RelatedDealDto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona additionalProperties: false RelatedAssociationDto: required: - properties type: object properties: associationType: type: - string - 'null' ownershipPercentage: type: - number - 'null' format: double associationToClient: type: - string - 'null' properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false AutoCreditAssessmentDto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona assessmentOutcome: type: - string - 'null' providerInternalIdentifier: type: - string - 'null' additionalProperties: false RelatedProductsDataSource: required: - products type: object properties: dataSource: type: - string - 'null' readOnly: true products: type: array items: $ref: '#/components/schemas/RelatedProductDto' additionalProperties: false AccountRelatedFundsDataSource: required: - accountRelatedFunds type: object properties: dataSource: type: - string - 'null' readOnly: true accountRelatedFunds: type: array items: $ref: '#/components/schemas/AccountRelatedFundDto' additionalProperties: false AccessLayerDetailsDto: type: object properties: dataKey: type: - string - 'null' description: Access layer data key example: Global inheritedFrom: uniqueItems: true type: - array - 'null' items: type: string format: uuid description: List of entity ids that access layer is inherited from isInherited: type: boolean description: Flag indicating if access layer is inherited by default additionalProperties: false CurrentProductDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona lifecycleStatus: type: - string - 'null' additionalProperties: false ManualCreditScreeningDataSource: required: - creditScreenings type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: array items: $ref: '#/components/schemas/ManualCreditScreeningDto' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PropertyType: enum: - Single - Custom - Collection type: string ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ManualUpdateGroupChildRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ManualUpdateGroupChildRequestDto' description: Request DTO Object for requesting a shared data template from the shared data template domain additionalProperties: false UpdateSharedDataTemplateRequestDto: type: object properties: sharedDataTemplateId: type: string description: The id for the shared data template to add to the entity format: uuid example: 4a833016-868a-4620-bb96-af2eeb3618ac versionNumber: type: integer description: The version number of the shared data template being currently used format: int32 additionalProperties: false DraftConflictDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/DraftConflictDto' description: Request DTO representing the conflict resolution data example: entityVersion: 4 pushChanges: true dataConflictResolutions: address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona firstName: type: Single value: John dateOfBirth: type: Single value: '2020-05-09' additionalProperties: false DraftConflictDto: type: object properties: entityVersion: type: - integer - 'null' description: Used to determine if passed draft is outdated format: int32 pushChanges: type: boolean description: If true updates the entity Draft when all conflicts are resolved example: true dataConflictResolutions: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona useSourceEntityVersion: type: boolean description: If true the draft's SourceEntityVersion will be used when determining if conflicts exist example: false additionalProperties: false description: Request DTO representing the conflict resolution data example: entityVersion: 4 pushChanges: true dataConflictResolutions: address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona firstName: type: Single value: John dateOfBirth: type: Single value: '2020-05-09' ManualUpdateGroupChildRequestDto: type: object properties: groupEntityId: type: string description: The group entity id format: uuid example: 4a833016-868a-4620-bb96-af2eeb3618ac childEntityId: type: string description: The child entity id format: uuid example: 4a833016-868a-4620-bb96-af2eeb3618ac childEntityDraftId: type: string description: The child entity draft Id format: uuid example: 4a833016-868a-4620-bb96-af2eeb3618ac journeyId: type: - string - 'null' description: The Id of the current Journey format: uuid example: 4a833016-868a-4620-bb96-af2eeb3618ac taskId: type: - string - 'null' description: The Id of the manual update task format: uuid example: 4a833012-868a-4620-bb96-af2eeb3618ac additionalProperties: false description: Request DTO Object for requesting a shared data template from the shared data template domain UpdateEntityDraftRequestV3Dto: type: object properties: riskVersions: allOf: - $ref: '#/components/schemas/RiskConfigurationVersionDto' description: List of Risk Configurations associated with EntityDraft jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: 'Collection of policy jurisdictions. Jurisdiction name and Id should be driven by the policy logic engine. Updating these attributes as part of an update to the entity draft can lead to a change in policy requirements, and should only be done once a wider assessment of the potential impacts to a journey is complete.' associatedJurisdictionsFromParents: type: - object - 'null' additionalProperties: uniqueItems: true type: - array - 'null' items: $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto' description: Jurisdictions associated from parents entityType: type: - string - 'null' description: The type of the entity example: Individual targetEntity: type: - string - 'null' description: Target Entity type (Client, Related Party) example: Client category: type: - array - 'null' items: type: string description: List of requirement category e.g. ["Basic Details", "Enrich Details"] journeyId: type: - string - 'null' description: 'Journey instance the save is occurring within. Supplied together with Fenergo.Nebula.EntityData.Command.Application.Features.UpdateEntityDraft.v3.UpdateEntityDraftRequestV3Dto.TaskId, this lets Policy re-fetch Related Products directly rather than trust the caller-supplied data source (see AB#537936 / AB#546876).' format: uuid taskId: type: - string - 'null' description: Task instance the save is occurring within. format: uuid properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43 collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Spain city: Madrid street: C. de Sevilla 93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2: properties: country: Spain city: Barcelona street: Carrer de Girona draftProperties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Draft Only properties dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation version: type: integer description: "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 additionalProperties: false UpdateEntityDraftRequestV3DtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateEntityDraftRequestV3Dto' additionalProperties: false UpdateSharedDataTemplateRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateSharedDataTemplateRequestDto' additionalProperties: false EntityRiskDto_2: type: object properties: riskCategory: type: - string - 'null' description: Risk category example: Low riskLevel: type: - number - 'null' description: Risk level format: double example: 1 additionalProperties: false description: Response DTO representing the entity risk data AccessLayerDto_2: type: object properties: geographic: type: - array - 'null' items: type: string description: Collection of geographic access layers businessRelated: type: - array - 'null' items: type: string description: Collection of business related access layers geographicDetails: type: - array - 'null' items: $ref: '#/components/schemas/AccessLayerDetailsDto' description: Collection of geographic access layers with details about inheritance businessRelatedDetails: type: - array - 'null' items: $ref: '#/components/schemas/AccessLayerDetailsDto' description: Collection of business related access layers with details about inheritance additionalProperties: false description: Response DTO representing associated access layers PropertyDto_2: 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' EntityRoleDto_2: type: object properties: name: type: - string - 'null' description: Role of the entity example: Client additionalProperties: false description: Response DTO representing the entity role data DataChangesDtoListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DataChangesDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data 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 - 'null' description: Parent draft Id format: uuid 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 - 'null' description: Entity draft type example: Individual properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Main entity draft properties draftProperties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Draft Only properties risk: allOf: - $ref: '#/components/schemas/EntityRiskDto_2' description: Entity draft risk role: allOf: - $ref: '#/components/schemas/EntityRoleDto_2' description: Entity draft role status: type: - string - 'null' description: Status example: InProgress created: type: - string - 'null' description: Created date format: date-time example: '2021-01-01T14:48:00.000Z' jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto_2' description: List of Jurisdictions associated with EntityDraft associatedJurisdictionsFromParents: type: - object - 'null' additionalProperties: type: - array - 'null' items: $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto_2' description: Jurisdictions associated from parents evaluatedJurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto_2' description: List of evaluated jurisdictions riskVersion: allOf: - $ref: '#/components/schemas/RiskConfigurationVersionDto' description: List of Risk Configurations associated with EntityDraft accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Entity access layers determining the access to the entity Draft 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 maskedProperties: allOf: - $ref: '#/components/schemas/MaskedPropertiesDto' description: Property name list of sensitive data requirements with masked value additionalProperties: false description: Response DTO representing entity draft data ServiceResponse_2: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data PropertyDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/PropertyDto_2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EntityDraftDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityDraftDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data GetParentJurisdictionsSnapshotDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/GetParentJurisdictionsSnapshotDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data 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 DataChangesDto: type: object properties: dataKey: type: - string - 'null' description: Property Datakey existingValue: allOf: - $ref: '#/components/schemas/PropertyDto_2' description: Existing value newValue: allOf: - $ref: '#/components/schemas/PropertyDto_2' description: New value changeType: type: - string - 'null' description: "Type of change \nOne of Add, Delete, Edit, Indentical" additionalProperties: false description: Class to represent data conflicts VersionedJurisdictionDto_2: type: object properties: jurisdiction: type: - string - 'null' description: Jurisdiction Name example: Global versionId: type: string description: Jurisdiction Version Id format: uuid example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65 additionalProperties: false EntityDraftDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EntityDraftDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValidationErrorModelListServiceResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response 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 StringServiceResponse_2: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ObjectServiceResponse_2: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValidationErrorModel_2: type: object properties: propertyName: type: - string - 'null' description: Name of the property example: data errorMessage: type: - string - 'null' description: User friendly error message example: Data is required attemptedValue: description: Invalid value errorCode: type: - string - 'null' description: Internal error code example: NotNullValidator additionalProperties: false description: Represents the details of validation error AssociatedVersionedJurisdictionDto_2: type: object properties: jurisdiction: type: - string - 'null' description: Jurisdiction Name 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 GetParentJurisdictionsSnapshotDto: type: object properties: associatedJurisdictionsFromParents: type: - object - 'null' additionalProperties: type: - array - 'null' items: $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto_2' description: List of Associated Jurisdictions From Parents hasAssociatedJurisdictionsChanged: type: boolean description: Information whether associated jurisdiction changed additionalProperties: false description: Request DTO representing entity jurisdictions snapshot for Parent Data Sync Task ServiceResponseMessage_2: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response EntityRiskDto_3: type: object properties: riskCategory: type: - string - 'null' description: Risk category example: Low riskLevel: type: - number - 'null' description: Risk level format: double example: 1 additionalProperties: false description: Response DTO representing the entity risk data EntityDraftPartialPropertiesItemDto: type: object properties: draftId: type: string description: Draft id. Always populated. format: uuid example: 8d631fde-505e-4101-a7cd-83ab6c054a5a type: type: - string - 'null' description: Draft type (e.g. Company, Individual, Group). Always populated. example: Company partialProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: 'The requested top-level `Properties` keys that exist on this draft, mapped to their full `PropertyDto` value. Requested keys absent from the draft are omitted. Always a non-null dictionary, empty when no requested key matches.' additionalProperties: false description: A single draft's identity plus the requested subset of its `Properties`. EntityDraftsIdsDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityDraftsIdsDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data SearchEntityDraftsDto: type: object properties: journeyId: type: string description: Journey id format: uuid example: e51b9087-7565-4d8d-864d-fa57177a8bea entityId: type: - string - 'null' description: Entity id format: uuid example: bb88430f-48ec-46de-92dc-905876e0e8eb deprecated: true entityIds: type: - array - 'null' items: type: string format: uuid description: Entity ids additionalProperties: false description: Request DTO representing entity drafts search criteria SimpleAccessLayerDto: type: object properties: geographic: type: - array - 'null' items: type: string description: Collection of geographic access layers businessRelated: type: - array - 'null' items: type: string description: Collection of business related access layers additionalProperties: false GetEntityDraftPartialPropertiesRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/GetEntityDraftPartialPropertiesRequestDto' description: The service request DTO additionalProperties: false description: Service request data GetEntityDraftNamesByIdsRequestDto: type: object properties: journeyId: type: string description: Journey id format: uuid example: e51b9087-7565-4d8d-864d-fa57177a8bea entityIds: type: - array - 'null' items: type: string format: uuid description: Entity ids to resolve names for additionalProperties: false description: Request DTO for `POST /entitydataquery/api/v2/entity/drafts/names`. AccessLayerDto_3: type: object properties: geographic: type: - array - 'null' items: type: string description: Collection of geographic access layers businessRelated: type: - array - 'null' items: type: string description: Collection of business related access layers geographicDetails: type: - array - 'null' items: $ref: '#/components/schemas/AccessLayerDetailsDto' description: Collection of geographic access layers with details about inheritance businessRelatedDetails: type: - array - 'null' items: $ref: '#/components/schemas/AccessLayerDetailsDto' description: Collection of business related access layers with details about inheritance additionalProperties: false description: Response DTO representing associated access layers PropertyDto_3: 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' EntityRoleDto_3: type: object properties: name: type: - string - 'null' description: Role of the entity example: Client additionalProperties: false description: Response DTO representing the entity role data SearchEntityDraftsV2Response: type: object properties: accessibleEntityDrafts: type: - array - 'null' items: $ref: '#/components/schemas/AuthorizedEntityDraftDto' description: List of entity drafts that the user has full access to inaccessibleEntityDrafts: type: - array - 'null' items: $ref: '#/components/schemas/UnauthorizedEntityDraftDto' description: List of entity drafts that the user has limited access to (only Search AL) forbiddenEntityDrafts: type: - array - 'null' items: $ref: '#/components/schemas/ForbiddenEntityDraftDto' description: List of entity draft ids that the user has no access to additionalProperties: false GetEntityDraftNamesByIdsResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/GetEntityDraftNamesByIdsResponse' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data SearchEntityDraftsDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/SearchEntityDraftsDto' description: The service request DTO additionalProperties: false description: Service request data SearchEntityDraftsV2ResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/SearchEntityDraftsV2Response' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DataChangesDtoListServiceResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DataChangesDto_2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EntityDraftDto_2: 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 - 'null' description: Parent draft Id format: uuid 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 - 'null' description: Entity draft type example: Individual properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Main entity draft properties draftProperties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Draft Only properties risk: allOf: - $ref: '#/components/schemas/EntityRiskDto_3' description: Entity draft risk role: allOf: - $ref: '#/components/schemas/EntityRoleDto_3' description: Entity draft role status: type: - string - 'null' description: Status example: InProgress created: type: - string - 'null' description: Created date format: date-time example: '2021-01-01T14:48:00.000Z' jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto_3' description: List of Jurisdictions associated with EntityDraft associatedJurisdictionsFromParents: type: - object - 'null' additionalProperties: type: - array - 'null' items: $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto_3' description: Jurisdictions associated from parents evaluatedJurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto_3' description: List of evaluated jurisdictions riskVersion: allOf: - $ref: '#/components/schemas/RiskConfigurationVersionDto' description: List of Risk Configurations associated with EntityDraft accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_3' description: Entity access layers determining the access to the entity Draft 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 maskedProperties: allOf: - $ref: '#/components/schemas/MaskedPropertiesDto' description: Property name list of sensitive data requirements with masked value additionalProperties: false description: Response DTO representing entity draft data EntityDraftPartialPropertiesResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityDraftPartialPropertiesResponse' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ServiceResponse_3: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data GetEntityDraftNamesByIdsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/GetEntityDraftNamesByIdsRequestDto' description: The service request DTO additionalProperties: false description: Service request data EntityDraftsIdsDto: type: object properties: items: type: - array - 'null' items: type: string format: uuid additionalProperties: false EntityDraftPartialPropertiesResponse: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/EntityDraftPartialPropertiesItemDto' description: One entry per accessible, existing requested draft. additionalProperties: false description: 'Response for `POST /entitydataquery/api/v2/entity/drafts/partial-properties`. Only accessible drafts are returned; missing and inaccessible drafts are silently omitted. Order is not guaranteed — callers key results by `DraftId`.' PropertyDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/PropertyDto_3' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ForbiddenEntityDraftDto: 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 additionalProperties: false description: Response DTO representing of entity draft that the user has no access to EntityDraftDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityDraftDto_2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data UnauthorizedEntityDraftDto: 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 name: type: - string - 'null' description: Name of the entity accessLayers: allOf: - $ref: '#/components/schemas/SimpleAccessLayerDto' description: Entity access layers determining the access to the entity 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 journeyId: type: string description: Journey id format: uuid example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65 type: type: - string - 'null' description: Entity draft type example: Individual status: type: - string - 'null' description: Status example: InProgress created: type: - string - 'null' description: Created date format: date-time example: '2021-01-01T14:48:00.000Z' version: type: integer description: Version number for given EntityDraft format: int32 example: 1 additionalProperties: false description: Response DTO for an entity draft, accessible to the user with limited permissions (Search AL only) GetParentJurisdictionsSnapshotDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/GetParentJurisdictionsSnapshotDto_2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DataChangesDto_2: type: object properties: dataKey: type: - string - 'null' description: Property Datakey existingValue: allOf: - $ref: '#/components/schemas/PropertyDto_3' description: Existing value newValue: allOf: - $ref: '#/components/schemas/PropertyDto_3' description: New value changeType: type: - string - 'null' description: "Type of change \nOne of Add, Delete, Edit, Indentical" additionalProperties: false description: Class to represent data conflicts VersionedJurisdictionDto_3: type: object properties: jurisdiction: type: - string - 'null' description: Jurisdiction Name example: Global versionId: type: string description: Jurisdiction Version Id format: uuid example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65 additionalProperties: false GetEntityDraftNamesByIdsResponse: type: object properties: entityDraftNames: type: - array - 'null' items: $ref: '#/components/schemas/EntityDraftNamesByIdsDto' description: 'Names for the requested entity IDs. Each row is sourced from either the journey draft (preferred — `EntityDraftId` populated) or the verified entity record (fallback — `EntityDraftId` null). Order is not guaranteed.' additionalProperties: false description: 'Response for `POST /entitydataquery/api/v2/entity/drafts/names`. Each row is the in-journey identity of the requested entity: the journey''s draft when one exists (with `EntityDraftId` populated), falling back to the verified entity record otherwise (with `EntityDraftId` null). Only accessible records are returned; inaccessible and forbidden records are silently dropped.' EntityDraftNamesByIdsDto: type: object properties: entityId: type: string description: Entity id (the canonical entity this row describes). format: uuid example: bb88430f-48ec-46de-92dc-905876e0e8eb entityDraftId: type: - string - 'null' description: 'Draft id when this row was sourced from an in-journey draft; `null` when sourced from the verified entity record (fallback path).' format: uuid example: 8d631fde-505e-4101-a7cd-83ab6c054a5a type: type: - string - 'null' description: Entity type (e.g. Company, Individual, Group). example: Company name: type: - string - 'null' description: 'Display name derived from the type-specific name properties (Company/Other → legalEntityName, Individual → firstName + lastName, Group → groupName). Empty string when the source has no usable name properties.' example: Acme Corp version: type: integer description: Aggregate version. Surfaced as `aggregateVersion` on the UI side. format: int32 example: 3 additionalProperties: false description: 'Lightweight summary of an entity or its in-journey draft. Carries the minimal identity fields a UI needs to render the entity (id, display name, type, aggregate version).' ObjectServiceResponse_3: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data StringServiceResponse_3: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValidationErrorModelListServiceResponse_3: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_3' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response 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 ValidationErrorModel_3: type: object properties: propertyName: type: - string - 'null' description: Name of the property example: data errorMessage: type: - string - 'null' description: User friendly error message example: Data is required attemptedValue: description: Invalid value errorCode: type: - string - 'null' description: Internal error code example: NotNullValidator additionalProperties: false description: Represents the details of validation error AssociatedVersionedJurisdictionDto_3: type: object properties: jurisdiction: type: - string - 'null' description: Jurisdiction Name 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 GetParentJurisdictionsSnapshotDto_2: type: object properties: associatedJurisdictionsFromParents: type: - object - 'null' additionalProperties: type: - array - 'null' items: $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto_3' description: List of Associated Jurisdictions From Parents hasAssociatedJurisdictionsChanged: type: boolean description: Information whether associated jurisdiction changed additionalProperties: false description: Request DTO representing entity jurisdictions snapshot for Parent Data Sync Task ServiceResponseMessage_3: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response GetEntityDraftPartialPropertiesRequestDto: type: object properties: draftIds: type: - array - 'null' items: type: string format: uuid description: Draft ids to retrieve partial properties for. At most 10 per request. requestedPropertiesDataKeys: type: - array - 'null' items: type: string description: 'Top-level `Properties` keys to include in the response for each draft. When null or empty, no properties are returned for any draft.' additionalProperties: false description: Request DTO for `POST /entitydataquery/api/v2/entity/drafts/partial-properties`. AuthorizedEntityDraftDto: 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 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 - 'null' description: Entity draft type example: Individual properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Main entity draft properties risk: allOf: - $ref: '#/components/schemas/EntityRiskDto_3' description: Entity draft risk role: allOf: - $ref: '#/components/schemas/EntityRoleDto_3' description: Entity draft role status: type: - string - 'null' description: Status example: InProgress created: type: - string - 'null' description: Created date format: date-time example: '2021-01-01T14:48:00.000Z' jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto_3' description: List of Jurisdictions associated with EntityDraft associatedJurisdictionsFromParents: type: - object - 'null' additionalProperties: type: - array - 'null' items: $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto_3' description: Jurisdictions associated from parents evaluatedJurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto_3' description: List of evaluated jurisdictions riskVersion: allOf: - $ref: '#/components/schemas/RiskConfigurationVersionDto' description: List of Risk Configurations associated with EntityDraft accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_3' description: Entity access layers determining the access to the entity Draft 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 maskedProperties: allOf: - $ref: '#/components/schemas/MaskedPropertiesDto' description: Property name list of sensitive data requirements with masked value additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-entitydatacommand-v1-0-openapi.json - fenergo-entitydatacommand-v2-0-openapi.json - fenergo-entitydatacommand-v3-0-openapi.json - fenergo-entitydataquery-v1-0-openapi.json - fenergo-entitydataquery-v2-0-openapi.json