openapi: 3.2.0 info: title: Fenergo Entity Check Configuration API version: '1.0' description: 'Operations tagged EntityCheckConfiguration across 2 of this provider''s published API definitions: fenergo-dataprotectioncommand-v1-0-openapi.json, fenergo-dataprotectionquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /dataprotectioncommand - url: /dataprotectionquery security: - Bearer: [] tags: - name: EntityCheckConfiguration paths: /api/entitycheckconfiguration: post: tags: - EntityCheckConfiguration summary: Create entity check configuration description: 'Creates a new entity check configuration 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: DataProtectionCreate' operationId: CreateEntityCheckConfiguration 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/EntityCheckConfigurationDtoServiceRequest' description: Service request data responses: '202': description: Success. Entity check configuration created content: application/json: schema: $ref: '#/components/schemas/EntityCheckConfigurationDtoServiceResponse' '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 get: tags: - EntityCheckConfiguration summary: Get entity check configurations description: 'Returns all entity check configurations Required permissions: Following permissions are required: DataProtectionAccess' operationId: GetAllEntityCheckConfigurations 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 check configurations is returned content: application/json: schema: $ref: '#/components/schemas/EntityCheckConfigurationDtoIEnumerableServiceResponse' '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: /dataprotectioncommand /api/entitycheckconfiguration/{configurationId}: post: tags: - EntityCheckConfiguration summary: Create entity check configuration version description: 'Creates a new version of an existing entity check configuration 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: DataProtectionCreate' operationId: CreateEntityCheckConfigurationVersion parameters: - name: configurationId in: path description: Entity check configuration 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 check configuration version request content: application/json: schema: allOf: - $ref: '#/components/schemas/EntityCheckConfigurationDtoServiceRequest' description: Service request data responses: '202': description: Success. Entity check configuration created content: application/json: schema: $ref: '#/components/schemas/EntityCheckConfigurationDtoServiceResponse' '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 check configuration with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - EntityCheckConfiguration summary: Delete entity check configuration and all its versions description: 'Deletes an existing entity check configuration and all its versions. Required permissions: Following permissions are required: DataProtectionDelete' operationId: DeleteEntityCheckConfiguration parameters: - name: configurationId in: path description: Entity check configuration 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 check configuration deleted '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 check configuration 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 get: tags: - EntityCheckConfiguration summary: Get entity check configuration by id description: 'Returns the active, currently in effect, published entity check configuration version for a given id. Required permissions: Following permissions are required: DataProtectionAccess' operationId: GetEntityCheckConfigurationById parameters: - name: configurationId in: path description: Entity check configuration id required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Entity check configuration is returned content: application/json: schema: $ref: '#/components/schemas/EntityCheckConfigurationVersionDtoServiceResponse' '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 check configuration 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: /dataprotectioncommand /api/entitycheckconfiguration/{configurationId}/version/{versionNumber}/draft: post: tags: - EntityCheckConfiguration summary: Create entity check configuration version from provided configuration id description: 'Creates a new version of an existing entity check configuration Assigns the next available version number. The new version initializes with the latest published entity check configuration data, has the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: DataProtectionCreate' operationId: CreateEntityCheckConfigurationVersionFromParentId parameters: - name: configurationId in: path description: Entity check configuration id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to create new draft from required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Entity check configuration created content: application/json: schema: $ref: '#/components/schemas/CreateEntityCheckConfigurationVersionFromParentIdResponseServiceResponse' '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 check configuration 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: /dataprotectioncommand /api/entitycheckconfiguration/{configurationId}/version/{versionNumber}: put: tags: - EntityCheckConfiguration summary: Update entity check configuration version description: 'Updates an existing entity check configuration version. Only draft and rejected versions are allowed to be updated. Required permissions: Following permissions are required: DataProtectionEdit' operationId: UpdateEntityCheckConfigurationVersion parameters: - name: configurationId in: path description: Entity check configuration 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 check configuration version request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateEntityCheckConfigurationVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Entity check configuration updated '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 check configuration 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 '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: - EntityCheckConfiguration summary: Delete entity check configuration version description: 'Deletes the selected version of an existing entity check configuration. 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: DataProtectionDelete' operationId: DeleteEntityCheckConfigurationVersion parameters: - name: configurationId in: path description: Entity check configuration 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 check configuration version deleted '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 check configuration 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 get: tags: - EntityCheckConfiguration summary: Get entity check configuration by id and version description: 'Returns entity check configuration for a given id and version number. Required permissions: Following permissions are required: DataProtectionAccess' operationId: GetEntityCheckConfigurationVersionById parameters: - name: configurationId in: path description: Entity check configuration id required: true schema: type: string - name: versionNumber in: path description: Entity check configuration 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 check configuration is returned content: application/json: schema: $ref: '#/components/schemas/EntityCheckConfigurationVersionDtoServiceResponse' '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 check configuration 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: /dataprotectioncommand /api/entitycheckconfiguration/{configurationId}/version/{versionNumber}/clone: post: tags: - EntityCheckConfiguration summary: Clone entity check configuration version description: 'Clones the selected version of an existing entity check configuration version 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 entity check configuration version. Required permissions: Following permissions are required: DataProtectionEdit' operationId: CloneEntityCheckConfigurationVersion parameters: - name: configurationId in: path description: Entity check configuration 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 check configuration version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CloneEntityCheckConfigurationVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Entity check configuration updated content: application/json: schema: $ref: '#/components/schemas/CloneEntityCheckConfigurationVersionResponseServiceResponse' '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 check configuration 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: /dataprotectioncommand /api/entitycheckconfiguration/{configurationId}/version/{versionNumber}/submit-for-approval: put: tags: - EntityCheckConfiguration summary: Submit entity check configuration version for approval description: 'Submits the selected version of an existing entity check configuration for approval. Required permissions: Following permissions are required: DataProtectionEdit' operationId: SubmitEntityCheckConfigurationVersion parameters: - name: configurationId in: path description: Entity check configuration 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 check configuration version submitted '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 check configuration 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: /dataprotectioncommand /api/entitycheckconfiguration/{configurationId}/version/{versionNumber}/sign: put: tags: - EntityCheckConfiguration summary: Sign entity check configuration version description: 'Signs the selected version of an existing entity check configuration and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: DataProtectionApprove' operationId: SignEntityCheckConfigurationVersion parameters: - name: configurationId in: path description: Entity check configuration 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 check configuration version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' description: Service request data responses: '202': description: Success. Entity check configuration version signed content: application/json: schema: $ref: '#/components/schemas/EntityCheckConfigurationVersionSignResponseServiceResponse' '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 check configuration 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: /dataprotectioncommand /api/entitycheckconfiguration/{configurationId}/version/{versionNumber}/archive: put: tags: - EntityCheckConfiguration summary: Archive entity check configuration version description: 'Archives the selected version of an existing entity check configuration. Required permissions: Following permissions are required: DataProtectionArchive' operationId: ArchiveEntityCheckConfigurationVersion parameters: - name: configurationId in: path description: Entity check configuration 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 check configuration version archived '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 check configuration 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: /dataprotectioncommand components: schemas: CloneEntityCheckConfigurationVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneEntityCheckConfigurationVersionDto' description: The service request DTO additionalProperties: false description: Service request data 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 EntityCheckConfigurationDto: type: object properties: parentId: type: string format: uuid name: type: - string - 'null' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' process: allOf: - $ref: '#/components/schemas/ProcessBaseDto' versionNumber: type: integer format: int32 effectiveFrom: type: string format: date-time signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' notes: type: - string - 'null' created: type: string format: date-time status: allOf: - $ref: '#/components/schemas/VersionStatus' type: type: - string - 'null' additionalProperties: false CloneEntityCheckConfigurationVersionDto: type: object properties: name: type: - string - 'null' additionalProperties: false CreateEntityCheckConfigurationVersionFromParentIdResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateEntityCheckConfigurationVersionFromParentIdResponse' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data UpdateEntityCheckConfigurationVersionDto: type: object properties: parentId: type: string format: uuid name: type: - string - 'null' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' process: allOf: - $ref: '#/components/schemas/ProcessBaseDto' versionNumber: type: integer format: int32 effectiveFrom: type: string format: date-time signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' notes: type: - string - 'null' version: type: integer format: int32 default: -1 additionalProperties: false ConditionDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root ServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValueField: type: object properties: dataSource: type: - string - 'null' description: Value of DataSource used to filter field values field: type: - string - 'null' description: Field value used to validate conditional value additionalProperties: false CloneEntityCheckConfigurationVersionResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneEntityCheckConfigurationVersionResponse' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data CloneEntityCheckConfigurationVersionResponse: type: object properties: entityCheckConfigurationId: type: string format: uuid additionalProperties: false Decision: enum: - Approve - Reject type: string EntityCheckConfigurationVersionSignResponse: type: object properties: configurationId: type: string format: uuid versionNumber: type: integer format: int32 status: allOf: - $ref: '#/components/schemas/VersionStatus' additionalProperties: false CreateEntityCheckConfigurationVersionFromParentIdResponse: type: object properties: parentId: type: string format: uuid versionNumber: type: integer format: int32 additionalProperties: false EntityCheckConfigurationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityCheckConfigurationDto' description: The service request DTO additionalProperties: false description: Service request data UpdateEntityCheckConfigurationVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateEntityCheckConfigurationVersionDto' description: The service request DTO additionalProperties: false description: Service request data ApproveActionServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' description: The service request DTO additionalProperties: false description: Service request data ObjectServiceResponse: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data StringServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data 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 EntityCheckConfigurationDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityCheckConfigurationDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ConditionDefinitionDto: type: object properties: fieldName: type: - string - 'null' description: Name of the field to evaluate example: EntityType value: type: - array - 'null' items: type: string description: List of values valueId: type: - array - 'null' items: type: string description: List of value ids valueType: type: - string - 'null' description: Type of the value example: text dataSource: type: - string - 'null' description: Data source from which field is retrieved. If empty then Entity Data properties will be used. example: entityDataMetadata operation: type: - string - 'null' description: Logical operation to be performed to match the values example: equal logicalOperation: type: - string - 'null' description: Logical operation to be performed on the operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto valueField: allOf: - $ref: '#/components/schemas/ValueField' description: Field value used for conditional limit validation additionalProperties: false description: Represents condition ProcessBaseDto: type: object properties: isEnabled: type: boolean frequencyCount: type: integer format: int32 actionType: type: - string - 'null' expiryPeriod: type: - integer - 'null' format: int32 additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string EntityCheckConfigurationVersionSignResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityCheckConfigurationVersionSignResponse' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response ApproveAction: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false EntityCheckConfigurationVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityCheckConfigurationVersionDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EntityCheckConfigurationDto_2: type: object properties: id: type: string format: uuid versions: type: - array - 'null' items: $ref: '#/components/schemas/EntityCheckConfigurationVersionDto' version: type: integer format: int32 status: type: - string - 'null' type: type: - string - 'null' additionalProperties: false ProcessBaseDto_2: type: object properties: frequencyCount: type: integer format: int32 isEnabled: type: boolean action: allOf: - $ref: '#/components/schemas/EntityCheckAction' expiryPeriod: type: - integer - 'null' format: int32 additionalProperties: false EntityCheckConfigurationVersionDto: type: object properties: id: type: string format: uuid configurationId: type: string format: uuid entityCheckConfigurationStatus: type: - string - 'null' name: type: - string - 'null' type: type: - string - 'null' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' process: allOf: - $ref: '#/components/schemas/ProcessBaseDto_2' versionNumber: type: integer format: int32 effectiveFrom: type: string format: date-time effectiveUntil: type: - string - 'null' format: date-time publicationDate: type: - string - 'null' format: date-time readOnly: true status: allOf: - $ref: '#/components/schemas/VersionStatus' created: type: string format: date-time isActive: type: boolean signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' version: type: integer format: int32 notes: type: - string - 'null' additionalProperties: false EntityCheckAction: enum: - ShowEntitiesOnDashboard - InitiateFullOffboarding - JourneyCreated - AutomatedOffboarding - AutomaticallyDeleted type: string EntityCheckConfigurationDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EntityCheckConfigurationDto_2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-dataprotectioncommand-v1-0-openapi.json - fenergo-dataprotectionquery-v1-0-openapi.json