openapi: 3.2.0 info: title: Fenergo Covenant Condition API version: '1.0' description: 'Operations tagged CovenantCondition across 2 of this provider''s published API definitions: fenergo-covenantsconditionscommand-v1-0-openapi.json, fenergo-covenantsconditionsquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /covenantsconditionscommand - url: /covenantsconditionsquery security: - Bearer: [] tags: - name: CovenantCondition paths: /api/CovenantCondition: post: tags: - CovenantCondition summary: Create a new Covenant Condition Set description: 'Creates a new Covenant Condition Set for the parent. Required permissions: Following permissions are required: CovenantsConditionsEdit' operationId: CreateCovenantConditionSet 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: Create Covenant Condition Set request content: application/json: schema: $ref: '#/components/schemas/CovenantConditionSetDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CovenantConditionSetDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CovenantConditionSetDtoServiceRequest' responses: '202': description: Success. Covenant Condition Set created content: text/plain: schema: $ref: '#/components/schemas/CovenantConditionSetDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CovenantConditionSetDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CovenantConditionSetDtoServiceResponse' '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' '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: /covenantsconditionscommand /api/CovenantCondition/{setId}/version: post: tags: - CovenantCondition summary: Create a new Covenant Condition Version description: 'This method creates a new Covenant Condition Version based on the previous completed version. Required permissions: Following permissions are required: CovenantsConditionsEdit' operationId: CreateCovenantConditionVersion parameters: - name: setId in: path description: Covenant Condition 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: ServiceRequest with the schema snapshot data content: application/json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Covenant Condition Set with given ID does not exists 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: /covenantsconditionscommand /api/CovenantCondition/{setId}/version/{id}: put: tags: - CovenantCondition summary: Update a Covenant Condition Version description: 'This method updates an existing Covenant Condition Version. Only Covenant Condition Version with draft status can be updated. Only Covenant Condition Version that satisfies non-mandatory validation rules can be updated. Required permissions: Following permissions are required: CovenantsConditionsEdit' operationId: UpdateCovenantConditionVersion parameters: - name: setId in: path description: Covenant Condition Set Id required: true schema: type: string format: uuid - name: id in: path description: Covenant Condition Version 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: Covenant Condition Version data content: application/json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Covenant Condition with given ID does not exists 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: /covenantsconditionscommand /api/CovenantCondition/{setId}/version/{id}/status: put: tags: - CovenantCondition summary: Update a Covenant Condition Version status description: 'This method updates an existing Covenant Condition Version status. Only Covenant Condition Version with draft status can be updated. Required permissions: Following permissions are required: CovenantsConditionsEdit' operationId: UpdateCovenantConditionVersionStatus parameters: - name: setId in: path description: Covenant Condition Set Id required: true schema: type: string format: uuid - name: id in: path description: Covenant Condition Version 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: 'Status body: Draft, Completed, Rejected, Verified' content: application/json: schema: $ref: '#/components/schemas/StatusDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/StatusDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/StatusDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/StatusDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/StatusDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/StatusDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Covenant Condition Set with given ID does not exists 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: /covenantsconditionscommand /api/CovenantCondition/journey/{journeyId}/verify: put: tags: - CovenantCondition summary: Update a Covenant Condition Version status description: 'This method verify the completed Covenant Condition Versions for the journey. Only Covenant Condition Version with Completed status can be verified. Required permissions: Following permissions are required: CovenantsConditionsEdit' operationId: VerifyCovenantConditionsForJourney parameters: - name: journeyId in: path description: Journey Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/StatusDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/StatusDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/StatusDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '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: /covenantsconditionscommand /api/CovenantCondition/set/{setId}/snapshot: post: tags: - CovenantCondition summary: Take a policy snapshot for Covenant Condition description: 'This method take a policy snapshot for a Covenant Condition. Required permissions: Following permissions are required: CovenantsConditionsEdit' operationId: SnapshotCovenantConditionConfiguration parameters: - name: setId in: path description: Covenant Condition 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: Covenant Condition Policy Snapshot data content: application/json: schema: $ref: '#/components/schemas/SnapshotSetServiceRequest' text/json: schema: $ref: '#/components/schemas/SnapshotSetServiceRequest' application/*+json: schema: $ref: '#/components/schemas/SnapshotSetServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse' application/json: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse' text/json: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Covenant Condition Set with given ID does not exists 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: /covenantsconditionscommand /api/covenantcondition/set/{setId}: get: tags: - CovenantCondition summary: Get a Covenant Condition Set of specified Id with all Version data description: 'This method returns the Covenant Condition Set of specified Id with all Covenant Condition Versions data. Required permissions: Following permissions are required: CovenantsConditionsAccess' operationId: GetCovenantConditionSetById parameters: - name: setId in: path description: The Id of the Covenant Condition Set 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. A Covenant Condition Set is returned content: application/json: schema: $ref: '#/components/schemas/CovenantConditionSetDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Covenant Condition 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: /covenantsconditionsquery /api/covenantcondition/data/parent/{parentId}/journey/{journeyId}/task/{taskId}: get: tags: - CovenantCondition summary: Get Covenant Condition Details for specified Parent Id, Journey and Task Id… description: 'This method returns the Covenant Condition Details for specified Parent Id, Journey and TaskId, with all and latest version.. Required permissions: Following permissions are required: CovenantsConditionsAccess' operationId: GetCovenantConditionDataByParentJourneyTaskId parameters: - name: parentId in: path description: The Parent Id of the Covenant Condition Set required: true schema: type: string format: uuid - name: journeyId in: path description: Journey Id required: true schema: type: string format: uuid - name: taskId in: path description: Task 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. Covenant Condition Task Details is returned content: application/json: schema: $ref: '#/components/schemas/CovenantConditionTaskDetailsDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Covenant Condition Set with given Parent 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: /covenantsconditionsquery /api/covenantcondition/version/{id}: get: tags: - CovenantCondition summary: Get a full Covenant Condition Version of specified Id description: 'This method returns the full Covenant Condition Version of specified Id. Required permissions: Following permissions are required: CovenantsConditionsAccess' operationId: GetCovenantConditionVersionById parameters: - name: id in: path description: The id of the Covenant Condition Version to retrieve 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. A Covenant Condition Version Dto is returned content: application/json: schema: $ref: '#/components/schemas/CovenantConditionVersionDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Covenant Condition 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: /covenantsconditionsquery /api/covenantcondition/set/parent/{parentId}: get: tags: - CovenantCondition summary: Get a Covenant Condition Set with all versions of specified Parent Id description: 'This method returns the Covenant Condition Set with all versions of specified Parent Id. Required permissions: Following permissions are required: CovenantsConditionsAccess' operationId: GetCovenantConditionSetByParentId parameters: - name: parentId in: path description: The Parent Id of the Covenant Condition Sets 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. A Covenant Condition Set is returned content: application/json: schema: $ref: '#/components/schemas/CovenantConditionSetDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '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: /covenantsconditionsquery /api/covenantcondition/set/{setId}/version/{versionId}/snapshot: get: tags: - CovenantCondition summary: Get a policy snapshot for Covenant Condition by version number description: 'This method returns the policy snapshot for Covenant Condition of specified set Id and Version. Required permissions: Following permissions are required: CovenantsConditionsAccess' operationId: GetCovenantConditionConfigurationSnapshotBySetVersionId parameters: - name: setId in: path description: The set id of the policy snapshot for Covenant Condition to retrieve required: true schema: type: string format: uuid - name: versionId in: path description: The version Id of the policy snapshot for Covenant Condition to retrieve 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. A Covenant Condition Policy Snapshot is returned content: application/json: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Covenant Condition 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: /covenantsconditionsquery components: schemas: SpecialCharactersRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' excludedCharacters: type: - array - 'null' items: type: string additionalProperties: false SnapshotSetServiceResponse: type: object properties: data: $ref: '#/components/schemas/SnapshotSet' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ExternalProviderRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' providerId: type: string format: uuid additionalProperties: false SinglePropertyDto: type: object properties: type: $ref: '#/components/schemas/PropertyType' discriminator: $ref: '#/components/schemas/PropertyType' value: type: - string - 'null' additionalProperties: false ValidationDataDto: type: object properties: isMandatory: $ref: '#/components/schemas/BasicRuleDto' specialCharacters: $ref: '#/components/schemas/SpecialCharactersRuleDto' noNumbers: $ref: '#/components/schemas/BasicRuleDto' onlyInteger: $ref: '#/components/schemas/BasicRuleDto' noNegative: $ref: '#/components/schemas/BasicRuleDto' onlyDecimal: $ref: '#/components/schemas/BasicRuleDto' regex: $ref: '#/components/schemas/RegexRuleDto' characterLimit: $ref: '#/components/schemas/ValueLimitRuleDto' numberLimit: $ref: '#/components/schemas/ValueLimitRuleDto' noFutureDates: $ref: '#/components/schemas/BasicRuleDto' noPastDates: $ref: '#/components/schemas/BasicRuleDto' dateLimit: $ref: '#/components/schemas/DateLimitRuleDto' multiSelectLimit: $ref: '#/components/schemas/ValueLimitRuleDto' collectionMinimumCount: $ref: '#/components/schemas/CollectionMinimumCountRuleDto' collectionMaximumCount: $ref: '#/components/schemas/CollectionMaximumCountRuleDto' externalProvider: $ref: '#/components/schemas/ExternalProviderRuleDto' additionalProperties: false StatusDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/StatusDto' additionalProperties: false CollectionMaximumCountRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: - integer - 'null' format: int32 overallMaximumCount: type: - integer - 'null' format: int32 additionalProperties: false ValueLimitRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' 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 GroupRequirement: type: object properties: name: type: - string - 'null' key: type: - string - 'null' primaryDataGroupField: type: - string - 'null' snapshotPropertyItems: type: - array - 'null' items: $ref: '#/components/schemas/GroupRequirementItem' validationRule: $ref: '#/components/schemas/ValidationRuleDto' additionalProperties: false CovenantConditionItemDto: type: object properties: id: type: string format: uuid dataKey: type: - string - 'null' value: type: - string - 'null' properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto' associations: type: - array - 'null' items: $ref: '#/components/schemas/CovenantConditionAssociationDto' additionalProperties: false StatusDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/StatusDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false SnapshotSetServiceRequest: type: object properties: data: $ref: '#/components/schemas/SnapshotSet' additionalProperties: false SnapshotSet: type: object properties: setId: type: string format: uuid tenantId: type: string format: uuid versionId: type: string format: uuid snapshotGroups: type: - array - 'null' items: $ref: '#/components/schemas/GroupRequirement' additionalProperties: false GroupRequirementItem: type: object properties: key: type: - string - 'null' label: type: - string - 'null' valueType: type: - string - 'null' order: type: integer format: int32 isAdditionalField: type: boolean validationRule: $ref: '#/components/schemas/ValidationRuleDto' additionalProperties: false CovenantConditionSetDto: type: object properties: id: type: string format: uuid parentId: type: string format: uuid parentType: type: - string - 'null' status: type: - string - 'null' additionalProperties: false CovenantConditionVersionDto: type: object properties: id: type: string format: uuid setId: type: string format: uuid journeyId: type: string format: uuid taskId: type: string format: uuid description: type: - string - 'null' status: type: - string - 'null' covenantConditionGroups: type: - array - 'null' items: $ref: '#/components/schemas/CovenantConditionGroupDto' lastUpdatedDateTime: type: string format: date-time createdDateTime: type: string format: date-time vesionNumber: type: integer format: int32 additionalProperties: false CollectionMinimumCountRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' requiredTypesMinCount: type: - object - 'null' additionalProperties: type: - integer - 'null' format: int32 overallMinimumCount: type: integer format: int32 additionalProperties: false CovenantConditionAssociationDto: type: object properties: id: type: string format: uuid sourceId: type: string format: uuid targetId: type: string format: uuid targetType: type: - string - 'null' additionalProperties: false ValidationRuleDto: type: object properties: id: type: string format: uuid setId: type: string format: uuid propertyId: type: string format: uuid dataGroupId: type: - string - 'null' format: uuid isDataGroup: type: boolean propertyName: type: - string - 'null' friendlyName: type: - string - 'null' validationType: type: - string - 'null' validationData: $ref: '#/components/schemas/ValidationDataDto' additionalProperties: false DateLimitRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' minDate: type: - string - 'null' format: date-time maxDate: type: - string - 'null' format: date-time additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false 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 PropertyType: enum: - Single type: string CovenantConditionSetDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CovenantConditionSetDto' additionalProperties: false ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false RegexRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' isCaseSensitive: type: boolean regexValue: type: - string - 'null' additionalProperties: false CovenantConditionSetDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CovenantConditionSetDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false CovenantConditionVersionDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CovenantConditionVersionDto' additionalProperties: false CovenantConditionGroupDto: type: object properties: id: type: string format: uuid dataGroupId: type: string format: uuid dataGroupVersionNumber: type: - integer - 'null' format: int32 name: type: - string - 'null' type: type: - string - 'null' covenantConditionItems: type: - array - 'null' items: $ref: '#/components/schemas/CovenantConditionItemDto' additionalProperties: false StatusDto: type: object properties: status: type: - string - 'null' additionalProperties: false CovenantConditionVersionDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CovenantConditionVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false SnapshotSetServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/SnapshotSet' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CovenantConditionTaskDetailsDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CovenantConditionTaskDetailsDto' description: Covenant Condition Details for ParentId, JourneyId and TaskId messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false SinglePropertyDto_2: type: object properties: type: allOf: - $ref: '#/components/schemas/PropertyType' readOnly: true discriminator: allOf: - $ref: '#/components/schemas/PropertyType' readOnly: true value: type: - string - 'null' additionalProperties: false ValidationDataDto_2: 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' dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto' multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto' collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto' externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' additionalProperties: false CovenantConditionTaskDetailsDto: type: object properties: id: type: string description: Covenant Condition Set Id format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 parentId: type: string description: Parent Id which Covenant Condition belongs format: uuid example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4 parentType: type: - string - 'null' description: Parent Type which Covenant Condition belongs example: Deal status: type: - string - 'null' description: Covenant Condition Set Status example: Draft covenantConditionVersions: type: - array - 'null' items: $ref: '#/components/schemas/CovenantConditionVersionDto_2' description: List of All Covenant Condition Versions for Task latestVersion: allOf: - $ref: '#/components/schemas/CovenantConditionVersionDto_2' description: Latest Covenant Condition Version for TaskId additionalProperties: false description: Covenant Condition Details for ParentId, JourneyId and TaskId GroupRequirement_2: type: object properties: name: type: - string - 'null' key: type: - string - 'null' primaryDataGroupField: type: - string - 'null' snapshotPropertyItems: type: - array - 'null' items: $ref: '#/components/schemas/GroupRequirementItem_2' validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto_2' additionalProperties: false CovenantConditionItemDto_2: type: object properties: id: type: string description: Covenant Condition Item GUiD format: uuid example: 88009731-77df-4e72-98e7-0d314b7a5151 dataKey: type: - string - 'null' value: type: - string - 'null' description: Covenant Condition Item Value example: Covenant 1 properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto_2' description: Properties of a Covenant Condition Item associations: type: - array - 'null' items: $ref: '#/components/schemas/CovenantConditionAssociationDto_2' description: List of Covenant Condition Associations additionalProperties: false description: Covenant Condition Item GroupRequirementItem_2: type: object properties: key: type: - string - 'null' label: type: - string - 'null' valueType: type: - string - 'null' order: type: integer format: int32 isAdditionalField: type: boolean validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto_2' additionalProperties: false CovenantConditionSetDto_2: type: object properties: id: type: string description: Covenant Condition Set GUiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 parentId: type: string description: Parent Id which Covenant Condition belongs format: uuid example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4 parentType: type: - string - 'null' description: Parent Type which Covenant Condition belongs example: Deal status: type: - string - 'null' description: Covenant Condition Set Status example: Draft covenantConditionVersions: type: - array - 'null' items: $ref: '#/components/schemas/CovenantConditionVersionDto_2' description: List of Covenant Condition Versions additionalProperties: false CovenantConditionVersionDto_2: type: object properties: id: type: string description: Covenant Condition Version GUiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 setId: type: string description: Covenant Condition Set GUiD format: uuid example: a4309731-77df-4e72-98e7-0d314b7a5151 journeyId: type: string description: Journey Id which Covenant Condition version belongs format: uuid example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4 taskId: type: string description: Task Id which Covenant Condition version belongs format: uuid example: 2c3c8433-efc3-493b-9b14-70b7681c7342 description: type: - string - 'null' description: Covenant Condition description example: Set 1 Version status: type: - string - 'null' description: Covenant Condition Status example: Draft covenantConditionGroups: type: - array - 'null' items: $ref: '#/components/schemas/CovenantConditionGroupDto_2' lastUpdatedDateTime: type: string description: Last time it was updated (Read-only) format: date-time example: '2022-12-12T15:55:00.000Z' createdDateTime: type: string description: Date time it was created (Read-only) format: date-time example: '2020-12-12T15:55:00.000Z' versionNumber: type: integer description: Covenant Condition Version format: int32 example: 1 additionalProperties: false description: Covenant Condition Version representation ValidationRuleDto_2: type: object properties: id: type: string format: uuid setId: type: string format: uuid propertyId: type: string format: uuid dataGroupId: type: - string - 'null' format: uuid isDataGroup: type: boolean propertyName: type: - string - 'null' friendlyName: type: - string - 'null' validationType: type: - string - 'null' validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto_2' additionalProperties: false CovenantConditionAssociationDto_2: type: object properties: id: type: string description: Covenant Condition Association Guid format: uuid example: 2db5d6e8-4f16-4c88-8b43-837f03d7b45f sourceId: type: string description: Association Source Id format: uuid example: a1f2c3e4-5678-49ab-9cde-0f1a2b3c4d5e targetId: type: string description: Association Target Id format: uuid example: f6e7d8c9-0a1b-2c3d-4e5f-6a7b8c9d0e1f targetType: type: - string - 'null' description: Association Target Type example: Entity additionalProperties: false description: Covenant Condition Association DTO CovenantConditionSetDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/CovenantConditionSetDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CovenantConditionGroupDto_2: type: object properties: id: type: string description: Covenant Condition Group Id format: uuid example: 51209731-77df-4e72-98e7-0d314b7a5151 dataGroupId: type: string description: Data Group Id format: uuid example: e6af5a6d-1f91-49b2-ae75-8d299ebc613d dataGroupVersionNumber: type: - integer - 'null' description: Data Group Version Number. format: int32 example: 1 name: type: - string - 'null' description: Covenant Condition Group Name example: Financial Covenants 1 type: type: - string - 'null' description: Covenant Condition Group Type example: Financial Covenants covenantConditionItems: type: - array - 'null' items: $ref: '#/components/schemas/CovenantConditionItemDto_2' description: List of Covenant Condition Items additionalProperties: false description: Covenant Condition Group CovenantConditionVersionDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/CovenantConditionVersionDto_2' description: Covenant Condition Version representation messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-covenantsconditionscommand-v1-0-openapi.json - fenergo-covenantsconditionsquery-v1-0-openapi.json