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


Association Query API provides endpoints in order to retrieve entity associations.


**Association Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/associationquery" } ], "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\nhave been verified in the read model. If any remain unverified (projection still draining),\nreturns 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": "\nThis 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": "\nThis 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": "\nThis 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" } ] } } } } } } }, "/api/association/{id}": { "get": { "tags": [ "Association" ], "summary": "Get an existing Association", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{EntityId}/journey/{JourneyId}": { "get": { "tags": [ "Association" ], "summary": "Get all Associations by Root Entity Id and Journey Id", "description": "\nThis method returns a list of associations for a given root entity and journey\n\nThe 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" } ] } } } } } } }, "/api/association/root/{entityId}": { "get": { "tags": [ "Association" ], "summary": "Get all verified Associations by Root Entity Id", "description": "\nThis method returns a list of verified associations for a given root entity\n\nThe 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" } ] } } } } } } }, "/api/association/outbound/root/{entityId}": { "get": { "tags": [ "Association" ], "summary": "Get all verified outbound Associations by Root Entity Id", "description": "\nThis method returns a list of verified outbound associations for a given root entity\n\nThe 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" } ] } } } } } } }, "/api/association/hierarchy/children/paged": { "post": { "tags": [ "Association" ], "summary": "Get a page of an entity's direct children in the entity-ownership hierarchy", "description": "\nReturns a single page of the direct children of the given entity, ordered by a stable internal key\n (not creation time or any other client-meaningful order). This one endpoint serves the first render\n of the root entity's children, a Branch Card drill-in into any other node's children, and\n continuation paging for a node whose children have already been partially shown - all three are\n simply a call against the relevant entityId, with or without a paginationToken carried over from a\n previous response.\n\nTakes its parameters as a JSON request body (replacing a previous GET/query-string version of this\n endpoint) so further parameters (e.g. taskId, a stable rootEntityId/parentEntityId pair) can be\n 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" } ] } } } } } } }, "/api/association/root/{EntityId}/journey/{JourneyId}/conflicts": { "get": { "tags": [ "Association" ], "summary": "Get all Association Conflicts by Root Entity Id and Journey Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{EntityId}/journey/{JourneyId}/product": { "get": { "tags": [ "Association" ], "summary": "Get all product Associations by Root Journey Id and Entity Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{entityId}/product": { "get": { "tags": [ "Association" ], "summary": "Get all product Associations by Root Entity Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{entityId}/product/verified": { "get": { "tags": [ "Association" ], "summary": "Get the verified product associations without agency associations", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{entityId}/managedProduct": { "get": { "tags": [ "Association" ], "summary": "Get all drafts and verified managed product associations without the agency Investment Manager associations", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{entityId}/product/all": { "get": { "tags": [ "Association" ], "summary": "Get all product Associations by Root Entity Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{entityId}/product/all/paged": { "get": { "tags": [ "Association" ], "summary": "Get all product Associations by Root Entity Id with paging", "description": "\nThis 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" } ] } } } } } } }, "/api/association/product/{productId}": { "get": { "tags": [ "Association" ], "summary": "Get all product Associations by Product Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/product/{productId}/journey/{journeyId}": { "get": { "tags": [ "Association" ], "summary": "Get all active product Associations within a Journey", "description": "\nThis 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" } ] } } } } } } }, "/api/association/products/journey/{journeyId}/is-agency": { "post": { "tags": [ "Association" ], "summary": "Get all active product Associations within a Journey for multiple products", "description": "\nThis 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" } ] } } } } } } }, "/api/association/productToProduct/{productId}": { "get": { "tags": [ "Association" ], "summary": "Get all product to product Associations by Product Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/productToProduct": { "post": { "tags": [ "Association" ], "summary": "Get all product to product Associations for a list of Products", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{EntityId}/journey/{JourneyId}/collateral": { "get": { "tags": [ "Association" ], "summary": "Get all collateral Associations by Root Journey Id and Entity Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{entityId}/collateral": { "get": { "tags": [ "Association" ], "summary": "Get all collateral Associations by Root Entity Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/collateral/{collateralId}": { "get": { "tags": [ "Association" ], "summary": "Get all collateral Associations by Collateral Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{EntityId}/journey/{JourneyId}/asset": { "get": { "tags": [ "Association" ], "summary": "Get all asset Associations by Root Journey Id and Collateral Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{collateralId}/asset": { "get": { "tags": [ "Association" ], "summary": "Get all asset Associations by Root Collateral Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/entity/{entityId}/asset": { "get": { "tags": [ "Association" ], "summary": "Get all Asset to Entity Associations by Root Entity Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/asset/{assetId}": { "get": { "tags": [ "Association" ], "summary": "Get all asset Associations by Asset Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/snapshot/{journeyId}/task/{taskId}": { "get": { "tags": [ "Association" ], "summary": "Get a temporal snapshot of the association hierarchy", "description": "\nThis 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" } ] } } } } } } }, "/api/association/snapshot/{journeyId}/task/{taskId}/root/{entityId}": { "get": { "tags": [ "Association" ], "summary": "Get a temporal snapshot of the direct association hierarchy", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{entityId}/journey/{journeyId}/transferAgency": { "get": { "tags": [ "Association" ], "summary": "Get all Transfer Agency Associations by Root Entity Id and Journey Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{fundId}/transferAgencyByFund": { "get": { "tags": [ "Association" ], "summary": "Get all Transfer Agency Associations by Fund Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{fundId}/transferAgencyByFundLight": { "get": { "tags": [ "Association" ], "summary": "Get all Transfer Agency Associations by Fund Id light", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{entityId}/groupManagement": { "get": { "tags": [ "Association" ], "summary": "Get all group management Associations by Root Entity Id", "description": "\nThis 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 } }, "/api/association/root/{EntityId}/journey/{JourneyId}/groupManagement": { "get": { "tags": [ "Association" ], "summary": "Get all verified and unverified group management Associations by Root Entity Id and Journey Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{entityId}/groupManagement/verified": { "get": { "tags": [ "Association" ], "summary": "Get all verified group management Associations by Root Entity Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{EntityId}/journey/{JourneyId}/groupManagement/unverified": { "get": { "tags": [ "Association" ], "summary": "Get all unverified group management Associations by Root Entity Id and Journey Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/groupManagementBySourceId/{sourceEntityId}": { "get": { "tags": [ "Association" ], "summary": "Get all group management Associations by Source Entity Id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/allGroupManagementBySourceId/{sourceEntityId}/journey/{journeyId}": { "get": { "tags": [ "Association" ], "summary": "Get all group management Associations by Source Entity Id including any unverified groups by journey id", "description": "\nThis 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" } ] } } } } } } }, "/api/association/root/{entityId}/journey/{journeyId}/proposedChanges/relatedParty": { "get": { "tags": [ "Association" ], "summary": "Get all proposed changes for given Source Entity associations", "description": "\nFor a given journey and entity this method returns a list of changed associations where the given entity is the source entity, along with \n 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" } ] } } } } } } }, "/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 during the journey", "description": "\nThis method returns a hierarchy tree of entity associations for a given root entity and journey with the change type (added, edited, deleted, identical) \n 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" } ] } } } } } } }, "/api/association/outbound/root/{entityId}/alldirect": { "get": { "tags": [ "Association" ], "summary": "Get all direct draft and verified outbound Associations by Root Entity Id", "description": "\nThis method returns a list of direct draft and verified outbound associations for a given root entity\n\nThe 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" } ] } } } } } } }, "/api/association/searchForVerifiedAssociations": { "post": { "tags": [ "Association" ], "summary": "Search for verified associations", "description": "\nThis method returns a list of inbound associations for given root entity, types and level\n\nThe 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" } ] } } } } } } }, "/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.\nThe search criteria include the root entity's id, maximum levels to search, journey id, association types, association direction (inbound or/and outbound),\nand allowed association types for traversal. The response includes all intermediate nodes encountered during traversal.\nRoot 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" } ] } } } } } } }, "/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": "\nThis method returns a list of associations for a given root entity, journey, and max level\n\nThe 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" } ] } } } } } } }, "/api/association/root/{EntityId}/maxlevel/{MaxLevel}": { "get": { "tags": [ "Association" ], "summary": "Get all verified Associations by Root Entity Id, and max level", "description": "\nThis method returns a list of verified associations for a given root entity, and max level\n\nThe 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" } ] } } } } } } }, "/api/association/inbound/root/{entityId}/alldirect": { "get": { "tags": [ "Association" ], "summary": "Get all direct draft and verified inbound Associations by Root Entity Id", "description": "\nThis method returns a list of direct draft and verified inbound associations for a given root entity\n\nThe 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" } ] } } } } } } }, "/api/association/root/{EntityId}/journey/{JourneyId}/direct": { "get": { "tags": [ "Association" ], "summary": "Get direct Associations by Root Entity Id and Journey Id", "description": "\nThis method returns a list of direct associations for a given root entity and journey\n\nThe 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" } ] } } } } } } }, "/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": "\nReads the RUNNING Step Functions execution that matches the given journeyInstanceId\n and taskId, then returns the Map Run item counts so the UI can show \"X of Y related\n parties updated\". Returns Status=\"NotFound\" (with all counts zero) when no matching\n 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" } ] } } } } } } }, "/api/association-business-process/{businessProcessId}": { "get": { "tags": [ "AssociationBusinessProcess" ], "summary": "Get a measure-completeness business process", "description": "\nPoll this endpoint after starting an asynchronous measure-completeness calculation. While the\n calculation is running the status is \"InProgress\"; it becomes \"Done\" with the computed requirement\n statuses in `items`, or \"Error\" with the reason in `messages`.

Required permissions:
At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly, AssociationAccess", "operationId": "GetMeasureCompletenessBusinessProcess", "parameters": [ { "name": "businessProcessId", "in": "path", "description": "The identifier returned by the initiate call.", "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": "Business process retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasureCompletenessBusinessProcessDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Business process with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/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/deals/root/{entityId}/journey/{journeyId}": { "get": { "tags": [ "Deals" ], "summary": "Get all verified Deal-Product associations and Deal-Product associations for a Journey", "description": "

Required permissions:
Following permissions are required: AssociationAccess", "operationId": "GetDealProductAssociations", "parameters": [ { "name": "entityId", "in": "path", "description": "The ID of the Entity to search for Product-Deal associations", "required": true, "schema": { "type": "string" } }, { "name": "journeyId", "in": "path", "description": "The ID of the Journey to search for Product-Deal 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": "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/deals/deal/{dealId}": { "get": { "tags": [ "Deals" ], "summary": "Get all deal Associations by Deal Id", "description": "\nThis method returns a deal associations list for a given deal", "operationId": "GetDealAssociationsByDealId", "parameters": [ { "name": "dealId", "in": "path", "description": "The unique identifier of the Deal 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" } ] } } } } } } }, "/api/entity/{id}": { "get": { "tags": [ "Entity" ], "summary": "Get an existing Entity", "description": "\nThis method returns the association metadata of an entity for a given tenant and id

Required permissions:
Following permissions are required: AssociationAccess", "operationId": "GetEntityById", "parameters": [ { "name": "id", "in": "path", "description": "Association Entity 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/EntityDtoServiceResponse" } } } }, "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 entity 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" } ] } } } } } } }, "/api/unwrapping-requirement-status/{id}": { "get": { "tags": [ "UnwrappingRequirementStatus" ], "summary": "Get an Unwrapping Requirement Status Model by Id", "description": "\nGet the Unwrapping Requirement Statuses for an Id

Required permissions:
Following permissions are required: AssociationAccess", "operationId": "GetUnwrappingRequirementStatusModelById", "parameters": [ { "name": "id", "in": "path", "description": "", "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/UnwrappingRequirementStatusResponseDtoServiceResponse" } } } }, "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/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "202": { "description": "Unwrapping Requirement Model retrieved successfully" }, "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/unwrapping-requirement-status/entity/{entityId}/journey/{journeyId}": { "get": { "tags": [ "UnwrappingRequirementStatus" ], "summary": "Get an Unwrapping Requirement Status Model by Entity Id and Journey Id", "description": "\nGet the Unwrapping Requirement Statuses for an Entity Id and Journey Id

Required permissions:
Following permissions are required: AssociationAccess", "operationId": "GetUnwrappingRequirementStatusModelByEntityIdAndJourneyId", "parameters": [ { "name": "entityId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "", "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/UnwrappingRequirementStatusResponseDtoServiceResponse" } } } }, "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/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "202": { "description": "Unwrapping Requirement Model retrieved successfully" }, "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": { "AgencyAssociationsByTargetIdListDto": { "type": "object", "properties": { "entityIds": { "type": "array", "items": { "type": "string" }, "description": "Entity Ids", "nullable": true } }, "additionalProperties": false }, "AgencyAssociationsByTargetIdListDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AgencyAssociationsByTargetIdListDto" } ], "nullable": true } }, "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 }, "AgencyProductDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AgencyProductDto" } ], "nullable": true } }, "additionalProperties": false }, "AssociationConflictDto": { "type": "object", "properties": { "verifiedAssociation": { "allOf": [ { "$ref": "#/components/schemas/AssociationDto" } ], "description": "The Verified association", "nullable": true }, "unverifiedAssociation": { "allOf": [ { "$ref": "#/components/schemas/AssociationDto" } ], "description": "The Unverified association", "nullable": true } }, "additionalProperties": false, "description": "A pair of conflicting associations" }, "AssociationConflictDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationConflictDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "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", "description": "The type of association", "nullable": true, "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\n(optional)", "format": "double", "nullable": true, "example": 5.007 }, "controlPercentage": { "type": "number", "description": "The percentage amount of the target entity controlled by the source entity\n(optional)", "format": "double", "nullable": true, "example": 23.4 }, "markedForDeletion": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lists the JourneyIds which have marked the association for deletion", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "A list of custom properties that describe the association", "nullable": true, "example": [ { "Ownership Percentage": 15 }, { "CountryOfIncorporation": "Ireland" } ] }, "subtype": { "type": "string", "description": "The subtype of association used for product association type", "nullable": true, "example": "Shareholder" }, "relationshipContext": { "allOf": [ { "$ref": "#/components/schemas/RelationshipContexts" } ], "description": "Identifies the relationship context for the association.\nNull when the IA RP feature is disabled or not applicable.", "nullable": true }, "investmentAccountName": { "type": "string", "description": "The name of the investment account this RP is associated with.\nNull when the RP originates from the entity hierarchy only.", "nullable": true } }, "additionalProperties": false, "description": "The metadata of an association between two entities" }, "AssociationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AssociationDtoItemsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationDto" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AssociationDtoItemsPageServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssociationDtoItemsPage" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AssociationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssociationDto" } ], "description": "The metadata of an association between two entities", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AssociationsChangedDto": { "type": "object", "properties": { "sourceId": { "type": "string", "description": "The UiD of the Parent Entity", "nullable": true }, "relationshipsChanges": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipChangesDto" }, "description": "Associations and property changes", "nullable": true } }, "additionalProperties": false }, "AssociationsChangedDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AssociationsChangedDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "BusinessProcessMessageDto": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "messageType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChildrenPageDto": { "type": "object", "properties": { "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/HierarchyChildNodeDto" }, "nullable": true }, "nextPaginationToken": { "type": "string", "description": "Pass this back as the `paginationToken` on a subsequent call against the same entityId and\njourneyId to fetch the next page. Null when there are no more children to fetch.", "nullable": true }, "ownChildCount": { "type": "integer", "description": "The requested entity's own child count - only populated when the request set\n`includeOwnChildCount` to true. Null otherwise, including whenever it wasn't requested.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "A single page of an entity's direct children, plus a token to fetch the next page if there is one." }, "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.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DataChangesDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Datakey of the property changed", "nullable": true }, "existingValue": { "type": "string", "description": "Existing value of the property changed", "nullable": true }, "newValue": { "type": "string", "description": "New value of the property changed", "nullable": true }, "dataChangeType": { "type": "string", "description": "Type of change", "nullable": true } }, "additionalProperties": false }, "EntityDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the entity model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "associatedEntityId": { "type": "string", "description": "The associated entity id", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "associatedJourneyId": { "type": "string", "description": "The associated journey id", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "type": { "type": "string", "description": "The type of the entity", "nullable": true, "example": "Product" } }, "additionalProperties": false, "description": "The metadata of an Entity" }, "EntityDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityDto" } ], "description": "The metadata of an Entity", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FundIdPageDto": { "required": [ "agentId" ], "type": "object", "properties": { "agentId": { "type": "string", "format": "uuid" }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/PageDto" } ], "nullable": true } }, "additionalProperties": false }, "FundIdPageDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/FundIdPageDto" } ], "nullable": true } }, "additionalProperties": false }, "GetEntityChildrenPageRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "The id of the entity whose direct children are requested.", "nullable": true }, "journeyId": { "type": "string", "description": "Optional journey id. When supplied, verified associations and current-journey draft associations\nare both included; when omitted, only verified associations are included.", "nullable": true }, "pageSize": { "type": "integer", "description": "The maximum number of children to return in this page. Defaults to 100.", "format": "int32" }, "paginationToken": { "type": "string", "description": "Token from a previous response's NextPaginationToken, to resume after the last item previously\nreturned. Must have been issued for this exact entityId and journeyId - a token issued for a\ndifferent entity or journey is rejected.", "nullable": true }, "includeOwnChildCount": { "type": "boolean", "description": "When true, the response's OwnChildCount also reports entityId's own child count. Defaults to false -\ncallers 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\nversion of this endpoint accepted, moved to a request body so future parameters can be added without\nanother breaking change to the query string." }, "GetEntityChildrenPageRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetEntityChildrenPageRequestDto" } ], "description": "POST body for `GetEntityChildrenPage` - carries the same parameters a previous GET/query-string\nversion of this endpoint accepted, moved to a request body so future parameters can be added without\nanother breaking change to the query string.", "nullable": true } }, "additionalProperties": false }, "GetRelatedPartiesAutocompleteProgressResponse": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "processed": { "type": "integer", "format": "int32" }, "percentage": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetRelatedPartiesAutocompleteProgressResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRelatedPartiesAutocompleteProgressResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GuidItemsPageDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GuidItemsPageDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GuidItemsPageDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "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", "description": "The association's own type (e.g. UBO, Controlling Person) - distinct from Fenergo.Nebula.Association.Query.Application.Dto.HierarchyChildNodeDto.Type\nbelow, which is the child *entity's* type (e.g. Corporation, Individual).", "nullable": true }, "ownershipPct": { "type": "number", "format": "double", "nullable": true }, "controlPct": { "type": "number", "format": "double", "nullable": true }, "name": { "type": "string", "description": "EntityData's name/type for Fenergo.Nebula.Association.Query.Application.Dto.HierarchyChildNodeDto.EntityId. Null if EntityData had nothing accessible for\nthis id (e.g. authorization filtered it out) - never populated from Neptune itself.", "nullable": true }, "type": { "type": "string", "nullable": true }, "childCount": { "type": "integer", "description": "True child count for this node - if non-zero, the client can offer a Branch Card / drill-in to\npage 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,\nFenergo.Nebula.Association.Query.Application.Dto.HierarchyChildNodeDto.ParentId is the entity whose children were requested." }, "MeasureCompletenessBusinessProcessDto": { "type": "object", "properties": { "businessProcessId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "nullable": true }, "payload": { "allOf": [ { "$ref": "#/components/schemas/MeasureCompletenessBusinessProcessPayloadDto" } ], "description": "Response DTO representing the payload of a measure-completeness business process", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessProcessMessageDto" }, "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MeasureCompletenessBusinessProcessItemDto" }, "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing a measure-completeness business process. Poll this until\n`Status` is \"Done\" or \"Error\"; while it is \"InProgress\" the calculation is still running." }, "MeasureCompletenessBusinessProcessDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MeasureCompletenessBusinessProcessDto" } ], "description": "Response DTO representing a measure-completeness business process. Poll this until\n`Status` is \"Done\" or \"Error\"; while it is \"InProgress\" the calculation is still running.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "MeasureCompletenessBusinessProcessItemDto": { "type": "object", "properties": { "requirementId": { "type": "string", "description": "The Id of the Requirement", "format": "uuid", "example": "8d9e92eb-d18e-4d4d-8971-7781ccc31c80" }, "requirementName": { "type": "string", "description": "The name of the Requirement", "nullable": true, "example": "Add 2 Directors" }, "idvName": { "type": "string", "description": "The name of the Idv Requirement", "nullable": true, "example": "Add 2 Directors" }, "status": { "type": "string", "description": "The status of the Requirement. This is the requirement's own status, not the business process status.", "nullable": true, "example": "Completed" }, "ownershipAndControlDataKey": { "type": "string", "description": "The OwnershipAndControl DataKey", "nullable": true, "example": "addTwoDirectors" }, "completedDate": { "type": "string", "description": "The date at which the requirement was set to Complete", "format": "date-time", "nullable": true }, "minimumPartyCount": { "type": "integer", "description": "The Minimum Party Count needed to validate the Requirement", "format": "int32", "nullable": true, "example": 2 }, "addAllParties": { "type": "boolean", "description": "Whether all Related Parties meeting the criteria are to be added", "nullable": true, "example": false } }, "additionalProperties": false, "description": "Response DTO representing one computed requirement status of a measure-completeness business process" }, "MeasureCompletenessBusinessProcessPayloadDto": { "type": "object", "properties": { "statusModelId": { "type": "string", "description": "The Id of the unwrapping requirement status model, empty when it was resolved during the calculation", "format": "uuid", "example": "fa8cb45d-ac78-4c4e-b701-ffcc2c9e79cf" }, "journeyId": { "type": "string", "description": "The Id of the Journey", "format": "uuid", "example": "7a15bd4a-20f7-497f-b16a-a75d52c8fe01" }, "taskId": { "type": "string", "description": "The Id of the Task", "format": "uuid", "example": "e205ea02-72c6-4aa6-9a10-804a3c78ccaf" }, "entityId": { "type": "string", "description": "The Id of the Entity", "format": "uuid", "example": "58e4b43a-a082-49a6-bf79-0cf8df2313c6" }, "entityDraftId": { "type": "string", "description": "The Id of the Entity Draft", "format": "uuid", "example": "24511767-4586-4b69-af43-c405ec6b154a" }, "productDraftId": { "type": "string", "description": "The Id of the Product Draft, when the calculation was for a product", "format": "uuid", "nullable": true, "example": null } }, "additionalProperties": false, "description": "Response DTO representing the payload of a measure-completeness business process" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PageDto": { "type": "object", "properties": { "paginationToken": { "type": "string", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true } }, "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" }, "ProductIsAgencyDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductIsAgencyDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProductToProductDto": { "type": "object", "properties": { "productIds": { "type": "array", "items": { "type": "string" }, "description": "The UiDs of the products we want to get the associations for", "nullable": true } }, "additionalProperties": false }, "ProductToProductDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProductToProductDto" } ], "nullable": true } }, "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", "description": "The type of association", "nullable": true, "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\n(optional)", "format": "double", "nullable": true, "example": 5.007 }, "controlPercentage": { "type": "number", "description": "The percentage amount of the target entity controlled by the source entity\n(optional)", "format": "double", "nullable": true, "example": 23.4 }, "markedForDeletion": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lists the JourneyIds which have marked the association for deletion", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "A list of custom properties that describe the association", "nullable": true, "example": [ { "Ownership Percentage": 15 }, { "CountryOfIncorporation": "Ireland" } ] }, "subtype": { "type": "string", "description": "The subtype of association used for product association type", "nullable": true, "example": "Shareholder" }, "relationshipContext": { "allOf": [ { "$ref": "#/components/schemas/RelationshipContexts" } ], "description": "Identifies the relationship context for the association.\nNull when the IA RP feature is disabled or not applicable.", "nullable": true }, "investmentAccountName": { "type": "string", "description": "The name of the investment account this RP is associated with.\nNull when the RP originates from the entity hierarchy only.", "nullable": true }, "changeType": { "type": "string", "description": "Change type", "nullable": true, "example": "Add" } }, "additionalProperties": false, "description": "The metadata of an association between two entities extended by change type" }, "ProposedChangesAssociationDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProposedChangesAssociationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RelationshipChangesDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the Child Entity", "nullable": true }, "type": { "type": "string", "description": "The type of association", "nullable": true }, "relationshipChangeType": { "type": "string", "description": "The type of association change", "nullable": true }, "dataChanges": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangesDto" }, "description": "Association property changes", "nullable": true } }, "additionalProperties": false }, "RelationshipContexts": { "enum": [ "None", "Hierarchy", "InvestmentAccount", "Both" ], "type": "string", "description": "Identifies the relationship context for a related party in the RPD&D task.\nDefined as a flags enum so that Fenergo.Nebula.Association.Query.Application.Enums.RelationshipContexts.Both is a true bitwise combination\nof Fenergo.Nebula.Association.Query.Application.Enums.RelationshipContexts.Hierarchy and Fenergo.Nebula.Association.Query.Application.Enums.RelationshipContexts.InvestmentAccount, allowing callers\nto use `HasFlag` to test individual origins." }, "SearchForAssociationDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "The UiD of the root entity.", "nullable": true, "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", "items": { "type": "string" }, "description": "Types of associations to search for.", "nullable": true }, "edgeDirection": { "type": "string", "description": "Edge direction - default inbound-outbound\ninbound - only inbound edges leading to root entity will be searched\noutbound - only outbound edges from root will be searched\ninbound-outbound - inbound and outbound edges will be searched", "nullable": true, "example": "inbound" }, "inboundEdgeTraversalLimit": { "type": "array", "items": { "type": "string" }, "description": "Limits search traversal of inbound edges to specified association type.", "nullable": true }, "outboundEdgeTraversalLimit": { "type": "array", "items": { "type": "string" }, "description": "Limits search traversal of outbound edges to specified association type.", "nullable": true } }, "additionalProperties": false }, "SearchForAssociationDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchForAssociationDto" } ], "nullable": true } }, "additionalProperties": false }, "SearchForAssociationDtoV2": { "required": [ "maxLevels" ], "type": "object", "properties": { "entityId": { "type": "string", "description": "The UiD of the root entity.", "nullable": true, "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", "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.", "nullable": true, "example": "c5d6c4e4-1246-4928-b6ba-6b4e3560e414" }, "associationTypes": { "type": "array", "items": { "type": "string" }, "description": "Types of associations to search for.\nIf not provided, all types of associations will be returned.", "nullable": true, "example": [ "legalEntity", "collateral" ] }, "edgeDirection": { "type": "string", "description": "Edge types - default inbound-outbound.\ninbound-outbound - inbound and outbound edges will be searched.\ninbound - only inbound edges leading to root entity will be searched.\noutbound - only outbound edges from root will be searched.\nIf A is the root entity and edgeDirection is outbound, A-->B will be returned.\nIf A is the root entity and edgeDirection is inbound, A<-C will be returned.\nIf A is the root entity and edgeDirection is inbound-outbound, A-> B and A<-C will be returned.", "nullable": true, "example": "inbound-outbound" }, "allowedInboundAssociationTypesForTraversal": { "type": "array", "items": { "type": "string" }, "description": "The allowed association types of inbound edges for traversal.\nIf not provided, all association types for inbound edges during traversal will be accepted.\nIf we have two associations A<--Shareholder---B, A<---collateral---C, and root entity is A,\nAllowedInboundAssociationTypesForTraversal: [\"Shareholder\"], then only A<--Shareholder---B will be returned.", "nullable": true, "example": [ "legalEntity" ] }, "allowedOutboundAssociationTypesForTraversal": { "type": "array", "items": { "type": "string" }, "description": "The allowed association types of outbound edges for traversal.\nIf not provided, all association types for outbound edges during traversal will be accepted.\nIf we have two associations A--Shareholder--->B, A---collateral--->C, and root entity is A,\nAllowedOutboundAssociationTypesForTraversal: [\"collateral\"], then only A---collateral--->C will be returned.", "nullable": true, "example": [ "product", "collateral" ] }, "excludeRootIds": { "type": "boolean", "description": "When true, the RelatedPartyRootIds attribute is excluded from the returned associations.\nDefaults to false (root ids are included).", "example": false }, "maxAssociations": { "type": "integer", "description": "Optional cap on the number of associations returned. When set (greater than 0), at most this\nmany associations are returned - protecting callers that invoke this query synchronously from\nthe AWS Lambda 6 MB response-size limit (a super-connected entity can otherwise exceed it and\nfail with Function.ResponseSizeTooLarge). When null or not provided, all associations are returned.", "format": "int32", "nullable": true, "example": 2000 } }, "additionalProperties": false }, "SearchForAssociationDtoV2ServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchForAssociationDtoV2" } ], "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "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", "description": "A custom property subtype", "nullable": true, "example": " AccountStructureBankAccount " } }, "additionalProperties": false, "description": "The metadata of the transfer agency association between two entities" }, "TransferAgencyAssociationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransferAgencyAssociationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UnwrappingRequirementStatusDto": { "type": "object", "properties": { "requirementId": { "type": "string", "description": "The Id of the Requirement", "format": "uuid", "example": "580565ee-0700-4aec-854d-8cc9dbb58bc1" }, "status": { "type": "string", "description": "The Status of the Unwrapping Requirement", "nullable": true, "example": "Complete" }, "ownershipAndControlDataKey": { "type": "string", "description": "The DataKey of the Requirement", "nullable": true, "example": "e28a3705-927b-47cd-98bc-b2ad63a6fa69" }, "completedDate": { "type": "string", "description": "The date when the Requirement was set to 'Completed'", "format": "date-time", "nullable": true, "example": null }, "requirementName": { "type": "string", "description": "The Name of the Requirement", "nullable": true, "example": "Add All UBOs" }, "idvName": { "type": "string", "description": "The Name of the Idv Requirement", "nullable": true, "example": "Add All Directors" }, "minimumPartyCount": { "type": "integer", "description": "The Minimum Party Count needed to validate the Requirement", "format": "int32", "nullable": true, "example": 2 }, "addAllParties": { "type": "boolean", "description": "The attribute which specified if all Related Parties which meet the criteria are to be added", "nullable": true, "example": false } }, "additionalProperties": false }, "UnwrappingRequirementStatusResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the model", "format": "uuid", "example": "410871d0-d2c6-4d2f-96ea-2fd652c1a92d" }, "entityId": { "type": "string", "description": "The Id of the current Entity", "format": "uuid", "example": "18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba" }, "journeyId": { "type": "string", "description": "The Id of the Journey", "format": "uuid", "example": "088f2d94-f2e1-4afb-b908-498a76ebf771" }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/UnwrappingRequirementStatusDto" }, "description": "The statuses of the unwrapping requirements", "nullable": true } }, "additionalProperties": false, "description": "Contains all the information needed to store the status of the Unwrapping Requirement" }, "UnwrappingRequirementStatusResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UnwrappingRequirementStatusResponseDto" } ], "description": "Contains all the information needed to store the status of the Unwrapping Requirement", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "VerifiedProductIdPageDto": { "required": [ "agentId", "fundId" ], "type": "object", "properties": { "agentId": { "type": "string", "format": "uuid" }, "fundId": { "type": "string", "format": "uuid" }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/PageDto" } ], "nullable": true } }, "additionalProperties": false }, "VerifiedProductIdPageDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/VerifiedProductIdPageDto" } ], "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }