Retrieve Schedule

get

[host-url]/dt-rest/v2/schedules/{scheduleId}

Retrieves a schedule by ID.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

A JSON response containing a schedule.
Body ()
Root Schema : schema
Match All
Represents a job schedule with additional information.
Show Source
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: object
Represents a job schedule with basic information.
Show Source
Nested Schema : type
Type: object
Represents a job schedule with additional information.
Show Source
Nested Schema : repetitionParams
Type: object
Complex object: RepetitionDTO
Nested Schema : variables
Type: array
Show Source
Nested Schema : RuntimeVariableDTO
Type: object
Represents a Data Transforms Variable during runtime.
Show Source
Nested Schema : lastValue
Type: object
Complex object: Object
Nested Schema : type
Type: object
Complex object: VariableType
Examples

401 Response

Unauthorized

404 Response

Not Found
Back to Top