Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
API to fetch Veridata Server Version and patch details.
", "operationId":"GetVeridataServerDetails", "responses":{ "200":{ "description":"Ok.\n", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/VeridataServerDetails" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-server-info-get", "x-filename-id":"services-server-info-get" } }, "/services/server/configuration":{ "get":{ "tags":[ "Common/Retrieve Server Information" ], "summary":"Retrieve Server Configurations", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Retrieves Veridata Server configuration properties as key-value pairs.\n
", "operationId":"GetVeridataServerConfigurations", "security":[ ], "responses":{ "200":{ "description":"Server Configurations Retrieved Successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ServerParams" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Role not found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-server-configuration-get", "x-filename-id":"services-server-configuration-get" }, "patch":{ "tags":[ "Common/Retrieve Server Information" ], "summary":"Update Server Configurations", "description":"Required Role: Administrator
Update Veridata Server configuration properties using key-value pairs.\n
", "operationId":"UpdateServerConfigurations", "security":[ ], "requestBody":{ "required":true, "description":"A JSON object containing the configuration key-value pairs to be updated.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/VeridataServerConfigUpdateRequest" } } } }, "responses":{ "200":{ "description":"Updated Server Configurations Successfully", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "message":{ "type":"string", "example":"Configurations updated successfully" } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Role not found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-server-configuration-patch", "x-filename-id":"services-server-configuration-patch" } }, "/services/server/configuration/reset":{ "put":{ "tags":[ "Common/Retrieve Server Information" ], "summary":"Reset Server Configurations To Default", "description":"Required Role: Administrator
Resets Veridata Server configuration to default values.\n
", "operationId":"ResetServerConfigurations", "security":[ ], "responses":{ "200":{ "description":"Reset Server Configurations Successfully", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "message":{ "type":"string", "example":"Properties reset to default" } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Default configuration file not found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-server-configuration-reset-put", "x-filename-id":"services-server-configuration-reset-put" } }, "/services/configuration/connections":{ "get":{ "tags":[ "Configure/Connections" ], "security":[ ], "summary":"Retrieve Connections", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Returns a list of connections.\n
", "operationId":"ListConnections", "parameters":[ { "name":"dbType", "in":"query", "description":"Database type.", "required":false, "schema":{ "$ref":"#/components/schemas/DatabaseType" } }, { "name":"name", "in":"query", "description":"The Connection's name.", "required":false, "schema":{ "type":"string" } }, { "name":"description", "in":"query", "description":"Connection description.", "required":false, "schema":{ "type":"string" } }, { "name":"ssl", "in":"query", "description":"SSL enabled Connections.", "required":false, "schema":{ "type":"string", "enum":[ "true", "false", "all" ], "default":"all" } }, { "name":"managed", "in":"query", "description":"Specifies whether the connection is associated with managed Agent.", "required":false, "schema":{ "type":"boolean", "nullable":true } }, { "name":"properties", "in":"query", "description":"When set to true, will fetch connection properties.", "required":false, "schema":{ "type":"boolean", "default":false } }, { "name":"settings", "in":"query", "description":"When set to true, will fetch connection settings.", "required":false, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Connections retrieved successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "allOf":[ { "$ref":"#/components/schemas/BaseConnection" } ], "properties":{ "dbType":{ "type":"string", "description":"Database Type." }, "managed":{ "type":"boolean", "nullable":true, "description":"Specifies whether the connection is associated with managed Agent." }, "properties":{ "type":"array", "items":{ "$ref":"#/components/schemas/ConnectionProperty" } }, "settings":{ "type":"array", "items":{ "$ref":"#/components/schemas/RetrieveConnectionSettings" } } } }, "example":[ { "createdOn":"2025-01-02T10:45:52.080Z", "host":"100.00.00.00", "id":1083, "name":"Oracle-Source-Connection", "description":"Oracle-Source-Connection", "port":7851, "dbType":"oracle", "managed":false, "properties":[ { "datatype":"ARRAY", "datatypeNumber":2004, "defaultFormat":{ "defaultFormatType":"ggComparisonFormatBlob", "formatName":"blob", "order":0 }, "formatName":"blob" } ], "settings":[ { "default":true, "defaultValue":true, "name":"useSourceTargetAsKeys", "type":"BOOLEAN", "value":true }, { "default":true, "min":0, "max":100000, "defaultValue":3600, "name":"agentTimeout", "type":"INTEGER", "value":3600 }, { "default":true, "min":0, "max":100000, "defaultValue":1000, "name":"fetchSize", "type":"INTEGER", "value":1000 } ], "updatedOn":"2025-01-02T10:45:52Z" }, { "createdOn":"2025-01-02T10:45:52.080Z", "host":"100.00.00.00", "id":1084, "name":"Oracle-Target-Connection", "description":"Oracle-Target-Connection", "port":7852, "dbType":"oracle", "managed":true, "properties":[ { "datatype":"ARRAY", "datatypeNumber":2004, "defaultFormat":{ "defaultFormatType":"ggComparisonFormatBlob", "formatName":"blob", "order":0 }, "formatName":"blob" } ], "settings":[ { "default":true, "defaultValue":true, "name":"useSourceTargetAsKeys", "type":"BOOLEAN", "value":true }, { "default":true, "min":0, "max":100000, "defaultValue":3600, "name":"agentTimeout", "type":"INTEGER", "value":3600 }, { "default":true, "min":0, "max":100000, "defaultValue":1000, "name":"fetchSize", "type":"INTEGER", "value":1000 } ], "updatedOn":"2025-01-02T10:45:52Z" } ] } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-connections-get", "x-filename-id":"services-configuration-connections-get" }, "post":{ "tags":[ "Configure/Connections" ], "security":[ ], "summary":"Create Connection", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Create Connection.\n
", "operationId":"CreateConnection", "requestBody":{ "description":"Connection which needs to be created in Veridata.\n", "content":{ "application/json":{ "schema":{ "type":"object", "$ref":"#/components/schemas/CreateConnection" } } }, "required":true }, "responses":{ "201":{ "description":"Agent connection created successfully.\n", "content":{ "application/json":{ "schema":{ "type":"object", "$ref":"#/components/schemas/BaseConnection" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-connections-post", "x-filename-id":"services-configuration-connections-post" } }, "/services/configuration/connections/{Id}":{ "get":{ "tags":[ "Configure/Connections" ], "security":[ ], "summary":"Retrieve Connection", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Returns connection details.\n
", "operationId":"GetConnection", "parameters":[ { "name":"Id", "in":"path", "description":"Connection ID.\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"Successfully returned agent connection.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-connections-{Id}-get", "x-filename-id":"services-configuration-connections-id-get" }, "patch":{ "tags":[ "Configure/Connections" ], "security":[ ], "summary":"Update Connection", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Update connection.\n
", "operationId":"UpdateConnection", "parameters":[ { "name":"Id", "in":"path", "description":"ID of the connection to be updated.\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"agent connection to be updated.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UpdateConnection" } } }, "required":true }, "responses":{ "200":{ "description":"Connection Updated.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connection" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-connections-{Id}-patch", "x-filename-id":"services-configuration-connections-id-patch" }, "delete":{ "tags":[ "Configure/Connections" ], "security":[ ], "summary":"Delete Connection", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
API to delete veridata connection.\n
", "operationId":"DeleteConnection", "parameters":[ { "name":"Id", "in":"path", "description":"Connection ID to be deleted.", "required":true, "schema":{ "type":"integer" } }, { "name":"force", "in":"query", "description":"When true, deletes the Job, Group and Compare Pairs associated with this Connection.", "schema":{ "type":"boolean", "default":false } } ], "responses":{ "204":{ "description":"No Content.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-connections-{Id}-delete", "x-filename-id":"services-configuration-connections-id-delete" } }, "/services/configuration/connections/{Id}/metadata":{ "post":{ "tags":[ "Configure/Connections" ], "security":[ ], "summary":"Retrieve Metadata", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Returns a list of metadata such as catalog/pdb/schema/table/partition/column.\n
", "operationId":"GetMetadata", "parameters":[ { "name":"Id", "in":"path", "description":"agent connection ID.\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"Metadada definition.\n", "content":{ "application/json":{ "schema":{ "type":"object", "$ref":"#/components/schemas/RequestMetaDataDefinition" } } }, "required":true }, "responses":{ "200":{ "description":"List of the meta objects.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResponseMetaDataDefinition" } }, "example":[ { "name":"EMPNO", "datatype":"NUMBER", "datatypeNumber":2, "scale":0 }, { "name":"ENAME", "datatype":"VARCHAR2", "datatypeNumber":3001 } ] } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-connections-{Id}-metadata-post", "x-filename-id":"services-configuration-connections-id-metadata-post" } }, "/services/configuration/connections/{Id}/status":{ "get":{ "tags":[ "Configure/Connections" ], "security":[ ], "summary":"Retrieve Connection Status", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Get the connection status.\n
", "operationId":"GetConnectionStatus", "parameters":[ { "name":"Id", "in":"path", "description":"agent connection ID.\n", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"type", "in":"query", "description":"Type of connection to be tested. Agent or DB, or both. Default is both.", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"connection status.\n", "content":{ "application/json":{ "schema":{ "type":"integer", "description":"O means DOWN , 1 means UP, 2 means UNKNOWN and 3 means NOTSPECIFIED.", "enum":[ 0, 1, 2, 3 ], "example":1 } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-connections-{Id}-status-get", "x-filename-id":"services-configuration-connections-id-status-get" } }, "/services/configuration/cps/group/{groupId}":{ "post":{ "tags":[ "Configure/Compare Pairs" ], "security":[ ], "summary":"Create Compare Pairs", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
API to create Compare Pairs.\n
", "operationId":"CreateComparePairs", "parameters":[ { "name":"groupId", "in":"path", "description":"group ID.\n", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"includeColumnMapping", "in":"query", "description":"Include column mapping details in payload.\n", "required":false, "schema":{ "type":"boolean" } } ], "requestBody":{ "description":"Creates Veridata compare pairs.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListComparePairInDetailsRequest" } } }, "required":true }, "responses":{ "201":{ "description":"Compare Pairs created successfully.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ComparePairInDetails" } } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "502":{ "description":"Bad Gateway.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-cps-group-{groupId}-post", "x-filename-id":"services-configuration-cps-group-groupid-post" } }, "/services/configuration/cps/mappings/group/{groupId}":{ "post":{ "tags":[ "Configure/Compare Pairs" ], "security":[ ], "summary":"Create or Generate Compare Pairs using mapped objects", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Create compare pairs.\n
", "operationId":"createComparePairsFromMappings", "parameters":[ { "name":"groupId", "in":"path", "description":"group ID.\n", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"includeColumnMapping", "in":"query", "description":"Include column mapping details in payload.Default is false.\n", "required":false, "schema":{ "type":"boolean" } }, { "name":"preview", "in":"query", "description":"If false compare pairs are persisted to the repository.Default value is true.\n", "required":false, "schema":{ "type":"boolean" } } ], "requestBody":{ "description":"Creates Veridata compare pairs.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListMappedObjectWithOptions" } } }, "required":true }, "responses":{ "201":{ "description":"Compare Pairs created successfully.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ComparePairInDetails" } } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "502":{ "description":"Bad Gateway.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-cps-mappings-group-{groupId}-post", "x-filename-id":"services-configuration-cps-mappings-group-groupid-post" } }, "/services/configuration/cps/mappings":{ "post":{ "tags":[ "Configure/Compare Pairs" ], "security":[ ], "summary":"Generate Mapping Objects using the Mapping Rules", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Generate mapping objects for viewing purpose.\n
", "operationId":"GenerateMappingForPreview", "requestBody":{ "description":"Generates table mappings.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MappingRule" } } }, "required":true }, "responses":{ "200":{ "description":"Successfully generated compare pairs.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/MappedObject" } } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "502":{ "description":"Bad Gateway.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-cps-mappings-post", "x-filename-id":"services-configuration-cps-mappings-post" } }, "/services/configuration/cps":{ "post":{ "tags":[ "Configure/Compare Pairs" ], "security":[ ], "summary":"Generate Compare Pairs using mapped objects", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Create compare pairs for preview purpose.This will not save the compare pairs in repository.This API doesn't need group ID and hence should be used when compare pairs are to be previewed without mapped to any group.\n
", "operationId":"createComparePairsGenerateWithoutGroup", "parameters":[ { "name":"sourceConnectionId", "in":"query", "description":"Source Connection ID.", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"targetConnectionId", "in":"query", "description":"Target Connection ID.", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"includeColumnMapping", "in":"query", "description":"Include column mapping details in payload.\n", "schema":{ "type":"boolean" } } ], "requestBody":{ "description":"Creates Veridata compare pairs for preview purpose.This will not save the compare pairs in repository.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListMappedObjectWithOptions" } } }, "required":true }, "responses":{ "200":{ "description":"Compare Pairs created successfully.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ComparePairInDetailsView" } } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "502":{ "description":"Bad Gateway.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-cps-post", "x-filename-id":"services-configuration-cps-post" } }, "/services/configuration/cps/{Id}":{ "get":{ "tags":[ "Configure/Compare Pairs" ], "security":[ ], "summary":"Retrieve Compare Pair", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Returns the compare pair details.\n
", "operationId":"GetComparePair", "parameters":[ { "name":"Id", "in":"path", "description":"ComparePair ID.", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"Ok.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComparePairInDetails" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-cps-{Id}-get", "x-filename-id":"services-configuration-cps-id-get" }, "put":{ "tags":[ "Configure/Compare Pairs" ], "security":[ ], "summary":"Replace Compare Pair", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Replace Compare Pair.\n
", "operationId":"ReplaceComparePair", "parameters":[ { "name":"Id", "in":"path", "description":"Compare Pair ID.", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"Compare pair to be replaced.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UpdateComparePairDetails" } } }, "required":true }, "responses":{ "200":{ "description":"Ok.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComparePairInDetails" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-cps-{Id}-put", "x-filename-id":"services-configuration-cps-id-put" }, "delete":{ "tags":[ "Configure/Compare Pairs" ], "security":[ ], "summary":"Delete Compare Pair", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
API to delete Veridata Compare Pair.\n
", "operationId":"DeleteComparePair", "parameters":[ { "name":"Id", "in":"path", "description":"Compare Pair ID to be deleted.", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "204":{ "description":"No Content.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-cps-{Id}-delete", "x-filename-id":"services-configuration-cps-id-delete" } }, "/services/configuration/cps/{Id}/colmap":{ "post":{ "tags":[ "Configure/Compare Pairs" ], "security":[ ], "summary":"Generate Column Mapping Pairs", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Create Column Mapping Pairs for viewing purpose. This will not save the column mappings in repository. This will only generate column mapping pairs to view the compare format and other information.\n
", "operationId":"generateColumnMapping", "parameters":[ { "name":"Id", "in":"path", "description":"compare pair id\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"List of mapped columns.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListColumnMappingPair" } } }, "required":true }, "responses":{ "200":{ "description":"Column Mapping Pairs created successfully.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ColumnMapping" } } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "502":{ "description":"Bad Gateway.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-cps-{Id}-colmap-post", "x-filename-id":"services-configuration-cps-id-colmap-post" } }, "/services/configuration/jobs":{ "get":{ "tags":[ "Configure/Jobs" ], "security":[ ], "summary":"Retrieve Jobs", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Returns Veridata Jobs.\n
", "operationId":"ListJobs", "parameters":[ { "name":"name", "in":"query", "description":"Job name.", "required":false, "schema":{ "type":"string" } }, { "name":"desc", "in":"query", "description":"The Job description.", "required":false, "schema":{ "type":"string" } }, { "name":"scheduled", "in":"query", "description":"Fetches scheduled jobs when true, and jobs that are not scheduled when false. When this parameter is not passed, all the jobs are retrieved.", "required":false, "schema":{ "type":"boolean" } } ], "responses":{ "200":{ "description":"Ok.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Job" }, "example":[ { "id":1001, "name":"job1", "description":"sample job to run", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z", "profileId":1, "numOfGroups":1, "schedulePattern":"0 * * * * ?", "isScheduleEnabled":true } ] } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-jobs-get", "x-filename-id":"services-configuration-jobs-get" }, "post":{ "tags":[ "Configure/Jobs" ], "security":[ ], "summary":"Create Job", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Create Veridata Jobs.
", "operationId":"CreateJobs", "requestBody":{ "description":"Create Veridata Jobs.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateJob" } } }, "required":true }, "responses":{ "201":{ "description":"Successfully created Veridata job.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateJobResponse" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "502":{ "description":"Bad Gateway.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-jobs-post", "x-filename-id":"services-configuration-jobs-post" } }, "/services/configuration/jobs/{Id}":{ "get":{ "tags":[ "Configure/Jobs" ], "security":[ ], "summary":"Retrieve Job details", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Retrieve Veridata Job details by Job ID.\n
", "operationId":"GetJob", "parameters":[ { "name":"Id", "in":"path", "description":"Veridata Job ID.", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"detail", "in":"query", "description":"Boolean value. When set to true fetches Compare Pair details of that Job.", "required":false, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Veridata Job details retrieved successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GetJobById" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-jobs-{Id}-get", "x-filename-id":"services-configuration-jobs-id-get" }, "put":{ "tags":[ "Configure/Jobs" ], "security":[ ], "summary":"Replace Job", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Replace Veridata Job.\n
", "operationId":"ReplaceJob", "parameters":[ { "name":"Id", "in":"path", "description":"Job ID.", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "description":"Veridata Job to be replaced.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UpdateJob" } } }, "required":true }, "responses":{ "200":{ "description":"Job replaced successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UpdateJobResponse" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-jobs-{Id}-put", "x-filename-id":"services-configuration-jobs-id-put" }, "delete":{ "tags":[ "Configure/Jobs" ], "security":[ ], "summary":"Delete Job", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Delete a Veridata Job.\n
", "operationId":"DeleteJob", "parameters":[ { "name":"Id", "in":"path", "description":"Job ID.", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "204":{ "description":"No Content.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-jobs-{Id}-delete", "x-filename-id":"services-configuration-jobs-id-delete" } }, "/services/configuration/schedule/jobs":{ "post":{ "tags":[ "Configure/Schedule Jobs" ], "security":[ ], "summary":"Schedule Jobs", "description":"Required Role: Administrator, SuperUser, CommandLineOperator, JobOperator, RepairOperator
Schedule Veridata Jobs.
", "operationId":"ScheduleJobs", "requestBody":{ "description":"Schedule Veridata Jobs.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScheduleRequest" } } }, "required":true }, "responses":{ "201":{ "description":"Successfully scheduled Veridata jobs\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScheduledJobsResponse" }, "example":{ "jobsScheduled":[ { "jobId":1001, "isEnabled":true }, { "jobId":1002, "isEnabled":true } ] } } } }, "207":{ "description":"Some Veridata jobs were successfully scheduled, while others failed to get scheduled.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScheduledJobsResponse" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-configuration-schedule-jobs-post", "x-filename-id":"services-configuration-schedule-jobs-post" }, "patch":{ "tags":[ "Configure/Schedule Jobs" ], "security":[ ], "summary":"Update Scheduled Jobs", "description":"Required Role: Administrator, SuperUser, CommandLineOperator, JobOperator, RepairOperator
Update Scheduled Veridata Jobs.
", "operationId":"UpdateScheduledJobs", "requestBody":{ "required":true, "description":"Update Scheduled Veridata Jobs.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScheduleRequest" } } } }, "responses":{ "200":{ "description":"Successfully updated the schedule of the Veridata Jobs", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScheduledJobsResponse" }, "example":{ "jobsScheduled":[ { "jobId":1001, "isEnabled":true }, { "jobId":1002, "isEnabled":true } ] } } } }, "207":{ "description":"Some Veridata jobs were successfully scheduled, while others failed to get scheduled.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScheduledJobsResponse" } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-schedule-jobs-patch", "x-filename-id":"services-configuration-schedule-jobs-patch" } }, "/services/configuration/schedule/jobs/{Id}":{ "get":{ "tags":[ "Configure/Schedule Jobs" ], "security":[ ], "summary":"Get Scheduled Job Details", "description":"Required Role: Administrator, SuperUser, CommandLineOperator, JobOperator, RepairOperator
API to fetch the Veridata Scheduled Job Details.
", "operationId":"GetScheduledJob", "parameters":[ { "name":"Id", "in":"path", "description":"Job ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Veridata Schedule Job details retrieved successfully.", "content":{ "application/json":{ "schema":{ "type":"object" }, "example":{ "jobId":1001, "isEnabled":true, "schedulePattern":"0 * * * * ?" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-schedule-jobs-{Id}-get", "x-filename-id":"services-configuration-schedule-jobs-id-get" }, "delete":{ "tags":[ "Configure/Schedule Jobs" ], "security":[ ], "summary":"Delete Scheduled Job", "description":"Required Role: Administrator, SuperUser, CommandLineOperator, JobOperator, RepairOperator
API to delete Veridata Scheduled Job.
", "operationId":"DeleteScheduledJob", "parameters":[ { "name":"Id", "in":"path", "description":"Job ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-schedule-jobs-{Id}-delete", "x-filename-id":"services-configuration-schedule-jobs-id-delete" } }, "/services/configuration/profiles":{ "get":{ "tags":[ "Configure/Profiles" ], "security":[ ], "summary":"Retrieve Profiles", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Get all Profiles.\n
", "operationId":"ListProfiles", "parameters":[ { "name":"name", "in":"query", "description":"name like.", "required":false, "schema":{ "type":"string" } }, { "name":"description", "in":"query", "description":"description like.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Profiles returned successfully.\n", "content":{ "*/*":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Profile" }, "example":[ { "id":1001, "name":"test_profile", "description":"profile", "createdOn":"2024-02-03T10:15:30Z", "updatedOn":"2024-02-03T10:15:30Z" } ] } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-profiles-get", "x-filename-id":"services-configuration-profiles-get" }, "post":{ "tags":[ "Configure/Profiles" ], "security":[ ], "summary":"Create Profile", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Creates Profile.\n
", "operationId":"CreateProfiles", "requestBody":{ "description":"Creates Profile.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateProfile" } } } }, "responses":{ "201":{ "description":"Profiles created successfully.\n", "content":{ "*/*":{ "schema":{ "type":"object", "$ref":"#/components/schemas/DetailedProfile" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-profiles-post", "x-filename-id":"services-configuration-profiles-post" } }, "/services/configuration/profiles/{Id}/reset":{ "put":{ "tags":[ "Configure/Profiles" ], "security":[ ], "summary":"Reset Profile", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Resets Veridata Profile to default value.\n
", "operationId":"ResetProfile", "parameters":[ { "name":"Id", "in":"path", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Profile returned successfully. The attributes of the profile will be reset to default values.\n", "content":{ "*/*":{ "schema":{ "type":"object", "$ref":"#/components/schemas/DetailedProfile" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-profiles-{Id}-reset-put", "x-filename-id":"services-configuration-profiles-id-reset-put" } }, "/services/configuration/profiles/{Id}":{ "get":{ "tags":[ "Configure/Profiles" ], "security":[ ], "summary":"Retrieve Profile details", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Gets Veridata Profile details.\n
", "operationId":"GetProfile", "parameters":[ { "name":"Id", "in":"path", "required":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Profile returned successfully.\n", "content":{ "*/*":{ "schema":{ "type":"object", "$ref":"#/components/schemas/DetailedProfile" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-profiles-{Id}-get", "x-filename-id":"services-configuration-profiles-id-get" }, "patch":{ "tags":[ "Configure/Profiles" ], "security":[ ], "summary":"Update Profile", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Update Veridata Profile.\n
", "operationId":"UpdateProfile", "parameters":[ { "name":"Id", "in":"path", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "description":"Profile parameters to be updated.\n", "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "$ref":"#/components/schemas/DetailedProfileRequest" } } } }, "responses":{ "200":{ "description":"Profile updated successfully.\n", "content":{ "*/*":{ "schema":{ "type":"object", "$ref":"#/components/schemas/DetailedProfile" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-profiles-{Id}-patch", "x-filename-id":"services-configuration-profiles-id-patch" }, "delete":{ "tags":[ "Configure/Profiles" ], "security":[ ], "summary":"Delete Profile", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
API to delete Veridata Profile.\n
", "operationId":"DeleteProfile", "parameters":[ { "name":"Id", "in":"path", "description":"Profile ID.", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "204":{ "description":"No Content.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-profiles-{Id}-delete", "x-filename-id":"services-configuration-profiles-id-delete" } }, "/services/configuration/groups/clone/{Id}":{ "post":{ "tags":[ "Configure/Groups" ], "security":[ ], "summary":"Clone Group", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Clone a Group.\n
", "operationId":"CloneGroup", "parameters":[ { "name":"Id", "in":"path", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "description":"Create a Group by cloning.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateGroupRequest" } } } }, "responses":{ "201":{ "description":"Group cloned successfully.\n", "content":{ "*/*":{ "schema":{ "type":"object", "$ref":"#/components/schemas/Group" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "502":{ "description":"Bad Gateway.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-groups-clone-{Id}-post", "x-filename-id":"services-configuration-groups-clone-id-post" } }, "/services/configuration/groups/{Id}":{ "get":{ "tags":[ "Configure/Groups" ], "security":[ ], "summary":"Retrieve Group details", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Get Veridata Group details.\n
", "operationId":"GetGroup", "parameters":[ { "name":"Id", "in":"path", "required":true, "schema":{ "type":"integer" } }, { "name":"name", "in":"query", "description":"compare pair name like.", "required":false, "schema":{ "type":"string" } }, { "name":"profile", "in":"query", "description":"compare pair profile like.", "required":false, "schema":{ "type":"string" } }, { "name":"srcTable", "in":"query", "description":"source table name like.", "required":false, "schema":{ "type":"string" } }, { "name":"tgtTable", "in":"query", "description":"target table name like.", "required":false, "schema":{ "type":"string" } }, { "name":"status", "in":"query", "description":"Compare pair validation status.", "required":false, "schema":{ "$ref":"#/components/schemas/ComparePairValidationStatus" } } ], "responses":{ "200":{ "description":"Group returned successfully.\n", "content":{ "*/*":{ "schema":{ "type":"object", "$ref":"#/components/schemas/Group" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-groups-{Id}-get", "x-filename-id":"services-configuration-groups-id-get" }, "patch":{ "tags":[ "Configure/Groups" ], "security":[ ], "summary":"Update Group", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Update Veridata Group.\n
", "operationId":"UpdateGroup", "parameters":[ { "name":"Id", "in":"path", "required":true, "schema":{ "type":"integer" } } ], "requestBody":{ "required":true, "description":"Veridata Group to be updated.\n", "content":{ "application/json":{ "schema":{ "type":"object", "$ref":"#/components/schemas/GroupRequest" } } } }, "responses":{ "200":{ "description":"Group updated successfully.\n", "content":{ "*/*":{ "schema":{ "type":"object", "$ref":"#/components/schemas/Group" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-groups-{Id}-patch", "x-filename-id":"services-configuration-groups-id-patch" }, "delete":{ "tags":[ "Configure/Groups" ], "security":[ ], "summary":"Delete Group", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
API to delete Veridata Group.\n
", "operationId":"DeleteGroup", "parameters":[ { "name":"Id", "in":"path", "description":"Group ID.", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "204":{ "description":"No Content.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-groups-{Id}-delete", "x-filename-id":"services-configuration-groups-id-delete" } }, "/services/configuration/groups":{ "get":{ "tags":[ "Configure/Groups" ], "security":[ ], "summary":"Retrieve Groups", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Get all Groups.\n
", "operationId":"ListGroups", "parameters":[ { "name":"name", "in":"query", "description":"group name like.", "required":false, "schema":{ "type":"string" } }, { "name":"desc", "in":"query", "description":"group description like.", "required":false, "schema":{ "type":"string" } }, { "name":"srcConn", "in":"query", "description":"source connection name like.", "required":false, "schema":{ "type":"string" } }, { "name":"tgtConn", "in":"query", "description":"target connection name like.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Groups returned successfully.\n", "content":{ "*/*":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ListAllResponseGroup" } } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-groups-get", "x-filename-id":"services-configuration-groups-get" }, "post":{ "tags":[ "Configure/Groups" ], "security":[ ], "summary":"Create Group", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Creates group.\n
", "operationId":"CreateGroup", "requestBody":{ "description":"Creates Group.\n", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateGroupRequest" } } } }, "responses":{ "201":{ "description":"Group created successfully.\n", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/CreateGroupResponse" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "502":{ "description":"Bad Gateway.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-groups-post", "x-filename-id":"services-configuration-groups-post" } }, "/services/currentuser":{ "get":{ "tags":[ "Manage User/Users" ], "security":[ ], "summary":"Retrieve Current User", "description":"Required Role: Administrator, CommandLineOperator, SuperUser, DetailMonitoringOperator, MonitoringOperator
Retrieve logged-in user details
", "operationId":"GetCurrentUser", "responses":{ "200":{ "description":"Retrieved current user details successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserDetails" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-currentuser-get", "x-filename-id":"services-currentuser-get" }, "patch":{ "tags":[ "Manage User/Users" ], "security":[ ], "summary":"Update Current User", "description":"Required Role: Administrator, CommandLineOperator, SuperUser, DetailMonitoringOperator, MonitoringOperator
Update logged-in user details
", "operationId":"UpdateCurrentUser", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UpdateUserBasicDetails" } } } }, "responses":{ "200":{ "description":"User details updated successfully.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-currentuser-patch", "x-filename-id":"services-currentuser-patch" } }, "/services/currentuser/password/reset":{ "patch":{ "tags":[ "Manage User/Users" ], "security":[ ], "summary":"Update Current User Password", "description":"Required Role: Administrator, CommandLineOperator, SuperUser, DetailMonitoringOperator, MonitoringOperator
Update logged-in user password\n
", "operationId":"UpdateCurrentUserPassword", "requestBody":{ "required":true, "description":"Current User password update\n", "content":{ "application/json":{ "schema":{ "type":"object", "$ref":"#/components/schemas/UpdatePassword" } } } }, "responses":{ "200":{ "description":"User password updated successfully\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-currentuser-password-reset-patch", "x-filename-id":"services-currentuser-password-reset-patch" } }, "/services/admin/access":{ "get":{ "tags":[ "Manage User/Users" ], "security":[ ], "summary":"Retrieve User Access", "description":"Required Role: Administrator
Retrieve User Access
", "operationId":"GetListVeridataAccess", "responses":{ "200":{ "description":"Retrieved access Successfully.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Access" }, "example":[ { "id":0, "name":"Admin", "description":"Admin", "createdAt":"2025-04-04T12:06:09.569Z", "modifiedAt":"2025-04-04T12:06:09.569Z" } ] } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-access-get", "x-filename-id":"services-admin-access-get" } }, "/services/admin/users":{ "get":{ "tags":[ "Manage User/Users" ], "security":[ ], "summary":"Retrieve Users", "description":"Required Role: Administrator, CommandLineOperator
Retrieve Veridata Users
", "operationId":"GetListVeridataUsers", "responses":{ "200":{ "description":"Retrieved user details successfully.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/UserDetailsResponse" }, "example":[ { "id":1001, "name":"user", "emailId":"user@oracle.com", "createdOn":"2024-02-03T10:15:30Z", "description":"user" } ] } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-users-get", "x-filename-id":"services-admin-users-get" }, "post":{ "tags":[ "Manage User/Users" ], "security":[ ], "summary":"Create a User", "description":"Required Role: Administrator, CommandLineOperator
Create a User
", "operationId":"CreateVeridataUser", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/User" } } } }, "responses":{ "201":{ "description":"User created successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserDetailsPostResponse" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-users-post", "x-filename-id":"services-admin-users-post" } }, "/services/admin/users/{Id}":{ "put":{ "tags":[ "Manage User/Users" ], "security":[ ], "summary":"Replace User", "description":"Required Role: Administrator, CommandLineOperator
Replace User
", "operationId":"VeridataUserReplace", "parameters":[ { "name":"Id", "in":"path", "description":"user ID.\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UpdateUser" } } } }, "responses":{ "200":{ "description":"User updated successfully.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-users-{Id}-put", "x-filename-id":"services-admin-users-id-put" }, "get":{ "tags":[ "Manage User/Users" ], "security":[ ], "summary":"Retrieve User", "description":"Required Role: Administrator, CommandLineOperator
Retrieve User
", "operationId":"GetVeridataUser", "parameters":[ { "name":"Id", "in":"path", "description":"user ID.\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"Retrieved User details successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserDetails" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-users-{Id}-get", "x-filename-id":"services-admin-users-id-get" }, "delete":{ "tags":[ "Manage User/Users" ], "security":[ ], "summary":"Delete User", "description":"Required Role: Administrator, CommandLineOperator
Delete User
", "operationId":"DeleteVeridataUser", "parameters":[ { "name":"Id", "in":"path", "description":"user ID.\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "204":{ "description":"No Content.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-users-{Id}-delete", "x-filename-id":"services-admin-users-id-delete" } }, "/services/admin/users/{Id}/password":{ "patch":{ "tags":[ "Manage User/Users" ], "security":[ ], "summary":"Update User Password", "description":"Required Role: Administrator, CommandLineOperator
Update User Password\n
", "operationId":"UpdateUserPassword", "parameters":[ { "name":"Id", "in":"path", "description":"user ID\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "required":true, "description":"User password update\n", "content":{ "application/json":{ "schema":{ "type":"object", "$ref":"#/components/schemas/UpdatePassword" } } } }, "responses":{ "200":{ "description":"User password updated successfully\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-users-{Id}-password-patch", "x-filename-id":"services-admin-users-id-password-patch" } }, "/services/admin/usergroups":{ "get":{ "tags":[ "Manage User/User Groups" ], "security":[ ], "summary":"Retrieve User Groups", "description":"Required Role: Administrator, CommandLineOperator
Retrieve User Groups
", "operationId":"GetListVeridataUserGroups", "responses":{ "200":{ "description":"Retrieved Group details successfully\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/UserGroupPostResponse" }, "example":[ { "id":1001, "name":"Admin", "description":"Admin", "isModifiable":"false", "createdOn":"2024-02-03T10:15:30Z" } ] } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-usergroups-get", "x-filename-id":"services-admin-usergroups-get" }, "post":{ "tags":[ "Manage User/User Groups" ], "security":[ ], "summary":"Create User Group", "description":"Required Role: Administrator, CommandLineOperator
Create User Group
", "operationId":"CreateVeridataUserGroup", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroup" } } } }, "responses":{ "201":{ "description":"User Group created successfully\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupPostResponse" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-usergroups-post", "x-filename-id":"services-admin-usergroups-post" } }, "/services/admin/usergroups/{Id}":{ "put":{ "tags":[ "Manage User/User Groups" ], "security":[ ], "summary":"Replace User Group", "description":"Required Role: Administrator, CommandLineOperator
Replace User Group
", "operationId":"VeridataUserGroupUpdate", "parameters":[ { "name":"Id", "in":"path", "description":"group ID\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UpdateUserGroup" } } } }, "responses":{ "200":{ "description":"User Group updated successfully\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-usergroups-{Id}-put", "x-filename-id":"services-admin-usergroups-id-put" }, "get":{ "tags":[ "Manage User/User Groups" ], "security":[ ], "summary":"Retrieve User Group", "description":"Required Role: Administrator, CommandLineOperator
Retrieve User Group
", "operationId":"GetVeridataGroup", "parameters":[ { "name":"Id", "in":"path", "description":"group ID\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"Retrieved Group details successfully\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserGroupDetails" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-usergroups-{Id}-get", "x-filename-id":"services-admin-usergroups-id-get" }, "delete":{ "tags":[ "Manage User/User Groups" ], "security":[ ], "summary":"Delete User Group", "description":"Required Role: Administrator, CommandLineOperator
Delete User Group
", "operationId":"DeleteVeridataUserGroup", "parameters":[ { "name":"Id", "in":"path", "description":"user group ID\n", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "204":{ "description":"No Content.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-admin-usergroups-{Id}-delete", "x-filename-id":"services-admin-usergroups-id-delete" } }, "/services/monitoring/jobs":{ "get":{ "tags":[ "Monitor" ], "security":[ ], "summary":"Retrieve Job statistics", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
This API is used to monitor running and completed Jobs. By default this returns the latest Job stats.
", "operationId":"MonitorVeridataJobs", "parameters":[ { "name":"status", "in":"query", "required":false, "schema":{ "$ref":"#/components/schemas/JobFinishedStatus" } }, { "name":"fromDate", "in":"query", "description":"Defines the start date range (inclusive) to filter out the Job response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'. \"\n", "required":false, "schema":{ "type":"string" } }, { "name":"toDate", "in":"query", "description":"Defines the end date range (not inclusive) to filter out the Job response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'.", "required":false, "schema":{ "type":"string" } }, { "name":"last", "in":"query", "description":"Fetch Job stats of last x units. Supported units D(Days) or H(hours) or M(minutes). Example: 1D ", "required":false, "schema":{ "type":"string" } }, { "name":"runId", "in":"query", "description":"The Job's Run ID. Example: runId=1024,0,0. Job runId can be obtained from Monitoring API.", "required":false, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Supported values: GROUP/CP. Valid only when Job runId is passed in Query Param. When type=GROUP, returns Group basestats info and when type=CP, returns both Group and Compare Pair stats along with Job stats", "required":false, "schema":{ "type":"string" } }, { "name":"jobId", "in":"query", "description":"The job ID.The response contains groups and compare pairs latest completed run.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Returns a collection of completed Jobs with the statistics.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/JobStats" }, "example":[ { "runId":{ "asString":"12377/0/0", "comparePairNum":0, "groupNum":0, "runID":12377 }, "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z", "jobId":1017, "jobName":"repairTestJob", "status":"OOS", "repairStatus":"OOS", "repairRunId":{ "asString":"10207/0/0", "comparePairNum":0, "groupNum":0, "runID":"10207" }, "comparePairsTotal":1, "comparePairsProcessed":1, "comparePairsWithErrors":0, "comparePairsWithOOS":1, "comparePairsWithNoOOS":0, "comparePairsCancelled":0, "comparePairsRunning":0, "comparePairsPending":0, "skippedRows":false, "group":[ { "runId":{ "asString":"12377/1/0", "comparePairNum":0, "groupNum":1, "runID":12377 }, "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z", "grpId":1007, "name":"base", "numOfComparePairs":1, "comparePairs":[ { "runId":{ "asString":"12377/1/1", "comparePairNum":1, "groupNum":1, "runID":12377 }, "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z", "comparePairId":1017, "name":"SRC1=TRG1", "numRowsOos":7, "skippedRows":false, "phase":"FINISHED", "status":"OOS", "repairStatus":"OOS", "repairRunId":{ "asString":"10207/1/1", "comparePairNum":1, "groupNum":1, "runID":10207 }, "errorMessage":"" } ], "skippedRows":false, "repairStatus":"OOS", "repairRunId":{ "asString":"10207/1/0", "comparePairNum":0, "groupNum":1, "runID":10207 }, "srcConnection":{ "name":"oracleLocal", "id":1014, "dbType":"oracle" }, "trgConnection":{ "name":"oracleLocal", "id":1014, "dbType":"oracle" } } ], "repairJobs":[ { "repairRunId":{ "asString":"10207/0/0", "comparePairNum":0, "groupNum":0, "runID":10207 }, "repairStatus":"OOS", "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z" } ] } ] } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"\"Unauthorized\".\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"\"Not found\".\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"\"Server error\".\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-monitoring-jobs-get", "x-filename-id":"services-monitoring-jobs-get" } }, "/services/monitoring/cps":{ "get":{ "tags":[ "Monitor" ], "security":[ ], "summary":"Retrieve Compare Pair Statistics", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
API to get Veridata Compare Pair monitoring details.
", "operationId":"MonitorVeridataCP", "parameters":[ { "name":"status", "in":"query", "required":false, "schema":{ "$ref":"#/components/schemas/ComparisonStatus" } }, { "name":"fromDate", "in":"query", "description":"Defines the start date range (inclusive) to filter out the Compare Pair response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z' \"\n", "required":false, "schema":{ "type":"string" } }, { "name":"toDate", "in":"query", "description":"Defines the end date range (not inclusive) to filter out the Compare Pair response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'.", "required":false, "schema":{ "type":"string" } }, { "name":"last", "in":"query", "description":"Fetch Compare Pair stats of last x units. Supported units D(Days) or H(hours) or M(minutes). Example: 1D ", "required":false, "schema":{ "type":"string" } }, { "name":"runId", "in":"query", "description":"The CP's Run ID. Example: runId=1024,1,1.", "required":false, "schema":{ "type":"string" } }, { "name":"cpId", "in":"query", "description":"Compare Pair ID.", "required":false, "schema":{ "type":"integer" } }, { "name":"includePerformance", "in":"query", "description":"This parameter when set to true will include performance statistics. Default value: false.", "required":false, "schema":{ "type":"boolean" } }, { "name":"finishedStatsCount", "in":"query", "description":"This parameter decides the number of completed statistics (current + previous run) to be shown in the response. Default is 5.", "required":false, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Compare Pair statistics fetched successfully.\n", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ComparePairStats" }, "example":[ { "runId":{ "asString":"10277/1/1", "comparePairNum":1, "groupNum":1, "runID":10277 }, "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z", "comparePairId":1027, "name":"SRC2=TRG2", "numRowsOos":9, "skippedRows":false, "phase":"FINISHED", "status":"OOS", "repairStatus":"SUCCESSFUL", "repairRunId":{ "asString":"18970/0/0", "comparePairNum":0, "groupNum":0, "runID":18970 }, "errorMessage":"", "rowsFromTarget":15, "rowsFromSource":16, "numOfDeletes":3, "numOfUpdates":4, "numOfInserts":2, "perfStats":{ "coosBytesPerSec":8, "coosDuration":{ "hours":0, "minutes":0, "seconds":15, "totalSeconds":15 }, "coosRowsPerSec":1, "coosStartTime":"2024-02-03T10:15:30Z", "coosStopTime":"2024-02-03T10:15:30Z", "coosTotalBytes":120, "coosTotalRows":15, "initCompareBytesPerSec":8, "initCompareDuration":{ "hours":0, "minutes":0, "seconds":15, "totalSeconds":15 }, "initCompareRowsPerSec":1, "initCompareStartTime":"2024-02-03T10:15:30Z", "initCompareStopTime":"2024-02-03T10:15:30Z", "initCompareTotalBytes":120, "initCompareTotalRows":15, "sortingSrcBytesPerSec":8, "sortingSrcDuration":{ "hours":0, "minutes":0, "seconds":15, "totalSeconds":15 }, "sortingSrcTotalBytes":120, "sortingSrcStartTime":"2024-02-03T10:15:30Z", "sortingSrcStopTime":"2024-02-03T10:15:30Z", "sortingSrcTotalRows":15, "sortingSrcRowsPerSec":1, "sortingTgtBytesPerSec":8, "sortingTgtDuration":{ "hours":0, "minutes":0, "seconds":16, "totalSeconds":16 }, "sortingTgtTotalBytes":128, "sortingTgtStartTime":"2024-02-03T10:15:30Z", "sortingTgtStopTime":"2024-02-03T10:15:30Z", "sortingTgtTotalRows":16, "sortingTgtRowsPerSec":1 }, "runningStats":{ "insyncBeforeCOOSInBytes":72, "insyncBeforeCOOS":9, "updatesOOS":4, "updatesInsyncAfterInFlight":3, "updatesOOSBeforeCOOS":1, "updatesOOSInBytes":32, "deletesOOSInBytes":24, "deletesInsyncAfterInFlightInBytes":2, "deletesOOS":3, "deletesOOSBeforeCOOS":1, "deletesOOSBeforeCOOSInBytes":2, "insertsInsyncAfterInFlight":2, "insertsOOS":2, "insertsOOSBeforeCOOS":0, "insertsOOSInBytes":16, "insertsInsyncAfterInFlightInBytes":0, "rowsIntoTargetSort":16, "rowsIntoSourceSort":15, "deletesInsyncAfterInFlight":0, "rowsFromSource":7, "rowsFromTarget":9, "totalRowsFromSource":15, "totalRowsFromTarget":16, "fetchLatencyFromTarget":null, "remainingTimeFromTarget":5, "remainingTimeFromSource":5, "bytesFromTarget":24, "bytesFromSource":32, "bytesIntoSourceSort":16, "bytesIntoTargetSort":8 } } ] } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"\"Unauthorized.\"\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"\"Not found.\"\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"\"Server error.\"\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-monitoring-cps-get", "x-filename-id":"services-monitoring-cps-get" } }, "/services/monitoring/comparison/{runId}/reports":{ "get":{ "tags":[ "Monitor" ], "security":[ ], "summary":"Retrieve Veridata comparison report", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
API to get Veridata comparison report for Job, Group and Compare Pair.
", "operationId":"GetVeridataComparisonReport", "parameters":[ { "name":"runId", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Defines the Run ID of the Job/Group/Compare pair for which the report should be fetched." } ], "responses":{ "200":{ "description":"Report successfully fetched.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Report" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"\"Unauthorized.\"\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"\"Not found.\"\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"\"Server error.\"\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-monitoring-comparison-{runId}-reports-get", "x-filename-id":"services-monitoring-comparison-runid-reports-get" } }, "/services/monitoring/repair/{runId}/reports":{ "get":{ "tags":[ "Monitor" ], "security":[ ], "summary":"Retrieve Veridata repair report", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
API to get Veridata repair report for Job, Group and Compare Pair.
", "operationId":"GetVeridataRepairReport", "parameters":[ { "name":"runId", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Defines the Run ID of the Repair Job/Group/Compare pair for which the report should be fetched." } ], "responses":{ "200":{ "description":"Report successfully fetched.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Report" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"\"Unauthorized.\"\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"\"Not found.\"\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"\"Server error.\"\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-monitoring-repair-{runId}-reports-get", "x-filename-id":"services-monitoring-repair-runid-reports-get" } }, "/services/monitoring/repair/jobs":{ "get":{ "tags":[ "Monitor" ], "security":[ ], "summary":"Retrieve Repair Statistics", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
This API is used to monitor Repair Jobs. Pass the runId as input to fetch Group and Compare Pair details.
", "operationId":"MonitorRepairJobs", "parameters":[ { "name":"status", "in":"query", "description":"Defines Repair Job Status. To fetch Jobs of different status, pass comma separated values.", "required":false, "schema":{ "$ref":"#/components/schemas/RepairStatus" } }, { "name":"fromDate", "in":"query", "description":"Defines the start date range (inclusive) to filter out the Repair Job response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'. Example: 2024-03-13T18:30:00ZRequired Role: Administrator, SuperUser, CommandLineOperator, DetailMonitoringOperator
Get out-of-sync data for a Compare Pair.
", "operationId":"ListComparePairOOSData", "parameters":[ { "name":"runId", "in":"path", "description":"Comparison Compare Pair run ID.", "required":true, "schema":{ "type":"integer", "format":"int64" } }, { "name":"repairStatus", "in":"query", "description":"Filter rows based on repair status. Comma seperated repair status. Default value is Out of Sync rows.", "required":false, "schema":{ "$ref":"#/components/schemas/RepairStatus" } }, { "name":"operationType", "in":"query", "description":"Filter rows based on operation type. Comma seperated operation type. Default is UPDATE,INSERT,DELETE.", "required":false, "schema":{ "$ref":"#/components/schemas/RepairApplyOperationTypeFilter" } } ], "responses":{ "200":{ "description":"Successfully retrieved Out-Of-Sync data.\n", "content":{ "*/*":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/OutOfSyncDetails" }, "example":[ { "repairStatus":"SUCCESSFUL", "rowsData":[ { "rowData":[ { "columnName":"BRANCH", "columnType":"VARCHAR2", "keyCol":false, "srcColumnData":[ { "name":"BRANCH", "hex":false, "binary":false, "diff":false, "value":"IT", "isnull":false } ], "tgtColumnData":[ { "name":"BRANCH", "hex":false, "binary":false, "diff":false, "isnull":false } ] } ], "operation":"INSERT", "repairStatus":"SUCCESSFUL", "skippedRow":false, "duplicateRow":false, "rowId":"1B7CE18868966C8B_0", "errorMessage":"" } ] } ] } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-oos-{runId}-get", "x-filename-id":"services-oos-runid-get" } }, "/services/configuration/vgpp":{ "post":{ "tags":[ "Manage Import and Export/Import" ], "security":[ ], "summary":"Import GoldenGate Parameter File", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Creates/Updates/Replaces Veridata Configurations using Goldengate Replicat Parameter File as Input.\n
", "operationId":"VeridataVGPP", "parameters":[ { "in":"query", "name":"operation", "description":"0 - no scripting, 1 - create, 2 - update, 3 - replace.", "schema":{ "type":"integer", "enum":[ 0, 1, 2, 3 ] }, "required":true }, { "in":"query", "name":"sourceConnection", "schema":{ "type":"string" }, "description":"Source Connection name." }, { "in":"query", "name":"targetConnection", "schema":{ "type":"string" }, "description":"Target Connection name." }, { "in":"query", "name":"sourceCatalog", "schema":{ "type":"string" }, "description":"Source catalog name to be overwritten." }, { "in":"query", "name":"targetCatalog", "schema":{ "type":"string" }, "description":"Target catalog name to be overwritten." }, { "in":"query", "name":"groupName", "schema":{ "type":"string" }, "description":"Group name to be overwritten." }, { "in":"query", "name":"jobName", "schema":{ "type":"string" }, "description":"Job name to be overwritten." } ], "requestBody":{ "required":true, "content":{ "application/text":{ "schema":{ "type":"string", "format":"binary" } } } }, "responses":{ "200":{ "description":"Replicat Param File Processing Successful.\n", "content":{ "application/xml":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request..\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized..\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found..\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error..\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-vgpp-post", "x-filename-id":"services-configuration-vgpp-post" } }, "/services/configuration/import":{ "post":{ "tags":[ "Manage Import and Export/Import" ], "security":[ ], "summary":"Import Veridata XML", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Import Veridata configurations
", "operationId":"VeridataImport", "parameters":[ { "in":"query", "name":"operation", "description":"0 - create , 1 - update, 2 - delete and 3 - replace.", "schema":{ "type":"integer", "description":"O means noscripting , 1 means create, 2 means update and 3 means delete", "enum":[ 0, 1, 2, 3 ] } } ], "requestBody":{ "required":true, "content":{ "application/xml":{ "schema":{ "type":"string", "format":"binary" } } } }, "responses":{ "200":{ "description":"Import Successful.\n", "content":{ "application/xml":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-import-post", "x-filename-id":"services-configuration-import-post" } }, "/services/configuration/export":{ "get":{ "tags":[ "Manage Import and Export/Export" ], "security":[ ], "summary":"Export Veridata Configurations", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Export Veridata Configurations
", "operationId":"VeridataExport", "parameters":[ { "in":"query", "name":"jobs", "schema":{ "type":"string" }, "description":"Jobs names, multiple jobs can be selected by comma separated strings." }, { "in":"query", "name":"groups", "schema":{ "type":"string" }, "description":"Groups names, multiple groups can be selected by comma separated strings." }, { "in":"query", "name":"connections", "schema":{ "type":"string" }, "description":"Connections names, multiple connections can be selected by comma separated strings." }, { "in":"query", "name":"profiles", "schema":{ "type":"string" }, "description":"Profiles names, multiple profile can be given by comma separated strings." }, { "in":"query", "name":"all", "schema":{ "type":"boolean" }, "description":"Export all Information." }, { "in":"query", "name":"exportPassword", "schema":{ "type":"boolean" }, "description":"Export the passwords for connections. By default, passwords for connections are not exported." } ], "responses":{ "200":{ "description":"Export Successful.\n", "content":{ "application/xml":{ "schema":{ "type":"string", "format":"binary" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-export-get", "x-filename-id":"services-configuration-export-get" } }, "/auth/login":{ "get":{ "security":[ { "DigestAuth":[ ] } ], "tags":[ "Manage User Session" ], "summary":"Login to Veridata", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Retrieve User Authorization token. Pass Veridata User Credentials as part of Digest Authorization.
", "operationId":"VeridataLogin", "responses":{ "200":{ "description":"Login successful.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Login" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"auth-login-get", "x-filename-id":"auth-login-get" } }, "/session/extend":{ "get":{ "security":[ { "DigestAuth":[ ] } ], "tags":[ "Manage User Session" ], "summary":"Extend User Session", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator, JobOperator
Extends user session by extending the token. Token expiration is 1 hour.
", "operationId":"VeridataLSessionExtend", "responses":{ "200":{ "description":"Session extended successful.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Login" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"session-extend-get", "x-filename-id":"session-extend-get" } }, "/session/invalidate":{ "get":{ "tags":[ "Manage User Session" ], "security":[ ], "summary":"Invalidate Session", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator, JobOperator
Invalidates current session
", "operationId":"UserLogOut", "responses":{ "200":{ "description":"Logout Successful.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"session-invalidate-get", "x-filename-id":"session-invalidate-get" } }, "/services/preferences/favorites":{ "get":{ "tags":[ "Manage User Settings/Favorites" ], "security":[ ], "summary":"Retrieve User Favorites", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Retrieve Veridata User Favorites
", "operationId":"FetchUserFavorites", "responses":{ "200":{ "description":"User Favorites fetched successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListUserFavorites" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-preferences-favorites-get", "x-filename-id":"services-preferences-favorites-get" }, "patch":{ "tags":[ "Manage User Settings/Favorites" ], "security":[ ], "summary":"Update User Favorites", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Update Veridata User Favorites
", "operationId":"EditUserFavorites", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserFavorites" } } } }, "responses":{ "200":{ "description":"User Favorites updated successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListUserFavorites" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-preferences-favorites-patch", "x-filename-id":"services-preferences-favorites-patch" }, "post":{ "tags":[ "Manage User Settings/Favorites" ], "security":[ ], "summary":"Create User Favorites", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Create Veridata User Favorites
", "operationId":"CreateUserFavorites", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserFavorites" } } } }, "responses":{ "201":{ "description":"User Favorites created successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListUserFavorites" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-preferences-favorites-post", "x-filename-id":"services-preferences-favorites-post" } }, "/services/preferences":{ "get":{ "tags":[ "Manage User Settings/Preferences" ], "security":[ ], "summary":"Retrieve User Preferences", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Fetch User Preferences
", "operationId":"FetchUserPreferenceDetails", "responses":{ "200":{ "description":"Retrieve User Preference details successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PreferenceDetails" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-preferences-get", "x-filename-id":"services-preferences-get" }, "patch":{ "tags":[ "Manage User Settings/Preferences" ], "security":[ ], "summary":"Update User Preferences", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Update Veridata User Preferences
", "operationId":"EditUserPrefrenceDetails", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserPreferenceDetails" } } } }, "responses":{ "200":{ "description":"User Preference details updated successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PreferenceDetails" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-preferences-patch", "x-filename-id":"services-preferences-patch" } }, "/services/preferences/favorites/{type}/{Id}":{ "delete":{ "security":[ ], "tags":[ "Manage User Settings/Favorites" ], "summary":"Delete User Favorite", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Delete Veridata User Favorite
", "operationId":"DeleteUserFavorites", "parameters":[ { "name":"type", "in":"path", "description":"User favorites type", "required":true, "schema":{ "$ref":"#/components/schemas/FavoritesType" } }, { "name":"Id", "in":"path", "description":"Favorite ID. It can be a Connection or Jobs ID OR MonitorJobs RunID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-preferences-favorites-{type}-{Id}-delete", "x-filename-id":"services-preferences-favorites-type-id-delete" } }, "/services/purge/stats":{ "delete":{ "tags":[ "Purge" ], "security":[ ], "summary":"Delete Veridata statistics", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
API to purge Veridata statistics for a list of Run IDs OR bulk purge for a dateTime.\n
", "operationId":"PurgeStats", "parameters":[ { "name":"runIds", "in":"query", "schema":{ "type":"string" }, "required":false, "description":"Comma separated RunID's whose instance to be purged. Example: 1001,1002,1003", "example":"1001,1002,1003" }, { "name":"dateTime", "in":"query", "schema":{ "type":"string", "format":"date-time" }, "description":"Data to be purged before this dateTime (inclusive). Supported format yyyy-MM-dd'T'HH:mm:ss'Z'.", "example":"2023-11-10'T'08:10:23Z" } ], "responses":{ "204":{ "description":"No Content.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-purge-stats-delete", "x-filename-id":"services-purge-stats-delete" } }, "/services/repair/jobs/{runId}/stop":{ "post":{ "tags":[ "Repair" ], "security":[ ], "summary":"Stop Repair Job", "description":"Required Role: Administrator, SuperUser, CommandLineOperator, RepairOperator
Stop a running Veridata Repair job\n
", "operationId":"StopRepairJob", "parameters":[ { "name":"runId", "in":"path", "description":"The Repair Job's Run ID. Example: runId=1024,0,0.This defines a unique id for a repair job run which can be obtained from repair monitoring API.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successfully Stopped\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StopJobStatus" } } } }, "400":{ "description":"Bad Request\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-repair-jobs-{runId}-stop-post", "x-filename-id":"services-repair-jobs-runid-stop-post" } }, "/services/repair/jobs/{runId}":{ "post":{ "tags":[ "Repair" ], "security":[ ], "summary":"Repair Job", "description":"Required Role: Administrator, SuperUser, CommandLineOperator, RepairOperator
Repair Veridata Job.\n
", "operationId":"RepairComparePair", "parameters":[ { "name":"runId", "in":"path", "description":"The Comparison Job's Run ID. Example: runId=1024,0,0.This defines a unique id for a job run which can be obtained from monitoring API.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "required":false, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RepairJobRequest" } } } }, "responses":{ "200":{ "description":"Repair job was submitted successfully. Below response will be shown only when repairSQL is false. Otherwise, bytes would be returned in response.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RepairJobResponse" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-repair-jobs-{runId}-post", "x-filename-id":"services-repair-jobs-runid-post" } }, "/services/execution/jobs/{Id}":{ "post":{ "tags":[ "Run Jobs" ], "security":[ ], "summary":"Run a Job", "description":"Required Role: Administrator, SuperUser, CommandLineOperator, JobOperator, RepairOperator
Run Veridata Job.\n
", "operationId":"RunJob", "parameters":[ { "name":"Id", "in":"path", "description":"ID of the job to be run.", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "requestBody":{ "required":false, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "profileId":{ "type":"integer", "format":"int32", "default":1 }, "runRepair":{ "type":"boolean", "default":false }, "groups":{ "type":"array", "description":"", "items":{ "$ref":"#/components/schemas/RunGroup" } } }, "example":{ "profileId":"1,", "runRepair":"false,", "groups":[ { "groupId":"1001,", "comparePairs":[ { "comparePairId":"1023,", "srcPartId":"10,", "tgtPartId":10 } ] } ] } } } } }, "responses":{ "200":{ "description":"Successful operation.\n", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "runID":{ "type":"integer", "description":"Job Run ID." } } } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-execution-jobs-{Id}-post", "x-filename-id":"services-execution-jobs-id-post" } }, "/services/execution/jobs/{runId}/stop":{ "post":{ "tags":[ "Run Jobs" ], "security":[ ], "summary":"Stop Compare Pair/Job", "description":"Required Role: Administrator, SuperUser, CommandLineOperator, JobOperator
Stop a running Veridata Comparison Job or Compare Pair.\n
", "operationId":"StopJob", "parameters":[ { "name":"runId", "in":"path", "description":"The Run ID. Example: runId=1024,0,0.This defines a unique id for a job/compare pair run which can be obtained from monitoring API.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successfully stopped Job/Compare Pair.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-execution-jobs-{runId}-stop-post", "x-filename-id":"services-execution-jobs-runid-stop-post" } }, "/services/configuration/cps/validate/{Id}":{ "post":{ "tags":[ "Validate" ], "security":[ ], "summary":"Validate Compare Pairs", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Validates and returns the validation status of Compare Pairs. This will not save the validation status.\n
", "operationId":"ValidateComparePairs", "parameters":[ { "name":"Id", "in":"path", "description":"Compare Pair ID or multiple ids comma separated.", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "responses":{ "200":{ "description":"Ok.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CpValidationStatus" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-cps-validate-{Id}-post", "x-filename-id":"services-configuration-cps-validate-id-post" } }, "/services/configuration/groups/validate/{Id}":{ "post":{ "tags":[ "Validate" ], "security":[ ], "summary":"Validate Group", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Validates and return the validation status of all the Compare Pairs in the group. This will not save \nthe validation status.\n
", "operationId":"ValidateGroup", "parameters":[ { "name":"Id", "in":"path", "description":"Group id.", "required":true, "schema":{ "type":"integer", "format":"int64" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ValidateGroupRequest" } } } }, "responses":{ "200":{ "description":"Ok.\n" }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-configuration-groups-validate-{Id}-post", "x-filename-id":"services-configuration-groups-validate-id-post" } }, "/services/validate/connection":{ "post":{ "tags":[ "Validate" ], "security":[ ], "summary":"Validate Agent Connection", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Validate Agent Connection.\n
", "operationId":"ValidateAgentConnection", "requestBody":{ "description":"Agent configuration to be validated.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Agent" } } }, "required":true }, "responses":{ "200":{ "description":"Agent Connection is valid.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Agent" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-validate-connection-post", "x-filename-id":"services-validate-connection-post" } }, "/services/validate/connection/db":{ "post":{ "tags":[ "Validate" ], "security":[ ], "summary":"Validate Agent Database", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Validates Agent Database connection.\n
", "operationId":"ValidateDBConnection", "requestBody":{ "description":"To check whether Database connection is successful.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionDatabase" } } }, "required":true }, "responses":{ "200":{ "description":"Database Connection is successful.\n", "content":{ } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"services-validate-connection-db-post", "x-filename-id":"services-validate-connection-db-post" } }, "/services/logs/server/configuration":{ "patch":{ "tags":[ "Manage Logs" ], "security":[ ], "summary":"Update Server Log Configurations", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Update Server Log configurations.
", "operationId":"UpdateServerLogConfig", "requestBody":{ "required":true, "description":"Payload containing the server log configuration details.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LogConfigParamsList" } } } }, "responses":{ "200":{ "description":"Updated Server log configurations successfully", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "message":{ "type":"string", "description":"Confirmation message." } }, "example":{ "message":"Successfully set the log level!" } } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-logs-server-configuration-patch", "x-filename-id":"services-logs-server-configuration-patch" }, "get":{ "tags":[ "Manage Logs" ], "security":[ ], "summary":"Retrieve Server Log Configurations", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Retrieve Server Log configurations.\n
", "operationId":"RetrieveServerLogConfig", "responses":{ "200":{ "description":"Retrieved server log configurations successfully.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LogParams" } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-logs-server-configuration-get", "x-filename-id":"services-logs-server-configuration-get" } }, "/services/logs/server/configuration/reset":{ "put":{ "tags":[ "Manage Logs" ], "security":[ ], "summary":"Reset Server Log Configurations to Default", "description":"Required Role: Administrator, SuperUser, CommandLineOperator
Reset Server Log configurations to default log level i.e. INFO.\n
", "operationId":"ResetServerLogLevel", "responses":{ "200":{ "description":"Reset the Server Log level successfully.\n", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "message":{ "type":"string", "description":"Confirmation message." } }, "example":{ "message":"Reset the Server Log Level successfully." } } } } }, "400":{ "description":"Bad Request.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.\n", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-logs-server-configuration-reset-put", "x-filename-id":"services-logs-server-configuration-reset-put" } }, "/services/logs/server":{ "get":{ "tags":[ "Manage Logs" ], "security":[ ], "summary":"Retrieve Server Logs", "description":"Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Retrieves Server Logs for specific log type (e.g. PERF, API, ALL) and allows filtering by log level and number of lines.
", "operationId":"RetrieveServerLogs", "parameters":[ { "name":"lines", "in":"query", "description":"Number of log lines to retrieve from the end of the log file", "required":false, "schema":{ "type":"integer", "minimum":1 } }, { "name":"level", "in":"query", "description":"Filter logs by level (e.g., `SEVERE`, `WARNING`, `INFO`, `FINE`, `FINER`, `FINEST`, `ALL`)", "required":false, "schema":{ "type":"string", "enum":[ "SEVERE", "WARNING", "INFO", "FINE", "FINER", "FINEST", "ALL" ] } }, { "name":"logType", "in":"query", "description":"Filter logs by log type (e.g., `ALL`, `API`, `PERF`)", "required":false, "schema":{ "type":"string", "enum":[ "ALL", "API", "PERF" ] } }, { "name":"Accept", "in":"header", "required":false, "description":"Media type to return.", "schema":{ "type":"string", "enum":[ "application/json", "text/plain" ] } } ], "responses":{ "200":{ "description":"Logs retrieved successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "content":{ "type":"array", "items":{ "type":"string" } } }, "example":{ "content":[ "[2025.04.07 13:19:23IST+0530] [WARN] [io.smallrye.openapi.runtime.scanner][Thread[main,5,main]]: SROAP04005: Could not find schema class in index: com.oracle.goldengate.veridata.Profile", "[2025.04.07 13:19:23IST+0530] [WARN] [io.smallrye.openapi.runtime.scanner][Thread[main,5,main]]: SROAP04005: Could not find schema class in index: com.oracle.goldengate.veridata.Profile", "[2025.04.07 13:19:23IST+0530] [WARN] [io.smallrye.openapi.runtime.scanner][Thread[main,5,main]]: SROAP04005: Could not find schema class in index: com.oracle.goldengate.veridata.Profile" ] } } }, "text/plain":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Server Error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"services-logs-server-get", "x-filename-id":"services-logs-server-get" } } }, "components":{ "securitySchemes":{ "DigestAuth":{ "type":"http", "scheme":"digest" }, "BearerAuth":{ "type":"http", "scheme":"bearer" }, "RolesAuth":{ "type":"http", "scheme":"bearer", "description":"Bearer token for role-based access" } }, "schemas":{ "Agent":{ "type":"object", "properties":{ "host":{ "type":"string", "description":"Agent host." }, "port":{ "type":"integer", "description":"Agent port." }, "ssl":{ "type":"boolean", "description":"Use Secure Socket Layer (SSL) for Server-Agent communication.", "default":false }, "dbType":{ "$ref":"#/components/schemas/DatabaseType" } }, "required":[ "host", "port" ], "example":{ "host":"100.101.98.100", "port":8089, "ssl":false, "dbType":"ORACLE" } }, "RetrieveConnectionSettings":{ "type":"object", "properties":{ "name":{ "type":"string" }, "default":{ "type":"boolean" }, "defaultValue":{ "type":"object" }, "value":{ "type":"object" }, "type":{ "type":"string", "enum":[ "BOOLEAN", "ENUM", "INTEGER", "STRING" ] }, "min":{ "type":"integer" }, "max":{ "type":"integer" } }, "example":[ { "default":true, "defaultValue":true, "name":"useSourceTargetAsKeys", "type":"BOOLEAN", "value":"true" }, { "default":true, "defaultValue":true, "name":"useAllColsAsKeys", "type":"BOOLEAN", "value":"true" }, { "default":true, "defaultValue":1000, "name":"fetchSize", "type":"INTEGER", "value":"1000" }, { "default":true, "min":0, "max":10000000, "defaultValue":3600, "name":"agentTimeout", "type":"INTEGER", "value":"3600" } ] }, "ConnectionSettings":{ "type":"object", "properties":{ "agentTimeout":{ "type":"integer", "description":"Agent Message Timeout in seconds.", "format":"int32", "default":3600 }, "trimTrailingSpaces":{ "type":"boolean", "description":"Truncate trailing spaces when comparing values.", "default":true }, "fetchSize":{ "type":"integer", "description":"Initial Compare Fetch Batch Size.", "format":"int32", "default":1000 }, "ssl":{ "type":"boolean", "description":"Use Secure Socket Layer (SSL) for server-agent communication.", "default":false }, "useSourceTargetAsKeys":{ "type":"boolean", "description":"Use Source or Target Columns as Key columns when generating ompare. Pairs", "default":true }, "useAllColsAsKeys":{ "type":"boolean", "description":"Use all Columns as Key columns when generating Compare Pairs.", "default":true } } }, "ConnectionProperty":{ "type":"object", "properties":{ "dataType":{ "type":"string" }, "compareFormat":{ "$ref":"#/components/schemas/CompareFormat" }, "precision":{ "type":"integer", "format":"int32" }, "scale":{ "type":"integer", "format":"int32" }, "timezone":{ "type":"string" }, "isDefault":{ "type":"boolean", "description":"Defines if default property is used or not.", "default":true } } }, "UpdateConnectionProperty":{ "type":"object", "properties":{ "dataType":{ "type":"string" }, "compareFormat":{ "$ref":"#/components/schemas/UpdateCompareFormat" } } }, "UpdateCompareFormat":{ "type":"object", "properties":{ "formatName":{ "$ref":"#/components/schemas/CompareFormat" }, "precision":{ "type":"integer", "format":"int32" }, "scale":{ "type":"integer", "format":"int32" }, "timezone":{ "type":"string" } } }, "CreateVeridataAgent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/AgentRequest" } ] }, "AgentConfigureResponse":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/AgentCreateResponse" } ], "properties":{ "coosJoinPrivate":{ "type":"boolean", "default":true, "description":"This parameter decides whether confirm-out-of-sync phase uses private temporary tables or not. When false uses Global temporary tables. This is applicable only for Oracle Agent." }, "coosBatch":{ "type":"boolean", "default":true, "description":"This parameter decides whether confirm-out-of-sync batch has to be carried or not." }, "databaseDriver":{ "type":"string", "description":"JDBC driver(s) used by Agent to connect to Database." } } }, "AgentDetailsResponse":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/AgentCreateResponse" } ], "properties":{ "poolMaxSize":{ "type":"integer", "format":"int32", "description":"Database connection pool. Default is 20." }, "poolIdleConnections":{ "type":"integer", "format":"int32", "description":"Maximum number of Database idle connections in a pool. Default is 20." }, "poolIdleTime":{ "type":"integer", "format":"int32", "description":"Maximum number of time connections can be left idle in a pool. Values are given in seconds. Default is 300 seconds." }, "zlibBufferFlushSize":{ "type":"integer", "format":"int64", "description":"This parameter is used in flushing the data. Decrease the value to a lower value (say 700000) if the agent appears to be in hanged state and the CPU usage for agent process is about 100%. Value should be between 10000 and 2000000. Default value is 1000000." }, "rowscn":{ "type":"integer", "format":"int64", "description":"This parameter is used only in Oracle Agent. It decides from which rowscn data has to be compared." }, "coosJoinPrivate":{ "type":"boolean", "default":true, "description":"This parameter decides whether confirm-out-of-sync phase uses private temporary tables or not. When false uses Global temporary tables. This is applicable only for Oracle Agent." }, "coosBatch":{ "type":"boolean", "default":true, "description":"This parameter decides whether confirm-out-of-sync batch has to be carried or not." }, "databaseDriver":{ "type":"string", "description":"JDBC driver(s) used by Agent to connect to Database." } } }, "VdtAgent":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Agent Name." }, "description":{ "type":"string", "description":"Agent Description." }, "host":{ "type":"string", "description":"Veridata Agent Host." }, "port":{ "type":"integer", "description":"Veridata Agent Port.", "format":"int32" }, "sslMode":{ "$ref":"#/components/schemas/SslMode" } } }, "AgentResponse":{ "type":"object", "properties":{ "host":{ "type":"string", "description":"Veridata Agent Host." }, "name":{ "type":"string", "description":"Agent Name." }, "port":{ "type":"integer", "description":"Veridata Agent Port.", "format":"int32" }, "id":{ "type":"integer", "description":"Agent Id.", "format":"int64" }, "sslMode":{ "$ref":"#/components/schemas/SslMode" }, "createdOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "modifiedOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "description":{ "type":"string" } } }, "AgentCreateResponse":{ "type":"object", "properties":{ "host":{ "type":"string", "description":"Veridata Agent Host." }, "name":{ "type":"string", "description":"Agent Name." }, "port":{ "type":"integer", "description":"Veridata Agent Port.", "format":"int32" }, "id":{ "type":"integer", "description":"Agent Id.", "format":"int64" }, "sslMode":{ "$ref":"#/components/schemas/SslMode" }, "databaseConnectionId":{ "type":"integer", "format":"int32" }, "createdOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "modifiedOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "description":{ "type":"string" } } }, "DatabaseVariant":{ "type":"object", "required":[ "version", "variant" ], "properties":{ "version":{ "type":"integer", "description":"Database major version" }, "variant":{ "type":"string", "description":"Database variant or build identifier" } } }, "DatabaseSupport":{ "type":"object", "properties":{ "includes":{ "type":"object", "description":"Supported databases and their versions", "additionalProperties":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseVariant" } } }, "excludes":{ "type":"object", "description":"Unsupported databases and their versions", "additionalProperties":{ "type":"array", "items":{ "$ref":"#/components/schemas/DatabaseVariant" } } } } }, "FeatureType":{ "type":"string", "description":"Features supported by Veridata.", "enum":[ "CDB", "AUTO_PARTITION", "TABLE_PARTITION", "SKIP_ROWS", "REPAIR_SQL", "COMPARISON_BY_ROWCOUNT", "COOS_JOIN" ] }, "Feature":{ "type":"object", "required":[ "name", "databases" ], "properties":{ "name":{ "$ref":"#/components/schemas/FeatureType" }, "databases":{ "$ref":"#/components/schemas/DatabaseSupport" } } }, "AgentAttributes":{ "type":"object", "properties":{ "version":{ "type":"string" }, "protocolVersion":{ "type":"string" }, "features":{ "type":"array", "items":{ "$ref":"#/components/schemas/Feature" } } } }, "AgentInfo":{ "type":"object", "properties":{ "attributes":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgentAttributes" } } }, "example":{ "attributes":[ { "features":[ { "databases":{ "includes":{ "Snowflake":[ ], "MongoDB":[ ], "Databricks":[ ], "Oracle":[ ], "SQLServer":[ ] } }, "name":"REPAIR_SQL" } ], "protocolVersion":"2" } ] } }, "AgentUpdateRequest":{ "type":"object", "properties":{ "poolMaxSize":{ "type":"integer", "format":"int32", "description":"Database connection pool. Default is 20." }, "poolIdleConnections":{ "type":"integer", "format":"int32", "description":"Maximum number of Database idle connections in a pool. Default is 20." }, "poolIdleTime":{ "type":"integer", "format":"int32", "description":"Maximum number of time connections can be left idle in a pool. Values are given in seconds. Default is 300 seconds." }, "zlibBufferFlushSize":{ "type":"integer", "format":"int64", "description":"This parameter is used in flushing the data. Decrease the value to a lower value (say 700000) if the agent appears to be in hanged state and the CPU usage for agent process is about 100%. Value should be between 10000 and 2000000. Default value is 1000000." }, "rowscn":{ "type":"integer", "format":"int64", "description":"This parameter is used only in Oracle Agent. It decides from which rowscn data has to be compared." }, "coosJoinPrivate":{ "type":"boolean", "description":"This parameter decides whether confirm-out-of-sync phase uses private temporary tables or not. When false uses Global temporary tables. This is applicable only for Oracle Agent." }, "coosBatch":{ "type":"boolean", "description":"This parameter decides whether confirm-out-of-sync batch has to be carried or not." }, "description":{ "type":"string", "description":"Agent Description." }, "host":{ "type":"string", "description":"Veridata Agent Host." }, "port":{ "type":"integer", "description":"Veridata Agent Port.", "format":"int32" }, "sslMode":{ "$ref":"#/components/schemas/SslMode" } } }, "SslMode":{ "type":"string", "description":"SSL mode between Veridata Agent and Veridata Server.", "default":"TWO_WAY", "enum":[ "NO_SSL", "ONE_WAY", "TWO_WAY" ] }, "AgentRequest":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Agent Name." }, "description":{ "type":"string", "description":"Agent Description." }, "host":{ "type":"string", "description":"Veridata Agent Host." }, "port":{ "type":"integer", "description":"Veridata Agent Port.", "format":"int32" }, "sslMode":{ "$ref":"#/components/schemas/SslMode" } }, "required":[ "host", "port", "name" ], "example":{ "name":"Oracle-Agent-Source", "description":"Oracle Agent", "host":"100.00.00.00", "port":7800, "sslMode":"TWO_WAY" } }, "BaseConnection":{ "type":"object", "properties":{ "id":{ "type":"integer", "description":"Connection Id.", "format":"int64" }, "name":{ "type":"string", "description":"Connection Name." }, "description":{ "type":"string", "description":"Connection Description." }, "host":{ "type":"string", "description":"Veridata Agent Host." }, "port":{ "type":"integer", "description":"Veridata Agent Port.", "format":"int32" }, "createdOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "updatedOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" } }, "example":{ "createdOn":"2025-04-02T11:20:51.269Z", "description":"Connection to source Oracle Database", "host":"100.00.00.00", "id":1090, "name":"Oracle-Connection-Source", "port":7800 } }, "DatabaseConnection":{ "type":"object", "discriminator":{ "propertyName":"connectionType", "mapping":{ "ORACLE":"./connections/oracle/definitions.cond.yaml#/components/schemas/RetrieveOracleConnection", "SNOWFLAKE":"./connections/snowflake/definitions.cond.yaml#/components/schemas/SnowflakeConnectionSummary", "MYSQL":"./connections/mysql/definitions.cond.yaml#/components/schemas/MysqlConnectionSummary", "POSTGRESQL":"./connections/postgresql/definitions.cond.yaml#/components/schemas/PostgresqlConnectionSummary", "DATABRICKS":"./connections/databricks/definitions.cond.yaml#/components/schemas/DatabricksConnectionSummary", "MONGODB":"./connections/mongodb/definitions.cond.yaml#/components/schemas/MongoDbConnectionSummary", "SQLSERVER":"./connections/microsoftsqlserver/definitions.cond.yaml#/components/schemas/MicrosoftSqlserverConnectionSummary" } }, "oneOf":[ { "type":"object", "allOf":[ { "type":"object", "properties":{ "id":{ "type":"integer", "description":"Object Id.", "format":"int64" }, "createdOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" }, "modifiedOn":{ "type":"string", "format":"date-time", "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ", "example":"2024-02-03T10:15:30Z" } } } ], "properties":{ "connectionType":{ "type":"string", "enum":[ "ORACLE" ] }, "technologyType":{ "type":"string", "enum":[ "AMAZON_RDS_ORACLE", "OCI_AUTONOMOUS_DATABASE", "ORACLE_DATABASE", "ORACLE_EXADATA", "ORACLE_EXADATA_DATABASE_AT_AZURE", "ORACLE_AUTONOMOUS_DATABASE_AT_AZURE", "ORACLE_EXADATA_DATABASE_AT_GOOGLE_CLOUD", "ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD", "ORACLE_EXADATA_DATABASE_AT_AWS", "ORACLE_AUTONOMOUS_DATABASE_AT_AWS" ] }, "username":{ "type":"string", "minLength":1, "maxLength":255 }, "authenticationMode":{ "type":"string", "enum":[ "TLS", "MTLS" ] }, "connectionString":{ "type":"string", "minLength":1, "maxLength":255 } } }, { "description":"Summary of the Snowflake Connection.\n", "type":"object", "allOf":[ { "$ref":"#/components/schemas/DatabaseConnection/oneOf/0/allOf/0" }, { "discriminator":"SNOWFLAKE", "required":[ "technologyType", "connectionUrl", "authenticationType" ], "properties":{ "connectionType":{ "description":"Database connection type.", "type":"string", "enum":[ "SNOWFLAKE" ] }, "technologyType":{ "description":"Snowflake technology type.", "type":"string", "enum":[ "SNOWFLAKE" ] }, "connectionUrl":{ "description":"JDBC connection URL.\ne.g.: 'jdbc:snowflake://