{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Association Command", "description": "**Association Command API**:


Association Command API provides endpoints in order to manage and configure all entity associations.


**Association Command API provides**:
", "version": "2.0" }, "servers": [ { "url": "/associationcommand" } ], "paths": { "/api/v2/association/verify/{id}/journeyId/{journeyId}": { "put": { "summary": "Verify a single association", "description": "\nThis method will make a single Association verified

Required permissions:
Following permissions are required: AssociationVerification", "operationId": "VerifyAssociation", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the Association to verify", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "Current Journey, Journey 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": { "202": { "description": "Association model verified successfully" }, "400": { "description": "Validation or permission error occured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/association/{id}/journeyId/{journeyId}": { "delete": { "summary": "Permanently delete an existing unverified Association", "description": "\nThis method will delete an existing unverified Association model.

Required permissions:
At least one of the following permissions is required: AssociationDeleteOnly, AssociationEditAndPartialDelete, AssociationEdit, EntityGroupManagementEdit", "operationId": "DeleteAssociation", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to delete", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "Current Journey, Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "rootEntityId", "in": "query", "description": "Related party root entity id", "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": { "202": { "description": "Association model deleted successfully" }, "400": { "description": "Bad Request", "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", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "put": { "summary": "Restore a soft deleted Association", "description": "\nThis method will restore a soft deleted Association

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationDeleteOnly", "operationId": "RestoreSoftDeletedAssociation", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to restore", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The Id of the journey where it was marked for deletion", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.RestoreSoftDeleteAssociationDto to restore and modify association", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RestoreSoftDeleteAssociationDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Association model restored successfully" }, "400": { "description": "Bad Request", "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", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/association/createAssociations": { "post": { "summary": "Create new Entity Associations", "description": "\nThis method will create new Association models.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, EntityGroupManagementEdit, AssociationEditAndLinkOnly", "operationId": "CreateAssociations", "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": "ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.CreateAssociationsDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAssociationsDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Valid associations models created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssociationsResultDtoServiceResponse" } } } }, "400": { "description": "Validation or permission error occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/association": { "post": { "tags": [ "Association" ], "summary": "Create new Entity Association", "description": "\nThis method will create a new Association model.\n The new model will initialize with the DTO data.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, EntityGroupManagementEdit, AssociationEditAndLinkOnly", "operationId": "CreateAssociation", "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": "ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.AssociationDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AssociationDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Association model created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociationDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/association/{id}": { "put": { "tags": [ "Association" ], "summary": "Update an existing unverified association", "description": "\nThis method will update an existing unverified Association\n with the data contained in the request DTO.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, EntityGroupManagementEdit, AssociationEditAndLinkOnly", "operationId": "UpdateAssociation", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing unverified Association to update", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the updated Fenergo.Nebula.Association.Command.Application.Dto.AssociationDto", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AssociationDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Association model updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociationDtoServiceResponse" } } } }, "400": { "description": "Model Id is invalid", "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", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/association/verifyAll/entityId/{entityId}/journeyId/{journeyId}": { "put": { "tags": [ "Association" ], "summary": "Verify all associations in a journey", "description": "\nThis method will verify all of the associations the entity has in the given journey

Required permissions:
Following permissions are required: AssociationVerification", "operationId": "VerifyAllAssociations", "parameters": [ { "name": "entityId", "in": "path", "description": "The Id of the root entity", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The Id of the journey the associations to verify belong to", "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": { "202": { "description": "All association models have been verified successfully" }, "400": { "description": "Validation or permission error occured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/association/verifyAllGroupManagement/entityId/{entityId}/journeyId/{journeyId}": { "put": { "tags": [ "Association" ], "summary": "Verify all group management associations in a journey", "description": "\nThis method will verify all of the group management associations the entity has in the given journey

Required permissions:
Following permissions are required: AssociationVerification", "operationId": "VerifyAllGroupManagementAssociations", "parameters": [ { "name": "entityId", "in": "path", "description": "The Id of the root entity", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The Id of the journey the associations to verify belong to", "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": { "202": { "description": "All association models have been verified successfully" }, "400": { "description": "Validation or permission error occured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/association/{id}/{journeyId}": { "delete": { "tags": [ "Association" ], "summary": "Mark a verified Association for deletion", "description": "\nThis method will mark a verified Association model for deletion.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationDeleteOnly, EntityGroupManagementEdit", "operationId": "DeleteVerifiedAssociation", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to delete", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The Id of the journey which requested the deletion", "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": { "202": { "description": "Association model deleted successfully" }, "400": { "description": "Bad Request", "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", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/association/resolveConflict/{id}": { "put": { "tags": [ "Association" ], "summary": "Resolve detected association conflict", "description": "\nThis method resolves a detected association conflict by accepting the merge \n result data and the invalid association that needs to be removed.

Required permissions:
Following permissions are required: AssociationVerification", "operationId": "ResolveConflict", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing Association to update", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the updated Fenergo.Nebula.Association.Command.Application.Dto.ConflictResolutionDto", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConflictResolutionDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Association conflicts merged successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResolutionDtoServiceResponse" } } } }, "400": { "description": "Association Id is invalid", "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", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/entity/{id}": { "put": { "tags": [ "Entity" ], "summary": "Update an existing entity", "description": "\nThis method will update the metadata of an existing Entity\n with the data contained in the request DTO.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, EntityGroupManagementEdit, AssociationEditAndLinkOnly", "operationId": "UpdateEntity", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing Entity to update", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the updated Fenergo.Nebula.Association.EntityCommand.Application.Dto.EntityDto", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Entity model updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDtoServiceResponse" } } } }, "400": { "description": "Model Id is invalid", "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", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/unwrapping-requirement-status": { "post": { "tags": [ "UnwrappingRequirementStatus" ], "summary": "Create new Unwrapping Requirement Status Model", "description": "\nThis method will create a new Unwrapping Requirement Status Model\n The new model will initialize with the DTO data.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly", "operationId": "CreateUnwrappingRequirementStatusModel", "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": "ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.CreateUnwrapReqStatusRequestDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUnwrapReqStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Unwrapping Requirement Model created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnwrappingRequirementStatusModelResponseDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/unwrapping-requirement-status/create-single-status": { "post": { "tags": [ "UnwrappingRequirementStatus" ], "summary": "Create single Unwrapping Requirement Status.", "description": "\nThis method will create a new Unwrapping Requirement Status\n The new model will initialize with the DTO data.\n\nParent model will be created if it has not been created already.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly", "operationId": "CreateSingleUnwrappingRequirementStatusModel", "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": "ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.CreateUnwrapReqStatusRequestDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSingleUnwrappingRequirementStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Unwrapping Requirement Status created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnwrappingRequirementStatusModelResponseDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/unwrapping-requirement-status/{id}": { "put": { "tags": [ "UnwrappingRequirementStatus" ], "summary": "Update existing Unwrapping Requirement Status Model.", "description": "\nThis method will update an existing Unwrapping Requirement Status Model\n The model will be updated with the DTO data.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly", "operationId": "UpdateUnwrappingRequirementStatusModel", "parameters": [ { "name": "id", "in": "path", "description": "The identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.SingleUnwrapReqStatusRequestDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateUnwrapReqStatusModelRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Unwrapping Requirement Model created successfully" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/unwrapping-requirement-status/update-single-status/{id}": { "put": { "tags": [ "UnwrappingRequirementStatus" ], "summary": "Update single Unwrapping Requirement Status.", "description": "\nThis method will update a single Unwrapping Requirement Status.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly", "operationId": "UpdateSingleUnwrappingRequirementStatusModel", "parameters": [ { "name": "id", "in": "path", "description": "The identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.SingleUnwrapReqStatusRequestDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingleUnwrapReqStatusRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Unwrapping Requirement Model created successfully" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/unwrapping-requirement-status/measure-completeness": { "post": { "tags": [ "UnwrappingRequirementStatus" ], "summary": "Measures the completeness of Ownership and Control Unwrapping requirements", "description": "

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly, AssociationAccess", "operationId": "MeasureCompleteness", "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": "ServiceRequest with the Fenergo.Nebula.Association.MeasureCompleteness.Dto.MeasureCompletenessRequestDto data used in the calculation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MeasureCompletenessRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Unwrapping Requirements successfully evaluated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasureCompletenessResponseDtoServiceResponse" } } } }, "400": { "description": "Validation or permission error occured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/v2/unwrapping-requirement-status/measure-completeness/initiate": { "post": { "tags": [ "UnwrappingRequirementStatus" ], "summary": "Starts an asynchronous measure-completeness calculation and returns immediately", "description": "\nCreates a BusinessProcess, publishes a service-task event to start the state machine, and returns\n the business process id. Poll `GET /api/association-business-process/{businessProcessId}` for the\n result. Each call starts an independent calculation with its own id; there is no server-side\n superseding, so a second call for the same journey and entity does not affect the first. Concurrent\n runs are last-writer-wins on the domain model, and the UI collapses duplicate triggers client-side.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly, AssociationAccess", "operationId": "InitiateMeasureCompleteness", "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": "ServiceRequest with the Fenergo.Nebula.Association.MeasureCompleteness.Dto.MeasureCompletenessRequestDto data used in the calculation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MeasureCompletenessRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Calculation successfully started", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateMeasureCompletenessResponseDtoServiceResponse" } } } }, "400": { "description": "Validation or permission error occured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AssociationDto": { "required": [ "journeyId", "sourceId", "targetId", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the association model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "sourceId": { "minLength": 1, "type": "string", "description": "The UiD of the Parent Entity", "format": "uuid", "example": "2920b7a7-7336-4fb1-82b7-1d691b8367fa" }, "targetId": { "minLength": 1, "type": "string", "description": "The UiD of the Child Entity", "format": "uuid", "example": "6b399cff-6e35-42a0-aaf0-69a94a008636" }, "rootEntityId": { "type": "string", "description": "The UiD of the Root Entity Id", "format": "uuid", "nullable": true, "example": "6b399cff-6e35-42a0-aaf0-69a94a008636" }, "type": { "minLength": 1, "type": "string", "description": "The type of association", "example": "Shareholder" }, "journeyId": { "minLength": 1, "type": "string", "description": "The UiD of the Journey that this association was created", "format": "uuid", "example": "4a056330-18d2-4ec1-8b1e-c959ed4b5f12" }, "isVerified": { "type": "boolean", "description": "Annotates whether the association has been validated", "example": true }, "ownershipPercentage": { "type": "number", "description": "The percentage amount of the target entity owned by the source entity\n(optional)", "format": "double", "example": 5.007 }, "controlPercentage": { "type": "number", "description": "The percentage amount of the target entity controlled by the source entity\n(optional)", "format": "double", "example": 23.4 }, "originalAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationSubsetDto" }, "description": "A list of Associations deleted\n(optional)", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "A list of custom properties that describe the association", "nullable": true } }, "additionalProperties": false, "description": "The metadata of an association between two entities" }, "AssociationDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssociationDto" } ], "description": "The metadata of an association between two entities", "nullable": true } }, "additionalProperties": false }, "AssociationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssociationDto" } ], "description": "The metadata of an association between two entities", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AssociationSubsetDto": { "type": "object", "properties": { "associationId": { "type": "string", "description": "The UiD of the association model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "type": { "type": "string", "description": "The type of association", "nullable": true, "example": "Shareholder" } }, "additionalProperties": false, "description": "The metadata of an association between two entities" }, "ConflictResolutionDto": { "type": "object", "properties": { "mergeResult": { "allOf": [ { "$ref": "#/components/schemas/AssociationDto" } ], "description": "The resulting merged association", "nullable": true }, "invalidAssociation": { "type": "string", "description": "The UiD of the invalid association model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" } }, "additionalProperties": false, "description": "Resolve Association conflict wrapper" }, "ConflictResolutionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ConflictResolutionDto" } ], "description": "Resolve Association conflict wrapper", "nullable": true } }, "additionalProperties": false }, "ConflictResolutionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ConflictResolutionDto" } ], "description": "Resolve Association conflict wrapper", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateAssociationDto": { "type": "object", "properties": { "requestId": { "type": "string", "nullable": true }, "association": { "allOf": [ { "$ref": "#/components/schemas/AssociationDto" } ], "description": "The metadata of an association between two entities", "nullable": true } }, "additionalProperties": false }, "CreateAssociationResultDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "requestId": { "type": "string", "nullable": true }, "association": { "allOf": [ { "$ref": "#/components/schemas/AssociationDto" } ], "description": "The metadata of an association between two entities", "nullable": true }, "isSuccess": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CreateAssociationsDto": { "type": "object", "properties": { "associations": { "type": "array", "items": { "$ref": "#/components/schemas/CreateAssociationDto" }, "nullable": true } }, "additionalProperties": false }, "CreateAssociationsDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateAssociationsDto" } ], "nullable": true } }, "additionalProperties": false }, "CreateAssociationsResultDto": { "type": "object", "properties": { "associationsResults": { "type": "array", "items": { "$ref": "#/components/schemas/CreateAssociationResultDto" }, "nullable": true } }, "additionalProperties": false }, "CreateAssociationsResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateAssociationsResultDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateSingleUnwrappingRequirementStatusRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "The Id of the Entity", "format": "uuid", "example": "18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba" }, "journeyId": { "type": "string", "description": "The Id of the Journey", "format": "uuid", "example": "088f2d94-f2e1-4afb-b908-498a76ebf771" }, "status": { "allOf": [ { "$ref": "#/components/schemas/SingleUnwrapReqStatusRequestDto" } ], "description": "Contains the data for updating an Unwrapping Requirement Status", "nullable": true } }, "additionalProperties": false, "description": "Contains all the information needed to store the status of the Unwrapping Requirement" }, "CreateSingleUnwrappingRequirementStatusRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateSingleUnwrappingRequirementStatusRequestDto" } ], "description": "Contains all the information needed to store the status of the Unwrapping Requirement", "nullable": true } }, "additionalProperties": false }, "CreateUnwrapReqStatusRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "The Id of the Entity", "format": "uuid", "example": "18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba" }, "journeyId": { "type": "string", "description": "The Id of the Journey", "format": "uuid", "example": "088f2d94-f2e1-4afb-b908-498a76ebf771" }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/SingleUnwrapReqStatusRequestDto" }, "description": "The statuses of the unwrapping requirements", "nullable": true } }, "additionalProperties": false, "description": "Contains all the information needed to store the status of the Unwrapping Requirement" }, "CreateUnwrapReqStatusRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateUnwrapReqStatusRequestDto" } ], "description": "Contains all the information needed to store the status of the Unwrapping Requirement", "nullable": true } }, "additionalProperties": false }, "EntityDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EntityDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityDto" } ], "nullable": true } }, "additionalProperties": false }, "EntityDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "HttpValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } } ] }, "InitiateMeasureCompletenessResponseDto": { "type": "object", "properties": { "businessProcessId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "InitiateMeasureCompletenessResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/InitiateMeasureCompletenessResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "MeasureCompletenessRequestDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "entityDraftId": { "type": "string", "format": "uuid" }, "productDraftId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "MeasureCompletenessRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MeasureCompletenessRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "MeasureCompletenessResponseDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "journeyId": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/MeasureCompletenessStatusResponse" }, "nullable": true } }, "additionalProperties": false }, "MeasureCompletenessResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MeasureCompletenessResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "MeasureCompletenessStatusResponse": { "type": "object", "properties": { "requirementId": { "type": "string", "nullable": true }, "requirementName": { "type": "string", "nullable": true }, "idvName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "ownershipAndControlDataKey": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "minimumPartyCount": { "type": "integer", "format": "int32", "nullable": true }, "addAllParties": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "RestoreSoftDeleteAssociationDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "A list of custom properties that describe the association", "nullable": true } }, "additionalProperties": false }, "RestoreSoftDeleteAssociationDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RestoreSoftDeleteAssociationDto" } ], "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SingleUnwrapReqStatusRequestDto": { "required": [ "requirementId" ], "type": "object", "properties": { "requirementId": { "minLength": 1, "type": "string", "description": "The Id of the Requirement", "format": "uuid", "example": "580565ee-0700-4aec-854d-8cc9dbb58bc1" }, "status": { "type": "string", "description": "The status of the Unwrapping Requirement", "nullable": true, "example": "Completed" }, "ownershipAndControlDataKey": { "type": "string", "description": "The DataKey of the Requirement", "nullable": true, "example": "addAllUBOs" }, "requirementName": { "type": "string", "description": "The Name of the Requirement", "nullable": true, "example": "Add All UBOs" }, "idvName": { "type": "string", "description": "The name of the Idv Requirement", "nullable": true, "example": "Add 2 Directors" }, "minimumPartyCount": { "type": "integer", "description": "The Minimum Party Count needed to validate the Requirement", "format": "int32", "nullable": true, "example": 2 }, "addAllParties": { "type": "boolean", "description": "The attribute which specified if all Related Parties which meet the criteria are to be added", "nullable": true, "example": false }, "overrideReason": { "type": "string", "description": "Optional reviewer-supplied reason for reopening this requirement (transitioning back to InProgress).", "nullable": true, "example": "Missing supporting documentation for the previously accepted unwrap." } }, "additionalProperties": false, "description": "Contains the data for updating an Unwrapping Requirement Status" }, "SingleUnwrapReqStatusRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SingleUnwrapReqStatusRequestDto" } ], "description": "Contains the data for updating an Unwrapping Requirement Status", "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UnwrappingRequirementStatusModelResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the model", "format": "uuid", "example": "088f2d94-f2e1-4afb-b908-498a76ebf771" }, "entityId": { "type": "string", "description": "The Id of the Entity", "format": "uuid", "example": "18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba" }, "journeyId": { "type": "string", "description": "The Id of the Journey", "format": "uuid", "example": "088f2d94-f2e1-4afb-b908-498a76ebf771" }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/UnwrappingRequirementStatusResponseDto" }, "description": "The statuses of the unwrapping requirements", "nullable": true } }, "additionalProperties": false, "description": "Contains all the information needed to store the status of the Unwrapping Requirement" }, "UnwrappingRequirementStatusModelResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UnwrappingRequirementStatusModelResponseDto" } ], "description": "Contains all the information needed to store the status of the Unwrapping Requirement", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UnwrappingRequirementStatusResponseDto": { "type": "object", "properties": { "requirementId": { "type": "string", "description": "The Id of the Requirement", "format": "uuid", "example": "580565ee-0700-4aec-854d-8cc9dbb58bc1" }, "status": { "type": "string", "description": "The Status of the Unwrapping Requirement", "nullable": true, "example": "Completed" }, "ownershipAndControlDataKey": { "type": "string", "description": "The DataKey of the Requirement", "nullable": true, "example": "addAllUBOs" }, "completedDate": { "type": "string", "description": "The date when the Requirement was set to 'Completed'", "format": "date-time", "nullable": true, "example": null }, "requirementName": { "type": "string", "description": "The Name of the Requirement", "nullable": true, "example": "Add All UBOs" }, "idvName": { "type": "string", "description": "The name of the Idv Requirement", "nullable": true, "example": "Add 2 Directors" }, "minimumPartyCount": { "type": "integer", "description": "The Minimum Party Count needed to validate the Requirement", "format": "int32", "nullable": true, "example": 2 }, "addAllParties": { "type": "boolean", "description": "The attribute which specified if all Related Parties which meet the criteria are to be added", "nullable": true, "example": false } }, "additionalProperties": false, "description": "Contains all the information needed to store the status of the Unwrapping Requirement" }, "UpdateUnwrapReqStatusModelRequestDto": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/SingleUnwrapReqStatusRequestDto" }, "description": "The statuses of the unwrapping requirements", "nullable": true } }, "additionalProperties": false, "description": "Contains the information needed to update the status of the Unwrapping Requirement" }, "UpdateUnwrapReqStatusModelRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateUnwrapReqStatusModelRequestDto" } ], "description": "Contains the information needed to update the status of the Unwrapping Requirement", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }