openapi: 3.2.0 info: title: Fenergo Requirement Set API version: '1.0' description: 'Operations tagged RequirementSet across 5 of this provider''s published API definitions: fenergo-dealscommand-v1-0-openapi.json, fenergo-dealsquery-v1-0-openapi.json, fenergo-policycommand-v1-0-openapi.json, fenergo-policyquery-v1-0-openapi.json, fenergo-policyquery-v2-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /dealscommand - url: /dealsquery - url: /policycommand - url: /policyquery security: - Bearer: [] tags: - name: RequirementSet paths: /api/requirement-set: post: tags: - RequirementSet summary: Create requirement set description: 'Creates a new requirement set along with its initial draft version. The newly created version is initialized with the provided data, starting with a default draft status, and the author is set as the only required signee. Required permissions: Following permissions are required: DealConfigurationEdit' operationId: CreateRequirementSet 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/RequirementSetDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/RequirementSetDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/RequirementSetDtoServiceRequest' responses: '201': description: Success. Requirement set created content: text/plain: schema: $ref: '#/components/schemas/CreateRequirementSetResponseServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateRequirementSetResponseServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateRequirementSetResponseServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '403': description: Forbidden. User doesn't have proper permissions '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - RequirementSet summary: Get Requirement Sets description: 'Returns all deals requirement sets. Required permissions: At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch' operationId: GetAllRequirementSets 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: Success. List of requirement sets is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /dealscommand /api/requirement-set/{requirementSetId}: post: tags: - RequirementSet summary: Create requirement set version description: 'Creates a new version of an existing requirement set. Required permissions: Following permissions are required: DealConfigurationEdit' operationId: CreateRequirementSetVersion parameters: - name: requirementSetId in: path description: Requirement set id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Create a new Version for existing Requirement Set content: application/json: schema: allOf: - $ref: '#/components/schemas/RequirementSetDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/RequirementSetDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/RequirementSetDtoServiceRequest' responses: '201': description: Created content: text/plain: schema: $ref: '#/components/schemas/CreateRequirementSetVersionResponseServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateRequirementSetVersionResponseServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateRequirementSetVersionResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '202': description: Success. Requirement set version created '403': description: Forbidden. User doesn't have proper permissions '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '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 delete: tags: - RequirementSet summary: Delete requirement set description: 'Deletes selected requirement set. Required permissions: Following permissions are required: DealConfigurationDelete' operationId: DeleteRequirementSet parameters: - name: requirementSetId in: path description: Requirement Set Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Requirement Set version deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - RequirementSet summary: Get deals requirement sets by Id description: 'Returns the requirement set for the given id. Required permissions: At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch' operationId: GetRequirementSetById parameters: - name: requirementSetId in: path description: Requirement Set Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Requirement set is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values 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 '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /dealscommand /api/requirement-set/{requirementSetId}/version/{versionNumber}: put: tags: - RequirementSet summary: Update requirement set version description: 'Updates an existing Deal requirement set version. Only draft and rejected versions are allowed to be updated. Required permissions: Following permissions are required: DealConfigurationEdit' operationId: UpdateRequirementSetVersion parameters: - name: requirementSetId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to update 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 requestBody: description: Update requirement set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/RequirementSetDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/RequirementSetDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/RequirementSetDtoServiceRequest' responses: '202': description: Success. Requirement set version updated '400': description: Bad request. The request has missing/invalid values 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: Not Found. Requirement set with given id does not exist type: Error errorCode: Error Code '403': description: Forbidden. User doesn't have proper permissions '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '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 delete: tags: - RequirementSet summary: Delete requirement set version description: 'Deletes the selected version of an existing requirement set. If the version is the last one, then the version number of it will become the next available one for the model. Required permissions: Following permissions are required: DealConfigurationDelete' operationId: DeleteRequirementSetVersion parameters: - name: requirementSetId in: path description: Requirement Set Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to delete 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: '202': description: Success. Requirement Set version deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Requirement set or Requirement set version with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - RequirementSet summary: Get deal requirement set by id and version description: 'Returns deal requirement set for a given id and version number. Required permissions: At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch' operationId: GetRequirementSetByIdVersionNumber parameters: - name: requirementSetId in: path description: Deal requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Deal requirement set version number 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: Success. Deal requirement set is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetVersionDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values 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. Deal requirement set with given id/version does not exist 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 '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 servers: - url: /dealscommand /api/requirement-set/{requirementSetId}/version/{versionNumber}/submit-for-approval: put: tags: - RequirementSet summary: Submit requirement set version for approval description: 'Submits the selected version of an existing requirement set for approval. Required permissions: Following permissions are required: DealConfigurationEdit' operationId: SubmitRequirementSetVersion parameters: - name: requirementSetId in: path description: Requirement Set Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to submit 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: '202': description: Success. Requirement version submitted '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist type: Error errorCode: Error Code '403': description: Forbidden. User doesn't have proper permissions '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '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 servers: - url: /dealscommand /api/requirement-set/{requirementSetId}/version/{versionNumber}/sign: put: tags: - RequirementSet summary: Sign requirement set version description: 'Signs the selected version of an existing requirements set and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: DealConfigurationApprove' operationId: SignRequirementSetVersion parameters: - name: requirementSetId in: path description: Requirement Set Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to sign 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 requestBody: description: Sign requirement set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' responses: '202': description: Success. Deals version signed '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Requirement Set with given id does not exist type: Error errorCode: Error Code '403': description: Forbidden. User doesn't have proper permissions '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '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 servers: - url: /dealscommand /api/requirement-set/{requirementSetId}/version/{versionNumber}/draft: post: tags: - RequirementSet summary: Create requirement set version from provided version number description: 'Creates a new version of an existing requirement set version. Required permissions: Following permissions are required: DealConfigurationEdit' operationId: CreateRequirementSetVersionDraft parameters: - name: requirementSetId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number from which new draft will be created 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: '201': description: Success. Requirement set version created content: text/plain: schema: $ref: '#/components/schemas/CreateRequirementSetVersionDraftResponseServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateRequirementSetVersionDraftResponseServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateRequirementSetVersionDraftResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Requirement set with given id and version number does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /dealscommand /api/requirement-set/{requirementSetId}/version/{versionNumber}/archive: put: tags: - RequirementSet summary: Archive a Deal Requirement Set Version description: 'Archives the selected version of an existing deal requirement set. Required permissions: Following permissions are required: DealConfigurationEdit' operationId: ArchiveRequirementSetVersion parameters: - name: requirementSetId in: path description: Requirement Set Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to archive 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: '202': description: Success. Requirement version archived '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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 '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 servers: - url: /dealscommand /api/requirement-set/{requirementSetId}/version/{versionNumber}/field: post: tags: - RequirementSet summary: Add deal requirement description: 'Adds a new requirement to a deal requirement set. Returns the id of the created requirement. Required permissions: Following permissions are required: DealConfigurationEdit' operationId: AddRequirement parameters: - name: requirementSetId in: path description: Deal requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Deal requirement set version number 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 requestBody: description: Add requirement request content: application/json: schema: allOf: - $ref: '#/components/schemas/RequirementDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/RequirementDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/RequirementDtoServiceRequest' responses: '201': description: Success. Requirement added content: text/plain: schema: $ref: '#/components/schemas/CreateRequirementResponseServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateRequirementResponseServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateRequirementResponseServiceResponse' '400': description: Bad request. The request has missing/invalid values 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: Not Found. Requirement set or version with given id does not exist 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 '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 servers: - url: /dealscommand /api/requirement-set/{requirementSetId}/version/{versionNumber}/field/{requirementId}: put: tags: - RequirementSet summary: Update a deal requirement description: 'Updates a requirement in a deal requirement set. Required permissions: Following permissions are required: DealConfigurationEdit' operationId: UpdateRequirement parameters: - name: requirementSetId in: path description: Requirement Set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version Number required: true schema: type: integer format: int32 - name: requirementId in: path description: Requirement Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Update requirement request content: application/json: schema: allOf: - $ref: '#/components/schemas/RequirementDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/RequirementDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/RequirementDtoServiceRequest' responses: '202': description: Success. Requirement updated '400': description: Bad request. The request has missing/invalid values 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: Not Found. Requirement set or version with given id does not exist 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 '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 delete: tags: - RequirementSet summary: Delete a deal requirement description: 'Deletes a requirement in a deal requirement set. Required permissions: Following permissions are required: DealConfigurationDelete' operationId: DeleteRequirement parameters: - name: requirementSetId in: path description: Requirement Set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version Number required: true schema: type: integer format: int32 - name: requirementId in: path description: Requirement Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Requirement Deleted '400': description: Bad request. The request has missing/invalid values 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: Not Found. Requirement set or version with given id does not exist 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 '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 servers: - url: /dealscommand /api/requirement-set/{requirementSetId}/version/active: get: tags: - RequirementSet summary: Get current active requirement set version description: 'Returns the current active version of the requirement set for the given id. Required permissions: At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch' operationId: GetActiveRequirementSetVersion parameters: - name: requirementSetId in: path description: Requirement Set Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Requirement set is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetVersionDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values 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 '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /dealsquery /api/requirement-set/{requirementSetId}/version/{versionNumber}/field/{id}: get: tags: - RequirementSet summary: Get requirement by id description: 'Returns requirement by given requirement set id, requirement set version number and requirement id. Required permissions: At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch' operationId: GetRequirementById parameters: - name: requirementSetId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Requirement set version number required: true schema: type: integer format: int32 - name: id in: path description: Requirement id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Requirement is returned content: application/json: schema: $ref: '#/components/schemas/RequirementDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values 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. Requirement set/requirement with given id/version does not exist 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 '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 servers: - url: /dealsquery /api/requirement-set/evaluate-requirements: post: tags: - RequirementSet summary: Evaluate all requirements description: 'Recommended way to get all evaluated requirements (conditional and not) for a given parameters. Required permissions: At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch' operationId: EvaluateRequirements 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: Evaluate all requirements request with a set of criteria to filter requirements and evaluate conditions. content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsRequestDtoServiceRequest' responses: '200': description: Success. Response is returned. content: application/json: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsResponseDtoServiceResponse' '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. The request has missing/invalid values. content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /dealsquery /api/requirement-set/evaluate-requirements/read-only: post: tags: - RequirementSet summary: Evaluate all requirements in read-only status. description: 'Recommended way to get all evaluated requirements (conditional and not) for a given parameters. Required permissions: At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch' operationId: EvaluateRequirementsReadonly 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: Evaluate all requirements request with a set of criteria to filter requirements and evaluate conditions, but it will skip calculation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsRequestDtoServiceRequest' responses: '200': description: Success. Response is returned. content: application/json: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsResponseDtoServiceResponse' '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. The request has missing/invalid values. content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /dealsquery /api/requirement-set/requirements-data-source: get: tags: - RequirementSet summary: Get Requirements Data Source description: 'Returns all requirements data source. Required permissions: At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch' operationId: GetRequirementsDataSource 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: Success. List of requirements is returned content: application/json: schema: $ref: '#/components/schemas/GetMergedRequirementSetsDataFieldsResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /dealsquery /api/requirement-set/{setId}: post: tags: - RequirementSet summary: Create requirement set version description: 'Creates a new version of an existing requirement set. Assigns the next available version number. The new version initializes with the provided data, has the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: postApiRequirementSetBySetId parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Create requirement set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/RequirementSetDtoServiceRequest_2' description: Service request data responses: '202': description: Success. Requirement set version created content: application/json: schema: $ref: '#/components/schemas/CreateRequirementSetResponseServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateRequirementSetVersion delete: tags: - RequirementSet summary: Delete requirement set and all its versions description: 'Deletes an existing requirement set and all its versions. Required permissions: Following permissions are required: PolicyConfigurationDelete' operationId: deleteApiRequirementSetBySetId parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: allowGlobalPolicyRemoval in: query description: Flag allowing to delete Global policy (Not recommended) schema: type: boolean default: false - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Requirement set deleted '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteRequirementSet get: tags: - RequirementSet summary: Get requirement set by id description: 'Returns the active, currently in effect, published requirement set version for a given id. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: getApiRequirementSetBySetId parameters: - name: setId in: path description: Requirement set 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: Success. Requirement set is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetVersionDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetRequirementSetById servers: - url: /policycommand /api/requirement-set/{setId}/version/{versionNumber}/draft: post: tags: - RequirementSet summary: Create requirement set version from provided set id description: 'Creates a new version of an existing requirement set. Assigns the next available version number. The new version initializes with the latest published requirement set data, has the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: CreateRequirementSetVersionFromSetId parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to create new draft from 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: '202': description: Success. Requirement set version created content: application/json: schema: $ref: '#/components/schemas/CreateRequirementSetVersionFromSetIdResponseServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/requirement-set/{setId}/version/{versionNumber}: put: tags: - RequirementSet summary: Update requirement set version description: 'Updates an existing requirement set version. Only draft and rejected versions are allowed to be updated. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: putApiRequirementSetBySetIdVersionByVersionNumber parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to update 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 requestBody: description: Update requirement set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateRequirementSetVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Requirement set version updated content: application/json: schema: $ref: '#/components/schemas/UpdatedRequirementSetVersionResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateRequirementSetVersion delete: tags: - RequirementSet summary: Delete requirement set version description: 'Deletes the selected version of an existing requirement set. If the version is the last one, then the version number of it will become the next available one for the model. Otherwise, the version number will be flagged as deleted and become unavailable. Required permissions: Following permissions are required: PolicyConfigurationDelete' operationId: deleteApiRequirementSetBySetIdVersionByVersionNumber parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to delete 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: '202': description: Success. Requirement set version deleted '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteRequirementSetVersion get: tags: - RequirementSet summary: Get requirement set by id and version description: 'Returns requirement set for a given id and version number. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: GetRequirementSetVersionById parameters: - name: setId in: path description: Requirement set id required: true schema: type: string - name: versionNumber in: path description: Requirement set version number 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: Success. Requirement set is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetVersionDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Not Found. Requirement set with given id/version does not exist 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/requirement-set/{setId}/version/{versionNumber}/lite: put: tags: - RequirementSet summary: Update properties in the specified requirement set version description: 'Updates an existing requirement set version. Only draft and rejected versions are allowed to be updated. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: UpdateRequirementSetVersionLite parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to update 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 requestBody: description: Update requirement set version request with editable properties content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateRequirementSetVersionLiteDtoServiceRequest' description: Service request data responses: '202': description: Success. Requirement set version updated content: application/json: schema: $ref: '#/components/schemas/UpdatedRequirementSetVersionResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/requirement-set/{requirementSetId}/version/{versionNumber}/clone: post: tags: - RequirementSet summary: Clone requirement set version description: 'Clones the selected version of an existing requirement set and creates a new model with a single version. The new version contains all the data of the original selected one, will have the default status of draft and the author as the only required signee. Returns the id of the cloned requirement set version. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: CloneRequirementSetVersion parameters: - name: requirementSetId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to clone 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 requestBody: description: Clone requirement set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CloneRequirementSetVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Requirement set version cloned content: application/json: schema: $ref: '#/components/schemas/CloneRequirementSetVersionResponseServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/requirement-set/{setId}/version/{versionNumber}/submit-for-approval: put: tags: - RequirementSet summary: Submit requirement set version for approval description: 'Submits the selected version of an existing requirement set for approval. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: putApiRequirementSetBySetIdVersionByVersionNumberSubmitForApproval parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to submit 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: '202': description: Success. Requirement set version submitted '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SubmitRequirementSetVersion servers: - url: /policycommand /api/requirement-set/{setId}/version/{versionNumber}/sign: put: tags: - RequirementSet summary: Sign requirement set version description: 'Signs the selected version of an existing requirement set and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: PolicyConfigurationApprove' operationId: putApiRequirementSetBySetIdVersionByVersionNumberSign parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to sign 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 requestBody: description: Sign requirement set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest_2' description: Service request data responses: '202': description: Success.Requirement set version signed content: application/json: schema: $ref: '#/components/schemas/RequirementSetVersionSignResponseServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SignRequirementSetVersion servers: - url: /policycommand /api/requirement-set/{setId}/version/{versionNumber}/archive: put: tags: - RequirementSet summary: Archive requirement set version description: 'Archives the selected version of an existing requirement set. Required permissions: Following permissions are required: PolicyConfigurationArchive' operationId: putApiRequirementSetBySetIdVersionByVersionNumberArchive parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to archive 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: '202': description: Success. Requirement set version archived content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: ArchiveRequirementSetVersion servers: - url: /policycommand /api/requirement-set/{id}/version/{versionNumber}/field: post: tags: - RequirementSet summary: Add requirement description: 'Adds a new requirement to an existing requirement set. Returns the id of the created requirement. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: postApiRequirementSetByIdVersionByVersionNumberField parameters: - name: id in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Requirement set version number 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 requestBody: description: Add requirement request content: application/json: schema: allOf: - $ref: '#/components/schemas/RequirementDtoServiceRequest_2' description: Service request data responses: '202': description: Success. Requirement added content: application/json: schema: $ref: '#/components/schemas/ItemCreatedDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: AddRequirement put: tags: - RequirementSet summary: Update requirement description: 'Updates an existing requirement in specific requirement set. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: putApiRequirementSetByIdVersionByVersionNumberField parameters: - name: id in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Requirement set version number 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 requestBody: description: Update requirement request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateRequirementDtoServiceRequest' description: Service request data responses: '202': description: Success. Requirement updated content: application/json: schema: $ref: '#/components/schemas/UpdateRequirementDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateRequirement servers: - url: /policycommand /api/requirement-set/{setId}/version/{versionNumber}/fields: post: tags: - RequirementSet summary: Add requirements description: 'Adds multiple requirements to an existing requirement set. Returns the ids of the created requirements. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: AddRequirements parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Requirement set version number 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 requestBody: description: Add requirements request content: application/json: schema: allOf: - $ref: '#/components/schemas/AddRequirementsRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Requirements added content: application/json: schema: $ref: '#/components/schemas/AddRequirementsResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/requirement-set/{id}/version/{versionNumber}/field/{fieldId}: delete: tags: - RequirementSet summary: Delete requirement description: 'Deletes an existing requirement in specific requirement set. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: deleteApiRequirementSetByIdVersionByVersionNumberFieldByFieldId parameters: - name: id in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Requirement set version number required: true schema: type: integer format: int32 - name: fieldId in: path description: Requirement id to delete required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Requirement deleted '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set/requirement with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteRequirement servers: - url: /policycommand /api/requirement-set/{setId}/version/{versionNumber}/update-requirements-dataprotection-jurisdiction: put: tags: - RequirementSet summary: Update requirements DataProtectionJurisdiction description: 'Update DataProtectionJurisdiction for all Requirements in specified Requirement Set using DefaultDataProtectionJurisdiction Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: UpdateRequirementsDataProtectionJurisdiction parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to update data protection jurisdiction 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: '202': description: Success. Requirement set attributes updated with default data protection jurisdiction '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_2' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/requirement-set/{setId}/version/{versionNumber}/field/{id}: get: tags: - RequirementSet summary: Get requirement by id description: 'Returns requirement by given requirement set id, requirement set version number and requirement id. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: getApiRequirementSetBySetIdVersionByVersionNumberFieldById parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Requirement set version number required: true schema: type: integer format: int32 - name: id in: path description: Requirement id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Requirement is returned content: application/json: schema: $ref: '#/components/schemas/RequirementDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Not Found. Requirement set/requirement with given id/version does not exist 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetRequirementById servers: - url: /policyquery /api/requirement-set/jurisdictions: get: tags: - RequirementSet summary: Get jurisdictions description: 'Returns all jurisdictions available in tenant requirement sets Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: GetJurisdictions 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: Success. List of available jurisdictions is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetJurisdictionDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v2/requirement-set: get: tags: - RequirementSet summary: Get requirement sets description: 'Returns all requirement sets and theirs requirements if specified in the parameter. Returns only requirement sets by default. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: getApiV2RequirementSet parameters: - name: includeRequirements in: query description: Flag to include requirements in the response. schema: type: boolean default: false - name: versionsLimit in: query description: Optional limit on versions returned per jurisdiction. When omitted, all versions are returned. 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: Success. List of requirement sets data is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetDtoIEnumerableServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '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_4' 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_4' 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_4' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAllRequirementSets servers: - url: /policyquery /api/v2/requirement-set/{setId}: get: tags: - RequirementSet summary: Get requirement set by id description: 'Returns the active, currently in effect, published requirement set version for a given id. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: getApiV2RequirementSetBySetId parameters: - name: setId in: path description: Requirement set 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: Success. Requirement set is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetVersionDtoServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_4' example: data: {} messages: - message: Not Found. Requirement set with given id does not exist 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_4' 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_4' 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_4' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetRequirementSetById servers: - url: /policyquery /api/v2/requirement-set/{setId}/version/{versionNumber}: get: tags: - RequirementSet summary: Get requirement set by id and version description: 'Returns requirement set for a given id and version number. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: getApiV2RequirementSetBySetIdVersionByVersionNumber parameters: - name: setId in: path description: Requirement set id required: true schema: type: string - name: versionNumber in: path description: Requirement set version number 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: Success. Requirement set is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetVersionDtoServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_4' example: data: {} messages: - message: Not Found. Requirement set with given id/version does not exist 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_4' 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_4' 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_4' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetRequirementSetVersionById servers: - url: /policyquery /api/v2/requirement-set/{setId}/version/{versionNumber}/field/{id}: get: tags: - RequirementSet summary: Get requirement by id description: 'Returns requirement by given requirement set id, requirement set version number and requirement id. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: getApiV2RequirementSetBySetIdVersionByVersionNumberFieldById parameters: - name: setId in: path description: Requirement set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Requirement set version number required: true schema: type: integer format: int32 - name: id in: path description: Requirement id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Requirement is returned content: application/json: schema: $ref: '#/components/schemas/RequirementDtoServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_4' example: data: {} messages: - message: Not Found. Requirement set/requirement with given id/version does not exist 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_4' 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_4' 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_4' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetRequirementById servers: - url: /policyquery /api/v2/requirement-set/jurisdictions: get: tags: - RequirementSet summary: Get jurisdictions description: 'Returns all jurisdictions available in tenant requirement sets Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: getApiV2RequirementSetJurisdictions 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: Success. List of available jurisdictions is returned content: application/json: schema: $ref: '#/components/schemas/RequirementSetJurisdictionDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '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_4' 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_4' 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_4' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetJurisdictions servers: - url: /policyquery components: schemas: ConditionalValueDto: allOf: - $ref: '#/components/schemas/StringConditionalValueDto' - type: object properties: valueId: type: - string - 'null' additionalProperties: false SpecialCharactersRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: excludedCharacters: type: array items: type: string additionalProperties: false DataFieldDto: type: object properties: propertyName: type: string propertyType: type: string propertyTypeId: type: - string - 'null' format: uuid linkChildFieldPropertyName: type: - string - 'null' formulaSchema: allOf: - $ref: '#/components/schemas/FormulaSchemaDto' additionalProperties: false CreateRequirementSetResponse: type: object properties: id: type: string format: uuid additionalProperties: false RequirementSetDto: type: object properties: id: type: - string - 'null' format: uuid name: type: string effectiveFrom: type: string format: date-time notes: type: - string - 'null' version: type: - integer - 'null' format: int32 requirements: type: - array - 'null' items: $ref: '#/components/schemas/RequirementDto' additionalProperties: false ValidationDataDto: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto' specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDto' onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto' noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto' onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto' regex: allOf: - $ref: '#/components/schemas/RegexRuleDto' characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' disallowTodaysDate: allOf: - $ref: '#/components/schemas/BasicRuleDto' dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto' multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto' collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto' timeZoneId: type: - string - 'null' additionalProperties: false CreateRequirementResponse: type: object properties: id: type: string format: uuid additionalProperties: false CreateRequirementSetVersionDraftResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateRequirementSetVersionDraftResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CollectionMaximumCountRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 overallMaximumCount: type: - integer - 'null' format: int32 additionalProperties: false ValueLimitRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: minValue: type: - integer - 'null' format: int32 maxValue: type: - integer - 'null' format: int32 additionalProperties: false BasicRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' additionalProperties: false CreateRequirementSetVersionResponse: type: object properties: id: type: string format: uuid versionNumber: type: integer format: int32 requirementSetId: type: string format: uuid name: type: string notes: type: - string - 'null' created: type: string format: date-time requirements: type: - array - 'null' items: $ref: '#/components/schemas/RequirementDto' additionalProperties: false StringConditionalValueDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' value: type: - string - 'null' priority: type: integer format: int32 additionalProperties: false ConditionDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ValueField: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false CreateRequirementSetVersionResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateRequirementSetVersionResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Decision: enum: - Approve - Reject type: string CreateRequirementResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateRequirementResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CollectionMinimumCountRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 overallMinimumCount: type: integer format: int32 additionalProperties: false ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} CreateRequirementSetResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateRequirementSetResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ValidationRuleDto: type: object properties: propertyName: type: string friendlyName: type: - string - 'null' validationType: type: - string - 'null' validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' additionalProperties: false DateLimitRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: minDate: type: - string - 'null' format: date-time maxDate: type: - string - 'null' format: date-time additionalProperties: false ApproveActionServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' 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 FormulaSchemaDto: type: object properties: formulaSetId: type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: type: string formulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/FormulaVariableDto' additionalProperties: false FilterConditionDto: type: object properties: fieldName: type: - string - 'null' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' additionalProperties: false ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ConditionDefinitionDto: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' valueField: allOf: - $ref: '#/components/schemas/ValueField' additionalProperties: false ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false RegexRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: isCaseSensitive: type: boolean regexValue: type: string additionalProperties: false RequirementDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementDto' additionalProperties: false FormulaVariableDto: type: object properties: dataSource: type: string propertyName: type: string filterConditions: type: - array - 'null' items: $ref: '#/components/schemas/FilterConditionDto' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false RequirementSetDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementSetDto' additionalProperties: false ApproveAction: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false RequirementDto: type: object properties: category: type: string description: type: string name: type: string classification: type: string tags: type: array items: type: string type: type: string dataField: allOf: - $ref: '#/components/schemas/DataFieldDto' validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto' order: type: - number - 'null' format: double defaultValue: type: - string - 'null' isSecondaryIdentifier: type: boolean secondaryIdentifierOrder: type: - number - 'null' format: double isReadOnly: type: boolean conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto' documentDescription: type: - string - 'null' documentDataKey: type: - string - 'null' isMandatory: type: boolean defaultDateType: type: - string - 'null' version: type: integer format: int32 uiDecoration: type: - string - 'null' additionalProperties: false CreateRequirementSetVersionDraftResponse: type: object properties: id: type: string format: uuid versionNumber: type: integer format: int32 additionalProperties: false EntityAssociationDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true associationType: type: - string - 'null' ownershipPercentage: type: - number - 'null' format: double associationToClient: type: - string - 'null' properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false RequirementSetDto_2: type: object properties: id: type: string format: uuid version: type: integer format: int32 jurisdiction: type: string status: type: string versions: type: array items: $ref: '#/components/schemas/RequirementSetVersionDto' additionalProperties: false EntityDataMetadataDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true entityType: type: - string - 'null' additionalProperties: false ManualCreditScreeningDto: type: object properties: taskDataKey: type: - string - 'null' taskId: type: string format: uuid entityId: type: string format: uuid creditScreeningOutcome: type: - string - 'null' properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' additionalProperties: false RelatedPartyDto: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' metadata: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false ChangedFieldsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true changedFields: type: - array - 'null' items: $ref: '#/components/schemas/ChangedFieldDto' additionalProperties: false RequirementSetDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementSetDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false RelatedAssetDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' additionalProperties: false DataFieldSummaryDto: type: object properties: propertyType: type: string propertyTypeId: type: - string - 'null' format: uuid linkChildFieldPropertyName: type: - string - 'null' name: type: string description: type: - string - 'null' categories: uniqueItems: true type: array items: type: string requirementSetsNames: uniqueItems: true type: array items: type: string names: uniqueItems: true type: array items: type: string additionalProperties: false EvaluateAllRequirementsRequestDto: type: object properties: requirementSetId: type: string version: type: integer format: int32 requirementType: type: string properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' categories: type: array items: type: string additionalProperties: false EvaluatedAllRequirementsResponseDto: type: object properties: allEvaluatedDataRequirements: type: array items: $ref: '#/components/schemas/EvaluatedDataFieldDto' evaluatedSingleDataRequirements: type: array items: $ref: '#/components/schemas/EvaluatedDataFieldDto' evaluatedDataGroupRequirements: type: array items: $ref: '#/components/schemas/EvaluatedDataGroupRequirementDto' evaluatedDocumentRequirements: type: array items: $ref: '#/components/schemas/EvaluatedDocumentRequirementDto' additionalProperties: false CalculatedResultDto: type: object properties: result: type: - string - 'null' error: type: - string - 'null' additionalProperties: false CurrentFieldDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true currentField: type: - string - 'null' additionalProperties: false AutoCreditScreeningDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto' additionalProperties: false SignificanceEngineDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true significanceEngine: type: - array - 'null' items: $ref: '#/components/schemas/SignificanceEngineDto' additionalProperties: false JourneyLevelDataDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false PropertyDto: required: - discriminator type: object properties: discriminator: allOf: - $ref: '#/components/schemas/PropertyType' readOnly: true type: allOf: - $ref: '#/components/schemas/PropertyType' readOnly: true isValid: type: - boolean - 'null' additionalProperties: false discriminator: propertyName: discriminator mapping: Collection: '#/components/schemas/CollectionPropertyDto' Custom: '#/components/schemas/CustomPropertyDto' Single: '#/components/schemas/SinglePropertyDto' AutoCreditAssessmentDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true autoCreditAssessments: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditAssessmentDto' additionalProperties: false RequirementSetDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/RequirementSetDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false RequirementSetVersionDto: type: object properties: id: type: string format: uuid setId: type: string format: uuid name: type: string created: type: string format: date-time isActive: type: boolean effectiveFrom: type: string format: date-time effectiveUntil: type: - string - 'null' format: date-time status: allOf: - $ref: '#/components/schemas/VersionStatus' notes: type: - string - 'null' versionNumber: type: integer format: int32 signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' version: type: integer format: int32 requirements: type: array items: $ref: '#/components/schemas/RequirementDto_2' jurisdiction: type: string additionalProperties: false CollectionItemDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto2' additionalProperties: false CollectionPropertyDto2: type: object properties: items: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CollectionItemDto' collectionId: type: - string - 'null' format: uuid additionalProperties: false EvaluatedDocumentRequirementDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' dataKey: type: - string - 'null' description: type: - string - 'null' category: type: - string - 'null' isRequired: type: boolean additionalProperties: false MainEntityDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false CustomPropertyDto2: type: object properties: singleProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto2' customProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CustomPropertyDto2' additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string ExternalDataAdapterDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: type: - string - 'null' eventSubtype: type: - string - 'null' additionalProperties: false RelatedAssetsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true assets: type: - array - 'null' items: $ref: '#/components/schemas/RelatedAssetDto' additionalProperties: false CurrentDataGroupItemDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false DataFieldDto_2: type: object properties: propertyName: type: - string - 'null' propertyType: type: string propertyTypeId: type: - string - 'null' format: uuid linkChildFieldPropertyName: type: - string - 'null' formulaSchema: allOf: - $ref: '#/components/schemas/FormulaSchemaDto' additionalProperties: false DataSourcesDto: type: object properties: entityDataMetadata: allOf: - $ref: '#/components/schemas/EntityDataMetadataDataSource' eventIngress: allOf: - $ref: '#/components/schemas/EventIngressDataSource' changedFields: allOf: - $ref: '#/components/schemas/ChangedFieldsDataSource' relatedClient: allOf: - $ref: '#/components/schemas/RelatedClientDataSource' relatedProducts: allOf: - $ref: '#/components/schemas/RelatedProductsDataSource' currentDataGroupItem: allOf: - $ref: '#/components/schemas/CurrentDataGroupItemDataSource' externalDataAdapter: allOf: - $ref: '#/components/schemas/ExternalDataAdapterDataSource' entityAssociation: allOf: - $ref: '#/components/schemas/EntityAssociationDataSource' manualCreditAssessment: allOf: - $ref: '#/components/schemas/ManualCreditAssessmentV2DataSource' autoCreditAssessment: allOf: - $ref: '#/components/schemas/AutoCreditAssessmentDataSource' manualCreditScreening: allOf: - $ref: '#/components/schemas/ManualCreditScreeningDataSource' collateral: allOf: - $ref: '#/components/schemas/CollateralDataSource' currentJourneys: allOf: - $ref: '#/components/schemas/CurrentJourneysDataSource' autoCreditScreening: allOf: - $ref: '#/components/schemas/AutoCreditScreeningDataSource' currentProduct: allOf: - $ref: '#/components/schemas/CurrentProductDataSource' relatedDeals: allOf: - $ref: '#/components/schemas/RelatedDealsDataSource' mainEntity: allOf: - $ref: '#/components/schemas/MainEntityDataSource' relatedAssets: allOf: - $ref: '#/components/schemas/RelatedAssetsDataSource' relatedAssociations: allOf: - $ref: '#/components/schemas/RelatedAssociationsDataSource' accountRelatedFunds: allOf: - $ref: '#/components/schemas/AccountRelatedFundsDataSource' journeyLevelData: allOf: - $ref: '#/components/schemas/JourneyLevelDataDataSource' relatedParties: allOf: - $ref: '#/components/schemas/RelatedPartiesDataSource' currentField: allOf: - $ref: '#/components/schemas/CurrentFieldDataSource' significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDataSource' additionalProperties: false EvaluatedDataGroupItemDto: type: object properties: evaluatedFields: type: array items: $ref: '#/components/schemas/EvaluatedDataGroupFieldDto' additionalProperties: false RelatedProductDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' lifecycleStatus: type: - string - 'null' relationshipTypes: type: - array - 'null' items: type: string additionalProperties: false AutoCreditScreeningDto: type: object properties: entityId: type: string format: uuid creditScreeningOutcome: type: - string - 'null' properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' providerInternalIdentifier: type: - string - 'null' additionalProperties: false Signee: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false RelatedAssociationsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedAssociations: type: - array - 'null' items: $ref: '#/components/schemas/RelatedAssociationDto' additionalProperties: false RelatedClientDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' additionalProperties: false CollateralDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' additionalProperties: false RelatedDealsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedDeals: type: - array - 'null' items: $ref: '#/components/schemas/RelatedDealDto' additionalProperties: false ValidationRuleDto_2: type: object properties: propertyName: type: string friendlyName: type: string validationType: type: string validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' additionalProperties: false SinglePropertyDto2: type: object properties: value: type: - string - 'null' valueId: type: - string - 'null' additionalProperties: false EventIngressDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: type: - string - 'null' eventSubtype: type: - string - 'null' additionalProperties: false ChangedFieldDto: type: object properties: key: type: - string - 'null' additionalProperties: false EvaluatedDataGroupRequirementDto: type: object properties: propertyName: type: - string - 'null' dataGroupId: type: string format: uuid evaluatedItems: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/EvaluatedDataGroupItemDto' category: type: - string - 'null' validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' order: type: - number - 'null' format: double dataGroupVersionNumber: type: - integer - 'null' format: int32 dataGroupName: type: - string - 'null' primaryDataGroupField: type: - string - 'null' description: type: - string - 'null' isReadOnly: type: boolean additionalProperties: false RelatedPartiesDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedParties: type: - array - 'null' items: $ref: '#/components/schemas/RelatedPartyDto' additionalProperties: false RequirementDto_2: type: object properties: requirementSetId: type: string format: uuid requirementSetName: type: - string - 'null' versionNumber: type: integer format: int32 id: type: string format: uuid category: type: string description: type: - string - 'null' name: type: string classification: type: - string - 'null' tags: type: array items: type: string type: type: string dataField: allOf: - $ref: '#/components/schemas/DataFieldDto_2' validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto_2' order: type: - number - 'null' format: double defaultValue: type: - string - 'null' isSecondaryIdentifier: type: boolean isReadOnly: type: boolean secondaryIdentifierOrder: type: - number - 'null' format: double conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto' documentDescription: type: - string - 'null' documentDataKey: type: - string - 'null' isMandatory: type: boolean version: type: integer format: int32 uiDecoration: type: - string - 'null' defaultDateType: type: - string - 'null' additionalProperties: false PropertiesDto: type: object properties: singleProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto2' collectionProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CollectionPropertyDto2' customProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CustomPropertyDto2' additionalProperties: false CurrentJourneysDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true inProgressJourneyTypes: type: - array - 'null' items: type: string additionalProperties: false SignificanceEngineDto: type: object properties: key: type: - string - 'null' additionalProperties: false ManualCreditAssessmentV2DataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true creditAssessments: type: - array - 'null' items: $ref: '#/components/schemas/CreditAssessmentDto' additionalProperties: false GetMergedRequirementSetsDataFieldsResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/GetMergedRequirementSetsDataFieldsResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AccountRelatedFundDto: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false CreditAssessmentDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' assessmentOutcome: type: - string - 'null' assessmentComment: type: - string - 'null' taskId: type: - string - 'null' taskDataKey: type: - string - 'null' additionalProperties: false CollateralDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true collaterals: type: - array - 'null' items: $ref: '#/components/schemas/CollateralDto' additionalProperties: false GetMergedRequirementSetsDataFieldsResponseDto: type: object properties: dataFieldsByPropertyName: type: object additionalProperties: $ref: '#/components/schemas/DataFieldSummaryDto' additionalProperties: false RelatedDealDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' additionalProperties: false RelatedAssociationDto: type: object properties: associationType: type: - string - 'null' ownershipPercentage: type: - number - 'null' format: double associationToClient: type: - string - 'null' properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false AutoCreditAssessmentDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' assessmentOutcome: type: - string - 'null' providerInternalIdentifier: type: - string - 'null' additionalProperties: false RelatedProductsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true products: type: - array - 'null' items: $ref: '#/components/schemas/RelatedProductDto' additionalProperties: false AccountRelatedFundsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true accountRelatedFunds: type: - array - 'null' items: $ref: '#/components/schemas/AccountRelatedFundDto' additionalProperties: false CurrentProductDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' lifecycleStatus: type: - string - 'null' additionalProperties: false CollectionMinimumCountRuleDto_2: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 overallMinimumCount: type: - integer - 'null' format: int32 additionalProperties: false ManualCreditScreeningDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto' additionalProperties: false RequirementSetVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementSetVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false RequirementDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Approver: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false PropertyType: enum: - Single - Custom - Collection type: string EvaluatedDataFieldDto: type: object properties: requirementSetId: type: string format: uuid versionNumber: type: integer format: int32 propertyName: type: - string - 'null' propertyType: type: - string - 'null' propertyTypeId: type: - string - 'null' format: uuid linkChildFieldPropertyName: type: - string - 'null' name: type: - string - 'null' description: type: - string - 'null' defaultValue: type: - string - 'null' isReadOnly: type: boolean category: type: - string - 'null' validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' isRequired: type: boolean order: type: - number - 'null' format: double isSecondaryIdentifier: type: boolean secondaryIdentifierOrder: type: - number - 'null' format: double hasEvaluatedConditionalValue: type: boolean evaluatedConditionalValue: type: - string - 'null' hasEvaluatedDefaultValue: type: boolean uiDecoration: type: - string - 'null' defaultDateType: type: - string - 'null' hasCalculatedValue: type: boolean calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' timeZoneId: type: - string - 'null' additionalProperties: false EvaluatedAllRequirementsResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluatedAllRequirementsResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false EvaluateAllRequirementsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsRequestDto' additionalProperties: false EvaluatedDataGroupFieldDto: allOf: - $ref: '#/components/schemas/EvaluatedDataFieldDto' - type: object additionalProperties: false CollectionMinimumCountRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto2' description: Static validation rule always applied when active additionalProperties: false ValueLimitRuleDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_2' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' description: Request DTO representing value limit rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false ExternalProviderRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' - type: object properties: providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata AddRequirementsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/AddRequirementsRequestDto' description: The service request DTO additionalProperties: false description: Service request data RequirementSetDto_3: allOf: - $ref: '#/components/schemas/CommonRequirementSetDto' - type: object properties: created: type: string description: The creation date of the version (Read-only) format: date-time example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft requirements: type: - array - 'null' items: $ref: '#/components/schemas/RequirementDto_3' description: List of requirements notes: type: - string - 'null' description: 'Optional description of changes made that will be visible to all users who can access the version. It''s assumed that version notes won''t contain ''personal identifiable information''. Please note that having many versions with very long notes could hurt API performance in the long term.' example: Example Notes defaultDataProtectionJurisdiction: type: - string - 'null' description: Default data protection jurisdiction for requirement set example: Global additionalProperties: false description: Request DTO representing requirement set data SpecialCharactersRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto2' description: Static validation rule always applied when active additionalProperties: false ValidationDataDto_2: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Mandatory Rule - does not allow empty value specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto_2' description: 'Special characters validation rule - does not allow special characters, but allows define array of characters which can be ignored by the validation' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that does not allow numbers onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that allows numbers up to two decimal places regex: allOf: - $ref: '#/components/schemas/RegexRuleDto_2' description: Validation rule that validates the value against provided regex characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' description: Validation rule that allows to set minimum and maximum count of characters numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' description: Validation rule that allows to set number range noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that does not allow future dates noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that does not allow past dates dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto_2' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' description: Validation rule that allows to set selection range collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto_3' description: Validation rule that allows to set minimum count requirements for collection collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto_2' description: Validation rule that allows to set maximum count requirements for collection externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' description: Validation rule that allows to use external provider for validation externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' description: Validation rule that allows to use external provider for validating all fields of a DataGroup as a collection additionalProperties: false description: Request DTO representing validation data metadata CommonRequirementSetDto: type: object properties: setId: type: string description: The UiD of the data requirement set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: Requirement set name example: Fenergo Comprehensive Standard Policy Requirements jurisdiction: type: - string - 'null' description: Requirement set jurisdiction example: Global conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' description: Conditions under which the requirement set can be applied versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version additionalProperties: false description: Request DTO representing requirement set data UpdateRequirementDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateRequirementDto' description: Request DTO representing requirement metadata additionalProperties: false description: Service request data BasicRuleDto_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata AddRequirementsResponseDto: type: object properties: requirementIds: type: - array - 'null' items: type: string format: uuid additionalProperties: false ConditionDto_2: required: - logicalOperation - name - operands type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: minLength: 1 type: string description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: minItems: 1 type: array items: $ref: '#/components/schemas/ConditionDefinitionDto_2' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root example: id: 118313c6-91e6-4b05-a537-5a1ab906418f name: Company-type only description: Applicable only when EntityType=Company logicalOperation: AND operands: - fieldName: EntityType value: - string valueType: text operation: equal operands: [] RegexRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/RegexRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/RegexRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false ServiceResponse_2: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data OwnershipValidationDataDto: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Request DTO representing basic validation rule metadata partyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' description: Request DTO representing value limit rule metadata addAllParties: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Request DTO representing basic validation rule metadata idvIsMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Request DTO representing basic validation rule metadata idvPartyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' description: Request DTO representing value limit rule metadata idvAllParties: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Request DTO representing basic validation rule metadata additionalProperties: false ValueField_2: type: object properties: dataSource: type: - string - 'null' description: Value of DataSource used to filter field values field: type: - string - 'null' description: Field value used to validate conditional value additionalProperties: false UpdatedRequirementSetVersionResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdatedRequirementSetVersionResponseDto' description: Response DTO representing updated requirement set version messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data CreateRequirementSetResponseServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateRequirementSetResponse_2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValueLimitRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false description: Request DTO representing value limit rule metadata DateLimitRuleDto_2: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' - type: object properties: minDate: type: - string - 'null' description: Minimum date format: date-time example: '2020-01-01T14:48:00.000Z' maxDate: type: - string - 'null' description: Maximum date format: date-time example: '2021-01-01T14:48:00.000Z' additionalProperties: false description: Request DTO representing date limit rule metadata ConditionDefinitionDto_2: type: object properties: fieldName: type: - string - 'null' description: Name of the field to evaluate example: EntityType value: type: - array - 'null' items: type: string description: List of values valueId: type: - array - 'null' items: type: string description: List of value ids valueType: type: - string - 'null' description: Type of the value example: text dataSource: type: - string - 'null' description: Data source from which field is retrieved. If empty then Entity Data properties will be used. example: entityDataMetadata operation: type: - string - 'null' description: Logical operation to be performed to match the values example: equal logicalOperation: type: - string - 'null' description: Logical operation to be performed on the operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_2' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto valueField: allOf: - $ref: '#/components/schemas/ValueField_2' description: Field value used for conditional limit validation additionalProperties: false description: Represents condition RegexRuleDto_2: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' - type: object properties: isCaseSensitive: type: boolean description: Flag that indicate if regex is case sensitive example: false regexValue: type: - string - 'null' description: Regex expression example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$ additionalProperties: false description: Request DTO representing regex rule metadata RequirementSetDtoServiceRequest_2: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementSetDto_3' description: Request DTO representing requirement set data additionalProperties: false description: Service request data BasicRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/BasicRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false DateTimePeriodFormulaSchemaDto: required: - formulaSetId - formulaString type: object properties: formulaSetId: minLength: 1 type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: minLength: 1 type: string dateTimePeriodFormulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DateTimePeriodFormulaVariableDto' additionalProperties: false RequirementSetVersionSignResponse: type: object properties: setId: type: string description: The UiD of the requirement set format: uuid versionNumber: type: integer description: The number of the version that has been signed format: int32 example: 2 status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The new version status example: Rejected additionalProperties: false description: Sign requirement set response contains the new version status ItemCreatedDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ItemCreatedDto' description: Response DTO representing created Item Instance messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DateTimePeriodFormulaVariableDto: type: object properties: dataSource: type: - string - 'null' timePeriodKind: type: - string - 'null' value: type: - string - 'null' type: type: - string - 'null' timeZoneId: type: - string - 'null' additionalProperties: false RegexRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: isCaseSensitive: type: boolean description: Flag that indicate if regex is case sensitive example: false regexValue: type: - string - 'null' description: Regex expression example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$ additionalProperties: false description: Request DTO representing regex rule metadata AccessLayerDto: required: - businessRelated - geographic type: object properties: geographic: type: array items: maxLength: 500 minLength: 1 type: string description: Collection of geographic access layers businessRelated: type: array items: maxLength: 500 minLength: 1 type: string description: Collection of business related access layers additionalProperties: false description: DTO representing associated access layers OwnershipValidationRuleDto: type: object properties: id: type: string description: The UiD of the ownership validation rule format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the requirement set format: uuid example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3 ownershipValidationData: allOf: - $ref: '#/components/schemas/OwnershipValidationDataDto' description: Ownership Validation Data - set of validation rules specific to ownership requirement additionalProperties: false ReferenceDto: required: - description - type - url type: object properties: type: maxLength: 256 minLength: 1 type: string description: Reference type example: FATCA description: maxLength: 2048 minLength: 1 type: string description: Reference description example: Foreign Account Tax Compliance Act url: maxLength: 2048 minLength: 1 type: string description: Reference URL example: www.irs.gov additionalProperties: false description: Request DTO representing reference metadata UpdateRequirementSetVersionLiteDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateRequirementSetVersionLiteDto' description: Request DTO representing set of properties which define a new version of requirement set additionalProperties: false description: Service request data StringConditionalValueDto_2: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_2' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: type: - string - 'null' description: Value that should be returned when conditions are met example: Relationship Manager priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false DateLimitRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: minDate: type: - string - 'null' description: Minimum date format: date-time example: '2020-01-01T14:48:00.000Z' maxDate: type: - string - 'null' description: Maximum date format: date-time example: '2021-01-01T14:48:00.000Z' additionalProperties: false description: Request DTO representing date limit rule metadata CreateRequirementSetVersionFromSetIdResponse: type: object properties: setId: type: string format: uuid versionNumber: type: integer format: int32 additionalProperties: false BasicRuleDto2: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata EmptyRuleDto: type: object additionalProperties: false description: Request DTO representing rule with no parameters BasicRuleDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_2' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/BasicRuleDto2' description: Request DTO representing basic validation rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false UpdateRequirementDto: allOf: - $ref: '#/components/schemas/RequirementDto_3' - type: object properties: version: type: integer description: 'Current version of Data Group aggregate where the changes needs to be applied. This parameter is required to guarantee consistency and conflicts detection. If it is not provided, it will save new changes on top of latest without conflicts checking' format: int32 default: -1 example: 5 additionalProperties: false description: Request DTO representing requirement metadata ExternalProviderRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto2' description: Static validation rule always applied when active additionalProperties: false ValueLimitRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false UpdateRequirementDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateRequirementDto' description: Request DTO representing requirement metadata messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data CollectionMinimumCountRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with minimum count example: Registered: 1 overallMinimumCount: type: integer description: Overall minimum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection minimum count validation rule metadata BasicRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto2' description: Static validation rule always applied when active additionalProperties: false SpecialCharactersRuleDto_2: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' - type: object properties: excludedCharacters: type: - array - 'null' items: type: string description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"] additionalProperties: false description: Request DTO representing special characters rule metadata DataFieldDto_3: required: - propertyName - propertyType type: object properties: propertyName: minLength: 1 type: string description: Property name example: firstName propertyType: minLength: 1 type: string description: Property type example: text propertyTypeId: type: - string - 'null' description: Property type id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldPropertyName: type: - string - 'null' description: Linked child field property name example: productCategory linkedParentFieldPropertyName: type: - string - 'null' description: Linked Parent field property name example: productCategory externalSearchApiProviderId: type: - string - 'null' description: External search api provider id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c formulaSchema: allOf: - $ref: '#/components/schemas/NumberFormulaSchemaDto' description: Number formula schema dateTimePeriodFormulaSchema: allOf: - $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto' description: Date Formula schema additionalProperties: false description: Request DTO representing data field metadata CloneRequirementSetVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneRequirementSetVersionDto' description: The service request DTO additionalProperties: false description: Service request data CreateRequirementSetResponse_2: allOf: - $ref: '#/components/schemas/RequirementSetDto_3' - type: object properties: defaultDataProtectionJurisdiction: type: - string - 'null' additionalProperties: false CollectionMaximumCountRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto2' description: Static validation rule always applied when active additionalProperties: false CloneRequirementSetVersionResponse: type: object properties: requirementSetId: type: string description: Id of the cloned requirement set format: uuid expectedRequirementCount: type: integer description: Expected number of requirements of the cloned requirement set format: int32 additionalProperties: false description: Request DTO representing clone requirement set data CollectionMaximumCountRuleDto_2: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' - type: object properties: requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with maximum count example: Registered: 1 overallMaximumCount: type: - integer - 'null' description: Overall maximum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection maximum count validation rule metadata RegexRuleDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_2' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/RegexRuleDto2' description: Request DTO representing regex rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false AddRequirementsResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AddRequirementsResponseDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data UpdatedRequirementSetVersionResponseDto: type: object properties: version: type: integer description: Version of requirement set version after the update format: int32 example: 4 additionalProperties: false description: Response DTO representing updated requirement set version CreateRequirementSetVersionFromSetIdResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateRequirementSetVersionFromSetIdResponse' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValidationRuleDto_3: type: object properties: id: type: string description: The UiD of the validation rule format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the requirement set/data group format: uuid example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3 propertyId: type: string description: The UiD of the requirement/data group field format: uuid example: 450df9bf-b2d3-48cf-ab8d-481c69b74373 dataGroupId: type: - string - 'null' description: The UiD of the of data group - is set only when requirement/data group field propertyType is set to "dataGroup" format: uuid example: 8eb83ec6-1539-46a9-b0ba-c5138a09580c isDataGroup: type: boolean description: Flag indicating it is validation rules for data group field example: true propertyName: type: - string - 'null' description: Requirement/data group field property name example: firstName friendlyName: type: - string - 'null' description: Requirement/data group field friendly Name example: First Name validationType: type: - string - 'null' description: Validation type example: text validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto_2' description: Request DTO representing validation data metadata additionalProperties: false description: Request DTO representing validation rule metadata ApproveActionServiceRequest_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' description: The service request DTO additionalProperties: false description: Service request data EmptyRuleDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_2' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/EmptyRuleDto' description: Request DTO representing rule with no parameters priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false AddRequirementsRequestDto: type: object properties: requirements: type: - array - 'null' items: $ref: '#/components/schemas/RequirementDto_3' additionalProperties: false NumberFormulaSchemaDto: required: - formulaSetId - formulaString type: object properties: formulaSetId: minLength: 1 type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: minLength: 1 type: string formulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/NumberFormulaVariableDto' additionalProperties: false DateLimitRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/DateLimitRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/DateLimitRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false ServiceResponseMessage_2: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response RequirementDto_3: required: - entityType - jurisdiction - type type: object properties: identifier: type: string description: The UiD of the requirement format: uuid example: 84ec28e2-d786-417b-850f-96321dd849dd requirementSetId: type: string description: The UiD of the requirement set format: uuid example: 228313c6-91e6-4b05-a537-5a1ab906418f category: type: - string - 'null' description: Requirement business category example: Basic Details description: type: - string - 'null' description: Requirement description example: This is the client first name template: type: - string - 'null' description: Requirement template example: Product entityType: minLength: 1 type: string description: Requirement entity type example: Individual name: type: - string - 'null' description: Requirement name example: First Name order: type: - number - 'null' description: Requirement the order which the field will appears format: double example: 1 isSensitiveData: type: boolean description: Requirement sensitive data flag example: true isMaterialData: type: boolean description: Requirement material data flag example: true isCoreDefinition: type: boolean description: 'Requirement is defined as core and cannot be deleted or altered' example: false isIndexable: type: boolean description: Requirement is data indexed for search flag example: true isJourneyLevelData: type: boolean description: Requirement journey level data flag example: false jurisdiction: minLength: 1 type: string description: Requirement jurisdiction example: Global dataProtectionJurisdiction: type: - string - 'null' description: Jurisdiction for data protection example: Global classification: type: - string - 'null' description: Requirement classification example: Customer Profiling isReadOnly: type: boolean description: Read-only flag example: true isMandatory: type: boolean description: Requirement mandatory flag example: true targetEntity: type: - string - 'null' description: Requirement target entity example: Client type: minLength: 1 type: string description: Requirement type example: Data documentDescription: type: - string - 'null' description: Requirement document description example: Articles of Incorporation documentDataKey: type: - string - 'null' description: Requirement document datakey example: Passport partyType: type: - string - 'null' description: Requirement party type example: Shareholder deprecated: true partyTypes: type: - array - 'null' items: type: string description: Requirement party types partyCount: type: - integer - 'null' description: Requirement party count format: int32 example: 1 deprecated: true uboThreshold: type: - number - 'null' description: Requirement UBO threshold format: double example: 10 ownershipDataKey: type: - string - 'null' description: The datakey that is used to identify this requirement example: seniorManagersRequirement sourceEntityType: type: - string - 'null' description: Any of the related party entity types selected can be counted toward this requirement example: Individual deprecated: true relatedPartyEntityTypes: type: - array - 'null' items: type: string description: Requirement related party entity types directAssociationsOnly: type: boolean description: 'When enabled, only related parties directly associated to the main client entity will be counted towards this requirement' example: true idvOn: type: boolean description: Is there an ID&V element applicable to this requirement? example: true idvName: type: - string - 'null' description: Name of the ID&V requirement and label which will be applied to the ID&V chip example: ID&V 1 Senior Manager idvTooltip: type: - string - 'null' description: Tooltip description of the ID&V requirement example: At Least one CEO, CFO, COO, CTO, Board Member or Executive Director must be ID&Vd ownershipValidationRule: allOf: - $ref: '#/components/schemas/OwnershipValidationRuleDto' description: Ownership requirement validation data dataField: allOf: - $ref: '#/components/schemas/DataFieldDto_3' description: Requirement data field references: type: - array - 'null' items: $ref: '#/components/schemas/ReferenceDto' description: Requirement references list conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' description: Requirement conditions list validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto_3' description: Requirement validation data validationRulesV2: allOf: - $ref: '#/components/schemas/DataValidationRulesDto' description: Request DTO representing validation data metadata defaultValue: type: - string - 'null' description: 'Default value value will be accepted base on datafield type' example: Australia documentAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Access layers determining the access to the document acceptableDocumentDataKeys: type: - array - 'null' items: type: string description: List of acceptable Document Types Id for the Document Requirement conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto_2' description: List of conditional values clearValueIfTriggerConditionNotMet: type: boolean description: Whether to clear the field value when all trigger conditions are not met example: false tags: type: - array - 'null' items: type: string description: List of tags fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Access layers determining the access to the field uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiColorDecoration: type: - string - 'null' description: Determines with what colour requirement should be rendered portalGuidance: type: - string - 'null' description: Portal guidance example: Provide at least one director RP additionalProperties: false description: Request DTO representing requirement metadata ExternalProviderRuleDto2: allOf: - $ref: '#/components/schemas/EmptyRuleDto' - type: object properties: providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata CloneRequirementSetVersionResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneRequirementSetVersionResponse' description: Request DTO representing clone requirement set data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ConditionalValueDto_2: allOf: - $ref: '#/components/schemas/StringConditionalValueDto_2' - type: object properties: valueId: type: - string - 'null' description: Value Id that should be returned when conditions are met example: RM additionalProperties: false SpecialCharactersRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: excludedCharacters: type: - array - 'null' items: type: string description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"] additionalProperties: false description: Request DTO representing special characters rule metadata ValueLimitRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' description: Static validation rule always applied when active additionalProperties: false UpdateRequirementSetVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateRequirementSetVersionDto' description: Request DTO representing set of properties which define a new version of requirement set additionalProperties: false description: Service request data EmptyRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/EmptyRuleDto' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/EmptyRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false NumberFormulaVariableDto: type: object properties: dataSource: type: - string - 'null' propertyName: type: - string - 'null' filterConditions: type: - array - 'null' items: $ref: '#/components/schemas/FilterConditionDto_2' additionalProperties: false CollectionMaximumCountRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with maximum count example: Registered: 1 overallMaximumCount: type: - integer - 'null' description: Overall maximum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection maximum count validation rule metadata ValueLimitRuleDto_2: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' - type: object properties: minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false description: Request DTO representing value limit rule metadata UpdateRequirementSetVersionDto: type: object properties: setId: type: string description: The UiD of the requirement set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: Requirement set name example: Standard Policy jurisdiction: type: - string - 'null' description: Requirement set jurisdiction example: Global defaultDataProtectionJurisdiction: type: - string - 'null' description: Default data protection jurisdiction for requirement set example: Global requirements: type: - array - 'null' items: $ref: '#/components/schemas/RequirementDto_3' description: List of requirements conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' description: List of conditions versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version version: type: integer description: 'Current version of Data Group aggregate where the changes needs to be applied. This parameter is required to guarantee consistency and conflicts detection. If it is not provided, it will save new changes on top of latest without conflicts checking' format: int32 default: -1 example: 5 notes: type: - string - 'null' description: 'Optional description of changes made that will be visible to all users who can access the version. It''s assumed that version notes won''t contain ''personal identifiable information''. Please note that having many versions with very long notes could hurt API performance in the long term.' example: Example Notes additionalProperties: false description: Request DTO representing set of properties which define a new version of requirement set UpdateRequirementSetVersionLiteDto: type: object properties: name: type: - string - 'null' description: Requirement set name example: Standard Policy defaultDataProtectionJurisdiction: type: - string - 'null' description: Default data protection jurisdiction for requirement set example: Global conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' description: List of conditions version: type: integer description: 'Current version of Data Group aggregate where the changes needs to be applied. This parameter is required to guarantee consistency and conflicts detection. If it is not provided, it will save new changes on top of latest without conflicts checking' format: int32 default: -1 example: 5 notes: type: - string - 'null' description: 'Optional description of changes made that will be visible to all users who can access the version. It''s assumed that version notes won''t contain ''personal identifiable information''. Please note that having many versions with very long notes could hurt API performance in the long term.' example: Example Notes additionalProperties: false description: Request DTO representing set of properties which define a new version of requirement set RequirementSetVersionSignResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementSetVersionSignResponse' description: Sign requirement set response contains the new version status messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DateLimitRuleDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_2' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/DateLimitRuleDto2' description: Request DTO representing date limit rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false ItemCreatedDto: type: object properties: id: type: string description: The UiD of the created item format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f additionalProperties: false description: Response DTO representing created Item Instance CollectionMinimumCountRuleDto_3: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' - type: object properties: requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with minimum count example: Registered: 1 overallMinimumCount: type: integer description: Overall minimum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection minimum count validation rule metadata ObjectServiceResponse_2: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data StringServiceResponse_2: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data FilterConditionDto_2: type: object properties: fieldName: type: - string - 'null' description: Field name for the filter condition conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' description: Conditions applied to the field additionalProperties: false RequirementDtoServiceRequest_2: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementDto_3' description: Request DTO representing requirement metadata additionalProperties: false description: Service request data CloneRequirementSetVersionDto: type: object properties: name: type: - string - 'null' description: Requirement Set Name example: Fenergo Comprehensive Standard Policy Requirements jurisdiction: type: - string - 'null' description: Requirement Set Jurisdiction example: Global additionalProperties: false DataValidationRulesDto: type: object properties: mandatory: allOf: - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto' description: Mandatory Rule - does not allow empty value specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto' description: 'Special characters validation rule - does not allow special characters, but allows define array of characters which can be ignored by the validation' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that does not allow numbers onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that allows numbers up to two decimal places regex: allOf: - $ref: '#/components/schemas/RegexRuleDtoConditionalValidationRuleDto' description: Validation rule that validates the value against provided regex characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto' description: Validation rule that allows to set minimum and maximum count of characters numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto' description: Validation rule that allows to set number range noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that does not allow future dates noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that does not allow past dates dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto' description: Validation rule that allows to set selection range collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto' description: Validation rule that allows to set minimum count requirements for collection collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto' description: Validation rule that allows to set maximum count requirements for collection externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto' description: Validation rule that allows to use external provider for validation externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto' description: Validation rule that allows to use external provider for validation of one field with other fields as context readOnly: allOf: - $ref: '#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto' description: Validation rule that allows to set if field should be read only conditionalLimit: allOf: - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto' description: Validation rule that validates the dynamic value against provided condition timeZoneId: type: - string - 'null' description: Time zone id used for date values validation in order to determine exact Today time range example: Europe/Warsaw additionalProperties: false description: Request DTO representing validation data metadata ConditionalValueDto_3: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_3' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: type: - string - 'null' description: Value that should be returned when conditions are met example: Relationship Manager priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 valueId: type: - string - 'null' description: Value Id that should be returned when conditions are met example: RM additionalProperties: false CollectionMinimumCountRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto_4' description: Static validation rule always applied when active additionalProperties: false SpecialCharactersRuleDto_3: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred excludedCharacters: type: - array - 'null' items: type: string description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"] additionalProperties: false description: Request DTO representing special characters rule metadata ValueLimitRuleDtoConditionalValueDto_2: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_3' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_3' description: Request DTO representing value limit rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false ValueLimitRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_3' description: Static validation rule always applied when active additionalProperties: false BasicRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto_3' description: Static validation rule always applied when active additionalProperties: false SpecialCharactersRuleDto2_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred excludedCharacters: type: - array - 'null' items: type: string description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"] additionalProperties: false description: Request DTO representing special characters rule metadata ExternalProviderRuleDto_2: type: object properties: providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata DataFieldDto_4: type: object properties: propertyName: type: - string - 'null' description: Property name example: firstName propertyType: type: - string - 'null' description: Property type example: text propertyTypeId: type: - string - 'null' description: Property type id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldPropertyName: type: - string - 'null' description: Linked child field property name example: productCategory linkedParentFieldPropertyName: type: - string - 'null' description: Linked Parent field property name example: productCategory externalSearchApiProviderId: type: - string - 'null' description: External search api provider id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c propertyTypeVersion: type: - integer - 'null' description: Property version format: int32 deprecated: true formulaSchema: allOf: - $ref: '#/components/schemas/NumberFormulaSchemaDto_2' description: Number formula schema dateTimePeriodFormulaSchema: allOf: - $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto_2' description: Date formula schema additionalProperties: false description: Response DTO representing data field data DateTimePeriodFormulaSchemaDto_2: type: object properties: formulaSetId: type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: type: - string - 'null' dateTimePeriodFormulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DateTimePeriodFormulaVariableDto' additionalProperties: false RequirementSetJurisdictionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementSetJurisdictionDto' description: Response DTO representing requirement sets jurisdictions available messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data CollectionMaximumCountRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto_3' description: Static validation rule always applied when active additionalProperties: false RegexRuleDto2_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred isCaseSensitive: type: boolean description: Flag that indicate if regex is case sensitive example: false regexValue: type: - string - 'null' description: Regex expression example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$ additionalProperties: false description: Request DTO representing regex rule metadata AccessLayerDto_2: type: object properties: geographic: type: - array - 'null' items: type: string businessRelated: type: - array - 'null' items: type: string additionalProperties: false RequirementSetDto_4: type: object properties: id: type: string description: The UiD of the requirement set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versions: type: - array - 'null' items: $ref: '#/components/schemas/RequirementSetVersionDto_2' description: Versions associated to this requirement set version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 status: type: - string - 'null' description: Requirement Set status example: Active jurisdiction: type: - string - 'null' description: Jurisdiction of the requirement set example: Global additionalProperties: false description: Response DTO representing requirement set data SpecialCharactersRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto_3' description: Static validation rule always applied when active additionalProperties: false NumberFormulaVariableDto_2: type: object properties: dataSource: type: - string - 'null' propertyName: type: - string - 'null' filterConditions: type: - array - 'null' items: $ref: '#/components/schemas/FilterConditionDto_3' additionalProperties: false ValidationDataDto_3: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Mandatory Rule - does not allow empty value specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto2_2' description: 'Special characters validation rule - does not allow special characters, but allows define array of characters which can be ignored by the validation' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that does not allow numbers onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that allows numbers up to two decimal places regex: allOf: - $ref: '#/components/schemas/RegexRuleDto2_2' description: Validation rule that validates the value against provided regex characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' description: Validation rule that allows to set minimum and maximum count of characters numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' description: Validation rule that allows to set number range noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that does not allow future dates noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that does not allow past dates dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto2_2' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' description: Validation rule that allows to set selection range collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto2_2' description: Validation rule that allows to set minimum count requirements for collection collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto2_2' description: Validation rule that allows to set maximum count requirements for collection externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto2_2' description: Validation rule that allows to use external provider for validation externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto2_2' description: Validation rule that allows to use external provider for validating all fields of a DataGroup as a collection additionalProperties: false description: Request DTO representing validation data metadata RequirementSetDtoIEnumerableServiceResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/RequirementSetDto_4' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ReferenceDto_2: type: object properties: type: type: - string - 'null' description: type: - string - 'null' url: type: - string - 'null' additionalProperties: false ExternalProviderRuleDto2_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata CollectionMaximumCountRuleDto2_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with maximum count example: Registered: 1 overallMaximumCount: type: - integer - 'null' description: Overall maximum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection maximum count validation rule metadata CollectionMaximumCountRuleDto_3: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with maximum count example: Registered: 1 overallMaximumCount: type: - integer - 'null' description: Overall maximum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection maximum count validation rule metadata ValueLimitRuleDto_3: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false description: Request DTO representing value limit rule metadata BasicRuleDto_3: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata ConditionDto_3: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_3' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root RegexRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/RegexRuleDto_3' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/RegexRuleDtoConditionalValueDto_2' description: Conditional validation rules additionalProperties: false RequirementSetVersionDto_2: type: object properties: id: type: string description: The UiD of the requirement set version format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the requirement set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f requirementSetStatus: type: - string - 'null' description: Requirement set status example: Active name: type: - string - 'null' description: Requirement set name example: Fenergo Comprehensive Standard Policy Requirements jurisdiction: type: - string - 'null' description: Requirement set jurisdiction example: Global defaultDataProtectionJurisdiction: type: - string - 'null' description: Default jurisdiction for data protection example: Global requirements: type: - array - 'null' items: $ref: '#/components/schemas/RequirementDto_4' description: List of requirements conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_3' description: Conditions under which the requirement set can be applied versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time readOnly: true example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 notes: type: - string - 'null' description: 'Optional description of changes made that will be visible to all users who can access the version. It''s assumed that version notes won''t contain ''personal identifiable information''. Please note that having many versions with very long notes could hurt API performance in the long term.' example: Example Notes additionalProperties: false description: Response DTO representing requirement set version data DateLimitRuleDto2_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minDate: type: - string - 'null' description: Minimum date format: date-time example: '2020-01-01T14:48:00.000Z' maxDate: type: - string - 'null' description: Maximum date format: date-time example: '2021-01-01T14:48:00.000Z' additionalProperties: false description: Request DTO representing date limit rule metadata RegexRuleDtoConditionalValueDto_2: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_3' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/RegexRuleDto_3' description: Request DTO representing regex rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false ServiceResponse_3: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data OwnershipValidationDataDto_2: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Request DTO representing basic validation rule metadata partyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' description: Request DTO representing value limit rule metadata addAllParties: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Request DTO representing basic validation rule metadata idvIsMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Request DTO representing basic validation rule metadata idvPartyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' description: Request DTO representing value limit rule metadata idvAllParties: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Request DTO representing basic validation rule metadata additionalProperties: false ValueField_3: type: object properties: dataSource: type: - string - 'null' description: Value of DataSource used to filter field values field: type: - string - 'null' description: Field value used to validate conditional value additionalProperties: false BasicRuleDto2_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata DateLimitRuleDtoConditionalValueDto_2: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_3' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/DateLimitRuleDto_3' description: Request DTO representing date limit rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false BasicRuleDtoConditionalValueDto_2: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_3' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/BasicRuleDto_3' description: Request DTO representing basic validation rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false CollectionMinimumCountRuleDto_4: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with minimum count example: Registered: 1 overallMinimumCount: type: integer description: Overall minimum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection minimum count validation rule metadata ValueLimitRuleDto2_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false description: Request DTO representing value limit rule metadata ValidationRuleDto_4: type: object properties: id: type: string description: The UiD of the validation rule format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the requirement set/data group format: uuid example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3 propertyId: type: string description: The UiD of the requirement/data group field format: uuid example: 450df9bf-b2d3-48cf-ab8d-481c69b74373 propertyTypeId: type: - string - 'null' description: The Guid containing the property type id format: uuid example: 450df9bf-b2d3-48cf-ab8d-481c69b74373 linkChildFieldPropertyName: type: - string - 'null' description: 'The string containing the property name child of this property, only has value when propertyType is set to "selectLink"' example: country linkedParentFieldPropertyName: type: - string - 'null' description: 'The string containing the property name parent of this property, only has value when propertyType is set to "LinkedSelectV2" or "LinkedMultiSelectV2"' example: country dataGroupId: type: - string - 'null' description: The UiD of the of data group - is set only when requirement/data group field propertyType is set to "dataGroup" format: uuid example: 8eb83ec6-1539-46a9-b0ba-c5138a09580c isDataGroup: type: boolean description: Flag indicating it is validation rules for data group field example: true propertyName: type: - string - 'null' description: Requirement/data group field property name example: firstName friendlyName: type: - string - 'null' description: Requirement/data group field friendly Name example: First Name validationType: type: - string - 'null' description: Validation type example: text validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto_3' description: Request DTO representing validation data metadata additionalProperties: false description: Request DTO representing validation rule metadata ExternalProviderRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto_2' description: Static validation rule always applied when active additionalProperties: false DateLimitRuleDto_3: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred minDate: type: - string - 'null' description: Minimum date format: date-time example: '2020-01-01T14:48:00.000Z' maxDate: type: - string - 'null' description: Maximum date format: date-time example: '2021-01-01T14:48:00.000Z' additionalProperties: false description: Request DTO representing date limit rule metadata RequirementSetVersionDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementSetVersionDto_2' description: Response DTO representing requirement set version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data RequirementDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementDto_4' description: Request DTO representing requirement metadata messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValueLimitRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_3' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValueDto_2' description: Conditional validation rules additionalProperties: false ObjectServiceResponse_3: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data StringServiceResponse_3: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data FilterConditionDto_3: type: object properties: fieldName: type: - string - 'null' description: Field name for the filter condition conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_3' description: Conditions applied to the field additionalProperties: false EmptyRuleDtoConditionalValueDto_2: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_3' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/EmptyRuleDto' description: Request DTO representing rule with no parameters priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false NumberFormulaSchemaDto_2: type: object properties: formulaSetId: type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: type: - string - 'null' formulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/NumberFormulaVariableDto_2' additionalProperties: false ConditionDefinitionDto_3: type: object properties: fieldName: type: - string - 'null' description: Name of the field to evaluate example: EntityType value: type: - array - 'null' items: type: string description: List of values valueId: type: - array - 'null' items: type: string description: List of value ids valueType: type: - string - 'null' description: Type of the value example: text dataSource: type: - string - 'null' description: Data source from which field is retrieved. If empty then Entity Data properties will be used. example: entityDataMetadata operation: type: - string - 'null' description: Logical operation to be performed to match the values example: equal logicalOperation: type: - string - 'null' description: Logical operation to be performed on the operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_3' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto valueField: allOf: - $ref: '#/components/schemas/ValueField_3' description: Field value used for conditional limit validation additionalProperties: false description: Represents condition RequirementSetJurisdictionDto: type: object properties: availableJurisdictions: uniqueItems: true type: - array - 'null' items: type: string description: List of available jurisdictions in which requirement sets are created additionalProperties: false description: Response DTO representing requirement sets jurisdictions available RegexRuleDto_3: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred isCaseSensitive: type: boolean description: Flag that indicate if regex is case sensitive example: false regexValue: type: - string - 'null' description: Regex expression example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$ additionalProperties: false description: Request DTO representing regex rule metadata DateLimitRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/DateLimitRuleDto_3' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/DateLimitRuleDtoConditionalValueDto_2' description: Conditional validation rules additionalProperties: false CollectionMinimumCountRuleDto2_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with minimum count example: Registered: 1 overallMinimumCount: type: integer description: Overall minimum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection minimum count validation rule metadata ServiceResponseMessage_3: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response BasicRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto_3' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/BasicRuleDtoConditionalValueDto_2' description: Conditional validation rules additionalProperties: false RequirementDto_4: type: object properties: rootVersionId: type: string description: The UiD of the root requirement set version format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versionNumber: type: integer description: Requirement set version number format: int32 example: 1 id: type: string description: The UiD of the requirement format: uuid example: 84ec28e2-d786-417b-850f-96321dd849dd tenant: type: - string - 'null' description: The UiD of the tenant example: c345f3e9-c9f7-40ac-9eaa-654c2d2de1d1 category: type: - string - 'null' description: Requirement business category example: Basic Details description: type: - string - 'null' description: Requirement description example: This is the client first name template: type: - string - 'null' description: Requirement template example: Product entityType: type: - string - 'null' description: Requirement entity type example: Individual name: type: - string - 'null' description: Requirement name example: First Name isSensitiveData: type: boolean description: Requirement sensitive data flag example: true isMaterialData: type: boolean description: Requirement material data flag example: true isCoreDefinition: type: boolean description: Requirement is defined as core and cannot be deleted or altered example: false jurisdiction: type: - string - 'null' description: Requirement jurisdiction example: Global references: type: - array - 'null' items: $ref: '#/components/schemas/ReferenceDto_2' description: Requirement references list targetEntity: type: - string - 'null' description: Requirement target entity example: Client classification: type: - string - 'null' description: Requirement classification example: Customer Profiling type: type: - string - 'null' description: Requirement type example: Data conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_3' description: Requirement conditions list RequirementSetId: type: string description: The UiD of the current requirement set version format: uuid example: c060f297-70a2-4d4c-9360-9b5b39060ff0 versionId: type: string description: The UiD of the current requirement set version format: uuid example: e060f297-70a2-4d4c-9360-9b5b39060ff0 dataField: allOf: - $ref: '#/components/schemas/DataFieldDto_4' description: Data Field dataProtectionJurisdiction: type: - string - 'null' description: Jurisdiction for data protection example: Global order: type: - number - 'null' description: Order format: double example: 1 defaultValue: type: - string - 'null' description: Default Value example: Not Available isReadOnly: type: boolean description: Is requirement readonly example: false isIndexable: type: boolean description: Is requirement indexable example: true isJourneyLevelData: type: boolean description: Is journey level data example: false isMandatoryIndexable: type: boolean description: Is requirement mandatory indexable example: true isMandatory: type: boolean description: Is requirement mandatory example: false documentDescription: type: - string - 'null' description: Document Description example: Driver License documentDataKey: type: - string - 'null' description: Document Data Key documentAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Document Access Layers acceptableDocumentDataKeys: type: - array - 'null' items: type: string description: List of acceptable Document Types for the Document Requirement fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Field Access Layers isMasked: type: boolean description: Flag indicating if field is masked due to missing Sensitive Data Access layers example: false ownershipDataKey: type: - string - 'null' description: Ownership Data Key example: DataKey partyTypes: type: - array - 'null' items: type: string description: Party Types e.g. ["Director"] uboThreshold: type: - number - 'null' description: UBO Threshold format: double example: 0.6 relatedPartyEntityTypes: type: - array - 'null' items: type: string description: Types of Related Party Entity e.g. ["Individual"] directAssociationsOnly: type: boolean description: Is Only direct association example: false idvOn: type: boolean description: Is Idv On example: false idvName: type: - string - 'null' description: Idv Name example: IdentityRequirement idvTooltip: type: - string - 'null' description: Idv Tooltip example: Identity Requirement ownershipValidationRule: allOf: - $ref: '#/components/schemas/OwnershipValidationRuleDto' description: Ownership Validation Rule validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto_4' description: Validation Rule validationRulesV2: allOf: - $ref: '#/components/schemas/DataValidationRulesDto' description: Request DTO representing validation data metadata conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto_3' description: List of conditional values hasEvaluatedConditionalValue: type: boolean description: Does this field has evaluated conditional value? evaluatedConditionalValueId: type: - string - 'null' description: Evaluated conditional value Id evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value tags: type: - array - 'null' items: type: string description: List of tags clearValueIfTriggerConditionNotMet: type: boolean description: Indicates whether the field value should be cleared when trigger conditions are not met example: false aggregateVersion: type: - integer - 'null' description: Requirement aggregate version format: int32 example: 1 uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiColorDecoration: type: - string - 'null' description: Determines with what colour requirement should be rendered portalGuidance: type: - string - 'null' description: Portal guidance example: Provide at least one director RP isLocked: type: boolean description: True if the aggregate is locked (obsolete) example: false deprecated: true discriminator: type: - string - 'null' description: Data group field core definition flag (obsolete) example: 'true' deprecated: true version: type: integer description: Requirement aggregate version (obsolete) format: int32 example: true deprecated: true partyCount: type: - integer - 'null' description: Requirement party count format: int32 example: 1 deprecated: true partyType: type: - string - 'null' description: Requirement party type example: Shareholder deprecated: true sourceEntityType: type: - string - 'null' description: Any of the related party entity types selected can be counted toward this requirement example: Individual deprecated: true additionalProperties: false description: Request DTO representing requirement metadata ConditionalValueDto_4: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_4' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: type: - string - 'null' description: Value that should be returned when conditions are met example: Relationship Manager priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 valueId: type: - string - 'null' description: Value Id that should be returned when conditions are met example: RM additionalProperties: false CollectionMinimumCountRuleDtoValidationRuleDto_3: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto_5' description: Static validation rule always applied when active additionalProperties: false SpecialCharactersRuleDto_4: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred excludedCharacters: type: - array - 'null' items: type: string description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"] additionalProperties: false description: Request DTO representing special characters rule metadata ValueLimitRuleDtoConditionalValueDto_3: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_4' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_4' description: Request DTO representing value limit rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false ValueLimitRuleDtoValidationRuleDto_3: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_4' description: Static validation rule always applied when active additionalProperties: false BasicRuleDtoValidationRuleDto_3: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto_4' description: Static validation rule always applied when active additionalProperties: false SpecialCharactersRuleDto2_3: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred excludedCharacters: type: - array - 'null' items: type: string description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"] additionalProperties: false description: Request DTO representing special characters rule metadata ExternalProviderRuleDto_3: type: object properties: providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata DataFieldDto_5: type: object properties: propertyName: type: - string - 'null' description: Property name example: firstName propertyType: type: - string - 'null' description: Property type example: text propertyTypeId: type: - string - 'null' description: Property type id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldPropertyName: type: - string - 'null' description: Linked child field property name example: productCategory linkedParentFieldPropertyName: type: - string - 'null' description: Linked Parent field property name example: productCategory externalSearchApiProviderId: type: - string - 'null' description: External search api provider id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c propertyTypeVersion: type: - integer - 'null' description: Property version format: int32 deprecated: true formulaSchema: allOf: - $ref: '#/components/schemas/NumberFormulaSchemaDto_3' description: Number formula schema dateTimePeriodFormulaSchema: allOf: - $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto_3' description: Date formula schema additionalProperties: false description: Response DTO representing data field data DateTimePeriodFormulaSchemaDto_3: type: object properties: formulaSetId: type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: type: - string - 'null' dateTimePeriodFormulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DateTimePeriodFormulaVariableDto' additionalProperties: false RequirementSetJurisdictionDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementSetJurisdictionDto' description: Response DTO representing requirement sets jurisdictions available messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data CollectionMaximumCountRuleDtoValidationRuleDto_3: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto_4' description: Static validation rule always applied when active additionalProperties: false RegexRuleDto2_3: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred isCaseSensitive: type: boolean description: Flag that indicate if regex is case sensitive example: false regexValue: type: - string - 'null' description: Regex expression example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$ additionalProperties: false description: Request DTO representing regex rule metadata AccessLayerDto_3: type: object properties: geographic: type: - array - 'null' items: type: string businessRelated: type: - array - 'null' items: type: string additionalProperties: false RequirementSetDto_5: type: object properties: id: type: string description: The UiD of the requirement set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versions: type: - array - 'null' items: $ref: '#/components/schemas/RequirementSetVersionDto_3' description: Versions associated to this requirement set version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 status: type: - string - 'null' description: Requirement Set status example: Active jurisdiction: type: - string - 'null' description: Jurisdiction of the requirement set example: Global additionalProperties: false description: Response DTO representing requirement set data SpecialCharactersRuleDtoValidationRuleDto_3: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto_4' description: Static validation rule always applied when active additionalProperties: false NumberFormulaVariableDto_3: type: object properties: dataSource: type: - string - 'null' propertyName: type: - string - 'null' filterConditions: type: - array - 'null' items: $ref: '#/components/schemas/FilterConditionDto_4' additionalProperties: false ValidationDataDto_4: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Mandatory Rule - does not allow empty value specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto2_3' description: 'Special characters validation rule - does not allow special characters, but allows define array of characters which can be ignored by the validation' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Validation rule that does not allow numbers onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Validation rule that allows numbers up to two decimal places regex: allOf: - $ref: '#/components/schemas/RegexRuleDto2_3' description: Validation rule that validates the value against provided regex characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_3' description: Validation rule that allows to set minimum and maximum count of characters numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_3' description: Validation rule that allows to set number range noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Validation rule that does not allow future dates noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Validation rule that does not allow past dates dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto2_3' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_3' description: Validation rule that allows to set selection range collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto2_3' description: Validation rule that allows to set minimum count requirements for collection collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto2_3' description: Validation rule that allows to set maximum count requirements for collection externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto2_3' description: Validation rule that allows to use external provider for validation externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto2_3' description: Validation rule that allows to use external provider for validating all fields of a DataGroup as a collection additionalProperties: false description: Request DTO representing validation data metadata RequirementSetDtoIEnumerableServiceResponse_3: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/RequirementSetDto_5' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ReferenceDto_3: type: object properties: type: type: - string - 'null' description: type: - string - 'null' url: type: - string - 'null' additionalProperties: false ExternalProviderRuleDto2_3: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata CollectionMaximumCountRuleDto2_3: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with maximum count example: Registered: 1 overallMaximumCount: type: - integer - 'null' description: Overall maximum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection maximum count validation rule metadata CollectionMaximumCountRuleDto_4: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with maximum count example: Registered: 1 overallMaximumCount: type: - integer - 'null' description: Overall maximum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection maximum count validation rule metadata ValueLimitRuleDto_4: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false description: Request DTO representing value limit rule metadata BasicRuleDto_4: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata ConditionDto_4: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_4' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root RegexRuleDtoConditionalValidationRuleDto_3: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/RegexRuleDto_4' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/RegexRuleDtoConditionalValueDto_3' description: Conditional validation rules additionalProperties: false RequirementSetVersionDto_3: type: object properties: id: type: string description: The UiD of the requirement set version format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the requirement set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f requirementSetStatus: type: - string - 'null' description: Requirement set status example: Active name: type: - string - 'null' description: Requirement set name example: Fenergo Comprehensive Standard Policy Requirements jurisdiction: type: - string - 'null' description: Requirement set jurisdiction example: Global defaultDataProtectionJurisdiction: type: - string - 'null' description: Default jurisdiction for data protection example: Global requirements: type: - array - 'null' items: $ref: '#/components/schemas/RequirementDto_5' description: List of requirements conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_4' description: Conditions under which the requirement set can be applied versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time readOnly: true example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 notes: type: - string - 'null' description: 'Optional description of changes made that will be visible to all users who can access the version. It''s assumed that version notes won''t contain ''personal identifiable information''. Please note that having many versions with very long notes could hurt API performance in the long term.' example: Example Notes additionalProperties: false description: Response DTO representing requirement set version data DateLimitRuleDto2_3: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minDate: type: - string - 'null' description: Minimum date format: date-time example: '2020-01-01T14:48:00.000Z' maxDate: type: - string - 'null' description: Maximum date format: date-time example: '2021-01-01T14:48:00.000Z' additionalProperties: false description: Request DTO representing date limit rule metadata RegexRuleDtoConditionalValueDto_3: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_4' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/RegexRuleDto_4' description: Request DTO representing regex rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false ServiceResponse_4: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data OwnershipValidationDataDto_3: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Request DTO representing basic validation rule metadata partyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_3' description: Request DTO representing value limit rule metadata addAllParties: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Request DTO representing basic validation rule metadata idvIsMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Request DTO representing basic validation rule metadata idvPartyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_3' description: Request DTO representing value limit rule metadata idvAllParties: allOf: - $ref: '#/components/schemas/BasicRuleDto2_3' description: Request DTO representing basic validation rule metadata additionalProperties: false ValueField_4: type: object properties: dataSource: type: - string - 'null' description: Value of DataSource used to filter field values field: type: - string - 'null' description: Field value used to validate conditional value additionalProperties: false BasicRuleDto2_3: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata DateLimitRuleDtoConditionalValueDto_3: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_4' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/DateLimitRuleDto_4' description: Request DTO representing date limit rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false BasicRuleDtoConditionalValueDto_3: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_4' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/BasicRuleDto_4' description: Request DTO representing basic validation rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false CollectionMinimumCountRuleDto_5: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with minimum count example: Registered: 1 overallMinimumCount: type: integer description: Overall minimum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection minimum count validation rule metadata ValueLimitRuleDto2_3: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false description: Request DTO representing value limit rule metadata ValidationRuleDto_5: type: object properties: id: type: string description: The UiD of the validation rule format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the requirement set/data group format: uuid example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3 propertyId: type: string description: The UiD of the requirement/data group field format: uuid example: 450df9bf-b2d3-48cf-ab8d-481c69b74373 propertyTypeId: type: - string - 'null' description: The Guid containing the property type id format: uuid example: 450df9bf-b2d3-48cf-ab8d-481c69b74373 linkChildFieldPropertyName: type: - string - 'null' description: 'The string containing the property name child of this property, only has value when propertyType is set to "selectLink"' example: country linkedParentFieldPropertyName: type: - string - 'null' description: 'The string containing the property name parent of this property, only has value when propertyType is set to "LinkedSelectV2" or "LinkedMultiSelectV2"' example: country dataGroupId: type: - string - 'null' description: The UiD of the of data group - is set only when requirement/data group field propertyType is set to "dataGroup" format: uuid example: 8eb83ec6-1539-46a9-b0ba-c5138a09580c isDataGroup: type: boolean description: Flag indicating it is validation rules for data group field example: true propertyName: type: - string - 'null' description: Requirement/data group field property name example: firstName friendlyName: type: - string - 'null' description: Requirement/data group field friendly Name example: First Name validationType: type: - string - 'null' description: Validation type example: text validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto_4' description: Request DTO representing validation data metadata additionalProperties: false description: Request DTO representing validation rule metadata ExternalProviderRuleDtoValidationRuleDto_3: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto_3' description: Static validation rule always applied when active additionalProperties: false DateLimitRuleDto_4: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred minDate: type: - string - 'null' description: Minimum date format: date-time example: '2020-01-01T14:48:00.000Z' maxDate: type: - string - 'null' description: Maximum date format: date-time example: '2021-01-01T14:48:00.000Z' additionalProperties: false description: Request DTO representing date limit rule metadata RequirementSetVersionDtoServiceResponse_3: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementSetVersionDto_3' description: Response DTO representing requirement set version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data RequirementDtoServiceResponse_3: type: object properties: data: allOf: - $ref: '#/components/schemas/RequirementDto_5' description: Request DTO representing requirement metadata messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValueLimitRuleDtoConditionalValidationRuleDto_3: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_4' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValueDto_3' description: Conditional validation rules additionalProperties: false ObjectServiceResponse_4: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data StringServiceResponse_4: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data FilterConditionDto_4: type: object properties: fieldName: type: - string - 'null' description: Field name for the filter condition conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_4' description: Conditions applied to the field additionalProperties: false EmptyRuleDtoConditionalValueDto_3: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_4' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/EmptyRuleDto' description: Request DTO representing rule with no parameters priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false NumberFormulaSchemaDto_3: type: object properties: formulaSetId: type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: type: - string - 'null' formulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/NumberFormulaVariableDto_3' additionalProperties: false ConditionDefinitionDto_4: type: object properties: fieldName: type: - string - 'null' description: Name of the field to evaluate example: EntityType value: type: - array - 'null' items: type: string description: List of values valueId: type: - array - 'null' items: type: string description: List of value ids valueType: type: - string - 'null' description: Type of the value example: text dataSource: type: - string - 'null' description: Data source from which field is retrieved. If empty then Entity Data properties will be used. example: entityDataMetadata operation: type: - string - 'null' description: Logical operation to be performed to match the values example: equal logicalOperation: type: - string - 'null' description: Logical operation to be performed on the operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_4' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto valueField: allOf: - $ref: '#/components/schemas/ValueField_4' description: Field value used for conditional limit validation additionalProperties: false description: Represents condition RegexRuleDto_4: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred isCaseSensitive: type: boolean description: Flag that indicate if regex is case sensitive example: false regexValue: type: - string - 'null' description: Regex expression example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$ additionalProperties: false description: Request DTO representing regex rule metadata DateLimitRuleDtoConditionalValidationRuleDto_3: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/DateLimitRuleDto_4' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/DateLimitRuleDtoConditionalValueDto_3' description: Conditional validation rules additionalProperties: false CollectionMinimumCountRuleDto2_3: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with minimum count example: Registered: 1 overallMinimumCount: type: integer description: Overall minimum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection minimum count validation rule metadata ServiceResponseMessage_4: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response BasicRuleDtoConditionalValidationRuleDto_3: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto_4' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/BasicRuleDtoConditionalValueDto_3' description: Conditional validation rules additionalProperties: false RequirementDto_5: type: object properties: rootVersionId: type: string description: The UiD of the root requirement set version format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versionNumber: type: integer description: Requirement set version number format: int32 example: 1 id: type: string description: The UiD of the requirement format: uuid example: 84ec28e2-d786-417b-850f-96321dd849dd tenant: type: - string - 'null' description: The UiD of the tenant example: c345f3e9-c9f7-40ac-9eaa-654c2d2de1d1 category: type: - string - 'null' description: Requirement business category example: Basic Details description: type: - string - 'null' description: Requirement description example: This is the client first name template: type: - string - 'null' description: Requirement template example: Product entityType: type: - string - 'null' description: Requirement entity type example: Individual name: type: - string - 'null' description: Requirement name example: First Name isSensitiveData: type: boolean description: Requirement sensitive data flag example: true isMaterialData: type: boolean description: Requirement material data flag example: true isCoreDefinition: type: boolean description: Requirement is defined as core and cannot be deleted or altered example: false jurisdiction: type: - string - 'null' description: Requirement jurisdiction example: Global references: type: - array - 'null' items: $ref: '#/components/schemas/ReferenceDto_3' description: Requirement references list targetEntity: type: - string - 'null' description: Requirement target entity example: Client classification: type: - string - 'null' description: Requirement classification example: Customer Profiling type: type: - string - 'null' description: Requirement type example: Data conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_4' description: Requirement conditions list RequirementSetId: type: string description: The UiD of the current requirement set version format: uuid example: c060f297-70a2-4d4c-9360-9b5b39060ff0 versionId: type: string description: The UiD of the current requirement set version format: uuid example: e060f297-70a2-4d4c-9360-9b5b39060ff0 dataField: allOf: - $ref: '#/components/schemas/DataFieldDto_5' description: Data Field dataProtectionJurisdiction: type: - string - 'null' description: Jurisdiction for data protection example: Global order: type: - number - 'null' description: Order format: double example: 1 defaultValue: type: - string - 'null' description: Default Value example: Not Available isReadOnly: type: boolean description: Is requirement readonly example: false isIndexable: type: boolean description: Is requirement indexable example: true isJourneyLevelData: type: boolean description: Is journey level data example: false isMandatoryIndexable: type: boolean description: Is requirement mandatory indexable example: true isMandatory: type: boolean description: Is requirement mandatory example: false documentDescription: type: - string - 'null' description: Document Description example: Driver License documentDataKey: type: - string - 'null' description: Document Data Key documentAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_3' description: Document Access Layers acceptableDocumentDataKeys: type: - array - 'null' items: type: string description: List of acceptable Document Types for the Document Requirement fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_3' description: Field Access Layers isMasked: type: boolean description: Flag indicating if field is masked due to missing Sensitive Data Access layers example: false ownershipDataKey: type: - string - 'null' description: Ownership Data Key example: DataKey partyTypes: type: - array - 'null' items: type: string description: Party Types e.g. ["Director"] uboThreshold: type: - number - 'null' description: UBO Threshold format: double example: 0.6 relatedPartyEntityTypes: type: - array - 'null' items: type: string description: Types of Related Party Entity e.g. ["Individual"] directAssociationsOnly: type: boolean description: Is Only direct association example: false idvOn: type: boolean description: Is Idv On example: false idvName: type: - string - 'null' description: Idv Name example: IdentityRequirement idvTooltip: type: - string - 'null' description: Idv Tooltip example: Identity Requirement ownershipValidationRule: allOf: - $ref: '#/components/schemas/OwnershipValidationRuleDto' description: Ownership Validation Rule validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto_5' description: Validation Rule validationRulesV2: allOf: - $ref: '#/components/schemas/DataValidationRulesDto' description: Request DTO representing validation data metadata conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto_4' description: List of conditional values hasEvaluatedConditionalValue: type: boolean description: Does this field has evaluated conditional value? evaluatedConditionalValueId: type: - string - 'null' description: Evaluated conditional value Id evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value tags: type: - array - 'null' items: type: string description: List of tags clearValueIfTriggerConditionNotMet: type: boolean description: Indicates whether the field value should be cleared when trigger conditions are not met example: false aggregateVersion: type: - integer - 'null' description: Requirement aggregate version format: int32 example: 1 uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiColorDecoration: type: - string - 'null' description: Determines with what colour requirement should be rendered portalGuidance: type: - string - 'null' description: Portal guidance example: Provide at least one director RP isLocked: type: boolean description: True if the aggregate is locked (obsolete) example: false deprecated: true discriminator: type: - string - 'null' description: Data group field core definition flag (obsolete) example: 'true' deprecated: true version: type: integer description: Requirement aggregate version (obsolete) format: int32 example: true deprecated: true partyCount: type: - integer - 'null' description: Requirement party count format: int32 example: 1 deprecated: true partyType: type: - string - 'null' description: Requirement party type example: Shareholder deprecated: true sourceEntityType: type: - string - 'null' description: Any of the related party entity types selected can be counted toward this requirement example: Individual deprecated: true additionalProperties: false description: Request DTO representing requirement metadata securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-dealscommand-v1-0-openapi.json - fenergo-dealsquery-v1-0-openapi.json - fenergo-policycommand-v1-0-openapi.json - fenergo-policyquery-v1-0-openapi.json - fenergo-policyquery-v2-0-openapi.json