openapi: 3.2.0 info: title: Fenergo Entity Rule API version: '1.0' description: 'Operations tagged EntityRule across 2 of this provider''s published API definitions: fenergo-reviewcommand-v1-0-openapi.json, fenergo-reviewquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /reviewcommand - url: /reviewquery security: - Bearer: [] tags: - name: EntityRule paths: /api/entity-rule: post: tags: - EntityRule summary: Create entity rule description: 'Creates a new entity rule with a first draft version. 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: ReviewJourneySchedulingEdit' operationId: CreateEntityRule 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/EntityRuleDtoServiceRequest' responses: '202': description: Success. EntityRule created content: application/json: schema: $ref: '#/components/schemas/EntityRuleDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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: - EntityRule summary: Get entityRule description: 'Returns all entityRule Returns only entityRule by default. Required permissions: Following permissions are required: ReviewJourneySchedulingAccess' operationId: GetAllEntityRules 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 entity rule data is returned content: application/json: schema: $ref: '#/components/schemas/EntityRuleDtoIEnumerableServiceResponse' '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: /reviewcommand /api/entity-rule/{entityRuleId}: post: tags: - EntityRule summary: Create entity rule version description: 'Creates a new version of an existing entity rule. 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: ReviewJourneySchedulingEdit' operationId: CreateEntityRuleVersion parameters: - name: entityRuleId in: path description: Entity rule 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 entity rule version request content: application/json: schema: allOf: - $ref: '#/components/schemas/EntityRuleDtoServiceRequest' responses: '202': description: Success. Entity rule version created content: application/json: schema: $ref: '#/components/schemas/EntityRuleDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Review schema with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/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 delete: tags: - EntityRule summary: Delete Entity Rule and all its versions description: 'Deletes an existing Entity Rule and all its versions. Required permissions: Following permissions are required: ReviewJourneySchedulingDelete' operationId: DeleteEntityRule parameters: - name: entityRuleId in: path description: Entity Rule 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. Entity rule deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Entity Rule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/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: - EntityRule summary: Get entity rule by id description: 'Returns the active, currently in effect, published entity rule version for a given id. Required permissions: Following permissions are required: ReviewJourneySchedulingAccess' operationId: GetEntityRuleById parameters: - name: entityRuleId in: path description: Entity rule 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. entity rule is returned content: application/json: schema: $ref: '#/components/schemas/EntityRuleVersionDtoServiceResponse' '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. Entity rule 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: /reviewcommand /api/entity-rule/{entityRuleId}/version/{versionNumber}: put: tags: - EntityRule summary: Update Entity Rule version description: 'Updates an existing Entity Rule version. Only draft and rejected versions are allowed to be updated. Required permissions: Following permissions are required: ReviewJourneySchedulingEdit' operationId: UpdateEntityRuleVersion parameters: - name: entityRuleId in: path description: Entity Rule 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 Entity Rule version request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateEntityRuleVersionDtoServiceRequest' responses: '202': description: Success. Entity Rule version updated content: application/json: schema: $ref: '#/components/schemas/UpdateEntityRuleVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Entity Rule 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' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '400': description: Bad request. The request has missing/invalid values content: application/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 delete: tags: - EntityRule summary: Delete Entity Rule version description: 'Deletes the selected version of an existing Entity Rule. 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: ReviewJourneySchedulingDelete' operationId: DeleteEntityRuleVersion parameters: - name: entityRuleId in: path description: Entity Rule 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. Entity Rule version deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Entity Rule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/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: - EntityRule summary: Get entity rule by id and version description: 'Returns entity rule for a given id and version number. Required permissions: Following permissions are required: ReviewJourneySchedulingAccess' operationId: GetEntityRuleVersionById parameters: - name: entityRuleId in: path description: entity rule id required: true schema: type: string format: uuid - name: versionNumber in: path description: entity rule 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. entity rule is returned content: application/json: schema: $ref: '#/components/schemas/EntityRuleVersionDtoServiceResponse' '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. entity rule 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: /reviewcommand /api/entity-rule/{entityRuleId}/version/{versionNumber}/clone: post: tags: - EntityRule summary: Clone Entity Rule version description: 'Clones the selected version of an existing Entity Rule 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 data group version. Required permissions: Following permissions are required: ReviewJourneySchedulingEdit' operationId: CloneEntityRuleVersion parameters: - name: entityRuleId in: path description: Entity Rule 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 Entity Rule version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CloneEntityRuleVersionDtoServiceRequest' responses: '202': description: Success. Entity Rule version cloned content: application/json: schema: $ref: '#/components/schemas/CloneEntityRuleVersionResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Entity Rule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/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: /reviewcommand /api/entity-rule/{entityRuleId}/version/{versionNumber}/submit-for-approval: put: tags: - EntityRule summary: Submit Entity Rule version for approval description: 'Submits the selected version of an existing Entity Rule for approval. Required permissions: Following permissions are required: ReviewJourneySchedulingEdit' operationId: SubmitEntityRuleVersion parameters: - name: entityRuleId in: path description: Entity Rule 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. Entity Rule version submitted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Entity Rule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/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: /reviewcommand /api/entity-rule/{entityRuleId}/version/{versionNumber}/sign: put: tags: - EntityRule summary: Sign Entity Rule version description: 'Signs the selected version of an existing Entity Rule and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: ReviewJourneySchedulingApprove' operationId: SignEntityRuleVersion parameters: - name: entityRuleId in: path description: Entity Rule 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 Entity Rule version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' responses: '202': description: Success. Entity Rule version signed content: application/json: schema: $ref: '#/components/schemas/EntityRuleVersionSignResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Entity Rule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/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: /reviewcommand /api/entity-rule/{entityRuleId}/version/{versionNumber}/archive: put: tags: - EntityRule summary: Archive Entity Rule version description: 'Archives the selected version of an existing Entity Rule. Required permissions: Following permissions are required: ReviewJourneySchedulingArchive' operationId: ArchiveEntityRuleVersion parameters: - name: entityRuleId in: path description: Entity Rule 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. Entity Rule version archived '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. Entity Rule 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: /reviewcommand components: schemas: 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 UpdateEntityRuleVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateEntityRuleVersionDto' additionalProperties: false EntityRuleDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityRuleDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false EntityRuleDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityRuleDto' additionalProperties: false CloneEntityRuleVersionResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneEntityRuleVersionResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false UpdateEntityRuleVersionDto: allOf: - $ref: '#/components/schemas/EntityRuleDto' - type: object properties: version: type: integer format: int32 default: -1 additionalProperties: false ConditionDto: required: - logicalOperation - operands type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: minLength: 1 type: string operands: minItems: 1 type: array items: $ref: '#/components/schemas/ConditionDefinitionDto' additionalProperties: false CloneEntityRuleVersionDto: type: object properties: name: type: - string - 'null' additionalProperties: false ValueField: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false EntityRuleVersionSignResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityRuleVersionSignResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CloneEntityRuleVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneEntityRuleVersionDto' additionalProperties: false Decision: enum: - Approve - Reject type: string EntityRuleDto: type: object properties: id: type: string format: uuid ruleId: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' journeyType: type: - string - 'null' launchJourneyIn: type: integer format: int32 advanceLaunchBy: type: integer format: int32 conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' entityReviewRequired: type: boolean additionalReviewTypes: type: - array - 'null' items: type: string conflictingJourneyTypes: type: - array - 'null' items: type: string journeyTypesScope: type: - array - 'null' items: type: string usePolicyDateField: type: boolean policyDateField: type: - string - 'null' versionNumber: type: integer format: int32 effectiveFrom: type: string format: date-time signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' created: type: string format: date-time isMigrated: type: boolean status: allOf: - $ref: '#/components/schemas/VersionStatus' 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 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 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 EntityRuleVersionSignResponse: type: object properties: entityRuleId: type: string format: uuid versionNumber: type: integer format: int32 status: allOf: - $ref: '#/components/schemas/VersionStatus' additionalProperties: false CloneEntityRuleVersionResponse: type: object properties: entityRuleId: type: string format: uuid additionalProperties: false UpdateEntityRuleVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateEntityRuleVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false 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 VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ApproveAction: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false BaseVersionDto: type: object properties: 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 additionalProperties: false description: Response DTO representing data group version data EntityRuleVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityRuleVersionDto' description: Response DTO representing entity rule version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false EntityRuleDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EntityRuleDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConditionDto_2: 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 EntityRuleDto_2: type: object properties: id: type: string description: The UiD of the entity rule format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versions: type: - array - 'null' items: $ref: '#/components/schemas/EntityRuleVersionDto' description: Versions associated to this entity rule version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Response DTO representing entity rule EntityRuleVersionDto: allOf: - $ref: '#/components/schemas/BaseVersionDto' - type: object properties: id: type: string description: The UiD of the entityRule set version format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f entityRuleId: type: string description: The UiD of the entityRule that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: EntityRule name example: Standard Entity Rule description: type: - string - 'null' description: Description of the Entity Rule example: Rule to trigger a one year review journeyType: type: - string - 'null' description: Configured journey type used at launch example: Maintenance launchJourneyIn: type: integer description: Launch journey in months format: int32 advanceLaunchBy: type: integer description: Launch journey in advance in days format: int32 conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' description: Conditions under which the entity rule can be applied entityReviewRequired: type: boolean description: Whether or not an Entity Review is required example: true additionalReviewTypes: type: - array - 'null' items: type: string description: List of review types when an entity review is required conflictingJourneyTypes: type: - array - 'null' items: type: string description: List of journey types treated as conflicting when JourneyConflictAtScheduling is used journeyTypesScope: type: - array - 'null' items: type: string description: List of journey types on completion of which a review should be launched usePolicyDateField: type: boolean description: Whether to use a date field from policy instead of calculated months example: false policyDateField: type: - string - 'null' description: The policy date field identifier when using policy date field example: d0871fbf-9c5f-45f5-9a9c-7563b07e9387 publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-01-01T14:48:00.000Z' isMigrated: type: boolean description: To show if the rule was migrated from Journey Scheduler example: true additionalProperties: false description: Response DTO representing entity rule version data securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-reviewcommand-v1-0-openapi.json - fenergo-reviewquery-v1-0-openapi.json