Retrieve Schedule
get
[host-url]/dt-rest/v2/schedules/{scheduleId}
Retrieves a schedule by ID.
Request
Path Parameters
-
scheduleId(required): string
ID of the schedule to retrieve.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
A JSON response containing a schedule.
Root Schema : schema
Match All
Represents a job schedule with additional information.
Show Source
-
object
JobScheduleBaseDTO
Represents a job schedule with basic information.
-
object
type
Represents a job schedule with additional information.
Example:
{
"scheduleId":"String",
"scheduleNumber":123,
"name":"String",
"designObjectType":"String",
"designObjectName":"String",
"designObjectId":"String",
"status":"String",
"activeFromDate":"String",
"activeEndDate":"String",
"designObjectNumber":123,
"variables":[
{
"name":"String",
"type":{
},
"lastValue":{
},
"defaultNumericValue":123,
"defaultDateValue":"2026-07-11T17:31:43.062577Z",
"defaultShortText":"String",
"defaultLongText":"String",
"variableOrder":123
}
],
"dailyActivationTimeRange":"String",
"excludeMonthDays":"String",
"excludeWeekDays":"String",
"recurrence":"String",
"repetition":"String",
"repetitionParams":{
},
"numberOfAttemptsAfterFailures":123,
"maxDuration":"String",
"timeZone":"String",
"serverTimeZone":"String",
"repositoryTimeZone":"String",
"serverRecurrence":"String",
"errorMessage":"String"
}Nested Schema : JobScheduleBaseDTO
Type:
objectRepresents a job schedule with basic information.
Show Source
Nested Schema : type
Type:
objectRepresents a job schedule with additional information.
Show Source
-
dailyActivationTimeRange: string
-
designObjectNumber: integer
(int64)
-
errorMessage: string
-
excludeMonthDays: string
-
excludeWeekDays: string
-
maxDuration: string
-
numberOfAttemptsAfterFailures: integer
(int32)
-
recurrence: string
-
repetition: string
-
repetitionParams: object
repetitionParams
Complex object: RepetitionDTO
-
repositoryTimeZone: string
-
serverRecurrence: string
-
serverTimeZone: string
-
timeZone: string
-
variables: array
variables
Nested Schema : repetitionParams
Type:
objectComplex object: RepetitionDTO
Nested Schema : variables
Type:
Show Source
array-
Array of:
object RuntimeVariableDTO
Represents a Data Transforms Variable during runtime.
Nested Schema : RuntimeVariableDTO
Type:
objectRepresents a Data Transforms Variable during runtime.
Show Source
-
defaultDateValue: string
(date-time)
-
defaultLongText: string
-
defaultNumericValue: integer
(int64)
-
defaultShortText: string
-
lastValue: object
lastValue
Complex object: Object
-
name: string
-
type: object
type
Complex object: VariableType
-
variableOrder: integer
(int64)
Nested Schema : lastValue
Type:
objectComplex object: Object
Nested Schema : type
Type:
objectComplex object: VariableType
Examples
401 Response
Unauthorized
404 Response
Not Found