REST API for Oracle Data Transforms

Root Schema : DataLoadDTO

Match All

Represents a detailed data load object, extending DataLoadBaseDTO.

Show Source

object DataLoadBaseDTO

Represents a base data load object, containing minimal attributes for data load operations.
object DataLoadDTO-allOf[1]

Represents a detailed data load object, extending DataLoadBaseDTO.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataLoadBaseDTO"
        },
        {
            "type":"object",
            "description":"Represents a detailed data load object, extending DataLoadBaseDTO.",
            "properties":{
                "sourceSchema":{
                    "$ref":"#/components/schemas/DataLoadSchemaDTO"
                },
                "targetSchema":{
                    "$ref":"#/components/schemas/DataLoadSchemaDTO"
                },
                "dataLoadOptions":{
                    "$ref":"#/components/schemas/DataLoadOptionsDTO"
                },
                "validationMessages":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ],
    "example":{
        "dataLoadNumber":123,
        "dataLoadId":"String",
        "name":"String",
        "description":"String",
        "projectId":"String",
        "projectName":"String",
        "dateCreated":"2026-07-11T17:31:42.998971Z",
        "dateUpdated":"2026-07-11T17:31:42.998991Z",
        "dataLoadMode":"INITIAL",
        "sourceSchema":{
            "schemaId":"String",
            "shortName":"String",
            "parentConnection":"String"
        },
        "targetSchema":{
            "schemaId":"String",
            "shortName":"String",
            "parentConnection":"String"
        },
        "dataLoadOptions":{
            "namingConvention":"String",
            "reservedWords":"String",
            "liveTablesList":[
                "String"
            ],
            "liveTablesMap":{
                "key":[
                    "String"
                ]
            },
            "biccExecutionMode":"String",
            "kmOptions":{
                "key":[
                    {
                        "optionName":"String",
                        "optionValue":"String",
                        "optionType":"String",
                        "setAsDefault":true,
                        "description":"String",
                        "help":"String",
                        "defaultValue":"String",
                        "choiceValues":[
                            "String"
                        ]
                    }
                ]
            },
            "kmOptions_RERUN":{
                "key":[
                    {
                        "optionName":"String",
                        "optionValue":"String",
                        "optionType":"String",
                        "setAsDefault":true,
                        "description":"String",
                        "help":"String",
                        "defaultValue":"String",
                        "choiceValues":[
                            "String"
                        ]
                    }
                ]
            },
            "offerings":[
                "String"
            ],
            "auditing":{
                "key":{
                    "enabled":true,
                    "description":"String"
                }
            },
            "tablesToDeleteInTGT":[
                "String"
            ]
        },
        "validationMessages":[
            "String"
        ]
    }
}

Example:

{
    "dataLoadNumber":123,
    "dataLoadId":"String",
    "name":"String",
    "description":"String",
    "projectId":"String",
    "projectName":"String",
    "dateCreated":"2026-07-11T17:31:42.998971Z",
    "dateUpdated":"2026-07-11T17:31:42.998991Z",
    "dataLoadMode":"INITIAL",
    "sourceSchema":{
        "schemaId":"String",
        "shortName":"String",
        "parentConnection":"String"
    },
    "targetSchema":{
        "schemaId":"String",
        "shortName":"String",
        "parentConnection":"String"
    },
    "dataLoadOptions":{
        "namingConvention":"String",
        "reservedWords":"String",
        "liveTablesList":[
            "String"
        ],
        "liveTablesMap":{
            "key":[
                "String"
            ]
        },
        "biccExecutionMode":"String",
        "kmOptions":{
            "key":[
                {
                    "optionName":"String",
                    "optionValue":"String",
                    "optionType":"String",
                    "setAsDefault":true,
                    "description":"String",
                    "help":"String",
                    "defaultValue":"String",
                    "choiceValues":[
                        "String"
                    ]
                }
            ]
        },
        "kmOptions_RERUN":{
            "key":[
                {
                    "optionName":"String",
                    "optionValue":"String",
                    "optionType":"String",
                    "setAsDefault":true,
                    "description":"String",
                    "help":"String",
                    "defaultValue":"String",
                    "choiceValues":[
                        "String"
                    ]
                }
            ]
        },
        "offerings":[
            "String"
        ],
        "auditing":{
            "key":{
                "enabled":true,
                "description":"String"
            }
        },
        "tablesToDeleteInTGT":[
            "String"
        ]
    },
    "validationMessages":[
        "String"
    ]
}

Nested Schema : DataLoadBaseDTO

Type: object

Represents a base data load object, containing minimal attributes for data load operations.

Show Source

dataLoadId: string
dataLoadMode: string
Allowed Values: [ "INITIAL", "INCREMENTAL", "GOLDENGATE", "DELTASHARE", "ICEBERG_TARGET", "ICEBERG_INCREMENTAL" ]
Enumerates the possible modes for data load operations.
- Initial: Loads all data for the first time.
- Incremental: Loads only new or changed data since the last load.
- Golden Gate: Uses Oracle GoldenGate for real-time data integration.
- Delta Share: Loads data via a Delta Sharing protocol.
- Iceberg target: Loads data directly into an Apache Iceberg table (target).
- Iceberg incremental: Loads only incremental changes into an Apache Iceberg table.
dataLoadNumber: integer (int64)
dateCreated: string (date-time)
dateUpdated: string (date-time)
description: string
name(required): string
projectID: string
projectName: string

