openapi: 3.2.0 info: title: Fenergo Nebula Association Query Agency API description: '**Association Query API**: Association Query API provides endpoints in order to retrieve entity associations. **Association Query API provides**: Entity Association retrieval Unwrapping Requirement Status Model Management' version: '1.0' servers: - url: /associationquery security: - Bearer: [] tags: - name: Agency paths: /api/agency/target/{entityId}/journey/{journeyId}: get: tags: - Agency summary: Get all associations from an Agent in a Journey description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetAgencyAssociationsByTargetAndJourney parameters: - name: entityId in: path description: The ID of the Entity that is the target of the association required: true schema: type: string - name: journeyId in: path description: The ID of the Journey to search for agency associations in the specific 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: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/targetlist/journey/{journeyId}: post: tags: - Agency summary: Get all associations from a list of Agents within a Journey description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetAgencyAssociationsByTargetIdListAndJourney parameters: - name: journeyId in: path description: The ID of the Journey to search for agency associations in the specific 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 requestBody: description: The DTO containing criteria such as IDs for the list of Entities that are the target of the association content: application/json: schema: allOf: - $ref: '#/components/schemas/AgencyAssociationsByTargetIdListDtoServiceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/source/{entityId}/journey/{journeyId}: get: tags: - Agency summary: Get all associations from a Fund in a Journey description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetAgencyAssociationsBySourceAndJourney parameters: - name: entityId in: path description: The ID of the Entity that is the source of the association required: true schema: type: string - name: journeyId in: path description: The ID of the Journey to search for agency associations in the specific 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: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/journey/{journeyId}: get: tags: - Agency summary: Get all agency associations in a journey description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetAgencyAssociationsInJourney parameters: - name: journeyId in: path description: The ID of the Journey to search for agency associations in the specific 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: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/agent/{agentId}/source/{sourceId}/verified: get: tags: - Agency summary: Get all verified associations from a specific source in a Journey description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetVerifiedAgencyAssociations parameters: - name: agentId in: path description: The ID of the Entity to find agency associations from this agent id required: true schema: type: string - name: sourceId in: path description: The ID of the Entity to find agency associations with this source id 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: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/source/{entityId}/productVerified: get: tags: - Agency summary: Get Agency and Product associations from a specific source description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetVerifiedAssociationHierarchyWithProduct parameters: - name: entityId in: path description: The ID of the Entity to find agency and product associations with this source id required: true schema: type: string - name: journeyId in: query description: 'Optional. When supplied, the endpoint checks whether all associations belonging to this journey have been verified in the read model. If any remain unverified (projection still draining), returns HTTP 404 Service Unavailable so the caller can retry.' 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: 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: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/source/{entityId}/journey/{journeyId}/mr: get: tags: - Agency summary: Get mr associations from a Fund in a Journey description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetAgencyMrAssociationsBySourceAndJourney parameters: - name: entityId in: path description: The ID of the Entity that is the source of the association required: true schema: type: string - name: journeyId in: path description: The ID of the Journey to search for agency associations in the specific 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: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/source/{entityId}/mr/agent: get: tags: - Agency summary: Get mr and agent associations from a Fund description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetMrAgentAssociationsBySourceId parameters: - name: entityId in: path description: The ID of the Entity that is the source of the association required: true schema: type: string - name: journeyId in: query description: The ID of the Journey when there is a child journey 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: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/snapshot/{journeyId}: get: tags: - Agency summary: Get a temporal snapshot of the agency association hierarchy description: 'This method retrieves a list of agency associations from S3 for a given journeyId Required permissions: Following permissions are required: AssociationAccess' operationId: GetAgencyHierarchySnapshot parameters: - 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 '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Snapshot not found for journeyId 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 /api/agency/fund/{fundId}/agent/{agentId}/mr: get: tags: - Agency summary: Get mr and agent associations from a Fund description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetMrAgentAssociationsByFundIdAndAgentId parameters: - name: fundId in: path description: The ID of the fund that is the source of the association required: true schema: type: string - name: agentId in: path description: The ID of the agent that is the source of the association required: true schema: type: string - name: journeyId in: query description: The ID of the Journey when there is a child journey 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: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/fundIds: post: tags: - Agency summary: Get all verified fund ids for agent id description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetFundIdsByAgentId parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/FundIdPageDtoServiceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GuidItemsPageDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/verifiedProductIds: post: tags: - Agency summary: Get all verified product ids for agent id and fund id description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetVerifiedProductIds parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/VerifiedProductIdPageDtoServiceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GuidItemsPageDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/product: post: tags: - Agency summary: Find All Product associations from a specific product in Agency description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetAllAgencyProductAssociations parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/AgencyProductDtoServiceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AssociationDtoIEnumerableServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/agent/{agentId}: get: tags: - Agency summary: Find All Product associations from a specific agent id description: 'Required permissions: Following permissions are required: AssociationAccess' operationId: GetVerifiedAssociationHierarchyWithProductByAgentId parameters: - name: agentId in: path description: The ID of the agent that is the source of the association 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: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/agency/verified/mr/{entityId}: get: tags: - Agency summary: Get all verified agency Associations by target Id description: 'This method returns a list of verified associations for a given target entity id Required permissions: Following permissions are required: AssociationAccess' operationId: GetAgencyMrVerifiedAssociations parameters: - name: entityId in: path description: The target id of the associations 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 /api/agency/verified/source/{entityId}: get: tags: - Agency summary: Get all verified agency Associations by source Id description: 'This method returns a list of verified associations for a given target entity id Required permissions: Following permissions are required: AssociationAccess' operationId: GetAgencyVerifiedAssociationsBySource parameters: - name: entityId in: path description: The target id of the associations 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 components: schemas: ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AgencyProductDto: type: object properties: entityId: type: string description: The UiD of the root entity. format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f mrId: type: string description: The UiD of the Managed relationship entity. format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f agentId: type: string description: The UiD of the agent entity. format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f productId: type: string description: The UiD of the product entity. format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f journeyId: type: string description: The UiD of the journey. format: uuid example: c5d6c4e4-1246-4928-b6ba-6b4e3560e414 additionalProperties: false AssociationDto: 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 FundIdPageDto: required: - agentId type: object properties: agentId: type: string format: uuid pagination: allOf: - $ref: '#/components/schemas/PageDto' additionalProperties: false AgencyProductDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/AgencyProductDto' additionalProperties: false VerifiedProductIdPageDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/VerifiedProductIdPageDto' additionalProperties: false FundIdPageDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/FundIdPageDto' additionalProperties: false AgencyAssociationsByTargetIdListDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/AgencyAssociationsByTargetIdListDto' additionalProperties: false PageDto: type: object properties: paginationToken: type: - string - 'null' pageSize: type: - integer - 'null' format: int32 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.' VerifiedProductIdPageDto: required: - agentId - fundId type: object properties: agentId: type: string format: uuid fundId: type: string format: uuid pagination: allOf: - $ref: '#/components/schemas/PageDto' additionalProperties: false AssociationDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AssociationDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false GuidItemsPageDto: type: object properties: items: type: - array - 'null' items: type: string format: uuid paginationToken: type: - string - 'null' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false AgencyAssociationsByTargetIdListDto: type: object properties: entityIds: type: - array - 'null' items: type: string description: Entity Ids additionalProperties: false GuidItemsPageDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/GuidItemsPageDto' 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 securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header