Jump to

• Request
• Response

Export All Design Objects

post

[host-url]/dt-rest/v2/migration/fullExport

Export all design objects within the project, such as Data Flows, Workflows, Variables, Data Loads, and Folders. It will also export dependent Connections, allowing the export of all Connections if specified.

To export all data flows from a project:

 { "objectStorageConnectionId":"your_obj_storage_connection_id", "exportFileName":"your_file_name.zip", "fullExport":[ { "projectId":"your_project_id", "export":["DATA_FLOW"] } ] } 

To export all workflows from a project:

 { "objectStorageConnectionId":"your_obj_storage_connection_id", "exportFileName":"your_file_name.zip", "fullExport":[ { "projectId":"your_project_id", "export":["WORKFLOW"] } ] } 

To export all data loads from a project:

 { "objectStorageConnectionId":"your_obj_storage_connection_id", "exportFileName":"your_file_name.zip", "fullExport":[ { "projectId":"your_project_id", "export":["DATA_LOAD"] } ] } 

To export all schedules from a project:

 { "objectStorageConnectionId":"your_obj_storage_connection_id", "exportFileName":"your_file_name.zip", "fullExport":[ { "projectId":"your_project_id", "export":["SCHEDULE"] } ] } 

To export all variables from a project:

 { "objectStorageConnectionId":"your_obj_storage_connection_id", "exportFileName":"your_file_name.zip", "fullExport":[ { "projectId":"your_project_id", "export":["VARIABLE"] } ] } 

To export all objects from a specified project, filtering by the type of resources you want to export. E.g. To export all workflows and data flows from a project.:

 { "objectStorageConnectionId":"your_obj_storage_connection_id", "exportFileName":"your_file_name.zip", "fullExport":[ { "projectId":"your_project_id", "export":["WORKFLOW","DATA_FLOW"] } ] } 

To export all connections:

 { "objectStorageConnectionId":"your_obj_storage_connection_id", "exportFileName":"your_file_name.zip", "allConnections": true } 

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

JSON for exporting data.

Show Source

• allConnections: boolean
• exportFileName(required): string
• fullExport: array fullExport
• jobDTO: RuntimeJobDTO
• objects: array objects
• objectStorageConnectionId(required): string

{
    "type":"object",
    "description":"JSON for exporting data.",
    "required":[
        "exportFileName",
        "objectStorageConnectionId"
    ],
    "properties":{
        "objectStorageConnectionId":{
            "type":"string"
        },
        "exportFileName":{
            "type":"string"
        },
        "jobDTO":{
            "$ref":"#/components/schemas/RuntimeJobDTO"
        },
        "objects":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DTObjectDTO"
            }
        },
        "fullExport":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExportItemDTO"
            }
        },
        "allConnections":{
            "type":"boolean"
        }
    },
    "example":{
        "objectStorageConnectionId":"your_obj_storage_connection_id",
        "exportFileName":"your_file_name.zip",
        "fullExport":[
            {
                "projectId":"your_project_id",
                "export":[
                    "WORKFLOW",
                    "DATA_FLOW"
                ]
            }
        ],
        "allConnections":false
    }
}

Example:

{
    "objectStorageConnectionId":"your_obj_storage_connection_id",
    "exportFileName":"your_file_name.zip",
    "fullExport":[
        {
            "projectId":"your_project_id",
            "export":[
                "WORKFLOW",
                "DATA_FLOW"
            ]
        }
    ],
    "allConnections":false
}

Nested Schema : fullExport

Type: array

Show Source

• Array of: object ExportItemDTO
  Represents an export item.

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

Nested Schema : RuntimeJobDTO

Match All

JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.

Show Source

• object RuntimeJobBaseDTO
  Represents a job during runtime.
• object RuntimeJobDTO-allOf[1]
  JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RuntimeJobBaseDTO"
        },
        {
            "type":"object",
            "description":"JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.",
            "properties":{
                "executionStatistics":{
                    "type":"object",
                    "description":"Complex object: ExecutionStatisticsDTO"
                },
                "recordStatistics":{
                    "type":"object",
                    "description":"Complex object: RecordStatisticsDTO"
                },
                "synchronous":{
                    "type":"boolean"
                },
                "errorMessage":{
                    "type":"string"
                },
                "jobVariables":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : objects

Type: array

Show Source

• Array of: object DTObjectDTO
  Represents an object to be exported.

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

Nested Schema : ExportItemDTO

Type: object

Represents an export item.

Show Source

• export(required): array export
• projectId(required): string

{
    "type":"object",
    "description":"Represents an export item.",
    "required":[
        "export",
        "projectId"
    ],
    "properties":{
        "projectId":{
            "type":"string"
        },
        "export":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExportType"
            }
        }
    }
}

Nested Schema : export

Type: array

Show Source

