\n3. When the token expires (after x hours), you'll receive a 401 response. To re-authenticate, use the refresh_token in the Authorization header.\n\nExample: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...\n\nNote: Be sure to handle token refresh and expiration accordingly to maintain uninterrupted access."
}
}
},
"tags":[
{
"name":"About",
"description":"Resource that handles requests related for retrieving deployment details.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"Authentication",
"description":"Resource responsible for handling REST API requests related to authentication.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"Connection",
"description":"Resource responsible for handling REST API requests related to connections.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"DataFlow",
"description":"Resource responsible for handling REST API requests related to data flows.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"DataLoad",
"description":"Resource responsible for handling REST API requests related to data loads.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"DesignMigration",
"description":"Resource responsible for handling REST API requests related to imports and exports.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"Folder",
"description":"Resource responsible for handling REST API requests related to folders.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"Job",
"description":"Resource responsible for handling REST API requests related to jobs.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"Project",
"description":"Resource responsible for handling REST API requests related to projects.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"Schedule",
"description":"Resource responsible for handling REST API requests related to schedules.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"Variable",
"description":"Resource responsible for handling REST API requests related to variables.",
"externalDocs":{
"description":"",
"url":""
}
},
{
"name":"Workflow",
"description":"Resource responsible for handling REST API requests related to workflows.",
"externalDocs":{
"description":"",
"url":""
}
}
],
"paths":{
"/dt-rest/v2/folders/{folderId}":{
"get":{
"operationId":"getFolderById",
"tags":[
"Folder"
],
"summary":"Retrieve Folder",
"description":"Retrieves a folder by its ID.",
"parameters":[
{
"name":"folderId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"The ID of the folder to retrieve."
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"A Response object containing the retrieved folder in a JSON.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DTFolderDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-folders-{folderId}-get",
"x-filename-id":"dt-rest-v2-folders-folderid-get"
}
},
"/dt-rest/v2/connections":{
"get":{
"operationId":"getAllConnections",
"tags":[
"Connection"
],
"summary":"List Connections",
"description":"Retrieves the list with all connections. 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 connections by nameconnectionType: filters connections by type of technology
The following examples demonstrate the supported query patterns:
- Retrieve all connections (no filters):
Retrieves all available connections without any name or connection type filtering. All default fields for these connections will be included in the response.
/connections
- Retrieve all connections with specific fields:
Retrieves all connections, but the response for each connection will only include the fields specified in the fields parameter.
/connections?fields=name,connectionId,...
- Filter by name only:
Retrieves all connections that match the specified name. All default fields for these connections will be included in the response.
/connections?name=your_connection_name
- Filter by name and select specific fields:
Retrieves connections that match the given name, and the response for these connections will only include the fields specified in the fields parameter.
/connections?name=your_connection_name&fields=name,connectionId,...
- Filter by connection type only:
Retrieves all connections that belong to the specified connectionType. All default fields for these connections will be included in the response.
/connections?connectionType=your_connection_type
- Filter by connection type and select specific fields:
Retrieves connections that belong to the specified connectionType, and the response for these connections will only include the fields specified in the fields parameter.
/connections?connectionType=your_connection_type&fields=name,connectionId,...
",
"parameters":[
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
},
{
"name":"name",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters connections by name"
},
{
"name":"connectionType",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters connections by technology type"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of connections",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ConnectionBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-connections-get",
"x-filename-id":"dt-rest-v2-connections-get"
}
},
"/dt-rest/v2/connections/{connectionId}":{
"get":{
"operationId":"getConnectionById",
"tags":[
"Connection"
],
"summary":"Retrieve Connection",
"description":"Retrieves a single Connection using the given ID.",
"parameters":[
{
"name":"connectionId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"the ID of the connection to retrieve."
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a Response object containing the connection details in JSON format with a 200 OK status code.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ConnectionBaseDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-connections-{connectionId}-get",
"x-filename-id":"dt-rest-v2-connections-connectionid-get"
}
},
"/dt-rest/v2/dataflows":{
"get":{
"operationId":"getAllDataFlows",
"tags":[
"DataFlow"
],
"summary":"List Data Flows",
"description":"Retrieves all data flows. 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 nameparentFolder: filters data flows by parentFolder
The following examples demonstrate the supported query patterns:
- Retrieve all data flows (no filters):
Retrieves all available data flows without any name or parent folder filtering. All default fields for these data flows will be included in the response.
/dataflows
- Retrieve all data flows with specific fields:
Retrieves all data flows, but the response for each data flow will only include the fields specified in the fields parameter.
/dataflows?fields=name,dataFlowId,dateCreated,...
- Filter by name only:
Retrieves all data flows that match the specified name. All default fields for these data flows will be included in the response.
/dataflows?name=your_dataflow_name
- Filter by name and select specific fields:
Retrieves data flows that match the given name, and the response for these data flows will only include the fields specified in the fields parameter.
/dataflows?name=your_dataflow_name&fields=name,dataFlowId,dateCreated,...
- Filter by parentFolder only:
Retrieves all data flows that match the specified parentFolder. All default fields for these data flows will be included in the response.
/dataflows?parentFolder=your_parentFolder
- Filter by parentFolder and select specific fields:
Retrieves data flows that match the given parentFolder, and the response for these data flows will only include the fields specified in the fields parameter.
/dataflows?parentFolder=your_parentFolder&fields=name,dataFlowId,dateCreated,...
",
"parameters":[
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
},
{
"name":"name",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters data flows by name"
},
{
"name":"parentFolder",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters data flows by parentFolder"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of DataFlowBaseDTO",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/DataFlowBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-dataflows-get",
"x-filename-id":"dt-rest-v2-dataflows-get"
}
},
"/dt-rest/v2/dataflows/{dataFlowId}":{
"get":{
"operationId":"getDataFlowById",
"tags":[
"DataFlow"
],
"summary":"Retrieve Data Flow",
"description":"Returns the specified data flow.",
"parameters":[
{
"name":"dataFlowId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"the ID of the data flow to retrieve"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a Response object containing a data flow",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DataFlowBaseDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-dataflows-{dataFlowId}-get",
"x-filename-id":"dt-rest-v2-dataflows-dataflowid-get"
}
},
"/dt-rest/v2/dataloads":{
"get":{
"operationId":"getAllDataLoads",
"tags":[
"DataLoad"
],
"summary":"List Data Loads",
"description":"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,...
",
"parameters":[
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"Comma-separated list of fields to include in the response. If not specified, all fields are included."
},
{
"name":"name",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"Name of the data load to retrieve. If specified, only the matching data load is returned."
}
],
"responses":{
"403":{
"description":"Forbidden"
},
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"409":{
"description":"Conflict"
},
"200":{
"description":"a Response object containing the requested list of data loads.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/DataLoadBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-dataloads-get",
"x-filename-id":"dt-rest-v2-dataloads-get"
}
},
"/dt-rest/v2/dataloads/{dataLoadId}":{
"get":{
"operationId":"getDataLoadById",
"tags":[
"DataLoad"
],
"summary":"Retrieve Data Load",
"description":"Retrieves the specified data load.",
"parameters":[
{
"name":"dataLoadId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"the ID of the data load to retrieve"
}
],
"responses":{
"403":{
"description":"Forbidden"
},
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"409":{
"description":"Conflict"
},
"200":{
"description":"a response containing the specified data load",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DataLoadDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-dataloads-{dataLoadId}-get",
"x-filename-id":"dt-rest-v2-dataloads-dataloadid-get"
}
},
"/dt-rest/v2/migration/export":{
"post":{
"operationId":"doExport",
"tags":[
"DesignMigration"
],
"summary":"Exports Selected Design Objects",
"description":"Exports selected design objects, such as Projects, Data Flows, Workflows, Variables, Data Loads, Folders and Connections, to a zip file stored in the specified object storage connection.
To export all objects from a project: { \"objectStorageConnectionId\":\"your_obj_storage_connection_id\", \"exportFileName\":\"your_file_name.zip\", \"objects\":[ { \"objectId\":\"your_object_id\", \"objectType\":\"Project\" } ] }
To export specific objects: { \"objectStorageConnectionId\":\"your_obj_storage_connection_id\", \"exportFileName\":\"your_file_name.zip\", \"objects\":[ { \"objectId\": \"your_connection_id\", \"objectType\": \"Connection\" }, { \"objectId\": \"your_workflow_id\", \"objectType\": \"Workflow\" }, { \"objectId\": \"your_data_load_id\", \"objectType\": \"Data Load\" } ] } ",
"requestBody":{
"description":"JSON containing a list of objects and any dependencies to export.",
"required":false,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DTExportDTO"
},
"example":{
"objectStorageConnectionId":"your_obj_storage_connection_id",
"exportFileName":"your_file_name.zip",
"objects":[
{
"objectId":"your_connection_id",
"objectType":"Connection"
},
{
"objectId":"your_workflow_id",
"objectType":"Workflow"
},
{
"objectId":"your_data_load_id",
"objectType":"Data Load"
}
]
}
}
}
},
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"Response object containing the job information for the Export job.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DTExportDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-migration-export-post",
"x-filename-id":"dt-rest-v2-migration-export-post"
}
},
"/dt-rest/v2/migration/fullExport":{
"post":{
"operationId":"doFullExport",
"tags":[
"DesignMigration"
],
"summary":"Export All Design Objects",
"description":"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 } ",
"requestBody":{
"description":"JSON containing a list of objects and any dependencies to export.",
"required":false,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DTExportDTO"
},
"example":{
"objectStorageConnectionId":"your_obj_storage_connection_id",
"exportFileName":"your_file_name.zip",
"fullExport":[
{
"projectId":"your_project_id",
"export":[
"WORKFLOW",
"DATA_FLOW"
]
}
],
"allConnections":false
}
}
}
},
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"Response object containing the job information for the Export job.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DTExportDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-migration-fullExport-post",
"x-filename-id":"dt-rest-v2-migration-fullexport-post"
}
},
"/dt-rest/v2/migration/import":{
"post":{
"operationId":"doImport",
"tags":[
"DesignMigration"
],
"summary":"Imports Design Objects",
"description":"Import objects provided by zip file indicated in the request body, which includes the object storage connection ID, import file name, and import options.",
"requestBody":{
"description":"JSON containing import details.",
"required":false,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DTImportDTO"
},
"example":{
"objectStorageConnectionId":"your_obj_storage_connection_id",
"importFileName":"your_file_name.zip",
"importOption":"MERGE"
}
}
}
},
"responses":{
"409":{
"description":"Conflict"
},
"403":{
"description":"Forbidden"
},
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"Response object containing the job information for the Import job.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DTImportDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-migration-import-post",
"x-filename-id":"dt-rest-v2-migration-import-post"
}
},
"/dt-rest/v2/migration/import/{objectStorageConnectionId}/list":{
"get":{
"operationId":"listImportableObjects",
"tags":[
"DesignMigration"
],
"summary":"List Importable Files",
"description":"Lists importable Files for the given object storage connection ID.",
"parameters":[
{
"name":"objectStorageConnectionId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"Object storage connection ID."
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"200":{
"description":"Response object containing a list of files for the given object storage connection.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-migration-import-{objectStorageConnectionId}-list-get",
"x-filename-id":"dt-rest-v2-migration-import-objectstorageconnectionid-list-get"
}
},
"/dt-rest/v2/projects":{
"get":{
"operationId":"getAllProjects",
"tags":[
"Project"
],
"summary":"List Projects",
"description":"Retrieves a list with all projects. This method supports various query parameters to filter and customize the response: name: filters projects by namefields: specifies the fields to include in the response (comma-separated)
The following examples demonstrate the supported query patterns:
- Retrieve all projects (no filters):
Retrieves all available projects without any name filtering. All default fields for these projects will be included in the response.
/projects
- Retrieve all projects with specific fields:
Retrieves all available projects without any name filtering, and the response will only include the fields specified in the fields parameter.
/projects?fields=name,projectId,...
- Retrieve a project by name:
Retrieves a project that matches the given name. All default fields for this project will be included in the response.
/projects?name=your_project_name
- Retrieve a project by name with specific fields:
Retrieves a project that matches the given name, and the response will only include the fields specified in the fields parameter.
/projects?name=your_project_name&fields=name,projectId,...
",
"parameters":[
{
"name":"name",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters projects by name"
},
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of projects",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/DTProjectDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-projects-get",
"x-filename-id":"dt-rest-v2-projects-get"
}
},
"/dt-rest/v2/projects/{projectId}":{
"get":{
"operationId":"getProjectById",
"tags":[
"Project"
],
"summary":"Retrieve Project",
"description":"Retrieves a specific project by its ID.",
"parameters":[
{
"name":"projectId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"The ID of the project to retrieve. This is a path parameter."
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"A Response object containing the project details.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DTProjectDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-projects-{projectId}-get",
"x-filename-id":"dt-rest-v2-projects-projectid-get"
}
},
"/dt-rest/v2/projects/{projectId}/dataflows":{
"get":{
"operationId":"getAllProjectDataflows",
"tags":[
"Project"
],
"summary":"List Data Flows",
"description":"Retrieves a list of data flows 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 projects data flows by the data flow name.parentFolder: filters the projects data flows by parent folder
The following examples demonstrate the supported filtering patterns:
- Retrieve all data flows for a project:
Retrieves all data flows for the project with the given projectId. All default fields for these data flows will be included in the response.
/projects/{projectId}/dataflows
- Retrieve all data flows for a project with specific fields:
Retrieves all data flows for the project with the given projectId, and the response will only include the fields specified in the fields parameter.
/projects/{projectId}/dataflows?fields=name,dataFlowId,...
- Retrieve data flows for a project by name:
Retrieves data flows for the project with the given projectId that match the specified name. All default fields for these data flows will be included in the response.
/projects/{projectId}/dataflows?name=your_dataflow_name
- Retrieve data flows for a project by name with specific fields:
Retrieves data flows 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}/dataflows?name=your_dataflow_name&fields=name,dataFlowId,...
- Retrieve data flows for a project by parent folder:
Retrieves data flows for the project with the given projectId that belong to the specified parentFolder. All default fields for these data flows will be included in the response.
/projects/{projectId}/dataflows?parentFolder=folderId
- Retrieve data flows for a project by parent folder with specific fields:
Retrieves data flows for the project with the given projectId that belong to the specified parentFolder, and the response will only include the fields specified in the fields parameter.
/projects/{projectId}/dataflows?parentFolder=folderId&fields=name,dataFlowId,...
",
"parameters":[
{
"name":"projectId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"ID of the project for which to retrieve data flows"
},
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
},
{
"name":"name",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters data flows by name"
},
{
"name":"folder",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters data flows by parent folder"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of data flows",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/DataFlowBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-projects-{projectId}-dataflows-get",
"x-filename-id":"dt-rest-v2-projects-projectid-dataflows-get"
}
},
"/dt-rest/v2/projects/{projectId}/workflows":{
"get":{
"operationId":"getAllProjectWorkflows",
"tags":[
"Project"
],
"summary":"List Workflows",
"description":"Retrieves a list of workflows 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 workflows by nameparentFolder: filters workflows by parent folder
The following examples demonstrate the supported query patterns:
- Retrieve all workflows for a project:
Retrieves all workflows for the project with the given projectId. All default fields for these workflows will be included in the response.
/projects/{projectId}/workflows
- Retrieve all workflows for a project with specific fields:
Retrieves all workflows for the project with the given projectId, and the response will only include the fields specified in the fields parameter.
/projects/{projectId}/workflows?fields=name,workflowId,...
- Retrieve workflows for a project by name:
Retrieves workflows for the project with the given projectId that match the specified name. All default fields for these workflows will be included in the response.
/projects/{projectId}/workflows?name=your_workflow_name
- Retrieve workflows for a project by name with specific fields:
Retrieves workflows 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}/workflows?name=your_workflow_name&fields=name,workflowId,...
- Retrieve workflows for a project by parent folder:
Retrieves workflows for the project with the given projectId that belong to the specified parentFolder. All default fields for these workflows will be included in the response.
/projects/{projectId}/workflows?parentFolder=your_workflow_parentFolder
- Retrieve workflows for a project by parent folder with specific fields:
Retrieves workflows for the project with the given projectId that belong to the specified parentFolder, and the response will only include the fields specified in the fields parameter.
/projects/{projectId}/workflows?parentFolder=your_workflow_parentFolder&fields=name,workflowId,...
",
"parameters":[
{
"name":"projectId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"ID of the project for which to retrieve workflows"
},
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
},
{
"name":"folder",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters workflows by parent folder"
},
{
"name":"name",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters workflows by name"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of workflows",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/WorkflowBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-projects-{projectId}-workflows-get",
"x-filename-id":"dt-rest-v2-projects-projectid-workflows-get"
}
},
"/dt-rest/v2/projects/{projectId}/dataloads":{
"get":{
"operationId":"getAllProjectDataLoads",
"tags":[
"Project"
],
"summary":"List Data Loads",
"description":"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,...
",
"parameters":[
{
"name":"projectId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"ID of the project for which to retrieve data loads"
},
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
},
{
"name":"name",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters data loads by name"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of data loads",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/DataLoadBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-projects-{projectId}-dataloads-get",
"x-filename-id":"dt-rest-v2-projects-projectid-dataloads-get"
}
},
"/dt-rest/v2/projects/{projectId}/schedules":{
"get":{
"operationId":"getAllProjectSchedules",
"tags":[
"Project"
],
"summary":"List Schedules",
"description":"Retrieves a list of schedules 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 schedules by namestatus: filters schedules by statusworkflowId: filters schedules by workflow IDdataFlowId: filters schedules by dataflow ID
The following examples demonstrate the supported query patterns:
- Retrieve all schedules for a project:
Retrieves all schedules for the project with the given projectId. All default fields for these schedules will be included in the response.
/projects/{projectId}/schedules
- Retrieve all schedules for a project with specific fields:
Retrieves all schedules for the project with the given projectId, and the response will only include the fields specified in the fields parameter.
/projects/{projectId}/schedules?fields=name,scheduleId,...
- Retrieves all schedules for a project by name:
Retrieves schedules for the project with the given projectId that match the specified name. All default fields for these schedules will be included in the response.
/projects/{projectId}/schedules?name=your_schedule_name
- Retrieve schedules for a project by name with specific fields:
Retrieves schedules 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}/schedules?name=your_schedule_name&fields=name,scheduleId,...
- Retrieves all schedules for a project by status:
Retrieves schedules for the project with the given projectId that match the specified status. All default fields for these schedules will be included in the response.
/projects/{projectId}/schedules?status=your_schedule_status
- Retrieve schedules for a project by status with specific fields:
Retrieves schedules 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}/schedules?status=your_schedule_status&fields=name,scheduleId,...
- Retrieves all schedules for the workflow associated with a specific project:
Retrieves all schedules for the workflow that match the project with the given projectId that match specified workflowId. All default fields for these schedules will be included in the response.
/projects/{projectId}/schedules?workflowId=your_workflowId
- Retrieves all schedules for the workflow associated with a specific project with fields:
Retrieves all schedules for the workflow that match the project with the given projectId that match the specified workflowId, and the response will only include the fields specified in the fields parameter.
/projects/{projectId}/schedules?workflowId=your_workflowId&fields=name,scheduleId,...
- Retrieves all schedules for the dataflow associated with a specific project:
Retrieves all schedules for the dataflow that match the project with the given projectId that match specified dataflowId. All default fields for these schedules will be included in the response.
/projects/{projectId}/schedules?dataflowId=your_dataFlowId
- Retrieves all schedules for the dataflow associated with a specific project with fields:
Retrieves all schedules for the dataflow that match the project with the given projectId that match the specified dataflowId, and the response will only include the fields specified in the fields parameter.
/projects/{projectId}/schedules?dataflowId=your_dataFlowId&fields=name,scheduleId,...
",
"parameters":[
{
"name":"projectId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"ID of the project for which to retrieve schedules"
},
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
},
{
"name":"name",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters schedules by name"
},
{
"name":"status",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters schedules by status"
},
{
"name":"workflowId",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters schedules by workflow ID"
},
{
"name":"dataFlowId",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters schedules by dataflow ID"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of schedules",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/JobScheduleBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-projects-{projectId}-schedules-get",
"x-filename-id":"dt-rest-v2-projects-projectid-schedules-get"
}
},
"/dt-rest/v2/projects/{projectId}/jobs":{
"post":{
"operationId":"getAllProjectJob",
"tags":[
"Project"
],
"summary":"List Jobs",
"description":"Retrieves a list of all project jobs matching the specified search criteria, returning only minimal information. The filtering criteria is provided in the request body. The filtering logic is as follows: - Job Name: If
jobName is provided, the response will contain the job with this name. - Status: If
status is provided, the response will contain jobs that match the status. - Date Range:
- If both
fromDate and toDate are provided, jobs that match the range will be returned in the response. - If only
fromDate is provided, jobs past this date will be returned. - If only
toDate is provided, jobs before this date will be returned. - Supported formats:
\"yyyy-MM-dd'T'HH:mm:ss.SSSX, \"yyyy-MM-dd'T'HH:mm:ss.SSS\", \"EEE, dd MMM yyyy HH:mm:ss zzz\", \"yyyy-MM-dd\" - The default timezone for fromDate and toDate is UTC.
- To use a different timezone, the date string must be formatted to include the timezone offset.
E.g. Wed, 10 Sep 2025 07:29:30 GMT+5:30
- Max Results: If
maxResults is provided, it limits the number of jobs retrieved. Otherwise, all are retrieved.
The fields available for filtering include: status (array of strings), fromDate (date-time), toDate (date-time), maxResults (integer), and jobName (string).
",
"parameters":[
{
"name":"projectId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"The unique identifier of the project. This is a path parameter."
}
],
"requestBody":{
"description":"The search criteria for filtering jobs, provided in the request body as a JSON.",
"required":false,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/JobsSearchDTO"
},
"example":{
"status":"WAITING",
"fromDate":"2025-11-12T23:22:26.687622Z",
"toDate":"2025-11-12T23:22:26.687641Z",
"maxResults":123,
"jobName":"jobName_example"
}
}
}
},
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"A response containing a list of jobs matching the criteria.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RuntimeJobBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-projects-{projectId}-jobs-post",
"x-filename-id":"dt-rest-v2-projects-projectid-jobs-post"
}
},
"/dt-rest/v2/projects/{projectId}/folders":{
"get":{
"operationId":"getAllProjectFolders",
"tags":[
"Project"
],
"summary":"List Folders",
"description":"Retrieves a list of folders 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)
The following examples demonstrate the supported query patterns:
- Retrieve all folders for a project:
Retrieves all folders for the project with the given projectId, including their children. All default fields for these folders will be included in the response.
/projects/{projectId}/folders
- Retrieve all folders for a project with specific fields:
Retrieves all folders for the project with the given projectId, including their children, and the response will only include the fields specified in the fields parameter.
/projects/{projectId}/folders?fields=name,folderId,...
",
"parameters":[
{
"name":"projectId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"ID of the project for which to retrieve folders"
},
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of folders",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/DTFolderDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-projects-{projectId}-folders-get",
"x-filename-id":"dt-rest-v2-projects-projectid-folders-get"
}
},
"/dt-rest/v2/projects/{projectId}/variables":{
"get":{
"operationId":"getAllProjectVariables",
"tags":[
"Project"
],
"summary":"List Variables",
"description":"Retrieves a list of variables 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)qualifiedName: filters variables by qualified name (projectName.variableName)
The following examples demonstrate the supported query patterns:
- Retrieve all variables for a project:
Retrieves all variables for the project with the given projectId. All default fields for these variables will be included in the response.
/projects/{projectId}/variables
- Retrieve all variables for a project with specific fields:
Retrieves all variables for the project with the given projectId, and the response will only include the fields specified in the fields parameter.
/projects/{projectId}/variables?fields=name,variableId,...
- Retrieve variable for a project by qualified name:
Retrieves variable for the project with the given projectId that match the specified qualifiedName. All default fields for these schedules will be included in the response.
/projects/{projectId}/variables?qualifiedName=projectName.variableName
- Retrieve variable for a project by qualified name with specific fields:
Retrieves variable for the project with the given projectId that match the specified qualifiedName, and the response will only include the fields specified in the fields parameter.
/projects/{projectId}/variables?qualifiedName=projectName.variableName&fields=name,variableId,...
",
"parameters":[
{
"name":"projectId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"ID of the project for which to retrieve variables"
},
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
},
{
"name":"qualifiedName",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"??? filters variables by projectName.variableName"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of variables",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/DTVariableBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-projects-{projectId}-variables-get",
"x-filename-id":"dt-rest-v2-projects-projectid-variables-get"
}
},
"/dt-rest/v2/jobs":{
"post":{
"operationId":"getAllJobs",
"tags":[
"Job"
],
"summary":"List Jobs",
"description":"Retrieves a list of all jobs matching the specified search criteria, returning only minimal information. The filtering criteria is provided in the request body. The filtering logic is as follows: - Job Name: If
jobName is provided, the response will contain the job with this name. - Status: If
status is provided, the response will contain jobs that match the status. - Date Range:
- If both
fromDate and toDate are provided, jobs that match the range will be returned in the response. - If only
fromDate is provided, jobs past this date will be returned. - If only
toDate is provided, jobs before this date will be returned. - Supported formats:
\"yyyy-MM-dd'T'HH:mm:ss.SSSX, \"yyyy-MM-dd'T'HH:mm:ss.SSS\", \"EEE, dd MMM yyyy HH:mm:ss zzz\", \"yyyy-MM-dd\" - The default timezone for fromDate and toDate is UTC.
- To use a different timezone, the date string must be formatted to include the timezone offset.
E.g. Wed, 10 Sep 2025 07:29:30 GMT+5:30
- Max Results: If
maxResults is provided, it limits the number of jobs retrieved. Otherwise, all are retrieved.
The fields available for filtering include: status (array of strings), fromDate (date-time), toDate (date-time), maxResults (integer), and jobName (string).
",
"parameters":[
{
"name":"page",
"in":"query",
"required":false,
"schema":{
"type":"integer",
"format":"int32"
},
"description":"The current page number."
},
{
"name":"limit",
"in":"query",
"required":false,
"schema":{
"type":"integer",
"format":"int32"
},
"description":"The maximum number of items per page."
}
],
"requestBody":{
"description":"A JSON object containing search criteria for jobs.",
"required":false,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/JobsSearchDTO"
},
"example":{
"status":"WAITING",
"fromDate":"2025-11-12T23:22:26.699450Z",
"toDate":"2025-11-12T23:22:26.699457Z",
"maxResults":123,
"jobName":"jobName_example"
}
}
}
},
"responses":{
"401":{
"description":"Unauthorized"
},
"200":{
"description":"A JSON object containing the paginated list of jobs.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RuntimeJobBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-jobs-post",
"x-filename-id":"dt-rest-v2-jobs-post"
}
},
"/dt-rest/v2/jobs/submit":{
"post":{
"operationId":"jobExecution",
"tags":[
"Job"
],
"summary":"Execute Job",
"description":"Handles the execution of a job based on the provided parameters.",
"requestBody":{
"description":"JSON containing information about the job to be executed.",
"required":false,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SubmitJobsDTO"
},
"example":{
"action":"RUN",
"objectType":"DATAFLOW",
"objectId":"objectId_example",
"objectName":"objectName_example",
"isSynchronous":true,
"ignorePreviousRunningJob":true,
"jobName":"jobName_example",
"jobVariables":{
}
}
}
}
},
"responses":{
"500":{
"description":"Internal Server Error"
},
"200":{
"description":"A response indicating the outcome of the job execution.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RuntimeJobDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-jobs-submit-post",
"x-filename-id":"dt-rest-v2-jobs-submit-post"
}
},
"/dt-rest/v2/jobs/{jobId}":{
"get":{
"operationId":"getJobById",
"tags":[
"Job"
],
"summary":"Retrieve Job",
"description":"Retrieves a job by its ID.",
"parameters":[
{
"name":"jobId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"The ID of the job to retrieve."
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"A response object containing the retrieved job.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RuntimeJobDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-jobs-{jobId}-get",
"x-filename-id":"dt-rest-v2-jobs-jobid-get"
}
},
"/dt-rest/v2/schedules":{
"get":{
"operationId":"getAllSchedules",
"tags":[
"Schedule"
],
"summary":"List Schedules",
"description":"Retrieves a list of schedules. 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 schedules by namestatus: filters schedules by statusworkflowId: filters schedules by workflow IDdataFlowId: filters schedules by data flow ID
The following examples demonstrate the supported query patterns:
- Retrieve all schedules (no filters):
Retrieves all available schedules without any filtering. All default fields for these schedules will be included in the response.
/schedules
- Retrieve all schedules with specific fields:
Retrieves all available schedules without any filtering, and the response will only include the fields specified in the fields parameter.
/schedules?fields=name,scheduleId,...
- Retrieve a schedule by name:
Retrieves a schedule that matches the given name. All default fields for this schedule will be included in the response.
/schedules?name=your_schedule_name
- Retrieve a schedule by name with specific fields:
Retrieves a schedule that matches the given name, and the response will only include the fields specified in the fields parameter.
/schedules?name=your_schedule_name&fields=name,scheduleId,...
- Retrieve schedules by status:
Retrieves all schedules that match the given status. All default fields for these schedules will be included in the response.
/schedules?status=your_status
- Retrieve schedules by status with specific fields:
Retrieves all schedules that match the given status, and the response will only include the fields specified in the fields parameter.
/schedules?status=your_status&fields=name,scheduleId,...
- Retrieve schedules by workflow ID:
Retrieves all schedules that are associated with the given workflowId. All default fields for these schedules will be included in the response.
/schedules?workflowId=your_workflow_id
- Retrieve schedules by workflow ID with specific fields:
Retrieves all schedules that are associated with the given workflowId, and the response will only include the fields specified in the fields parameter.
/schedules?workflowId=your_workflow_id&fields=name,scheduleId,...
- Retrieve schedules by data flow ID:
Retrieves all schedules that are associated with the given dataflowId. All default fields for these schedules will be included in the response.
/schedules?dataFlowId=your_dataflow_id
- Retrieve schedules by data flow ID with specific fields:
Retrieves all schedules that are associated with the given dataflowId, and the response will only include the fields specified in the fields parameter.
/schedules?dataFlowId=your_dataflow_id&fields=name,scheduleId,...
",
"parameters":[
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
},
{
"name":"name",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters schedules by name"
},
{
"name":"status",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters schedules by status"
},
{
"name":"workflowId",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters schedules by workflow ID"
},
{
"name":"dataflowId",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"QueryParam parameter dataflowId"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of schedules",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/JobScheduleBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-schedules-get",
"x-filename-id":"dt-rest-v2-schedules-get"
},
"post":{
"operationId":"createSchedule",
"tags":[
"Schedule"
],
"summary":"Create Schedule",
"description":"Creates a new schedule for a job or an executable design object. The details of the schedule, including the target object, recurrence, and variables, should be provided in the request body.",
"requestBody":{
"description":"The object containing the details for the new schedule. This is expected in the request body.",
"required":false,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/JobScheduleDTO"
},
"example":{
"name":"your_schedule_name",
"status":"ACTIVE_FOR_PERIOD",
"designObjectType":"Data Flow",
"designObjectId":"c589c90f-0fab-40fc-b45a-401cff663556",
"activeEndDate":"2025-12-19T11:39:00",
"activeFromDate":"2025-08-18T11:39:23",
"dailyActivationTimeRange":"T11:39:23 T23:39:00",
"excludeWeekDays":"TUESDAY,SUNDAY",
"excludeMonthDays":"",
"maxDuration":"2 MINUTE",
"numberOfAttemptsAfterFailures":0,
"recurrence":"SIMPLE 2025-03-14T17:25:00",
"repetition":"None"
}
}
}
},
"responses":{
"409":{
"description":"Conflict"
},
"403":{
"description":"Forbidden"
},
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"A Response object containing the created schedule.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/JobScheduleDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-schedules-post",
"x-filename-id":"dt-rest-v2-schedules-post"
}
},
"/dt-rest/v2/schedules/{scheduleId}":{
"get":{
"operationId":"getScheduleById",
"tags":[
"Schedule"
],
"summary":"Retrieve Schedule",
"description":"Retrieves a schedule by ID.",
"parameters":[
{
"name":"scheduleId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"ID of the schedule to retrieve."
}
],
"responses":{
"404":{
"description":"Not Found"
},
"401":{
"description":"Unauthorized"
},
"200":{
"description":"A JSON response containing a schedule.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/JobScheduleDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-schedules-{scheduleId}-get",
"x-filename-id":"dt-rest-v2-schedules-scheduleid-get"
}
},
"/dt-rest/v2/variables":{
"get":{
"operationId":"getAllVariables",
"tags":[
"Variable"
],
"summary":"List Variables",
"description":"Retrieves a list of variables. This method supports various query parameters to filter and customize the response: fields: specifies the fields to include in the response (comma-separated)qualifiedName: filters variables by qualified name
The following examples demonstrate the supported query patterns:
- Retrieve all variables (no filters):
Retrieves all available variables without any qualified name filtering. All default fields for these variables will be included in the response.
/variables
- Retrieve all variables with specific fields:
Retrieves all available variables without any qualified name filtering, and the response will only include the fields specified in the fields parameter.
/variables?fields=name,variableId,...
- Retrieve a variable by qualified name:
Retrieves a variable that matches the given qualifiedName. All default fields for this variable will be included in the response.
/variables?qualifiedName=your_variable_name
- Retrieve a variable by qualified name with specific fields:
Retrieves a variable that matches the given qualifiedName, and the response will only include the fields specified in the fields parameter.
/variables?qualifiedName=your_variable_name&fields=name,variableId,...
",
"parameters":[
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"comma-separated list of fields to include in the response"
},
{
"name":"qualifiedName",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"filters variables by qualified name"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a response object containing the list of variables",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/DTVariableBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-variables-get",
"x-filename-id":"dt-rest-v2-variables-get"
}
},
"/dt-rest/v2/variables/{variableId}":{
"get":{
"operationId":"getVariableById",
"tags":[
"Variable"
],
"summary":"Retrieve Variable",
"description":"Retrieves a variable by its ID.",
"parameters":[
{
"name":"variableId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"the ID of the variable to retrieve."
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a Response object containing the variable details in JSON format.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DTVariableDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-variables-{variableId}-get",
"x-filename-id":"dt-rest-v2-variables-variableid-get"
}
},
"/dt-rest/v2/workflows":{
"get":{
"operationId":"getAllWorkflows",
"tags":[
"Workflow"
],
"summary":"List Workflows",
"description":"Retrieves a list of all workflows. 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 workflows by nameparentFolder: filters workflows by parent folder
The following examples demonstrate supported query patterns for this endpoint:
- Retrieve all workflows (no filters):
Retrieves all available workflows without any name filtering. All default fields for these workflows will be included in the response.
/workflows
- Retrieve all workflows with specific fields:
Retrieves all available workflows without any name filtering, and the response will only include the fields specified in the fields parameter.
/workflows?fields=name,workflowId,...
- Retrieve a workflow by name:
Retrieves workflows that match the given name. All default fields for these workflows will be included in the response.
/workflows?name=your_workflow_name
- Retrieve a workflow by name with specific fields:
Retrieves workflows that match the given name, and the response will only include the fields specified in the fields parameter.
/workflows?name=your_workflow_name&fields=name,workflowId,...
- Retrieves workflows by parentFolder:
Retrieves workflows that match the given parentFolder. All default fields for these workflows will be included in the response.
/workflows?parentFolder=your_workflow_parentFolder
- Retrieves workflows by parentFolder with specific fields:
Retrieves workflows that match the given parentFolder, and the response will only include the fields specified in the fields parameter.
/workflows?parentFolder=your_workflow_parentFolder&fields=name,workflowId,...
",
"parameters":[
{
"name":"fields",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"Optional. A comma-separated list of fields to include in the response for each workflow (e.g., \"workflowId,name,projectName\")."
},
{
"name":"name",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"QueryParam parameter name"
},
{
"name":"parentFolder",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"QueryParam parameter parentFolder"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"200":{
"description":"A Response object containing a list of workflows.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/WorkflowBaseDTO"
}
}
}
}
}
},
"x-internal-id":"dt-rest-v2-workflows-get",
"x-filename-id":"dt-rest-v2-workflows-get"
}
},
"/dt-rest/v2/workflows/{workflowId}":{
"get":{
"operationId":"getWorkflowById",
"tags":[
"Workflow"
],
"summary":"Retrieve Workflow",
"description":"Retrieves a workflow by its ID.",
"parameters":[
{
"name":"workflowId",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"description":"the ID of the workflow to retrieve"
}
],
"responses":{
"401":{
"description":"Unauthorized"
},
"404":{
"description":"Not Found"
},
"200":{
"description":"a workflow object, wrapped in a Response object",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/WorkflowBaseDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-workflows-{workflowId}-get",
"x-filename-id":"dt-rest-v2-workflows-workflowid-get"
}
},
"/odi/broker/pdbcs/public/v1/token":{
"post":{
"summary":"Retrieve Authentication Token - Autonomous AI Database Deployments",
"description":"Steps to authenticate:
- Send a
POST request with the required JSON payload to the endpoint. - Save the access_token and use it as your Bearer token.
- The token expires after the amount of seconds indicated by 'expires_in'.
- After the token expires, request a new token.
",
"tags":[
"Authentication"
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AuthenticationDTO"
},
"example":{
"username":"your_username",
"password":"your_pwd",
"database_name":"your_database_name",
"tenant_name":"your_tenant_ocid",
"cloud_database_name":"your_cloud_database_ocid",
"grant_type":"password"
}
}
}
},
"responses":{
"200":{
"description":"Successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TokenDTO"
},
"example":{
"access_token":"String",
"refresh_token":"String",
"token_type":"String",
"expires_in":"Number"
}
}
}
}
},
"x-internal-id":"odi-broker-pdbcs-public-v1-token-post",
"x-filename-id":"odi-broker-pdbcs-public-v1-token-post"
}
},
"/dt-rest/v2/authentication/token":{
"get":{
"operationId":"getToken",
"tags":[
"Authentication"
],
"summary":"Retrieves Authentication Token - Marketplace Deployments",
"description":"Steps to authenticate:
- Send a
GET request with the required Basic Authentication credentials to the endpoint. - Save the access_token and use it as your Bearer token.
- The token expires after the amount of seconds indicated by 'expires_in'.
- After the token expires, request a new token.
",
"responses":{
"401":{
"description":"Unauthorized"
},
"200":{
"description":"a Response object containing the authentication token",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TokenDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-authentication-token-get",
"x-filename-id":"dt-rest-v2-authentication-token-get"
}
},
"/dt-rest/v2/about":{
"get":{
"operationId":"getDTInfo",
"tags":[
"About"
],
"summary":"Retrieve Deployment Details",
"description":"Retrieves repository version, data transforms version, and deployment type.",
"responses":{
"401":{
"description":"Unauthorized"
},
"200":{
"description":"an HTTP response containing the deployment details",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/VersionDTO"
}
}
}
}
},
"x-internal-id":"dt-rest-v2-about-get",
"x-filename-id":"dt-rest-v2-get"
}
}
}
}