openapi: 3.1.0 info: title: Oracle GoldenGate Veridata REST API description: >- REST API for Oracle GoldenGate Veridata, a data comparison and repair solution that verifies data consistency between source and target databases. Provides operations for managing connections, compare groups, compare pairs, jobs, profiles, monitoring comparison results, and repairing out-of-sync data. Based on Oracle GoldenGate Veridata 23c REST API documentation. version: '1.0' contact: name: Oracle Support url: https://support.oracle.com license: name: Oracle Technology Network License url: https://www.oracle.com/legal/terms.html x-documentation: - url: https://docs.oracle.com/en/middleware/goldengate/veridata/23/ggvra/rest-endpoints.html description: Oracle GoldenGate Veridata REST API Reference servers: - url: https://{veridata-host}:{port}/veridata/v1 description: Oracle GoldenGate Veridata server variables: veridata-host: default: localhost description: Veridata server host port: default: '8830' description: Veridata HTTPS port security: - basicAuth: [] tags: - name: Compare Pairs description: Manage compare pairs within groups - name: Connections description: Manage source and target database connections - name: Execution description: Run and stop comparison jobs - name: Groups description: Manage compare groups - name: Import/Export description: Import and export Veridata configurations - name: Jobs description: Manage and execute comparison jobs - name: Logs description: Access server logs - name: Monitoring description: Monitor comparison and repair statistics - name: Profiles description: Manage comparison profiles - name: Repair description: Repair out-of-sync data - name: Server description: Server information and configuration - name: Users description: User and user group management - name: Validation description: Validate connections and configurations paths: /services/server/info: get: operationId: getServerInfo summary: Oracle Goldengate Retrieve Server Details description: Returns server information including version, uptime, and system details. tags: - Server responses: '200': description: Server information retrieved content: application/json: schema: $ref: '#/components/schemas/ServerInfo' examples: Getserverinfo200Example: summary: Default getServerInfo 200 response x-microcks-default: true value: version: example_value buildNumber: example_value uptime: example_value javaVersion: example_value '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/server/configuration: get: operationId: getServerConfiguration summary: Oracle Goldengate Retrieve Server Configurations description: Returns the current server configuration settings. tags: - Server responses: '200': description: Configuration retrieved content: application/json: schema: $ref: '#/components/schemas/ServerConfiguration' examples: Getserverconfiguration200Example: summary: Default getServerConfiguration 200 response x-microcks-default: true value: maxConcurrentJobs: 10 maxThreadsPerJob: 10 reportRetentionDays: 10 oosRetentionDays: 10 '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updateServerConfiguration summary: Oracle Goldengate Update Server Configurations description: Updates server configuration settings. tags: - Server requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateServerConfigurationRequest' examples: UpdateserverconfigurationRequestExample: summary: Default updateServerConfiguration request x-microcks-default: true value: maxConcurrentJobs: 10 maxThreadsPerJob: 10 reportRetentionDays: 10 responses: '200': description: Configuration updated content: application/json: schema: $ref: '#/components/schemas/ServerConfiguration' examples: Updateserverconfiguration200Example: summary: Default updateServerConfiguration 200 response x-microcks-default: true value: maxConcurrentJobs: 10 maxThreadsPerJob: 10 reportRetentionDays: 10 oosRetentionDays: 10 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/server/configuration/reset: put: operationId: resetServerConfiguration summary: Oracle Goldengate Reset Server Configurations to Default description: Resets all server configuration settings to their factory default values. tags: - Server responses: '200': description: Configuration reset to defaults content: application/json: schema: $ref: '#/components/schemas/ServerConfiguration' examples: Resetserverconfiguration200Example: summary: Default resetServerConfiguration 200 response x-microcks-default: true value: maxConcurrentJobs: 10 maxThreadsPerJob: 10 reportRetentionDays: 10 oosRetentionDays: 10 '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/connections: get: operationId: listConnections summary: Oracle Goldengate Retrieve All Connections description: Returns a list of all configured source and target database connections. tags: - Connections responses: '200': description: Connections listed content: application/json: schema: $ref: '#/components/schemas/ConnectionList' examples: Listconnections200Example: summary: Default listConnections 200 response x-microcks-default: true value: connections: - id: abc123 name: Example Title description: A sample description. databaseType: Oracle host: example_value port: 10 serviceName: example_value schema: example_value agentHost: example_value agentPort: 10 '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createConnection summary: Oracle Goldengate Create a Connection description: Creates a new database connection for use as a source or target in comparisons. tags: - Connections requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateConnectionRequest' examples: CreateconnectionRequestExample: summary: Default createConnection request x-microcks-default: true value: name: Example Title description: A sample description. databaseType: example_value host: example_value port: 10 serviceName: example_value schema: example_value username: example_value password: example_value agentHost: example_value agentPort: 10 responses: '201': description: Connection created content: application/json: schema: $ref: '#/components/schemas/Connection' examples: Createconnection201Example: summary: Default createConnection 201 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. databaseType: Oracle host: example_value port: 10 serviceName: example_value schema: example_value agentHost: example_value agentPort: 10 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/connections/{Id}: get: operationId: getConnection summary: Oracle Goldengate Retrieve a Connection description: Returns the details of a specific database connection. tags: - Connections parameters: - $ref: '#/components/parameters/connectionIdParam' responses: '200': description: Connection retrieved content: application/json: schema: $ref: '#/components/schemas/Connection' examples: Getconnection200Example: summary: Default getConnection 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. databaseType: Oracle host: example_value port: 10 serviceName: example_value schema: example_value agentHost: example_value agentPort: 10 '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updateConnection summary: Oracle Goldengate Update a Connection description: Updates properties of an existing database connection. tags: - Connections parameters: - $ref: '#/components/parameters/connectionIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateConnectionRequest' examples: UpdateconnectionRequestExample: summary: Default updateConnection request x-microcks-default: true value: name: Example Title description: A sample description. host: example_value port: 10 username: example_value password: example_value responses: '200': description: Connection updated content: application/json: schema: $ref: '#/components/schemas/Connection' examples: Updateconnection200Example: summary: Default updateConnection 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. databaseType: Oracle host: example_value port: 10 serviceName: example_value schema: example_value agentHost: example_value agentPort: 10 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteConnection summary: Oracle Goldengate Delete a Connection description: Deletes a database connection. tags: - Connections parameters: - $ref: '#/components/parameters/connectionIdParam' responses: '204': description: Connection deleted '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/connections/{Id}/status: get: operationId: getConnectionStatus summary: Oracle Goldengate Retrieve Connection Status description: Returns the connectivity status of a database connection. tags: - Connections parameters: - $ref: '#/components/parameters/connectionIdParam' responses: '200': description: Connection status retrieved content: application/json: schema: $ref: '#/components/schemas/ConnectionStatus' examples: Getconnectionstatus200Example: summary: Default getConnectionStatus 200 response x-microcks-default: true value: connectionId: '500123' status: connected message: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/connections/{Id}/metadata: post: operationId: getConnectionMetadata summary: Oracle Goldengate Retrieve Connection Metadata description: Returns database metadata (schemas, tables, columns) for a connection. tags: - Connections parameters: - $ref: '#/components/parameters/connectionIdParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/MetadataRequest' examples: GetconnectionmetadataRequestExample: summary: Default getConnectionMetadata request x-microcks-default: true value: schemaPattern: example_value tablePattern: example_value responses: '200': description: Metadata retrieved content: application/json: schema: $ref: '#/components/schemas/ConnectionMetadata' examples: Getconnectionmetadata200Example: summary: Default getConnectionMetadata 200 response x-microcks-default: true value: schemas: - name: Example Title tables: - {} '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/groups: get: operationId: listGroups summary: Oracle Goldengate Retrieve All Compare Groups description: Returns a list of all compare groups configured in Veridata. tags: - Groups responses: '200': description: Groups listed content: application/json: schema: $ref: '#/components/schemas/GroupList' examples: Listgroups200Example: summary: Default listGroups 200 response x-microcks-default: true value: groups: - id: abc123 name: Example Title description: A sample description. sourceConnectionId: '500123' targetConnectionId: '500123' profileId: '500123' comparePairCount: 10 '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createGroup summary: Oracle Goldengate Create a Compare Group description: Creates a new compare group linking source and target connections for data comparison. tags: - Groups requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateGroupRequest' examples: CreategroupRequestExample: summary: Default createGroup request x-microcks-default: true value: name: Example Title description: A sample description. sourceConnectionId: '500123' targetConnectionId: '500123' profileId: '500123' responses: '201': description: Group created content: application/json: schema: $ref: '#/components/schemas/Group' examples: Creategroup201Example: summary: Default createGroup 201 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. sourceConnectionId: '500123' targetConnectionId: '500123' profileId: '500123' comparePairCount: 10 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/groups/{Id}: get: operationId: getGroup summary: Oracle Goldengate Retrieve a Compare Group description: Returns the details of a specific compare group including its source and target connections. tags: - Groups parameters: - $ref: '#/components/parameters/groupIdParam' responses: '200': description: Group retrieved content: application/json: schema: $ref: '#/components/schemas/Group' examples: Getgroup200Example: summary: Default getGroup 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. sourceConnectionId: '500123' targetConnectionId: '500123' profileId: '500123' comparePairCount: 10 '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updateGroup summary: Oracle Goldengate Update a Compare Group description: Updates properties of an existing compare group. tags: - Groups parameters: - $ref: '#/components/parameters/groupIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateGroupRequest' examples: UpdategroupRequestExample: summary: Default updateGroup request x-microcks-default: true value: name: Example Title description: A sample description. profileId: '500123' responses: '200': description: Group updated content: application/json: schema: $ref: '#/components/schemas/Group' examples: Updategroup200Example: summary: Default updateGroup 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. sourceConnectionId: '500123' targetConnectionId: '500123' profileId: '500123' comparePairCount: 10 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteGroup summary: Oracle Goldengate Delete a Compare Group description: Deletes a compare group and its associated compare pairs. tags: - Groups parameters: - $ref: '#/components/parameters/groupIdParam' responses: '204': description: Group deleted '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/groups/clone/{Id}: post: operationId: cloneGroup summary: Oracle Goldengate Clone a Compare Group description: Creates a copy of an existing compare group including all its compare pairs. tags: - Groups parameters: - $ref: '#/components/parameters/groupIdParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneGroupRequest' examples: ClonegroupRequestExample: summary: Default cloneGroup request x-microcks-default: true value: newName: example_value responses: '201': description: Group cloned content: application/json: schema: $ref: '#/components/schemas/Group' examples: Clonegroup201Example: summary: Default cloneGroup 201 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. sourceConnectionId: '500123' targetConnectionId: '500123' profileId: '500123' comparePairCount: 10 '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/groups/validate/{Id}: post: operationId: validateGroup summary: Oracle Goldengate Validate a Compare Group description: Validates the configuration of a compare group including connection and table accessibility. tags: - Validation parameters: - $ref: '#/components/parameters/groupIdParam' responses: '200': description: Validation result content: application/json: schema: $ref: '#/components/schemas/ValidationResult' examples: Validategroup200Example: summary: Default validateGroup 200 response x-microcks-default: true value: valid: '500123' messages: - severity: example_value message: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/cps/group/{groupId}: post: operationId: createComparePairs summary: Oracle Goldengate Create Compare Pairs in a Group description: Creates one or more compare pairs within a specific compare group. tags: - Compare Pairs parameters: - $ref: '#/components/parameters/groupIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateComparePairsRequest' examples: CreatecomparepairsRequestExample: summary: Default createComparePairs request x-microcks-default: true value: comparePairs: - sourceSchema: example_value sourceTable: example_value targetSchema: example_value targetTable: example_value responses: '201': description: Compare pairs created content: application/json: schema: $ref: '#/components/schemas/ComparePairList' examples: Createcomparepairs201Example: summary: Default createComparePairs 201 response x-microcks-default: true value: comparePairs: - id: abc123 groupId: '500123' sourceSchema: example_value sourceTable: example_value targetSchema: example_value targetTable: example_value profileId: '500123' columnMappings: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/cps/{Id}: get: operationId: getComparePair summary: Oracle Goldengate Retrieve a Compare Pair description: Returns the details of a specific compare pair including source and target table mappings. tags: - Compare Pairs parameters: - $ref: '#/components/parameters/comparePairIdParam' responses: '200': description: Compare pair retrieved content: application/json: schema: $ref: '#/components/schemas/ComparePair' examples: Getcomparepair200Example: summary: Default getComparePair 200 response x-microcks-default: true value: id: abc123 groupId: '500123' sourceSchema: example_value sourceTable: example_value targetSchema: example_value targetTable: example_value profileId: '500123' columnMappings: - sourceColumn: example_value targetColumn: example_value dataType: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: replaceComparePair summary: Oracle Goldengate Replace a Compare Pair description: Replaces the configuration of an existing compare pair. tags: - Compare Pairs parameters: - $ref: '#/components/parameters/comparePairIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReplaceComparePairRequest' examples: ReplacecomparepairRequestExample: summary: Default replaceComparePair request x-microcks-default: true value: sourceSchema: example_value sourceTable: example_value targetSchema: example_value targetTable: example_value profileId: '500123' responses: '200': description: Compare pair replaced content: application/json: schema: $ref: '#/components/schemas/ComparePair' examples: Replacecomparepair200Example: summary: Default replaceComparePair 200 response x-microcks-default: true value: id: abc123 groupId: '500123' sourceSchema: example_value sourceTable: example_value targetSchema: example_value targetTable: example_value profileId: '500123' columnMappings: - sourceColumn: example_value targetColumn: example_value dataType: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteComparePair summary: Oracle Goldengate Delete a Compare Pair description: Deletes a compare pair from its group. tags: - Compare Pairs parameters: - $ref: '#/components/parameters/comparePairIdParam' responses: '204': description: Compare pair deleted '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/cps/{Id}/colmap: post: operationId: generateColumnMappings summary: Oracle Goldengate Generate Column Mapping Pairs description: Automatically generates column mappings between source and target tables for a compare pair. tags: - Compare Pairs parameters: - $ref: '#/components/parameters/comparePairIdParam' responses: '200': description: Column mappings generated content: application/json: schema: $ref: '#/components/schemas/ColumnMappingList' examples: Generatecolumnmappings200Example: summary: Default generateColumnMappings 200 response x-microcks-default: true value: mappings: - sourceColumn: example_value targetColumn: example_value dataType: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/cps/validate/{Id}: post: operationId: validateComparePair summary: Oracle Goldengate Validate a Compare Pair description: Validates the configuration of a compare pair including table and column accessibility. tags: - Validation parameters: - $ref: '#/components/parameters/comparePairIdParam' responses: '200': description: Validation result content: application/json: schema: $ref: '#/components/schemas/ValidationResult' examples: Validatecomparepair200Example: summary: Default validateComparePair 200 response x-microcks-default: true value: valid: '500123' messages: - severity: example_value message: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/cps/mappings: post: operationId: generateMappingObjects summary: Oracle Goldengate Generate Mapping Objects From Rules description: Generates compare pair mappings based on mapping rules for automatic pair creation. tags: - Compare Pairs requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MappingRulesRequest' examples: GeneratemappingobjectsRequestExample: summary: Default generateMappingObjects request x-microcks-default: true value: sourceSchemaPattern: example_value targetSchemaPattern: example_value tablePattern: example_value responses: '200': description: Mapping objects generated content: application/json: schema: $ref: '#/components/schemas/MappingObjectList' examples: Generatemappingobjects200Example: summary: Default generateMappingObjects 200 response x-microcks-default: true value: mappings: - sourceSchema: example_value sourceTable: example_value targetSchema: example_value targetTable: example_value '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/jobs: get: operationId: listJobs summary: Oracle Goldengate Retrieve All Jobs description: Returns a list of all comparison jobs configured in Veridata. tags: - Jobs responses: '200': description: Jobs listed content: application/json: schema: $ref: '#/components/schemas/JobList' examples: Listjobs200Example: summary: Default listJobs 200 response x-microcks-default: true value: jobs: - id: abc123 name: Example Title description: A sample description. groupIds: {} profileId: '500123' status: idle '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createJob summary: Oracle Goldengate Create a Job description: >- Creates a new comparison job that references one or more compare groups. Jobs control the execution of data comparisons. tags: - Jobs requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateJobRequest' examples: CreatejobRequestExample: summary: Default createJob request x-microcks-default: true value: name: Example Title description: A sample description. groupIds: - 10 profileId: '500123' responses: '201': description: Job created content: application/json: schema: $ref: '#/components/schemas/Job' examples: Createjob201Example: summary: Default createJob 201 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. groupIds: - 10 profileId: '500123' status: idle '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/jobs/{Id}: get: operationId: getJob summary: Oracle Goldengate Retrieve a Job description: Returns the details of a specific comparison job. tags: - Jobs parameters: - $ref: '#/components/parameters/jobIdParam' responses: '200': description: Job retrieved content: application/json: schema: $ref: '#/components/schemas/Job' examples: Getjob200Example: summary: Default getJob 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. groupIds: - 10 profileId: '500123' status: idle '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: replaceJob summary: Oracle Goldengate Replace a Job description: Replaces the configuration of an existing comparison job. tags: - Jobs parameters: - $ref: '#/components/parameters/jobIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReplaceJobRequest' examples: ReplacejobRequestExample: summary: Default replaceJob request x-microcks-default: true value: name: Example Title description: A sample description. groupIds: - 10 profileId: '500123' responses: '200': description: Job replaced content: application/json: schema: $ref: '#/components/schemas/Job' examples: Replacejob200Example: summary: Default replaceJob 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. groupIds: - 10 profileId: '500123' status: idle '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteJob summary: Oracle Goldengate Delete a Job description: Deletes a comparison job. tags: - Jobs parameters: - $ref: '#/components/parameters/jobIdParam' responses: '204': description: Job deleted '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/profiles: get: operationId: listProfiles summary: Oracle Goldengate Retrieve All Profiles description: Returns a list of all comparison profiles that define comparison behavior settings. tags: - Profiles responses: '200': description: Profiles listed content: application/json: schema: $ref: '#/components/schemas/ProfileList' examples: Listprofiles200Example: summary: Default listProfiles 200 response x-microcks-default: true value: profiles: - id: abc123 name: Example Title description: A sample description. comparisonMethod: row maxConcurrentComparePairs: 10 deltaProcessing: true reportOutOfSync: true '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createProfile summary: Oracle Goldengate Create a Profile description: Creates a new comparison profile with custom comparison settings. tags: - Profiles requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateProfileRequest' examples: CreateprofileRequestExample: summary: Default createProfile request x-microcks-default: true value: name: Example Title description: A sample description. comparisonMethod: row maxConcurrentComparePairs: 10 deltaProcessing: true responses: '201': description: Profile created content: application/json: schema: $ref: '#/components/schemas/Profile' examples: Createprofile201Example: summary: Default createProfile 201 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. comparisonMethod: row maxConcurrentComparePairs: 10 deltaProcessing: true reportOutOfSync: true '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/profiles/{Id}: get: operationId: getProfile summary: Oracle Goldengate Retrieve a Profile description: Returns the details of a specific comparison profile. tags: - Profiles parameters: - $ref: '#/components/parameters/profileIdParam' responses: '200': description: Profile retrieved content: application/json: schema: $ref: '#/components/schemas/Profile' examples: Getprofile200Example: summary: Default getProfile 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. comparisonMethod: row maxConcurrentComparePairs: 10 deltaProcessing: true reportOutOfSync: true '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updateProfile summary: Oracle Goldengate Update a Profile description: Updates properties of an existing comparison profile. tags: - Profiles parameters: - $ref: '#/components/parameters/profileIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateProfileRequest' examples: UpdateprofileRequestExample: summary: Default updateProfile request x-microcks-default: true value: name: Example Title description: A sample description. comparisonMethod: example_value maxConcurrentComparePairs: 10 responses: '200': description: Profile updated content: application/json: schema: $ref: '#/components/schemas/Profile' examples: Updateprofile200Example: summary: Default updateProfile 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. comparisonMethod: row maxConcurrentComparePairs: 10 deltaProcessing: true reportOutOfSync: true '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteProfile summary: Oracle Goldengate Delete a Profile description: Deletes a comparison profile. tags: - Profiles parameters: - $ref: '#/components/parameters/profileIdParam' responses: '204': description: Profile deleted '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/profiles/{Id}/reset: put: operationId: resetProfile summary: Oracle Goldengate Reset a Profile to Defaults description: Resets a comparison profile to its default settings. tags: - Profiles parameters: - $ref: '#/components/parameters/profileIdParam' responses: '200': description: Profile reset content: application/json: schema: $ref: '#/components/schemas/Profile' examples: Resetprofile200Example: summary: Default resetProfile 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. comparisonMethod: row maxConcurrentComparePairs: 10 deltaProcessing: true reportOutOfSync: true '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/execution/jobs/{Id}: post: operationId: runJob summary: Oracle Goldengate Run a Comparison Job description: Starts execution of a comparison job to compare data between source and target databases. tags: - Execution parameters: - $ref: '#/components/parameters/jobIdParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/RunJobRequest' examples: RunjobRequestExample: summary: Default runJob request x-microcks-default: true value: profileOverrides: example_value responses: '200': description: Job started content: application/json: schema: $ref: '#/components/schemas/JobExecution' examples: Runjob200Example: summary: Default runJob 200 response x-microcks-default: true value: runId: '500123' jobId: '500123' status: running startTime: '2026-01-15T10:30:00Z' endTime: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/execution/jobs/{runId}/stop: post: operationId: stopJob summary: Oracle Goldengate Stop a Running Job description: Stops a currently running comparison job or specific compare pairs within it. tags: - Execution parameters: - $ref: '#/components/parameters/runIdParam' responses: '200': description: Job stopped content: application/json: schema: $ref: '#/components/schemas/JobExecution' examples: Stopjob200Example: summary: Default stopJob 200 response x-microcks-default: true value: runId: '500123' jobId: '500123' status: running startTime: '2026-01-15T10:30:00Z' endTime: '2026-01-15T10:30:00Z' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/monitoring/jobs: get: operationId: getJobStatistics summary: Oracle Goldengate Retrieve Job Statistics description: Returns comparison statistics for completed and running jobs. tags: - Monitoring responses: '200': description: Job statistics retrieved content: application/json: schema: $ref: '#/components/schemas/JobStatisticsList' examples: Getjobstatistics200Example: summary: Default getJobStatistics 200 response x-microcks-default: true value: statistics: - runId: '500123' jobName: example_value status: example_value startTime: '2026-01-15T10:30:00Z' endTime: '2026-01-15T10:30:00Z' totalComparePairs: 10 inSyncCount: 10 outOfSyncCount: 10 failedCount: 10 '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/monitoring/cps: get: operationId: getComparePairStatistics summary: Oracle Goldengate Retrieve Compare Pair Statistics description: Returns detailed comparison statistics at the compare pair level. tags: - Monitoring responses: '200': description: Compare pair statistics retrieved content: application/json: schema: $ref: '#/components/schemas/ComparePairStatisticsList' examples: Getcomparepairstatistics200Example: summary: Default getComparePairStatistics 200 response x-microcks-default: true value: statistics: - comparePairId: '500123' sourceTable: example_value targetTable: example_value status: In Sync sourceRowCount: 10 targetRowCount: 10 outOfSyncRows: 10 '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/oos/{runId}: get: operationId: getOutOfSyncData summary: Oracle Goldengate Retrieve Out-of-sync Data description: Returns the rows identified as out-of-sync during a comparison run. tags: - Monitoring parameters: - $ref: '#/components/parameters/runIdParam' responses: '200': description: Out-of-sync data retrieved content: application/json: schema: $ref: '#/components/schemas/OutOfSyncData' examples: Getoutofsyncdata200Example: summary: Default getOutOfSyncData 200 response x-microcks-default: true value: runId: '500123' rows: - comparePairId: '500123' sourceTable: example_value targetTable: example_value oosType: missing_in_target keyValues: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/monitoring/comparison/{runId}/reports: get: operationId: getComparisonReport summary: Oracle Goldengate Retrieve Comparison Report description: Returns a detailed comparison report for a specific job run. tags: - Monitoring parameters: - $ref: '#/components/parameters/runIdParam' responses: '200': description: Report retrieved content: application/json: schema: $ref: '#/components/schemas/ComparisonReport' examples: Getcomparisonreport200Example: summary: Default getComparisonReport 200 response x-microcks-default: true value: runId: '500123' jobName: example_value startTime: '2026-01-15T10:30:00Z' endTime: '2026-01-15T10:30:00Z' summary: totalComparePairs: 10 inSync: 10 outOfSync: 10 failed: 10 details: - sourceTable: example_value targetTable: example_value status: example_value sourceRowCount: 10 targetRowCount: 10 '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/repair/jobs/{runId}: post: operationId: repairJob summary: Oracle Goldengate Repair Out-of-sync Data description: Initiates a repair operation to synchronize out-of-sync rows found during a comparison. tags: - Repair parameters: - $ref: '#/components/parameters/runIdParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/RepairJobRequest' examples: RepairjobRequestExample: summary: Default repairJob request x-microcks-default: true value: repairMode: insert responses: '200': description: Repair initiated content: application/json: schema: $ref: '#/components/schemas/RepairExecution' examples: Repairjob200Example: summary: Default repairJob 200 response x-microcks-default: true value: runId: '500123' status: running startTime: '2026-01-15T10:30:00Z' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/repair/jobs/{runId}/stop: post: operationId: stopRepairJob summary: Oracle Goldengate Stop a Repair Job description: Stops a currently running repair operation. tags: - Repair parameters: - $ref: '#/components/parameters/runIdParam' responses: '200': description: Repair stopped '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/monitoring/repair/jobs: get: operationId: getRepairStatistics summary: Oracle Goldengate Retrieve Repair Statistics description: Returns statistics for repair operations. tags: - Repair responses: '200': description: Repair statistics retrieved content: application/json: schema: $ref: '#/components/schemas/RepairStatisticsList' examples: Getrepairstatistics200Example: summary: Default getRepairStatistics 200 response x-microcks-default: true value: statistics: - runId: '500123' status: example_value rowsRepaired: 10 rowsFailed: 10 '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/monitoring/repair/cps/{runId}: get: operationId: getRepairedRowDetails summary: Oracle Goldengate Retrieve Repaired Row Details description: Returns detailed information about rows that were repaired during a repair operation. tags: - Repair parameters: - $ref: '#/components/parameters/runIdParam' responses: '200': description: Repair details retrieved content: application/json: schema: $ref: '#/components/schemas/RepairedRowDetails' examples: Getrepairedrowdetails200Example: summary: Default getRepairedRowDetails 200 response x-microcks-default: true value: runId: '500123' rows: - table: example_value repairType: example_value status: example_value keyValues: example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/monitoring/repair/{runId}/reports: get: operationId: getRepairReport summary: Oracle Goldengate Retrieve Repair Report description: Returns a detailed repair report for a specific repair run. tags: - Repair parameters: - $ref: '#/components/parameters/runIdParam' responses: '200': description: Repair report retrieved content: application/json: schema: $ref: '#/components/schemas/RepairReport' examples: Getrepairreport200Example: summary: Default getRepairReport 200 response x-microcks-default: true value: runId: '500123' startTime: '2026-01-15T10:30:00Z' endTime: '2026-01-15T10:30:00Z' totalRows: 10 repairedRows: 10 failedRows: 10 '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/export: get: operationId: exportConfiguration summary: Oracle Goldengate Export Veridata Configurations description: Exports all Veridata configurations (connections, groups, jobs, profiles) as an XML document. tags: - Import/Export responses: '200': description: Configuration exported content: application/xml: schema: type: string examples: Exportconfiguration200Example: summary: Default exportConfiguration 200 response x-microcks-default: true value: example_value '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/import: post: operationId: importConfiguration summary: Oracle Goldengate Import Veridata Xml Configuration description: Imports Veridata configurations from an XML document. tags: - Import/Export requestBody: required: true content: application/xml: schema: type: string examples: ImportconfigurationRequestExample: summary: Default importConfiguration request x-microcks-default: true value: example_value responses: '200': description: Configuration imported content: application/json: schema: $ref: '#/components/schemas/ImportResult' examples: Importconfiguration200Example: summary: Default importConfiguration 200 response x-microcks-default: true value: success: true itemsImported: 10 messages: - example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/configuration/vgpp: post: operationId: importGoldenGateParameterFile summary: Oracle Goldengate Import Goldengate Parameter File description: Imports a GoldenGate parameter file to automatically create compare pairs from table mappings. tags: - Import/Export requestBody: required: true content: text/plain: schema: type: string examples: ImportgoldengateparameterfileRequestExample: summary: Default importGoldenGateParameterFile request x-microcks-default: true value: example_value responses: '200': description: Parameter file imported content: application/json: schema: $ref: '#/components/schemas/ImportResult' examples: Importgoldengateparameterfile200Example: summary: Default importGoldenGateParameterFile 200 response x-microcks-default: true value: success: true itemsImported: 10 messages: - example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/admin/users: get: operationId: listUsers summary: Oracle Goldengate Retrieve All Users description: Returns a list of all Veridata users. tags: - Users responses: '200': description: Users listed content: application/json: schema: $ref: '#/components/schemas/UserList' examples: Listusers200Example: summary: Default listUsers 200 response x-microcks-default: true value: users: - id: abc123 username: example_value firstName: example_value lastName: example_value email: user@example.com role: example_value userGroupId: '500123' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createUser summary: Oracle Goldengate Create a User description: Creates a new Veridata user account. tags: - Users requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateUserRequest' examples: CreateuserRequestExample: summary: Default createUser request x-microcks-default: true value: username: example_value password: example_value firstName: example_value lastName: example_value email: user@example.com role: example_value userGroupId: '500123' responses: '201': description: User created content: application/json: schema: $ref: '#/components/schemas/User' examples: Createuser201Example: summary: Default createUser 201 response x-microcks-default: true value: id: abc123 username: example_value firstName: example_value lastName: example_value email: user@example.com role: example_value userGroupId: '500123' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/admin/users/{Id}: get: operationId: getUser summary: Oracle Goldengate Retrieve a User description: Returns the details of a specific user. tags: - Users parameters: - $ref: '#/components/parameters/userIdParam' responses: '200': description: User retrieved content: application/json: schema: $ref: '#/components/schemas/User' examples: Getuser200Example: summary: Default getUser 200 response x-microcks-default: true value: id: abc123 username: example_value firstName: example_value lastName: example_value email: user@example.com role: example_value userGroupId: '500123' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: replaceUser summary: Oracle Goldengate Replace a User description: Replaces user account details. tags: - Users parameters: - $ref: '#/components/parameters/userIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReplaceUserRequest' examples: ReplaceuserRequestExample: summary: Default replaceUser request x-microcks-default: true value: firstName: example_value lastName: example_value email: user@example.com role: example_value userGroupId: '500123' responses: '200': description: User replaced content: application/json: schema: $ref: '#/components/schemas/User' examples: Replaceuser200Example: summary: Default replaceUser 200 response x-microcks-default: true value: id: abc123 username: example_value firstName: example_value lastName: example_value email: user@example.com role: example_value userGroupId: '500123' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteUser summary: Oracle Goldengate Delete a User description: Deletes a Veridata user account. tags: - Users parameters: - $ref: '#/components/parameters/userIdParam' responses: '204': description: User deleted '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/admin/usergroups: get: operationId: listUserGroups summary: Oracle Goldengate Retrieve All User Groups description: Returns a list of all user groups. tags: - Users responses: '200': description: User groups listed content: application/json: schema: $ref: '#/components/schemas/UserGroupList' examples: Listusergroups200Example: summary: Default listUserGroups 200 response x-microcks-default: true value: userGroups: - id: abc123 name: Example Title description: A sample description. permissions: {} '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createUserGroup summary: Oracle Goldengate Create a User Group description: Creates a new user group with specified permissions. tags: - Users requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateUserGroupRequest' examples: CreateusergroupRequestExample: summary: Default createUserGroup request x-microcks-default: true value: name: Example Title description: A sample description. permissions: - example_value responses: '201': description: User group created content: application/json: schema: $ref: '#/components/schemas/UserGroup' examples: Createusergroup201Example: summary: Default createUserGroup 201 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. permissions: - example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/admin/usergroups/{Id}: get: operationId: getUserGroup summary: Oracle Goldengate Retrieve a User Group description: Returns the details of a user group. tags: - Users parameters: - $ref: '#/components/parameters/userGroupIdParam' responses: '200': description: User group retrieved content: application/json: schema: $ref: '#/components/schemas/UserGroup' examples: Getusergroup200Example: summary: Default getUserGroup 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. permissions: - example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: replaceUserGroup summary: Oracle Goldengate Replace a User Group description: Replaces a user group configuration. tags: - Users parameters: - $ref: '#/components/parameters/userGroupIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReplaceUserGroupRequest' examples: ReplaceusergroupRequestExample: summary: Default replaceUserGroup request x-microcks-default: true value: name: Example Title description: A sample description. permissions: - example_value responses: '200': description: User group replaced content: application/json: schema: $ref: '#/components/schemas/UserGroup' examples: Replaceusergroup200Example: summary: Default replaceUserGroup 200 response x-microcks-default: true value: id: abc123 name: Example Title description: A sample description. permissions: - example_value '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteUserGroup summary: Oracle Goldengate Delete a User Group description: Deletes a user group. tags: - Users parameters: - $ref: '#/components/parameters/userGroupIdParam' responses: '204': description: User group deleted '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/logs/server: get: operationId: getServerLogs summary: Oracle Goldengate Retrieve Server Logs description: Returns server log entries. tags: - Logs parameters: - name: logType in: query schema: type: string enum: - api - perf - both example: api - name: logLevel in: query schema: type: string enum: - ERROR - WARNING - INFO - DEBUG example: ERROR - name: lastLines in: query schema: type: integer example: 10 responses: '200': description: Logs retrieved content: application/json: schema: $ref: '#/components/schemas/ServerLogs' examples: Getserverlogs200Example: summary: Default getServerLogs 200 response x-microcks-default: true value: entries: - timestamp: '2026-01-15T10:30:00Z' level: example_value message: example_value '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/validate/connection: post: operationId: validateAgentConnection summary: Oracle Goldengate Validate Agent Connection description: Tests connectivity to a Veridata agent. tags: - Validation requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ValidateConnectionRequest' examples: ValidateagentconnectionRequestExample: summary: Default validateAgentConnection request x-microcks-default: true value: host: example_value port: 10 responses: '200': description: Validation result content: application/json: schema: $ref: '#/components/schemas/ValidationResult' examples: Validateagentconnection200Example: summary: Default validateAgentConnection 200 response x-microcks-default: true value: valid: '500123' messages: - severity: example_value message: example_value '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/validate/connection/db: post: operationId: validateDatabaseConnection summary: Oracle Goldengate Validate Database Connection description: Tests database connectivity through a Veridata agent. tags: - Validation requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ValidateDatabaseRequest' examples: ValidatedatabaseconnectionRequestExample: summary: Default validateDatabaseConnection request x-microcks-default: true value: host: example_value port: 10 databaseType: example_value serviceName: example_value username: example_value password: example_value responses: '200': description: Validation result content: application/json: schema: $ref: '#/components/schemas/ValidationResult' examples: Validatedatabaseconnection200Example: summary: Default validateDatabaseConnection 200 response x-microcks-default: true value: valid: '500123' messages: - severity: example_value message: example_value '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/purge/stats: delete: operationId: purgeStatistics summary: Oracle Goldengate Purge Comparison Statistics description: Deletes stored comparison and repair statistics data. tags: - Monitoring responses: '204': description: Statistics purged '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /auth/login: get: operationId: login summary: Oracle Goldengate Login to Veridata description: Authenticates a user and establishes a session. tags: - Server security: [] parameters: - name: Authorization in: header required: true schema: type: string example: example_value responses: '200': description: Login successful content: application/json: schema: $ref: '#/components/schemas/LoginResponse' examples: Login200Example: summary: Default login 200 response x-microcks-default: true value: token: example_value sessionTimeout: 10 username: example_value '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /session/extend: get: operationId: extendSession summary: Oracle Goldengate Extend User Session description: Extends the current user session timeout. tags: - Server responses: '200': description: Session extended '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /session/invalidate: get: operationId: invalidateSession summary: Oracle Goldengate Invalidate Session (logout) description: Invalidates the current user session. tags: - Server responses: '200': description: Session invalidated '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: basicAuth: type: http scheme: basic description: HTTP Basic authentication with Veridata credentials parameters: connectionIdParam: name: Id in: path required: true description: Connection identifier schema: type: integer format: int64 groupIdParam: name: Id in: path required: true description: Compare group identifier schema: type: integer format: int64 groupIdPathParam: name: groupId in: path required: true description: Compare group identifier schema: type: integer format: int64 comparePairIdParam: name: Id in: path required: true description: Compare pair identifier schema: type: integer format: int64 jobIdParam: name: Id in: path required: true description: Job identifier schema: type: integer format: int64 profileIdParam: name: Id in: path required: true description: Profile identifier schema: type: integer format: int64 runIdParam: name: runId in: path required: true description: Job or repair run identifier schema: type: integer format: int64 userIdParam: name: Id in: path required: true description: User identifier schema: type: integer format: int64 userGroupIdParam: name: Id in: path required: true description: User group identifier schema: type: integer format: int64 responses: BadRequest: description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Authentication required content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: ErrorResponse: type: object properties: code: type: integer example: 10 message: type: string example: example_value ServerInfo: type: object properties: version: type: string example: example_value buildNumber: type: string example: example_value uptime: type: string example: example_value javaVersion: type: string example: example_value ServerConfiguration: type: object properties: maxConcurrentJobs: type: integer example: 10 maxThreadsPerJob: type: integer example: 10 reportRetentionDays: type: integer example: 10 oosRetentionDays: type: integer example: 10 UpdateServerConfigurationRequest: type: object properties: maxConcurrentJobs: type: integer example: 10 maxThreadsPerJob: type: integer example: 10 reportRetentionDays: type: integer example: 10 ConnectionList: type: object properties: connections: type: array items: $ref: '#/components/schemas/Connection' example: [] Connection: type: object properties: id: type: integer format: int64 example: abc123 name: type: string example: Example Title description: type: string example: A sample description. databaseType: type: string enum: - Oracle - MySQL - SQL Server - PostgreSQL - DB2 - Sybase - Teradata example: Oracle host: type: string example: example_value port: type: integer example: 10 serviceName: type: string example: example_value schema: type: string example: example_value agentHost: type: string example: example_value agentPort: type: integer example: 10 CreateConnectionRequest: type: object required: - name - databaseType - host - port properties: name: type: string example: Example Title description: type: string example: A sample description. databaseType: type: string example: example_value host: type: string example: example_value port: type: integer example: 10 serviceName: type: string example: example_value schema: type: string example: example_value username: type: string example: example_value password: type: string format: password example: example_value agentHost: type: string example: example_value agentPort: type: integer example: 10 UpdateConnectionRequest: type: object properties: name: type: string example: Example Title description: type: string example: A sample description. host: type: string example: example_value port: type: integer example: 10 username: type: string example: example_value password: type: string format: password example: example_value ConnectionStatus: type: object properties: connectionId: type: integer format: int64 example: '500123' status: type: string enum: - connected - disconnected - error example: connected message: type: string example: example_value MetadataRequest: type: object properties: schemaPattern: type: string example: example_value tablePattern: type: string example: example_value ConnectionMetadata: type: object properties: schemas: type: array items: type: object properties: name: type: string tables: type: array items: type: object properties: name: type: string columns: type: array items: type: object properties: name: type: string dataType: type: string nullable: type: boolean primaryKey: type: boolean example: [] GroupList: type: object properties: groups: type: array items: $ref: '#/components/schemas/Group' example: [] Group: type: object properties: id: type: integer format: int64 example: abc123 name: type: string example: Example Title description: type: string example: A sample description. sourceConnectionId: type: integer format: int64 example: '500123' targetConnectionId: type: integer format: int64 example: '500123' profileId: type: integer format: int64 example: '500123' comparePairCount: type: integer example: 10 CreateGroupRequest: type: object required: - name - sourceConnectionId - targetConnectionId properties: name: type: string example: Example Title description: type: string example: A sample description. sourceConnectionId: type: integer format: int64 example: '500123' targetConnectionId: type: integer format: int64 example: '500123' profileId: type: integer format: int64 example: '500123' UpdateGroupRequest: type: object properties: name: type: string example: Example Title description: type: string example: A sample description. profileId: type: integer format: int64 example: '500123' CloneGroupRequest: type: object properties: newName: type: string example: example_value ComparePairList: type: object properties: comparePairs: type: array items: $ref: '#/components/schemas/ComparePair' example: [] ComparePair: type: object properties: id: type: integer format: int64 example: abc123 groupId: type: integer format: int64 example: '500123' sourceSchema: type: string example: example_value sourceTable: type: string example: example_value targetSchema: type: string example: example_value targetTable: type: string example: example_value profileId: type: integer format: int64 example: '500123' columnMappings: type: array items: $ref: '#/components/schemas/ColumnMapping' example: [] CreateComparePairsRequest: type: object properties: comparePairs: type: array items: type: object required: - sourceSchema - sourceTable - targetSchema - targetTable properties: sourceSchema: type: string sourceTable: type: string targetSchema: type: string targetTable: type: string example: [] ReplaceComparePairRequest: type: object properties: sourceSchema: type: string example: example_value sourceTable: type: string example: example_value targetSchema: type: string example: example_value targetTable: type: string example: example_value profileId: type: integer format: int64 example: '500123' ColumnMapping: type: object properties: sourceColumn: type: string example: example_value targetColumn: type: string example: example_value dataType: type: string example: example_value ColumnMappingList: type: object properties: mappings: type: array items: $ref: '#/components/schemas/ColumnMapping' example: [] MappingRulesRequest: type: object properties: sourceSchemaPattern: type: string example: example_value targetSchemaPattern: type: string example: example_value tablePattern: type: string example: example_value MappingObjectList: type: object properties: mappings: type: array items: type: object properties: sourceSchema: type: string sourceTable: type: string targetSchema: type: string targetTable: type: string example: [] ValidationResult: type: object properties: valid: type: boolean example: '500123' messages: type: array items: type: object properties: severity: type: string message: type: string example: [] JobList: type: object properties: jobs: type: array items: $ref: '#/components/schemas/Job' example: [] Job: type: object properties: id: type: integer format: int64 example: abc123 name: type: string example: Example Title description: type: string example: A sample description. groupIds: type: array items: type: integer format: int64 example: [] profileId: type: integer format: int64 example: '500123' status: type: string enum: - idle - running - completed - failed example: idle CreateJobRequest: type: object required: - name - groupIds properties: name: type: string example: Example Title description: type: string example: A sample description. groupIds: type: array items: type: integer format: int64 example: [] profileId: type: integer format: int64 example: '500123' ReplaceJobRequest: type: object properties: name: type: string example: Example Title description: type: string example: A sample description. groupIds: type: array items: type: integer format: int64 example: [] profileId: type: integer format: int64 example: '500123' RunJobRequest: type: object properties: profileOverrides: type: object additionalProperties: true example: example_value JobExecution: type: object properties: runId: type: integer format: int64 example: '500123' jobId: type: integer format: int64 example: '500123' status: type: string enum: - running - completed - stopped - failed example: running startTime: type: string format: date-time example: '2026-01-15T10:30:00Z' endTime: type: string format: date-time example: '2026-01-15T10:30:00Z' ProfileList: type: object properties: profiles: type: array items: $ref: '#/components/schemas/Profile' example: [] Profile: type: object properties: id: type: integer format: int64 example: abc123 name: type: string example: Example Title description: type: string example: A sample description. comparisonMethod: type: string enum: - row - hash example: row maxConcurrentComparePairs: type: integer example: 10 deltaProcessing: type: boolean example: true reportOutOfSync: type: boolean example: true CreateProfileRequest: type: object required: - name properties: name: type: string example: Example Title description: type: string example: A sample description. comparisonMethod: type: string enum: - row - hash example: row maxConcurrentComparePairs: type: integer example: 10 deltaProcessing: type: boolean example: true UpdateProfileRequest: type: object properties: name: type: string example: Example Title description: type: string example: A sample description. comparisonMethod: type: string example: example_value maxConcurrentComparePairs: type: integer example: 10 JobStatisticsList: type: object properties: statistics: type: array items: type: object properties: runId: type: integer format: int64 jobName: type: string status: type: string startTime: type: string format: date-time endTime: type: string format: date-time totalComparePairs: type: integer inSyncCount: type: integer outOfSyncCount: type: integer failedCount: type: integer example: [] ComparePairStatisticsList: type: object properties: statistics: type: array items: type: object properties: comparePairId: type: integer format: int64 sourceTable: type: string targetTable: type: string status: type: string enum: - In Sync - Out Of Sync - Failed sourceRowCount: type: integer format: int64 targetRowCount: type: integer format: int64 outOfSyncRows: type: integer format: int64 example: [] OutOfSyncData: type: object properties: runId: type: integer format: int64 example: '500123' rows: type: array items: type: object properties: comparePairId: type: integer format: int64 sourceTable: type: string targetTable: type: string oosType: type: string enum: - missing_in_target - missing_in_source - different keyValues: type: object additionalProperties: true example: [] ComparisonReport: type: object properties: runId: type: integer format: int64 example: '500123' jobName: type: string example: example_value startTime: type: string format: date-time example: '2026-01-15T10:30:00Z' endTime: type: string format: date-time example: '2026-01-15T10:30:00Z' summary: type: object properties: totalComparePairs: type: integer inSync: type: integer outOfSync: type: integer failed: type: integer example: example_value details: type: array items: type: object properties: sourceTable: type: string targetTable: type: string status: type: string sourceRowCount: type: integer format: int64 targetRowCount: type: integer format: int64 example: [] RepairJobRequest: type: object properties: repairMode: type: string enum: - insert - update - delete - all example: insert RepairExecution: type: object properties: runId: type: integer format: int64 example: '500123' status: type: string enum: - running - completed - stopped - failed example: running startTime: type: string format: date-time example: '2026-01-15T10:30:00Z' RepairStatisticsList: type: object properties: statistics: type: array items: type: object properties: runId: type: integer format: int64 status: type: string rowsRepaired: type: integer format: int64 rowsFailed: type: integer format: int64 example: [] RepairedRowDetails: type: object properties: runId: type: integer format: int64 example: '500123' rows: type: array items: type: object properties: table: type: string repairType: type: string status: type: string keyValues: type: object additionalProperties: true example: [] RepairReport: type: object properties: runId: type: integer format: int64 example: '500123' startTime: type: string format: date-time example: '2026-01-15T10:30:00Z' endTime: type: string format: date-time example: '2026-01-15T10:30:00Z' totalRows: type: integer format: int64 example: 10 repairedRows: type: integer format: int64 example: 10 failedRows: type: integer format: int64 example: 10 ImportResult: type: object properties: success: type: boolean example: true itemsImported: type: integer example: 10 messages: type: array items: type: string example: [] UserList: type: object properties: users: type: array items: $ref: '#/components/schemas/User' example: [] User: type: object properties: id: type: integer format: int64 example: abc123 username: type: string example: example_value firstName: type: string example: example_value lastName: type: string example: example_value email: type: string example: user@example.com role: type: string example: example_value userGroupId: type: integer format: int64 example: '500123' CreateUserRequest: type: object required: - username - password properties: username: type: string example: example_value password: type: string format: password example: example_value firstName: type: string example: example_value lastName: type: string example: example_value email: type: string example: user@example.com role: type: string example: example_value userGroupId: type: integer format: int64 example: '500123' ReplaceUserRequest: type: object properties: firstName: type: string example: example_value lastName: type: string example: example_value email: type: string example: user@example.com role: type: string example: example_value userGroupId: type: integer format: int64 example: '500123' UserGroupList: type: object properties: userGroups: type: array items: $ref: '#/components/schemas/UserGroup' example: [] UserGroup: type: object properties: id: type: integer format: int64 example: abc123 name: type: string example: Example Title description: type: string example: A sample description. permissions: type: array items: type: string example: [] CreateUserGroupRequest: type: object required: - name properties: name: type: string example: Example Title description: type: string example: A sample description. permissions: type: array items: type: string example: [] ReplaceUserGroupRequest: type: object properties: name: type: string example: Example Title description: type: string example: A sample description. permissions: type: array items: type: string example: [] ServerLogs: type: object properties: entries: type: array items: type: object properties: timestamp: type: string format: date-time level: type: string message: type: string example: [] ValidateConnectionRequest: type: object required: - host - port properties: host: type: string example: example_value port: type: integer example: 10 ValidateDatabaseRequest: type: object required: - host - port - databaseType properties: host: type: string example: example_value port: type: integer example: 10 databaseType: type: string example: example_value serviceName: type: string example: example_value username: type: string example: example_value password: type: string format: password example: example_value LoginResponse: type: object properties: token: type: string example: example_value sessionTimeout: type: integer example: 10 username: type: string example: example_value