• Array of: string
  Allowed Values: [ "DATA_FLOW", "WORKFLOW", "DATA_LOAD", "SCHEDULE", "VARIABLE" ]

  Enumerates the types of export operations that can be performed. The export types include data flows, workflows, data loads, schedules, and variables.

  • Data flow: To export all dataflows from the given project.
  • Workflow: To export all workflows from the given project.
  • Data load: To export all data loads from the given project.
  • Schedule: To export all schedules from the given project.
  • Variable: To export all variables from the given project.

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

Nested Schema : RuntimeJobBaseDTO

Type: object

Represents a job during runtime.

Show Source

• endDate: string (date-time)
• jobId: string
• jobName(required): string
• jobNumber: integer (int64)
• startDate: string (date-time)
• status: string
  Allowed Values: [ "WAITING", "ERROR", "RUNNING", "DONE", "WARNING", "QUEUED", "NOT_STARTED", "PREPARING", "VALID", "INVALID" ]

  Enumerates the possible statuses of a job.

  • Waiting: The Job is waiting to be executed.
  • Error: The Job terminated due to an error.
  • Running: The Job is being executed.
  • Done: The Job executed successfully.
  • Warning: The Job completed successfully but errors have been detected during the data quality check.
  • Queued: The Job is waiting for an agent to be available for its execution.
  • Not started: The Job has not started.
  • Preparing: The Job is preparing to be executed.
  • Valid: The Job is valid to be executed.
  • Invalid: The Job is not valid to be executed.

