Package org.qubership.atp.tdm.controllers.api

Interface DataRefreshControllerApi

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-09-12T06:59:11.597365407Z[Etc/UTC]")
@Validated
public interface DataRefreshControllerApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<String>	getNextScheduledRun(@NotNull @Valid String cronExpression)	GET /api/tdm/data/refresh/next/run : Get next run's date / time details.
org.springframework.http.ResponseEntity<TestDataRefreshConfigDto>	getRefreshConfig(UUID id)	GET /api/tdm/data/refresh/config/{id} : Get refresh configuration for specified dataset / table ID.
org.springframework.http.ResponseEntity<List<RefreshResultsDto>>	runDataRefresh(@NotNull @Valid String tableName, @NotNull @Valid Integer queryTimeout, @NotNull @Valid Boolean allEnv)	POST /api/tdm/data/refresh/run : Force run data refresh.
org.springframework.http.ResponseEntity<TestDataRefreshConfigDto>	saveRefreshConfig(@NotNull @Valid String tableName, @NotNull @Valid Integer queryTimeout, @Valid TestDataRefreshConfigDto testDataRefreshConfigDto)	POST /api/tdm/data/refresh/config : Save / update data refresh settings.

Method Details

getNextScheduledRun

@RequestMapping(method=GET,
                value="/api/tdm/data/refresh/next/run",
                produces="application/json")
org.springframework.http.ResponseEntity<String> getNextScheduledRun(@NotNull @Valid @RequestParam(value="cronExpression",required=true)
 @NotNull @Valid String cronExpression)

GET /api/tdm/data/refresh/next/run : Get next run's date / time details.

Parameters:

cronExpression - cronExpression (required)

Returns:

OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

getRefreshConfig

@RequestMapping(method=GET,
                value="/api/tdm/data/refresh/config/{id}",
                produces="application/json")
org.springframework.http.ResponseEntity<TestDataRefreshConfigDto> getRefreshConfig(@PathVariable("id")
 UUID id)

GET /api/tdm/data/refresh/config/{id} : Get refresh configuration for specified dataset / table ID.

Parameters:

id - id (required)

Returns:

OK (status code 200) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

runDataRefresh

@RequestMapping(method=POST,
                value="/api/tdm/data/refresh/run",
                produces="application/json")
org.springframework.http.ResponseEntity<List<RefreshResultsDto>> runDataRefresh(@NotNull @Valid @RequestParam(value="tableName",required=true)
 @NotNull @Valid String tableName,
 @NotNull @Valid @RequestParam(value="queryTimeout",required=true)
 @NotNull @Valid Integer queryTimeout,
 @NotNull @Valid @RequestParam(value="allEnv",required=true)
 @NotNull @Valid Boolean allEnv)

POST /api/tdm/data/refresh/run : Force run data refresh.

Parameters:

tableName - tableName (required)

queryTimeout - queryTimeout (required)

allEnv - allEnv (required)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)

saveRefreshConfig

@RequestMapping(method=POST,
                value="/api/tdm/data/refresh/config",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<TestDataRefreshConfigDto> saveRefreshConfig(@NotNull @Valid @RequestParam(value="tableName",required=true)
 @NotNull @Valid String tableName,
 @NotNull @Valid @RequestParam(value="queryTimeout",required=true)
 @NotNull @Valid Integer queryTimeout,
 @Valid @RequestBody(required=false)
 @Valid TestDataRefreshConfigDto testDataRefreshConfigDto)

POST /api/tdm/data/refresh/config : Save / update data refresh settings.

Parameters:

tableName - tableName (required)

queryTimeout - queryTimeout (required)

testDataRefreshConfigDto - (optional)

Returns:

OK (status code 200) or Created (status code 201) or Unauthorized (status code 401) or Forbidden (status code 403) or Not Found (status code 404)