Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

A JSON response containing a schedule.

Body ()

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/JobScheduleBaseDTO"
        },
        {
            "type":"object",
            "description":"Represents a job schedule with additional information.",
            "properties":{
                "designObjectNumber":{
                    "type":"integer",
                    "format":"int64"
                },
                "variables":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "description":"Complex object: ScenarioVariableDTO"
                    }
                },
                "dailyActivationTimeRange":{
                    "type":"string"
                },
                "excludeMonthDays":{
                    "type":"string"
                },
                "excludeWeekDays":{
                    "type":"string"
                },
                "recurrence":{
                    "type":"string"
                },
                "repetition":{
                    "type":"string"
                },
                "repetitionParams":{
                    "type":"object",
                    "description":"Complex object: RepetitionDTO"
                },
                "numberOfAttemptsAfterFailures":{
                    "type":"integer",
                    "format":"int32"
                },
                "maxDuration":{
                    "type":"string"
                },
                "timeZone":{
                    "type":"string"
                },
                "serverTimeZone":{
                    "type":"string"
                },
                "repositoryTimeZone":{
                    "type":"string"
                },
                "serverRecurrence":{
                    "type":"string"
                },
                "errorMessage":{
                    "type":"string"
                }
            }
        }
    ],
    "example":{
        "name":"your_schedule_name",
        "status":"ACTIVE_FOR_PERIOD",
        "designObjectType":"Data Flow",
        "designObjectId":"c589c90f-0fab-40fc-b45a-401cff663556",
        "activeEndDate":"2025-12-19T11:39:00",
        "activeFromDate":"2025-08-18T11:39:23",
        "dailyActivationTimeRange":"T11:39:23 T23:39:00",
        "excludeWeekDays":"TUESDAY,SUNDAY",
        "excludeMonthDays":"",
        "maxDuration":"2 MINUTE",
        "numberOfAttemptsAfterFailures":0,
        "recurrence":"SIMPLE 2025-03-14T17:25:00",
        "repetition":"None"
    }
}

Example:

{
    "name":"your_schedule_name",
    "status":"ACTIVE_FOR_PERIOD",
    "designObjectType":"Data Flow",
    "designObjectId":"c589c90f-0fab-40fc-b45a-401cff663556",
    "activeEndDate":"2025-12-19T11:39:00",
    "activeFromDate":"2025-08-18T11:39:23",
    "dailyActivationTimeRange":"T11:39:23 T23:39:00",
    "excludeWeekDays":"TUESDAY,SUNDAY",
    "excludeMonthDays":"",
    "maxDuration":"2 MINUTE",
    "numberOfAttemptsAfterFailures":0,
    "recurrence":"SIMPLE 2025-03-14T17:25:00",
    "repetition":"None"
}

Nested Schema : JobScheduleBaseDTO

Type: object

Represents a job schedule with basic information.

Show Source

• activeEndDate: string
• activeFromDate: string
• designObjectId: string
• designObjectName: string
• designObjectType(required): string
• name(required): string
• scheduleId: string
• scheduleNumber: integer (int64)
• status(required): string

{
    "type":"object",
    "description":"Represents a job schedule with basic information.",
    "required":[
        "designObjectType",
        "name",
        "status"
    ],
    "properties":{
        "scheduleId":{
            "type":"string"
        },
        "scheduleNumber":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "designObjectType":{
            "type":"string"
        },
        "designObjectName":{
            "type":"string"
        },
        "designObjectId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "activeFromDate":{
            "type":"string"
        },
        "activeEndDate":{
            "type":"string"
        }
    }
}

Nested Schema : type

Type: object

Represents 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

{
    "type":"object",
    "description":"Represents a job schedule with additional information.",
    "properties":{
        "designObjectNumber":{
            "type":"integer",
            "format":"int64"
        },
        "variables":{
            "type":"array",
            "items":{
                "type":"object",
                "description":"Complex object: ScenarioVariableDTO"
            }
        },
        "dailyActivationTimeRange":{
            "type":"string"
        },
        "excludeMonthDays":{
            "type":"string"
        },
        "excludeWeekDays":{
            "type":"string"
        },
        "recurrence":{
            "type":"string"
        },
        "repetition":{
            "type":"string"
        },
        "repetitionParams":{
            "type":"object",
            "description":"Complex object: RepetitionDTO"
        },
        "numberOfAttemptsAfterFailures":{
            "type":"integer",
            "format":"int32"
        },
        "maxDuration":{
            "type":"string"
        },
        "timeZone":{
            "type":"string"
        },
        "serverTimeZone":{
            "type":"string"
        },
        "repositoryTimeZone":{
            "type":"string"
        },
        "serverRecurrence":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : repetitionParams

Type: object

Complex object: RepetitionDTO

Nested Schema : variables

Type: array

Show Source

• Array of: object items
  Complex object: ScenarioVariableDTO

{
    "type":"array",
    "items":{
        "type":"object",
        "description":"Complex object: ScenarioVariableDTO"
    }
}

Nested Schema : items

Type: object

Complex object: ScenarioVariableDTO

401 Response

Unauthorized

404 Response

Not Found

Back to Top