openapi: 3.2.0 info: title: Fenergo Orphan Entity API version: '1.0' description: 'Operations tagged OrphanEntity 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: OrphanEntity paths: /api/orphanentity/{entityId}: post: tags: - OrphanEntity summary: Create orphan entity description: 'Initializes a new orphan entity Initializes a orphan entity. Required permissions: Following permissions are required: DataProtectionCreate' operationId: CreateOrphanEntity parameters: - name: entityId in: path description: Id of the entity for which orphan entity will be created 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 orphan entity request content: application/json: schema: allOf: - $ref: '#/components/schemas/OrphanEntityDtoServiceRequest' description: Service request data responses: '202': description: Success. Orphan entity created '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: - OrphanEntity summary: Delete orphan entity description: 'Deletes the selected orphan entity. Required permissions: Following permissions are required: DataProtectionDelete' operationId: DeleteOrphanEntity parameters: - name: entityId in: path description: Id of the entity 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. Orphan entity deleted '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. Orphan entity 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/orphanentity/{id}/update: put: tags: - OrphanEntity summary: Update orphan entity description: 'Updates an existing orphan entity. Required permissions: Following permissions are required: DataProtectionEdit' operationId: UpdateOrphanEntity parameters: - name: id in: path description: Orhan Entity id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Update orphan entity request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateOrphanEntityDtoServiceRequest' description: Service request data responses: '202': description: Success. Orhan Entity 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. Orhan entity 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 servers: - url: /dataprotectioncommand /api/orphanentity/bulk/update: put: tags: - OrphanEntity summary: Update orphan entities action description: 'Updates action for multiple orphan entities at once. Required permissions: Following permissions are required: DataProtectionEdit' operationId: UpdateOrphanEntities 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: Update orphan entities request content: application/json: schema: allOf: - $ref: '#/components/schemas/BulkUpdateOrphanEntityDtoServiceRequest' description: Service request data responses: '202': description: Success. Orphan entities updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /dataprotectioncommand /api/orphanentity/{entityId}/verify: put: tags: - OrphanEntity summary: Verify orphan entity description: 'Verify existing orphan entity. Required permissions: Following permissions are required: DataProtectionEdit' operationId: VerifyOrphanEntity parameters: - name: entityId in: path description: Orhan Entity 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. Orhan Entity verified content: application/json: schema: $ref: '#/components/schemas/VerificationOrphanEntityDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Orhan entity 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 servers: - url: /dataprotectioncommand /api/orphanentity/verifyAll: put: tags: - OrphanEntity summary: Verify orphan entities description: 'Triggers orphan entity verification process. Removes entity from orphanes if entity is no longer in scope for orphan conditions. Required permissions: Following permissions are required: DataProtectionEdit' operationId: VerifyAllOrphanEnties 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: '202': description: Accepted '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '200': description: Success. Removed orphan entities are returned '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Orhan entity 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 '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/orphanentity: post: tags: - OrphanEntity summary: Get all orphan entities description: 'Returns all existing orphan entities. Required permissions: At least one of the following permissions is required: DataProtectionAccess, DataProtectionDashboardAccess' operationId: GetAllOrphanEntities 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: Orphan entity request DTO content: application/json: schema: allOf: - $ref: '#/components/schemas/GetAllOrphanEntitiesRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. The list of orphan entities is returned content: application/json: schema: $ref: '#/components/schemas/GetAllOrphanEntitiesResponseDtoServiceResponse' '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: /dataprotectionquery /api/orphanentity/{id}: get: tags: - OrphanEntity summary: Get orphan entity by id description: 'Returns orphan entity. Required permissions: Following permissions are required: DataProtectionAccess' operationId: GetOrphanEntityById parameters: - name: id in: path description: Orphan entity 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. Orphan entity is returned content: application/json: schema: $ref: '#/components/schemas/OrphanEntityDtoServiceResponse' '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: /dataprotectionquery components: schemas: 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 BulkUpdateOrphanEntityDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/BulkUpdateOrphanEntityDto' description: The service request DTO additionalProperties: false description: Service request data OrphanEntityDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/OrphanEntityDto' description: The service request DTO additionalProperties: false description: Service request data UpdateOrphanEntityDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateOrphanEntityDto' description: The service request DTO additionalProperties: false description: Service request data ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' 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 example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code VerificationOrphanEntityDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/VerificationOrphanEntityDto' 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 BulkUpdateOrphanEntityDto: type: object properties: ids: type: - array - 'null' items: type: string format: uuid action: type: - string - 'null' additionalProperties: false ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' description: Name of the property example: data errorMessage: type: - string - 'null' description: User friendly error message example: Data is required attemptedValue: description: Invalid value errorCode: type: - string - 'null' description: Internal error code example: NotNullValidator additionalProperties: false description: Represents the details of validation error 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 OrphanEntityDto: type: object properties: entityCheckVersion: type: integer format: int32 entityCheckConfigurationId: type: string format: uuid type: type: - string - 'null' action: type: - string - 'null' additionalProperties: false VerificationOrphanEntityDto: type: object properties: isOrphanEntity: type: boolean additionalProperties: false UpdateOrphanEntityDto: type: object properties: action: type: - string - 'null' additionalProperties: false 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 SortOrder: enum: - 0 - 1 type: integer description: Sort Order (Ascending or Descending) format: int32 ActionDetailsDto: type: object properties: actionType: type: - string - 'null' actionedBy: type: - string - 'null' actionedDate: type: string format: date-time additionalProperties: false OrphanEntityDto_2: type: object properties: id: type: string format: uuid entityCheckVersion: type: integer format: int32 entityCheckConfigurationId: type: string format: uuid type: type: - string - 'null' action: allOf: - $ref: '#/components/schemas/ActionDetailsDto' createdAt: type: string format: date-time createdBySystem: type: boolean additionalProperties: false GetAllOrphanEntitiesRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/GetAllOrphanEntitiesRequestDto' description: The service request DTO additionalProperties: false description: Service request data GetAllOrphanEntitiesRequestDto: type: object properties: actionsGroup: type: - string - 'null' pager: allOf: - $ref: '#/components/schemas/PageOptions' description: Options for setting up the results page additionalProperties: false GetAllOrphanEntitiesResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/GetAllOrphanEntitiesResponseDto' 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 GetAllOrphanEntitiesResponseDto: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/OrphanEntityDto_2' paginationToken: type: - string - 'null' additionalProperties: false OrphanEntityDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/OrphanEntityDto_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 PageOptions: type: object properties: paginationToken: type: - string - 'null' description: 'Position token for the search results to start (leave empty to start from the 1st item)' pageSize: type: integer description: Size of the page (result set) format: int32 example: 10 sortOrder: allOf: - $ref: '#/components/schemas/SortOrder' description: Sort Order (Ascending or Descending) additionalProperties: false description: Options for setting up the results page 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