1. REST API for Oracle Data Transforms
  2. Tasks
  3. Schedule

Create Schedule

post

[host-url]/dt-rest/v2/schedules

Creates a new schedule for a job or an executable design object. The details of the schedule, including the target object, recurrence, and variables, should be provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
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
Back to Top

Response

Supported Media Types

200 Response

A Response object containing the created 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

403 Response

Forbidden

404 Response

Not Found

409 Response

Conflict
Back to Top