Jump to

• Request
• Response

List Data Loads

get

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

Retrieves all data loads. This method supports various query parameters to filter and customize the response:

• fields: specifies the fields to include in the response (comma-separated)
• name: filters data flows by name

The following examples demonstrate the supported query patterns:

• Retrieve all data loads (no filters):

  Retrieves all available data loads without any name or field-specific filtering.

  /dataloads


• Retrieve all data loads with specific fields:

  Retrieves data loads, but only includes the specified fields for each data load.

  /dataloads?fields=name,dataLoadId,description,...


• Filter by name only:

  Retrieves data loads that match a specific name.

  /dataloads?name=your_dataLoad_name


• Filter by both name and fields:

  Retrieves data loads that match a specific name AND include specified fields.

  /dataloads?name=your_dataLoad_name&fields=name,dataLoadId,description,...

Request

Query Parameters

• fields: string
  Comma-separated list of fields to include in the response. If not specified, all fields are included.
• name: string
  Name of the data load to retrieve. If specified, only the matching data load is returned.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a Response object containing the requested list of data loads.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DataLoadBaseDTO
  Represents a base data load object, containing minimal attributes for data load operations.

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

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"
        }
    }
}

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

409 Response

Conflict

Back to Top