{
    "type":"object",
    "description":"Represents a base data load object, containing minimal attributes for data load operations.",
    "required":[
        "name"
    ],
    "properties":{
        "dataLoadNumber":{
            "type":"integer",
            "format":"int64"
        },
        "dataLoadId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "projectID":{
            "type":"string"
        },
        "projectName":{
            "type":"string"
        },
        "dateCreated":{
            "type":"string",
            "format":"date-time"
        },
        "dateUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "dataLoadMode":{
            "$ref":"#/components/schemas/DataLoadMode"
        }
    }
}

Nested Schema : DataLoadDTO-allOf[1]

Type: object

Represents a detailed data load object, extending DataLoadBaseDTO.

Show Source

dataLoadOptions: object DataLoadOptionsDTO

Exposes per-run configuration flags used by data load REST endpoints.
Every property corresponds to a JSON field expected when configuring a data load request, covering naming conventions, live table selection, Knowledge Module (KM) overrides, and audit metadata.
sourceSchema: object DataLoadSchemaDTO

Represents a data load schema.
targetSchema: object DataLoadSchemaDTO

Represents a data load schema.
validationMessages: array validationMessages

{
    "type":"object",
    "description":"Represents a detailed data load object, extending DataLoadBaseDTO.",
    "properties":{
        "sourceSchema":{
            "$ref":"#/components/schemas/DataLoadSchemaDTO"
        },
        "targetSchema":{
            "$ref":"#/components/schemas/DataLoadSchemaDTO"
        },
        "dataLoadOptions":{
            "$ref":"#/components/schemas/DataLoadOptionsDTO"
        },
        "validationMessages":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : DataLoadOptionsDTO

Type: object

Exposes per-run configuration flags used by data load REST endpoints.

Every property corresponds to a JSON field expected when configuring a data load request, covering naming conventions, live table selection, Knowledge Module (KM) overrides, and audit metadata.

Show Source

auditing: object auditing

Additional Properties Allowed: DTAuditField
biccExecutionMode: string
kmOptions: object kmOptions

Additional Properties Allowed: additionalProperties
kmOptions_RERUN: object kmOptions_RERUN

Additional Properties Allowed: additionalProperties
liveTablesList: array liveTablesList
liveTablesMap: object liveTablesMap

Additional Properties Allowed: additionalProperties
namingConvention: string
offerings: array offerings
reservedWords: string
tablesToDeleteInTGT: array tablesToDeleteInTGT

{
    "type":"object",
    "description":"Exposes per-run configuration flags used by data load REST endpoints. <p>Every property corresponds to a JSON field expected when configuring a data load request, covering naming conventions, live table selection, Knowledge Module (KM) overrides, and audit metadata.</p>",
    "properties":{
        "namingConvention":{
            "type":"string"
        },
        "reservedWords":{
            "type":"string"
        },
        "liveTablesList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "liveTablesMap":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "biccExecutionMode":{
            "type":"string"
        },
        "kmOptions":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/components/schemas/DTKMOption"
                }
            }
        },
        "kmOptions_RERUN":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/components/schemas/DTKMOption"
                }
            }
        },
        "offerings":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "auditing":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/DTAuditField"
            }
        },
        "tablesToDeleteInTGT":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : DataLoadSchemaDTO

Type: object

Represents a data load schema.

Show Source

parentConnection: string
schemaId: string
shortName: string

{
    "type":"object",
    "description":"Represents a data load schema.",
    "properties":{
        "schemaId":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        },
        "parentConnection":{
            "type":"string"
        }
    }
}

Nested Schema : validationMessages

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : auditing

Type: object

Additional Properties Allowed

Show Source

object DTAuditField

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/DTAuditField"
    }
}

Nested Schema : kmOptions

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/components/schemas/DTKMOption"
        }
    }
}

Nested Schema : kmOptions_RERUN

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/components/schemas/DTKMOption"
        }
    }
}

Nested Schema : liveTablesList

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : liveTablesMap

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : offerings

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : tablesToDeleteInTGT

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : DTAuditField

Type: object

Show Source

description: string
enabled: boolean

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object DTKMOption

Represents Knowledge Module Options in Data Transforms.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DTKMOption"
    }
}

Nested Schema : DTKMOption

Type: object

Represents Knowledge Module Options in Data Transforms.

Show Source

choiceValues: array choiceValues
defaultValue: string
description: string
help: string
optionName: string
optionType: string
optionValue: string
setAsDefault: boolean

{
    "type":"object",
    "description":"Represents Knowledge Module Options in Data Transforms.",
    "properties":{
        "optionName":{
            "type":"string"
        },
        "optionValue":{
            "type":"string"
        },
        "optionType":{
            "type":"string"
        },
        "setAsDefault":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "help":{
            "type":"string"
        },
        "defaultValue":{
            "type":"string"
        },
        "choiceValues":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : choiceValues

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object DTKMOption

Represents Knowledge Module Options in Data Transforms.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DTKMOption"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Retrieve Data Load

Request

Response

200 Response

401 Response

403 Response

404 Response

409 Response