{
    "type":"object",
    "description":"Represents a job during runtime.",
    "required":[
        "jobName"
    ],
    "properties":{
        "status":{
            "$ref":"#/components/schemas/JobStatus"
        },
        "jobName":{
            "type":"string"
        },
        "jobNumber":{
            "type":"integer",
            "format":"int64"
        },
        "jobId":{
            "type":"string"
        },
        "startDate":{
            "type":"string",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : RuntimeJobDTO-allOf[1]

Type: object

JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.

Show Source

• errorMessage: string
• executionStatistics: object executionStatistics
  Complex object: ExecutionStatisticsDTO
• jobVariables: object jobVariables
  Additional Properties Allowed: additionalProperties
• recordStatistics: object recordStatistics
  Complex object: RecordStatisticsDTO
• synchronous: boolean

{
    "type":"object",
    "description":"JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.",
    "properties":{
        "executionStatistics":{
            "type":"object",
            "description":"Complex object: ExecutionStatisticsDTO"
        },
        "recordStatistics":{
            "type":"object",
            "description":"Complex object: RecordStatisticsDTO"
        },
        "synchronous":{
            "type":"boolean"
        },
        "errorMessage":{
            "type":"string"
        },
        "jobVariables":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : executionStatistics

Type: object

Complex object: ExecutionStatisticsDTO

Nested Schema : jobVariables

Type: object

Additional Properties Allowed

Show Source

• string

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

Nested Schema : recordStatistics

Type: object

Complex object: RecordStatisticsDTO

Nested Schema : DTObjectDTO

Type: object

Represents an object to be exported.

Show Source

• objectId(required): string
• objectType(required): string

{
    "type":"object",
    "description":"Represents an object to be exported.",
    "required":[
        "objectId",
        "objectType"
    ],
    "properties":{
        "objectId":{
            "type":"string"
        },
        "objectType":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response object containing the job information for the Export job.

Body ()

Root Schema : schema

Type: object

JSON for exporting data.

Show Source

• allConnections: boolean
• exportFileName(required): string
• fullExport: array fullExport
• jobDTO: RuntimeJobDTO
• objects: array objects
• objectStorageConnectionId(required): string

{
    "type":"object",
    "description":"JSON for exporting data.",
    "required":[
        "exportFileName",
        "objectStorageConnectionId"
    ],
    "properties":{
        "objectStorageConnectionId":{
            "type":"string"
        },
        "exportFileName":{
            "type":"string"
        },
        "jobDTO":{
            "$ref":"#/components/schemas/RuntimeJobDTO"
        },
        "objects":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DTObjectDTO"
            }
        },
        "fullExport":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExportItemDTO"
            }
        },
        "allConnections":{
            "type":"boolean"
        }
    },
    "example":{
        "objectStorageConnectionId":"your_obj_storage_connection_id",
        "exportFileName":"your_file_name.zip",
        "fullExport":[
            {
                "projectId":"your_project_id",
                "export":[
                    "WORKFLOW",
                    "DATA_FLOW"
                ]
            }
        ],
        "allConnections":false
    }
}

Example:

{
    "objectStorageConnectionId":"your_obj_storage_connection_id",
    "exportFileName":"your_file_name.zip",
    "fullExport":[
        {
            "projectId":"your_project_id",
            "export":[
                "WORKFLOW",
                "DATA_FLOW"
            ]
        }
    ],
    "allConnections":false
}

Nested Schema : fullExport

Type: array

Show Source

• Array of: object ExportItemDTO
  Represents an export item.

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

Nested Schema : RuntimeJobDTO

Match All

JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.

Show Source

• object RuntimeJobBaseDTO
  Represents a job during runtime.
• object RuntimeJobDTO-allOf[1]
  JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RuntimeJobBaseDTO"
        },
        {
            "type":"object",
            "description":"JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.",
            "properties":{
                "executionStatistics":{
                    "type":"object",
                    "description":"Complex object: ExecutionStatisticsDTO"
                },
                "recordStatistics":{
                    "type":"object",
                    "description":"Complex object: RecordStatisticsDTO"
                },
                "synchronous":{
                    "type":"boolean"
                },
                "errorMessage":{
                    "type":"string"
                },
                "jobVariables":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : objects

Type: array

Show Source

• Array of: object DTObjectDTO
  Represents an object to be exported.

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

Nested Schema : ExportItemDTO

Type: object

Represents an export item.

Show Source

• export(required): array export
• projectId(required): string

{
    "type":"object",
    "description":"Represents an export item.",
    "required":[
        "export",
        "projectId"
    ],
    "properties":{
        "projectId":{
            "type":"string"
        },
        "export":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExportType"
            }
        }
    }
}

Nested Schema : export

Type: array

Show Source

• Array of: string
  Allowed Values: [ "DATA_FLOW", "WORKFLOW", "DATA_LOAD", "SCHEDULE", "VARIABLE" ]

  Enumerates the types of export operations that can be performed. The export types include data flows, workflows, data loads, schedules, and variables.

  • Data flow: To export all dataflows from the given project.
  • Workflow: To export all workflows from the given project.
  • Data load: To export all data loads from the given project.
  • Schedule: To export all schedules from the given project.
  • Variable: To export all variables from the given project.

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

Nested Schema : RuntimeJobBaseDTO

Type: object

Represents a job during runtime.

Show Source

• endDate: string (date-time)
• jobId: string
• jobName(required): string
• jobNumber: integer (int64)
• startDate: string (date-time)
• status: string
  Allowed Values: [ "WAITING", "ERROR", "RUNNING", "DONE", "WARNING", "QUEUED", "NOT_STARTED", "PREPARING", "VALID", "INVALID" ]

  Enumerates the possible statuses of a job.

  • Waiting: The Job is waiting to be executed.
  • Error: The Job terminated due to an error.
  • Running: The Job is being executed.
  • Done: The Job executed successfully.
  • Warning: The Job completed successfully but errors have been detected during the data quality check.
  • Queued: The Job is waiting for an agent to be available for its execution.
  • Not started: The Job has not started.
  • Preparing: The Job is preparing to be executed.
  • Valid: The Job is valid to be executed.
  • Invalid: The Job is not valid to be executed.

{
    "type":"object",
    "description":"Represents a job during runtime.",
    "required":[
        "jobName"
    ],
    "properties":{
        "status":{
            "$ref":"#/components/schemas/JobStatus"
        },
        "jobName":{
            "type":"string"
        },
        "jobNumber":{
            "type":"integer",
            "format":"int64"
        },
        "jobId":{
            "type":"string"
        },
        "startDate":{
            "type":"string",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : RuntimeJobDTO-allOf[1]

Type: object

JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.

Show Source

• errorMessage: string
• executionStatistics: object executionStatistics
  Complex object: ExecutionStatisticsDTO
• jobVariables: object jobVariables
  Additional Properties Allowed: additionalProperties
• recordStatistics: object recordStatistics
  Complex object: RecordStatisticsDTO
• synchronous: boolean

{
    "type":"object",
    "description":"JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.",
    "properties":{
        "executionStatistics":{
            "type":"object",
            "description":"Complex object: ExecutionStatisticsDTO"
        },
        "recordStatistics":{
            "type":"object",
            "description":"Complex object: RecordStatisticsDTO"
        },
        "synchronous":{
            "type":"boolean"
        },
        "errorMessage":{
            "type":"string"
        },
        "jobVariables":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : executionStatistics

Type: object

Complex object: ExecutionStatisticsDTO

Nested Schema : jobVariables

Type: object

Additional Properties Allowed

Show Source

• string

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

Nested Schema : recordStatistics

Type: object

Complex object: RecordStatisticsDTO

Nested Schema : DTObjectDTO

Type: object

Represents an object to be exported.

Show Source

• objectId(required): string
• objectType(required): string

{
    "type":"object",
    "description":"Represents an object to be exported.",
    "required":[
        "objectId",
        "objectType"
    ],
    "properties":{
        "objectId":{
            "type":"string"
        },
        "objectType":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Not Found

Back to Top