openapi: 3.2.0 info: title: Fenergo Nebula Change Management Query Review And Approval… description: Query API to get the change management data to show in the UI. version: '1.0' servers: - url: /changemanagementquery security: - Bearer: [] tags: - name: ReviewAndApprovalConfigurationQuery paths: /api/review-approval-configuration: get: tags: - ReviewAndApprovalConfigurationQuery summary: Gets all configuration summaries by tenantId description: 'This method returns all configuration summary for tenant Required permissions: Following permissions are required: ReviewApprovalConfigurationAccess' 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 responses: '200': description: Configuration Summary models returned successfully content: text/plain: schema: $ref: '#/components/schemas/ConfigurationSummaryDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/ConfigurationSummaryDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/ConfigurationSummaryDtoIEnumerableServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: Unauthorised content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT operationId: getApiReviewApprovalConfiguration x-operation-id-source: derived /api/review-approval-configuration/{configurationId}: get: tags: - ReviewAndApprovalConfigurationQuery summary: Get configuration by id description: This method returns configuration for tenant by id parameters: - name: configurationId in: path required: true schema: type: string format: uuid - name: journeyInstanceId in: query 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: Configuration model returned successfully content: text/plain: schema: $ref: '#/components/schemas/ConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ConfigurationDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: Unauthorised content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT operationId: getApiReviewApprovalConfigurationByConfigurationId x-operation-id-source: derived /api/review-approval-configuration/{configurationId}/versions: get: tags: - ReviewAndApprovalConfigurationQuery summary: Get version history for a configuration description: 'Returns all versions of a review approval configuration, ordered by version number descending. Required permissions: Following permissions are required: ReviewApprovalConfigurationAccess' parameters: - name: configurationId in: path 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: Version history returned successfully content: text/plain: schema: $ref: '#/components/schemas/ConfigurationVersionSummaryDtoIReadOnlyCollectionServiceResponse' application/json: schema: $ref: '#/components/schemas/ConfigurationVersionSummaryDtoIReadOnlyCollectionServiceResponse' text/json: schema: $ref: '#/components/schemas/ConfigurationVersionSummaryDtoIReadOnlyCollectionServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: Unauthorised content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Configuration not found type: Error errorCode: Error Code '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT operationId: getApiReviewApprovalConfigurationByConfigurationIdVersions x-operation-id-source: derived /api/review-approval-configuration/{configurationId}/versions/{versionNumber}: get: tags: - ReviewAndApprovalConfigurationQuery summary: Get a specific version of a configuration description: 'Returns the full details of a specific version of a review approval configuration. Required permissions: Following permissions are required: ReviewApprovalConfigurationAccess' parameters: - name: configurationId in: path required: true schema: type: string format: uuid - name: versionNumber in: path required: true schema: type: integer 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: Configuration version returned successfully content: text/plain: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: Unauthorised content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Configuration or version not found type: Error errorCode: Error Code '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT operationId: getApiReviewApprovalConfigurationByConfigurationIdVersionsByVersionNumber x-operation-id-source: derived /api/review-approval-configuration/{configurationId}/draft: get: tags: - ReviewAndApprovalConfigurationQuery summary: Get the current draft version of a configuration description: 'Returns the draft version of a review approval configuration if one exists. Required permissions: Following permissions are required: ReviewApprovalConfigurationAccess' parameters: - name: configurationId in: path 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: Draft configuration returned successfully content: text/plain: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: Unauthorised content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Configuration or draft not found type: Error errorCode: Error Code '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT operationId: getApiReviewApprovalConfigurationByConfigurationIdDraft x-operation-id-source: derived components: schemas: ConfigurationDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConfigurationVersionSummaryDtoIReadOnlyCollectionServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationVersionSummaryDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false BankAccountsDetailsDto: type: object properties: dataAndDocumentPolicyCategories: type: - array - 'null' items: type: string additionalProperties: false ApprovalConfigurationDto: type: object properties: approvalOptions: type: - array - 'null' items: type: string approvalOptionsConfigurations: type: - array - 'null' items: $ref: '#/components/schemas/ApprovalOptionConfigurationDto' requireResolutionofAllComments: type: boolean topicsLookup: type: - string - 'null' additionalProperties: false ConfigurationVersionSummaryDto: type: object properties: versionNumber: type: integer format: int32 status: allOf: - $ref: '#/components/schemas/VersionStatus' name: type: - string - 'null' versionNote: type: - string - 'null' changedFields: type: - array - 'null' items: type: string createdAt: type: - string - 'null' format: date-time publishedBy: type: - string - 'null' publishedAt: type: - string - 'null' format: date-time archivedBy: type: - string - 'null' archivedAt: type: - string - 'null' format: date-time submittedBy: type: - string - 'null' submittedAt: type: - string - 'null' format: date-time rejectedBy: type: - string - 'null' rejectedAt: type: - string - 'null' format: date-time deletedBy: type: - string - 'null' deletedAt: type: - string - 'null' format: date-time additionalProperties: false ApprovalOptionConfigurationDto: type: object properties: option: type: - string - 'null' reasonType: type: - string - 'null' lookup: type: - string - 'null' linkLookup: type: - string - 'null' additionalProperties: false ProductsDetailsDto: type: object properties: productCategories: type: - array - 'null' items: type: string productScopingRule: type: - string - 'null' enableAllProductCategories: type: boolean additionalProperties: false ConfigurationDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' showChangesFor: type: - array - 'null' items: type: string approvalConfiguration: allOf: - $ref: '#/components/schemas/ApprovalConfigurationDto' entityDataDetails: allOf: - $ref: '#/components/schemas/EntityDataDetailsDto' documentsDetails: allOf: - $ref: '#/components/schemas/DocumentsDetailsDto' relatedPartiesDetails: allOf: - $ref: '#/components/schemas/RelatedPartiesDetailsDto' productsDetails: allOf: - $ref: '#/components/schemas/ProductsDetailsDto' riskDetails: allOf: - $ref: '#/components/schemas/RiskDetailsDto' investmentAccountsDetails: allOf: - $ref: '#/components/schemas/InvestmentAccountsDetailsDto' bankAccountsDetails: allOf: - $ref: '#/components/schemas/BankAccountsDetailsDto' additionalProperties: false EntityDataDetailsDto: type: object properties: requirementCategories: type: - array - 'null' items: type: string additionalProperties: false DocumentsDetailsDto: type: object properties: requirementCategories: type: - array - 'null' items: type: string additionalProperties: false RiskDetailsDto: type: object properties: riskSubTabs: type: - array - 'null' items: type: string additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConfigurationSummaryDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSummaryDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false InvestmentAccountsDetailsDto: type: object properties: dataAndDocumentPolicyCategories: type: - array - 'null' items: type: string additionalProperties: false ConfigurationSummaryDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' latestVersionNumber: type: - integer - 'null' format: int32 status: allOf: - $ref: '#/components/schemas/VersionStatus' createdAt: type: - string - 'null' format: date-time additionalProperties: false ConfigurationVersionDto: type: object properties: id: type: string format: uuid versionNumber: type: integer format: int32 status: allOf: - $ref: '#/components/schemas/VersionStatus' name: type: - string - 'null' description: type: - string - 'null' showChangesFor: type: - array - 'null' items: type: string approvalConfiguration: allOf: - $ref: '#/components/schemas/ApprovalConfigurationDto' entityDataDetails: allOf: - $ref: '#/components/schemas/EntityDataDetailsDto' documentsDetails: allOf: - $ref: '#/components/schemas/DocumentsDetailsDto' relatedPartiesDetails: allOf: - $ref: '#/components/schemas/RelatedPartiesDetailsDto' productsDetails: allOf: - $ref: '#/components/schemas/ProductsDetailsDto' riskDetails: allOf: - $ref: '#/components/schemas/RiskDetailsDto' investmentAccountsDetails: allOf: - $ref: '#/components/schemas/InvestmentAccountsDetailsDto' bankAccountsDetails: allOf: - $ref: '#/components/schemas/BankAccountsDetailsDto' versionNote: type: - string - 'null' changedFields: type: - array - 'null' items: type: string isMigrated: type: boolean createdAt: type: - string - 'null' format: date-time publishedBy: type: - string - 'null' publishedAt: type: - string - 'null' format: date-time archivedBy: type: - string - 'null' archivedAt: type: - string - 'null' format: date-time submittedBy: type: - string - 'null' submittedAt: type: - string - 'null' format: date-time rejectedBy: type: - string - 'null' rejectedAt: type: - string - 'null' format: date-time deletedBy: type: - string - 'null' deletedAt: type: - string - 'null' format: date-time additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false RelatedPartiesDetailsDto: type: object properties: dataAndDocumentPolicyCategories: type: - array - 'null' items: type: string relatedPartyScopingRule: type: - string - 'null' additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ConfigurationVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header