Jump to

• Request
• Response

List Data Loads

get

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

Retrieves a list of data loads for a specific project. 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 load name

The following examples demonstrate the supported query patterns:

• Retrieve all data loads for a project:

  Retrieves all data loads for the project with the given projectId. All default fields for these data loads will be included in the response.

  /projects/{projectId}/dataloads


• Retrieve all data loads for a project with specific fields:

  Retrieves all data loads for the project with the given projectId, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/dataloads?fields=name,dataLoadId,...


• Retrieves all data loads for a project by name:

  Retrieves data loads for the project with the given projectId that match the specified name. All default fields for these data loads will be included in the response.

  /projects/{projectId}/dataloads?name=your_dataload_name


• Retrieve data loads for a project by name with specific fields:

  Retrieves data loads for the project with the given projectId that match the specified name, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/dataloads?name=your_dataload_name&fields=name,dataLoadId,...

Request

Path Parameters

• projectId(required): string
  ID of the project for which to retrieve data loads

Query Parameters

• fields: string
  comma-separated list of fields to include in the response
• name: string
  filters data loads by name

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a response object containing the 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

404 Response

Not Found

Back to Top