openapi: 3.2.0 info: title: Fenergo Association API version: '1.0' description: 'Operations tagged Association across 6 of this provider''s published API definitions: fenergo-associationcommand-v1-0-openapi.json, fenergo-associationcommand-v2-0-openapi.json, fenergo-associationquery-v1-0-openapi.json, fenergo-externaloutreachcommand-v1-0-openapi.json, fenergo-externaloutreachcommand-v2-0-openapi.json, fenergo-externaloutreachquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /associationcommand - url: /associationquery - url: /externaloutreachcommand - url: /externaloutreachquery security: - Bearer: [] tags: - name: Association paths: /api/association: post: tags: - Association summary: Create new Entity Association description: 'This method will create a new Association model. 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 servers: - url: /associationcommand /api/association/{id}: put: tags: - Association summary: Update an existing unverified association description: 'This method will update an existing unverified Association 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 delete: tags: - Association summary: Permanently delete an existing unverified Association description: 'This method will delete an existing unverified Association model. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationDeleteOnly, 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: 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 get: tags: - Association summary: Get an existing Association description: 'This method returns the association for a given tenant and id Required permissions: At least one of the following permissions is required: AssociationAccess, EntityGroupManagementAccessAndSearch' operationId: GetAssociationById parameters: - name: id in: path description: Association identifier 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoServiceResponse' '400': description: Invalid 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: No association found type: Error errorCode: Error Code '500': description: An exception occurred while processing the query '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 servers: - url: /associationcommand /api/association/verify/{id}: put: tags: - Association summary: Verify a single association description: 'This 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: 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 servers: - url: /associationcommand /api/association/verifyAll/entityId/{entityId}/journeyId/{journeyId}: put: tags: - Association summary: Verify all associations in a journey description: 'This 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 servers: - url: /associationcommand /api/association/verifyAllGroupManagement/entityId/{entityId}/journeyId/{journeyId}: put: tags: - Association summary: Verify all group management associations in a journey description: 'This 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 servers: - url: /associationcommand /api/association/{id}/{journeyId}: delete: tags: - Association summary: Mark a verified Association for deletion description: 'This 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 servers: - url: /associationcommand /api/association/{id}/journeyId/{journeyId}: put: tags: - Association summary: Restore a soft deleted Association description: 'This 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 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 servers: - url: /associationcommand /api/association/resolveConflict/{id}: put: tags: - Association summary: Resolve detected association conflict description: 'This method resolves a detected association conflict by accepting the merge 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 servers: - url: /associationcommand /api/v2/association/verify/{id}/journeyId/{journeyId}: put: summary: Verify a single association description: 'This method will make a single Association verified Required permissions: Following permissions are required: AssociationVerification' operationId: putApiV2AssociationVerifyByIdJourneyIdByJourneyId 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 tags: - Association x-operation-id-source: normalized x-operation-id-original: VerifyAssociation servers: - url: /associationcommand /api/v2/association/{id}/journeyId/{journeyId}: delete: summary: Permanently delete an existing unverified Association description: 'This method will delete an existing unverified Association model. Required permissions: At least one of the following permissions is required: AssociationDeleteOnly, AssociationEditAndPartialDelete, AssociationEdit, EntityGroupManagementEdit' operationId: deleteApiV2AssociationByIdJourneyIdByJourneyId 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 tags: - Association x-operation-id-source: normalized x-operation-id-original: DeleteAssociation put: summary: Restore a soft deleted Association description: 'This method will restore a soft deleted Association Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationDeleteOnly' operationId: putApiV2AssociationByIdJourneyIdByJourneyId 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 tags: - Association x-operation-id-source: normalized x-operation-id-original: RestoreSoftDeletedAssociation servers: - url: /associationcommand /api/v2/association/createAssociations: post: summary: Create new Entity Associations description: 'This 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 tags: - Association servers: - url: /associationcommand /api/v2/association: post: tags: - Association summary: Create new Entity Association description: 'This method will create a new Association model. 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: postApiV2Association 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 x-operation-id-source: normalized x-operation-id-original: CreateAssociation servers: - url: /associationcommand /api/v2/association/{id}: put: tags: - Association summary: Update an existing unverified association description: 'This method will update an existing unverified Association 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: putApiV2AssociationById 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 x-operation-id-source: normalized x-operation-id-original: UpdateAssociation servers: - url: /associationcommand /api/v2/association/verifyAll/entityId/{entityId}/journeyId/{journeyId}: put: tags: - Association summary: Verify all associations in a journey description: 'This method will verify all of the associations the entity has in the given journey Required permissions: Following permissions are required: AssociationVerification' operationId: putApiV2AssociationVerifyAllEntityIdByEntityIdJourneyIdByJourneyId 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 x-operation-id-source: normalized x-operation-id-original: VerifyAllAssociations servers: - url: /associationcommand /api/v2/association/verifyAllGroupManagement/entityId/{entityId}/journeyId/{journeyId}: put: tags: - Association summary: Verify all group management associations in a journey description: 'This method will verify all of the group management associations the entity has in the given journey Required permissions: Following permissions are required: AssociationVerification' operationId: putApiV2AssociationVerifyAllGroupManagementEntityIdByEntityIdJourneyIdByJourneyId 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 x-operation-id-source: normalized x-operation-id-original: VerifyAllGroupManagementAssociations servers: - url: /associationcommand /api/v2/association/{id}/{journeyId}: delete: tags: - Association summary: Mark a verified Association for deletion description: 'This 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: deleteApiV2AssociationByIdByJourneyId 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 x-operation-id-source: normalized x-operation-id-original: DeleteVerifiedAssociation servers: - url: /associationcommand /api/v2/association/resolveConflict/{id}: put: tags: - Association summary: Resolve detected association conflict description: 'This method resolves a detected association conflict by accepting the merge result data and the invalid association that needs to be removed. Required permissions: Following permissions are required: AssociationVerification' operationId: putApiV2AssociationResolveConflictById 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 x-operation-id-source: normalized x-operation-id-original: ResolveConflict servers: - url: /associationcommand /api/association/root/{EntityId}/journey/{JourneyId}: get: tags: - Association summary: Get all Associations by Root Entity Id and Journey Id description: 'This method returns a list of associations for a given root entity and journey The response is limited to ten thousand associations Required permissions: Following permissions are required: AssociationAccess' operationId: GetAssociations parameters: - name: EntityId in: path description: The UiD of the root entity required: true schema: minLength: 1 type: string description: The UiD of the root entity - name: JourneyId in: path description: The UiD of a journey that the associations belong to required: true schema: minLength: 1 type: string description: The UiD of a journey that the associations belong to - 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/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{entityId}: get: tags: - Association summary: Get all verified Associations by Root Entity Id description: 'This method returns a list of verified associations for a given root entity The response is limited to ten thousand associations Required permissions: Following permissions are required: AssociationAccess' operationId: GetVerifiedAssociations parameters: - name: entityId in: path description: The id of the root entity required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/outbound/root/{entityId}: get: tags: - Association summary: Get all verified outbound Associations by Root Entity Id description: 'This method returns a list of verified outbound associations for a given root entity The response is limited to ten thousand associations Required permissions: Following permissions are required: AssociationAccess' operationId: GetVerifiedOutboundAssociations parameters: - name: entityId in: path description: The id of the root entity required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/hierarchy/children/paged: post: tags: - Association summary: Get a page of an entity's direct children in the entity-ownership hierarchy description: 'Returns a single page of the direct children of the given entity, ordered by a stable internal key (not creation time or any other client-meaningful order). This one endpoint serves the first render of the root entity''s children, a Branch Card drill-in into any other node''s children, and continuation paging for a node whose children have already been partially shown - all three are simply a call against the relevant entityId, with or without a paginationToken carried over from a previous response. Takes its parameters as a JSON request body (replacing a previous GET/query-string version of this endpoint) so further parameters (e.g. taskId, a stable rootEntityId/parentEntityId pair) can be added without another breaking change to the query string. Required permissions: Following permissions are required: AssociationAccess' operationId: GetEntityChildrenPage 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: The request body - see Fenergo.Nebula.Association.Query.Application.Dto.GetEntityChildrenPageRequestDto. content: application/json: schema: allOf: - $ref: '#/components/schemas/GetEntityChildrenPageRequestDtoServiceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ChildrenPageDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{EntityId}/journey/{JourneyId}/conflicts: get: tags: - Association summary: Get all Association Conflicts by Root Entity Id and Journey Id description: 'This method returns a list of association conflicts for a given root entity and journey Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly' operationId: GetAssociationConflicts parameters: - name: EntityId in: path description: The UiD of the root entity required: true schema: type: string - name: JourneyId in: path description: The UiD of a journey that the associations belong to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationConflictDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{EntityId}/journey/{JourneyId}/product: get: tags: - Association summary: Get all product Associations by Root Journey Id and Entity Id description: This method returns a product associations list for a given root entity and journey operationId: GetProductAssociations parameters: - name: EntityId in: path description: The UiD of the root entity required: true schema: type: string - name: JourneyId in: path description: The UiD of a journey that the associations belong to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{entityId}/product: get: tags: - Association summary: Get all product Associations by Root Entity Id description: This method returns a product associations list for a given root entity operationId: GetProductAssociationsByEntityId parameters: - name: entityId in: path description: The unique identifier of the Entity that associations are required for 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{entityId}/product/verified: get: tags: - Association summary: Get the verified product associations without agency associations description: This method returns a list of verified product associations for a given root entity, excluding agency associations operationId: GetVerifiedProductAssociations parameters: - name: entityId in: path description: The unique identifier of the Entity that associations are required for 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{entityId}/managedProduct: get: tags: - Association summary: Get all drafts and verified managed product associations without the agency… description: This method returns a list of product associations that is used in the Managed Product task operationId: GetManagedProductAssociations parameters: - name: entityId in: path description: The unique identifier of the Entity that associations are required for 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{entityId}/product/all: get: tags: - Association summary: Get all product Associations by Root Entity Id description: This method returns a product associations list for a given root entity operationId: GetAllProductAssociationsByEntityId parameters: - name: entityId in: path description: The unique identifier of the Entity that associations are required for 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{entityId}/product/all/paged: get: tags: - Association summary: Get all product Associations by Root Entity Id with paging description: This method returns a product associations list for a given root entity with a given limit and paging token operationId: GetAllProductAssociationsByEntityIdPaged parameters: - name: entityId in: path description: The unique identifier of the Entity that associations are required for required: true schema: type: string - name: paginationToken in: query description: Token to retrieve more results schema: type: string - name: limit in: query description: Number of records to retrieve at a point schema: type: integer format: int32 default: 150 - 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/AssociationDtoItemsPageServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/product/{productId}: get: tags: - Association summary: Get all product Associations by Product Id description: This method returns a product associations list for a given product operationId: GetProductAssociationsByProductId parameters: - name: productId in: path description: The unique identifier of the Product that associations are connected to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/product/{productId}/journey/{journeyId}: get: tags: - Association summary: Get all active product Associations within a Journey description: This method returns a list of active product associations (that are not deleted or markled for deletion within the current journey) operationId: GetActiveProductAssociationsByProductId parameters: - name: productId in: path description: The unique identifier of the Product that associations are connected to required: true schema: type: string - name: journeyId in: path description: The id of the current Product Journey 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/products/journey/{journeyId}/is-agency: post: tags: - Association summary: Get all active product Associations within a Journey for multiple products description: This method returns a list of active product associations (that are not deleted or marked for deletion within the current journey) for a batch of products operationId: GetIsAgencyByProductIds parameters: - name: journeyId in: path description: The id of the current Product Journey required: true schema: type: string - name: subtype in: query schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: A list of the unique identifiers of the Products to get associations for content: application/json: schema: allOf: - $ref: '#/components/schemas/ProductToProductDtoServiceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductIsAgencyDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/productToProduct/{productId}: get: tags: - Association summary: Get all product to product Associations by Product Id description: This method returns a product to product associations list for a given product operationId: GetProductToProductAssociationsByProductId parameters: - name: productId in: path description: The unique identifier of the Product that associations are connected to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/productToProduct: post: tags: - Association summary: Get all product to product Associations for a list of Products description: This method returns a product to product associations list for all given product ids operationId: GetProductToProductAssociationsForProductIdList 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: A list of the unique identifiers of the Products that we want to get the Product to Product associations content: application/json: schema: allOf: - $ref: '#/components/schemas/ProductToProductDtoServiceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{EntityId}/journey/{JourneyId}/collateral: get: tags: - Association summary: Get all collateral Associations by Root Journey Id and Entity Id description: This method returns a collateral associations list for a given root entity and journey operationId: GetCollateralAssociations parameters: - name: EntityId in: path description: The UiD of the root entity required: true schema: type: string - name: JourneyId in: path description: The UiD of a journey that the associations belong to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{entityId}/collateral: get: tags: - Association summary: Get all collateral Associations by Root Entity Id description: This method returns a collateral associations list for a given root entity operationId: GetCollateralAssociationsByEntityId parameters: - name: entityId in: path description: The unique identifier of the Entity that associations are required for 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/collateral/{collateralId}: get: tags: - Association summary: Get all collateral Associations by Collateral Id description: This method returns a collateral associations list for a given collateral operationId: GetCollateralAssociationsByCollateralId parameters: - name: collateralId in: path description: The unique identifier of the Collateral that associations are connected to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{EntityId}/journey/{JourneyId}/asset: get: tags: - Association summary: Get all asset Associations by Root Journey Id and Collateral Id description: This method returns a asset associations list for a given root collateral and journey operationId: GetAssetAssociations parameters: - name: EntityId in: path description: The UiD of the root entity required: true schema: type: string - name: JourneyId in: path description: The UiD of a journey that the associations belong to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{collateralId}/asset: get: tags: - Association summary: Get all asset Associations by Root Collateral Id description: This method returns a asset associations list for a given root collateral operationId: GetAssetAssociationsByCollateralId parameters: - name: collateralId in: path description: The unique identifier of the Collateral that associations are required for 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/entity/{entityId}/asset: get: tags: - Association summary: Get all Asset to Entity Associations by Root Entity Id description: This method returns a list of asset to entity associations for a given root entity operationId: GetAssetAssociationsByEntityId parameters: - name: entityId in: path description: The unique identifier of the Entity that associations are required for 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/asset/{assetId}: get: tags: - Association summary: Get all asset Associations by Asset Id description: This method returns a asset associations list for a given asset operationId: GetAssetAssociationsByAssetId parameters: - name: assetId in: path description: The unique identifier of the Asset that associations are connected to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/snapshot/{journeyId}/task/{taskId}: get: tags: - Association summary: Get a temporal snapshot of the association hierarchy description: 'This method retrieves a list of associations from S3 for a given journeyId and taskId Required permissions: Following permissions are required: AssociationAccess' operationId: GetHierarchySnapShot parameters: - name: journeyId in: path description: The id of a journey that the associations belong to required: true schema: type: string - name: taskId in: path description: The id of a task that the associations belong to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 '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: /associationquery /api/association/snapshot/{journeyId}/task/{taskId}/root/{entityId}: get: tags: - Association summary: Get a temporal snapshot of the direct association hierarchy description: 'This method retrieves a list of direct associations from S3 for a given journeyId, taskId and entityId Required permissions: Following permissions are required: AssociationAccess' operationId: GetDirectHierarchySnapshot parameters: - name: journeyId in: path description: The id of a journey that the associations belong to required: true schema: type: string - name: taskId in: path description: The id of a task that the associations belong to required: true schema: type: string - name: entityId in: path description: The id of a root entity required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 '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: /associationquery /api/association/root/{entityId}/journey/{journeyId}/transferAgency: get: tags: - Association summary: Get all Transfer Agency Associations by Root Entity Id and Journey Id description: 'This method returns a list of transfer agency associations for a given root entity and journey Required permissions: Following permissions are required: AssociationAccess' operationId: GetTransferAgencyAssociations parameters: - name: entityId in: path description: The id of the root entity required: true schema: type: string - name: journeyId in: path description: The id of a journey that the associations belong to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{fundId}/transferAgencyByFund: get: tags: - Association summary: Get all Transfer Agency Associations by Fund Id description: 'This method returns a list of transfer agency associations for a given fund Required permissions: Following permissions are required: AssociationAccess' operationId: GetTransferAgencyAssociationsByFund parameters: - name: fundId in: path description: The id of the fund entity required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{fundId}/transferAgencyByFundLight: get: tags: - Association summary: Get all Transfer Agency Associations by Fund Id light description: 'This method returns a light version of the list of transfer agency associations for a given fund Required permissions: Following permissions are required: AssociationAccess' operationId: GetTransferAgencyAssociationsByFundLight parameters: - name: fundId in: path description: The id of the fund entity required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TransferAgencyAssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{entityId}/groupManagement: get: tags: - Association summary: Get all group management Associations by Root Entity Id description: 'This method returns a list of group management associations for a given root entity Required permissions: Following permissions are required: EntityGroupManagementAccessAndSearch' operationId: GetGroupManagementAssociations parameters: - name: entityId in: path description: The id of the root entity required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 deprecated: true servers: - url: /associationquery /api/association/root/{EntityId}/journey/{JourneyId}/groupManagement: get: tags: - Association summary: Get all verified and unverified group management Associations by Root Entity Id… description: 'This method returns a list of verified and unverified group management associations for a given root entity and journey ID Required permissions: Following permissions are required: EntityGroupManagementAccessAndSearch' operationId: GetGroupManagementAssociationsByJourneyId parameters: - name: EntityId in: path description: The UiD of the root entity required: true schema: type: string - name: JourneyId in: path description: The UiD of a journey that the associations belong to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{entityId}/groupManagement/verified: get: tags: - Association summary: Get all verified group management Associations by Root Entity Id description: 'This method returns a list of verified group management associations for a given root entity Required permissions: Following permissions are required: EntityGroupManagementAccessAndSearch' operationId: GetVerifiedGroupManagementAssociations parameters: - name: entityId in: path description: The id of the root entity required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{EntityId}/journey/{JourneyId}/groupManagement/unverified: get: tags: - Association summary: Get all unverified group management Associations by Root Entity Id and Journey… description: 'This method returns a list of unverified group management associations for a given root entity and Journey Id Required permissions: Following permissions are required: EntityGroupManagementAccessAndSearch' operationId: GetUnverifiedGroupManagementAssociations parameters: - name: EntityId in: path description: The UiD of the root entity required: true schema: type: string - name: JourneyId in: path description: The UiD of a journey that the associations belong to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/groupManagementBySourceId/{sourceEntityId}: get: tags: - Association summary: Get all group management Associations by Source Entity Id description: 'This method returns a list of group management associations which have a matching source entity id Required permissions: Following permissions are required: EntityGroupManagementAccessAndSearch' operationId: GetAllGroupsAssociatedBySourceEntityId parameters: - name: sourceEntityId in: path description: The id of the source entity required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/allGroupManagementBySourceId/{sourceEntityId}/journey/{journeyId}: get: tags: - Association summary: Get all group management Associations by Source Entity Id including any… description: 'This method returns a list of group management associations which have a matching source entity id Required permissions: Following permissions are required: EntityGroupManagementAccessAndSearch' operationId: GetAllInclUnverifiedGroupsAssociatedBySourceEntityId parameters: - name: sourceEntityId in: path description: The id of the source entity required: true schema: type: string - name: journeyId in: path description: The id of the journey 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{entityId}/journey/{journeyId}/proposedChanges/relatedParty: get: tags: - Association summary: Get all proposed changes for given Source Entity associations description: 'For a given journey and entity this method returns a list of changed associations where the given entity is the source entity, along with the properties changed for each association (added, edited, deleted) Required permissions: Following permissions are required: ProposedChangesAccess' operationId: GetProposedChangesByRelatedParty parameters: - name: journeyId in: path description: The id of the journey required: true schema: type: string - name: entityId in: path description: The id of the source entity required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationsChangedDtoServiceResponse' '400': description: Invalid 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 query '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 servers: - url: /associationquery /api/association/root/{EntityId}/journey/{JourneyId}/proposedChanges/hierarchy: get: tags: - Association summary: Get all associations for the journey extended with change type that was made… description: 'This method returns a hierarchy tree of entity associations for a given root entity and journey with the change type (added, edited, deleted, identical) of each association Required permissions: Following permissions are required: ProposedChangesAccess' operationId: GetProposedChangesAssociationsHierarchy parameters: - name: EntityId in: path description: The UiD of the root entity required: true schema: type: string - name: JourneyId in: path description: The UiD of a journey that the associations belong to 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: OK content: application/json: schema: $ref: '#/components/schemas/ProposedChangesAssociationDtoListServiceResponse' '400': description: Invalid 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 query '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 servers: - url: /associationquery /api/association/outbound/root/{entityId}/alldirect: get: tags: - Association summary: Get all direct draft and verified outbound Associations by Root Entity Id description: 'This method returns a list of direct draft and verified outbound associations for a given root entity The response will include draft associations added across all journeys Required permissions: Following permissions are required: AssociationAccess' operationId: GetAllDirectOutboundAssociations parameters: - name: entityId in: path description: The id of the root entity required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/searchForVerifiedAssociations: post: tags: - Association summary: Search for verified associations description: 'This method returns a list of inbound associations for given root entity, types and level The response will contain intermediate nodes of different type then in search parameters if encounter in traversal. Required permissions: Following permissions are required: AssociationAccess' operationId: SearchForVerifiedAssociations 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 criteria. content: application/json: schema: allOf: - $ref: '#/components/schemas/SearchForAssociationDtoServiceRequest' responses: '200': description: Success. The list of entities is returned content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/searchForAssociations: post: tags: - Association summary: Searches for associations based on specified criteria description: 'This method retrieves a comprehensive list of associations for the specified root entity. The search criteria include the root entity''s id, maximum levels to search, journey id, association types, association direction (inbound or/and outbound), and allowed association types for traversal. The response includes all intermediate nodes encountered during traversal. Root entity''s id, and maximum levels to search, are mandatory in search criteria. Required permissions: Following permissions are required: AssociationAccess' operationId: SearchForAssociations 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: The search criteria. content: application/json: schema: allOf: - $ref: '#/components/schemas/SearchForAssociationDtoV2ServiceRequest' responses: '200': description: Success. A list of Fenergo.Nebula.Association.Query.Application.Dto.AssociationDto objects is returned. content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Bad request. The request contains missing or invalid values. content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal server error. An exception occurred while processing the query. '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 servers: - url: /associationquery /api/association/root/{EntityId}/journey/{JourneyId}/maxlevel/{MaxLevel}: get: tags: - Association summary: Get all Associations by Root Entity Id, Journey Id, and max level description: 'This method returns a list of associations for a given root entity, journey, and max level The response is not limited. Required permissions: Following permissions are required: AssociationAccess' operationId: GetAssociationsWithMaxLevel parameters: - name: JourneyId in: path description: The UiD of a journey that the associations belong to required: true schema: minLength: 1 type: string description: The UiD of a journey that the associations belong to - name: EntityId in: path description: The UiD of the root entity required: true schema: minLength: 1 type: string description: The UiD of the root entity - name: MaxLevel in: path description: The number of levels to retrieve required: true schema: type: integer description: The number of levels to retrieve format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{EntityId}/maxlevel/{MaxLevel}: get: tags: - Association summary: Get all verified Associations by Root Entity Id, and max level description: 'This method returns a list of verified associations for a given root entity, and max level The response is not limited. Required permissions: Following permissions are required: AssociationAccess' operationId: GetVerifiedAssociationsWithMaxLevel parameters: - name: EntityId in: path description: The UiD of the root entity required: true schema: minLength: 1 type: string description: The UiD of the root entity - name: MaxLevel in: path description: The number of levels to retrieve required: true schema: type: integer description: The number of levels to retrieve format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/inbound/root/{entityId}/alldirect: get: tags: - Association summary: Get all direct draft and verified inbound Associations by Root Entity Id description: 'This method returns a list of direct draft and verified inbound associations for a given root entity The response will include draft associations added across all journeys Required permissions: Following permissions are required: AssociationAccess' operationId: GetAllDirectInboundAssociations parameters: - name: entityId in: path description: The id of the root entity required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/root/{EntityId}/journey/{JourneyId}/direct: get: tags: - Association summary: Get direct Associations by Root Entity Id and Journey Id description: 'This method returns a list of direct associations for a given root entity and journey The response is limited to ten thousand associations Required permissions: Following permissions are required: AssociationAccess' operationId: GetDirectAssociationsByJourney parameters: - name: EntityId in: path description: The UiD of the root entity required: true schema: type: string - name: JourneyId in: path description: The UiD of a journey that the associations belong to 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: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/journey/{journeyInstanceId}/task/{taskId}/autocomplete-progress: get: tags: - Association summary: Get live progress of the related-parties autocomplete for a journey task description: 'Reads the RUNNING Step Functions execution that matches the given journeyInstanceId and taskId, then returns the Map Run item counts so the UI can show "X of Y related parties updated". Returns Status="NotFound" (with all counts zero) when no matching execution exists — designed for polling; does not throw on miss. Required permissions: Following permissions are required: AssociationAccess' operationId: GetRelatedPartiesAutocompleteProgress parameters: - name: journeyInstanceId in: path description: The journey instance identifier required: true schema: type: string - name: taskId in: path description: The task identifier within the journey 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: OK content: application/json: schema: $ref: '#/components/schemas/GetRelatedPartiesAutocompleteProgressResponseServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the query '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 servers: - url: /associationquery /api/association/{id}/journeyid/{journeyId}: delete: tags: - Association summary: Permanently delete an existing outreach Association description: 'This method will delete an existing outreach Association model. Required permissions: At least one of the following permissions is required: AssociationEdit, EntityGroupManagementEdit' operationId: deleteApiAssociationByIdJourneyidByJourneyId 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: 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 '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteAssociation servers: - url: /externaloutreachcommand /api/association/existingassociatedentitycomments/{journeyId}: put: tags: - Association summary: Stores comments of an existing associated entity description: 'This method will store a comment of an existing associated entity Required permissions: At least one of the following permissions is required: AssociationEdit, EntityGroupManagementEdit' operationId: UpsertExistingAssociatedEntityComments parameters: - name: journeyId in: path description: The JourneyId of the existing associated entity comments 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.ExternalData.Outreach.Command.Application.Dto.ExistingAssociatedEntityCommentsDto content: application/json: schema: allOf: - $ref: '#/components/schemas/ExistingAssociatedEntityCommentsDtoServiceRequest' responses: '202': description: Associated Entity Comments Updated Successfully content: application/json: schema: $ref: '#/components/schemas/ApiResponseServiceResponse' '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: JourneyId is invalid content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - Association summary: Get all Existing Associated Entities Comments by Journey Id description: 'This method returns a list of existing associated entity comments for a given journey Required permissions: Following permissions are required: AssociationAccess' operationId: GetAssociatedEntityComments parameters: - name: journeyId in: path description: Id of a journey that associated entities comments 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: '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExistingAssociatedEntityCommentsDtoServiceResponse' '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: /externaloutreachcommand /api/v2/association/{id}/journeyid/{journeyId}: delete: tags: - Association summary: Permanently delete an existing outreach Association description: 'This method will delete an existing outreach Association model. Required permissions: At least one of the following permissions is required: AssociationEdit, EntityGroupManagementEdit' operationId: deleteApiV2AssociationByIdJourneyidByJourneyId 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: 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 '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteAssociation servers: - url: /externaloutreachcommand /api/v2/association/existingassociatedentitycomments/{journeyId}: put: tags: - Association summary: Stores comments of an existing associated entity description: 'This method will store a comment of an existing associated entity Required permissions: At least one of the following permissions is required: AssociationEdit, EntityGroupManagementEdit' operationId: putApiV2AssociationExistingassociatedentitycommentsByJourneyId parameters: - name: journeyId in: path description: The JourneyId of the existing associated entity comments 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.ExternalData.Outreach.Command.Application.Dto.ExistingAssociatedEntityCommentsDto content: application/json: schema: allOf: - $ref: '#/components/schemas/ExistingAssociatedEntityCommentsDtoServiceRequest' responses: '202': description: Associated Entity Comments Updated Successfully content: application/json: schema: $ref: '#/components/schemas/ApiResponseServiceResponse' '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: JourneyId is invalid content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpsertExistingAssociatedEntityComments servers: - url: /externaloutreachcommand components: schemas: ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' 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 - 'null' description: The type of association example: Shareholder additionalProperties: false description: The metadata of an association between two entities 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 - 'null' description: The UiD of the Root Entity Id format: uuid 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 (optional)' format: double example: 5.007 controlPercentage: type: number description: 'The percentage amount of the target entity controlled by the source entity (optional)' format: double example: 23.4 originalAssociations: type: - array - 'null' items: $ref: '#/components/schemas/AssociationSubsetDto' description: 'A list of Associations deleted (optional)' properties: type: - object - 'null' additionalProperties: type: - string - 'null' description: A list of custom properties that describe the association 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 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 AssociationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/AssociationDto' description: The metadata of an association between two entities additionalProperties: false ConflictResolutionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ConflictResolutionDto' description: Resolve Association conflict wrapper additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false AssociationDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AssociationDto' description: The metadata of an association between two entities messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConflictResolutionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConflictResolutionDto' description: Resolve Association conflict wrapper messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' 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 CreateAssociationDto: type: object properties: requestId: type: - string - 'null' association: allOf: - $ref: '#/components/schemas/AssociationDto' description: The metadata of an association between two entities additionalProperties: false RestoreSoftDeleteAssociationDto: type: object properties: properties: type: - object - 'null' additionalProperties: type: - string - 'null' description: A list of custom properties that describe the association additionalProperties: false CreateAssociationsDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateAssociationsDto' additionalProperties: false CreateAssociationsResultDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateAssociationsResultDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateAssociationsResultDto: type: object properties: associationsResults: type: - array - 'null' items: $ref: '#/components/schemas/CreateAssociationResultDto' additionalProperties: false CreateAssociationResultDto: type: object properties: id: type: - string - 'null' format: uuid requestId: type: - string - 'null' association: allOf: - $ref: '#/components/schemas/AssociationDto' description: The metadata of an association between two entities isSuccess: type: boolean messages: type: - array - 'null' items: type: string additionalProperties: false RestoreSoftDeleteAssociationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/RestoreSoftDeleteAssociationDto' additionalProperties: false CreateAssociationsDto: type: object properties: associations: type: - array - 'null' items: $ref: '#/components/schemas/CreateAssociationDto' additionalProperties: false GetRelatedPartiesAutocompleteProgressResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/GetRelatedPartiesAutocompleteProgressResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ProductIsAgencyDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ProductIsAgencyDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false RelationshipChangesDto: type: object properties: id: type: - string - 'null' description: The UiD of the Child Entity type: type: - string - 'null' description: The type of association relationshipChangeType: type: - string - 'null' description: The type of association change dataChanges: type: - array - 'null' items: $ref: '#/components/schemas/DataChangesDto' description: Association property changes additionalProperties: false ChildrenPageDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ChildrenPageDto' description: A single page of an entity's direct children, plus a token to fetch the next page if there is one. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ProposedChangesAssociationDto: type: object properties: id: type: string description: The UiD of the association model format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f sourceId: type: string description: The UiD of the Parent Entity format: uuid example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa targetId: type: string description: The UiD of the Child Entity format: uuid example: 6b399cff-6e35-42a0-aaf0-69a94a008636 type: type: - string - 'null' description: The type of association example: Shareholder journeyId: 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 - 'null' description: 'The percentage amount of the target entity owned by the source entity (optional)' format: double example: 5.007 controlPercentage: type: - number - 'null' description: 'The percentage amount of the target entity controlled by the source entity (optional)' format: double example: 23.4 markedForDeletion: uniqueItems: true type: - array - 'null' items: type: string format: uuid description: Lists the JourneyIds which have marked the association for deletion properties: type: - object - 'null' additionalProperties: type: - string - 'null' description: A list of custom properties that describe the association example: - Ownership Percentage: 15 - CountryOfIncorporation: Ireland subtype: type: - string - 'null' description: The subtype of association used for product association type example: Shareholder relationshipContext: allOf: - $ref: '#/components/schemas/RelationshipContexts' description: 'Identifies the relationship context for the association. Null when the IA RP feature is disabled or not applicable.' investmentAccountName: type: - string - 'null' description: 'The name of the investment account this RP is associated with. Null when the RP originates from the entity hierarchy only.' changeType: type: - string - 'null' description: Change type example: Add additionalProperties: false description: The metadata of an association between two entities extended by change type HierarchyChildNodeDto: type: object properties: associationId: type: string format: uuid sourceId: type: string format: uuid targetId: type: string format: uuid entityId: type: string format: uuid parentId: type: string format: uuid associationType: type: - string - 'null' description: 'The association''s own type (e.g. UBO, Controlling Person) - distinct from Fenergo.Nebula.Association.Query.Application.Dto.HierarchyChildNodeDto.Type below, which is the child *entity''s* type (e.g. Corporation, Individual).' ownershipPct: type: - number - 'null' format: double controlPct: type: - number - 'null' format: double name: type: - string - 'null' description: 'EntityData''s name/type for Fenergo.Nebula.Association.Query.Application.Dto.HierarchyChildNodeDto.EntityId. Null if EntityData had nothing accessible for this id (e.g. authorization filtered it out) - never populated from Neptune itself.' type: type: - string - 'null' childCount: type: integer description: 'True child count for this node - if non-zero, the client can offer a Branch Card / drill-in to page this node''s own children via another call to the same endpoint with this node''s EntityId.' format: int32 additionalProperties: false description: 'A single direct child returned by a children-page request. Fenergo.Nebula.Association.Query.Application.Dto.HierarchyChildNodeDto.EntityId is the child, Fenergo.Nebula.Association.Query.Application.Dto.HierarchyChildNodeDto.ParentId is the entity whose children were requested.' ChildrenPageDto: type: object properties: nodes: type: - array - 'null' items: $ref: '#/components/schemas/HierarchyChildNodeDto' nextPaginationToken: type: - string - 'null' description: 'Pass this back as the `paginationToken` on a subsequent call against the same entityId and journeyId to fetch the next page. Null when there are no more children to fetch.' ownChildCount: type: - integer - 'null' description: 'The requested entity''s own child count - only populated when the request set `includeOwnChildCount` to true. Null otherwise, including whenever it wasn''t requested.' format: int32 additionalProperties: false description: A single page of an entity's direct children, plus a token to fetch the next page if there is one. SearchForAssociationDto: type: object properties: entityId: type: - string - 'null' description: The UiD of the root entity. example: 118313c6-91e6-4b05-a537-5a1ab906418f maxLevels: type: integer description: Maximum hierarchy levels to search. format: int32 example: 3 includeProducts: type: boolean description: Includes Products in search result associationTypes: type: - array - 'null' items: type: string description: Types of associations to search for. edgeDirection: type: - string - 'null' description: 'Edge direction - default inbound-outbound inbound - only inbound edges leading to root entity will be searched outbound - only outbound edges from root will be searched inbound-outbound - inbound and outbound edges will be searched' example: inbound inboundEdgeTraversalLimit: type: - array - 'null' items: type: string description: Limits search traversal of inbound edges to specified association type. outboundEdgeTraversalLimit: type: - array - 'null' items: type: string description: Limits search traversal of outbound edges to specified association type. additionalProperties: false AssociationConflictDto: type: object properties: verifiedAssociation: allOf: - $ref: '#/components/schemas/AssociationDto_2' description: The Verified association unverifiedAssociation: allOf: - $ref: '#/components/schemas/AssociationDto_2' description: The Unverified association additionalProperties: false description: A pair of conflicting associations ProductToProductDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ProductToProductDto' additionalProperties: false AssociationDtoItemsPage: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/AssociationDto_2' paginationToken: type: - string - 'null' additionalProperties: false AssociationConflictDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AssociationConflictDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false GetEntityChildrenPageRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/GetEntityChildrenPageRequestDto' description: 'POST body for `GetEntityChildrenPage` - carries the same parameters a previous GET/query-string version of this endpoint accepted, moved to a request body so future parameters can be added without another breaking change to the query string.' additionalProperties: false AssociationDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AssociationDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false GetRelatedPartiesAutocompleteProgressResponse: type: object properties: total: type: integer format: int32 processed: type: integer format: int32 percentage: type: integer format: int32 status: type: - string - 'null' additionalProperties: false ProductIsAgencyDto: type: object properties: productId: type: string description: The unique identifier of the product format: uuid isAgency: type: boolean description: Whether the product has an active agency Owner association additionalProperties: false description: Lightweight DTO representing whether a product has an agency association TransferAgencyAssociationDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/TransferAgencyAssociationDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AssociationDto_2: type: object properties: id: type: string description: The UiD of the association model format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f sourceId: type: string description: The UiD of the Parent Entity format: uuid example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa targetId: type: string description: The UiD of the Child Entity format: uuid example: 6b399cff-6e35-42a0-aaf0-69a94a008636 type: type: - string - 'null' description: The type of association example: Shareholder journeyId: 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 - 'null' description: 'The percentage amount of the target entity owned by the source entity (optional)' format: double example: 5.007 controlPercentage: type: - number - 'null' description: 'The percentage amount of the target entity controlled by the source entity (optional)' format: double example: 23.4 markedForDeletion: uniqueItems: true type: - array - 'null' items: type: string format: uuid description: Lists the JourneyIds which have marked the association for deletion properties: type: - object - 'null' additionalProperties: type: - string - 'null' description: A list of custom properties that describe the association example: - Ownership Percentage: 15 - CountryOfIncorporation: Ireland subtype: type: - string - 'null' description: The subtype of association used for product association type example: Shareholder relationshipContext: allOf: - $ref: '#/components/schemas/RelationshipContexts' description: 'Identifies the relationship context for the association. Null when the IA RP feature is disabled or not applicable.' investmentAccountName: type: - string - 'null' description: 'The name of the investment account this RP is associated with. Null when the RP originates from the entity hierarchy only.' additionalProperties: false description: The metadata of an association between two entities AssociationDtoItemsPageServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AssociationDtoItemsPage' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DataChangesDto: type: object properties: dataKey: type: - string - 'null' description: Datakey of the property changed existingValue: type: - string - 'null' description: Existing value of the property changed newValue: type: - string - 'null' description: New value of the property changed dataChangeType: type: - string - 'null' description: Type of change additionalProperties: false ProposedChangesAssociationDtoListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ProposedChangesAssociationDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false SearchForAssociationDtoV2ServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/SearchForAssociationDtoV2' additionalProperties: false TransferAgencyAssociationDto: type: object properties: sourceId: type: string description: The UiD of the Parent Entity format: uuid example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa targetId: type: string description: The UiD of the Child Entity format: uuid example: 6b399cff-6e35-42a0-aaf0-69a94a008636 propertySubtype: type: - string - 'null' description: A custom property subtype example: ' AccountStructureBankAccount ' additionalProperties: false description: The metadata of the transfer agency association between two entities GetEntityChildrenPageRequestDto: type: object properties: entityId: type: - string - 'null' description: The id of the entity whose direct children are requested. journeyId: type: - string - 'null' description: 'Optional journey id. When supplied, verified associations and current-journey draft associations are both included; when omitted, only verified associations are included.' pageSize: type: integer description: The maximum number of children to return in this page. Defaults to 100. format: int32 paginationToken: type: - string - 'null' description: 'Token from a previous response''s NextPaginationToken, to resume after the last item previously returned. Must have been issued for this exact entityId and journeyId - a token issued for a different entity or journey is rejected.' includeOwnChildCount: type: boolean description: 'When true, the response''s OwnChildCount also reports entityId''s own child count. Defaults to false - callers should only set this for a node whose count they don''t already know some other way.' additionalProperties: false description: 'POST body for `GetEntityChildrenPage` - carries the same parameters a previous GET/query-string version of this endpoint accepted, moved to a request body so future parameters can be added without another breaking change to the query string.' AssociationsChangedDto: type: object properties: sourceId: type: - string - 'null' description: The UiD of the Parent Entity relationshipsChanges: type: - array - 'null' items: $ref: '#/components/schemas/RelationshipChangesDto' description: Associations and property changes additionalProperties: false AssociationsChangedDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AssociationsChangedDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false RelationshipContexts: enum: - None - Hierarchy - InvestmentAccount - Both type: string description: 'Identifies the relationship context for a related party in the RPD&D task. Defined as a flags enum so that Fenergo.Nebula.Association.Query.Application.Enums.RelationshipContexts.Both is a true bitwise combination of Fenergo.Nebula.Association.Query.Application.Enums.RelationshipContexts.Hierarchy and Fenergo.Nebula.Association.Query.Application.Enums.RelationshipContexts.InvestmentAccount, allowing callers to use `HasFlag` to test individual origins.' SearchForAssociationDtoV2: required: - maxLevels type: object properties: entityId: type: - string - 'null' description: The UiD of the root entity. example: 118313c6-91e6-4b05-a537-5a1ab906418f maxLevels: maximum: 2147483647 minimum: 1 type: integer description: Maximum hierarchy levels to search. format: int32 example: 3 journeyId: type: - string - 'null' description: "The UiD of the journey.\nIf not provided, only the verified associations will be returned.\nIf provided, unverified associations in the given journey and \nall the verified associations will be returned." example: c5d6c4e4-1246-4928-b6ba-6b4e3560e414 associationTypes: type: - array - 'null' items: type: string description: 'Types of associations to search for. If not provided, all types of associations will be returned.' example: - legalEntity - collateral edgeDirection: type: - string - 'null' description: 'Edge types - default inbound-outbound. inbound-outbound - inbound and outbound edges will be searched. inbound - only inbound edges leading to root entity will be searched. outbound - only outbound edges from root will be searched. If A is the root entity and edgeDirection is outbound, A-->B will be returned. If A is the root entity and edgeDirection is inbound, A<-C will be returned. If A is the root entity and edgeDirection is inbound-outbound, A-> B and A<-C will be returned.' example: inbound-outbound allowedInboundAssociationTypesForTraversal: type: - array - 'null' items: type: string description: 'The allowed association types of inbound edges for traversal. If not provided, all association types for inbound edges during traversal will be accepted. If we have two associations A<--Shareholder---B, A<---collateral---C, and root entity is A, AllowedInboundAssociationTypesForTraversal: ["Shareholder"], then only A<--Shareholder---B will be returned.' example: - legalEntity allowedOutboundAssociationTypesForTraversal: type: - array - 'null' items: type: string description: 'The allowed association types of outbound edges for traversal. If not provided, all association types for outbound edges during traversal will be accepted. If we have two associations A--Shareholder--->B, A---collateral--->C, and root entity is A, AllowedOutboundAssociationTypesForTraversal: ["collateral"], then only A---collateral--->C will be returned.' example: - product - collateral excludeRootIds: type: boolean description: 'When true, the RelatedPartyRootIds attribute is excluded from the returned associations. Defaults to false (root ids are included).' example: false maxAssociations: type: - integer - 'null' description: 'Optional cap on the number of associations returned. When set (greater than 0), at most this many associations are returned - protecting callers that invoke this query synchronously from the AWS Lambda 6 MB response-size limit (a super-connected entity can otherwise exceed it and fail with Function.ResponseSizeTooLarge). When null or not provided, all associations are returned.' format: int32 example: 2000 additionalProperties: false SearchForAssociationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/SearchForAssociationDto' additionalProperties: false ProductToProductDto: type: object properties: productIds: type: - array - 'null' items: type: string description: The UiDs of the products we want to get the associations for additionalProperties: false ApiResponse: type: object properties: version: type: integer format: int32 messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' 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 AssociationDto_3: type: object properties: id: type: string description: The UiD of the association model format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f sourceId: type: string description: The UiD of the Parent Entity format: uuid example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa targetId: type: string description: The UiD of the Child Entity format: uuid example: 6b399cff-6e35-42a0-aaf0-69a94a008636 type: type: - string - 'null' description: The type of association example: Shareholder journeyId: 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 (optional)' format: double example: 5.007 properties: type: - object - 'null' additionalProperties: type: - string - 'null' description: A list of custom properties that describe the association example: - OwnershipPercentage: 15 - CountryOfIncorporation: Portugal additionalProperties: false description: The metadata of an association between two entities ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ExistingAssociatedEntityCommentsDto: type: object properties: associatedEntityIdsComments: type: - object - 'null' additionalProperties: type: - string - 'null' description: Associatied Entity Comments Dictionary example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65: This is not valid association 6c4bc3ff-9d5b-4ccd-839b-637c227b1c65: This is old association version: type: integer description: Version number for given Object format: int32 example: 1 additionalProperties: false description: Comment for Existing Associated Entity in the System ApiResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ApiResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ExistingAssociatedEntityCommentsDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ExistingAssociatedEntityCommentsDto' description: Comment for Existing Associated Entity in the System additionalProperties: false AssociationDto_4: type: object properties: id: type: string description: The UiD of the association model format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f sourceId: type: string description: The UiD of the Parent Entity format: uuid example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa targetId: type: string description: The UiD of the Child Entity format: uuid example: 6b399cff-6e35-42a0-aaf0-69a94a008636 type: type: - string - 'null' description: The type of association example: Shareholder journeyId: 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 (optional)' format: double example: 5.007 properties: type: - object - 'null' additionalProperties: type: - string - 'null' description: A list of custom properties that describe the association example: - OwnershipPercentage: 15 - CountryOfIncorporation: Portugal additionalProperties: false description: The metadata of an association between two entities 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 AssociationDto_5: type: object properties: id: type: string description: The UiD of the association model format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f sourceId: type: string description: The UiD of the Parent Entity format: uuid example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa targetId: type: string description: The UiD of the Child Entity format: uuid example: 6b399cff-6e35-42a0-aaf0-69a94a008636 type: type: - string - 'null' description: The type of association example: Shareholder journeyId: 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 createdBySnapshot: type: boolean description: Annotates whether the association was created by the outreach snapshot process example: false ownershipPercentage: type: - number - 'null' description: 'The percentage amount of the target entity owned by the source entity (optional)' format: double example: 5.007 properties: type: - object - 'null' additionalProperties: type: - string - 'null' description: A list of custom properties that describe the association example: - Ownership Percentage: 15 - CountryOfIncorporation: Ireland additionalProperties: false description: The metadata of an association between two entities ExistingAssociatedEntityCommentsDto_2: type: object properties: associatedEntityIdsComments: type: - object - 'null' additionalProperties: type: - string - 'null' description: EntityId Comments Dictionary example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65: This is not valid association 6c4bc3ff-9d5b-4ccd-839b-637c227b1c65: This is old association version: type: integer description: Version number for given Object format: int32 example: 1 additionalProperties: false description: Comment for Existing Associated Entity in the System AssociationDtoIEnumerableServiceResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AssociationDto_5' 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 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 ExistingAssociatedEntityCommentsDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ExistingAssociatedEntityCommentsDto_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 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 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 securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-associationcommand-v1-0-openapi.json - fenergo-associationcommand-v2-0-openapi.json - fenergo-associationquery-v1-0-openapi.json - fenergo-externaloutreachcommand-v1-0-openapi.json - fenergo-externaloutreachcommand-v2-0-openapi.json - fenergo-externaloutreachquery-v1-0-openapi.json