Jump to

• Request
• Response

Retrieve Data Load

get

[host-url]/dt-rest/v2/dataloads/{dataLoadId}

Retrieves the specified data load.

Request

Path Parameters

• dataLoadId(required): string
  the ID of the data load to retrieve

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a response containing the specified data load

Body ()

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":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"object",
                        "description":"Complex object: Object"
                    }
                },
                "validationMessages":{
                    "type":"array",
                    "items":{
                        "type":"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 dataLoadOptions
  Additional Properties Allowed: additionalProperties
• 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":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Complex object: Object"
            }
        },
        "validationMessages":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : dataLoadOptions

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Complex object: Object

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Complex object: Object"
    }
}

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 : additionalProperties

Type: object

Complex object: Object

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

409 Response

Conflict

Back to Top