IBM APIs for DataStage

Introduction You can use a collection of IBM DataStage REST APIs to process, compile, and run flows. DataStage flows are design-time assets that contain data integration logic in JSON-based schemas. Process flows Use the processing API to manipulate data that you have read from a data source before writing it to a data target. Compile flows Use the compile API to compile flows. All flows must be compiled before you run them. . Run flows Use the run API to run flows. When you run a flow, the extraction, loading, and transforming tasks that were built into the flow designs are actually implemented. You can use the DataStage REST APIs for both DataStage in Cloud Pak for Data as a service and DataStage in Cloud Pak for Data. For more information on the DataStage service, see the following links: - DataStage in Cloud Pak for Data as a Servicehttps://dataplatform.cloud.ibm.com/docs/content/dstage/dsnav/topics/datastage.html?audience=wdp - DataStage in Cloud Pak for Datahttps://www.ibm.com/docs/en/cloud-paks/cp-data/4.0?topic=data-transforming The code examples on this tab use the client library that is provided for Java.

MethodPathSummary
DELETE/v3/data_intg_flowsDelete DataStage flows
GET/v3/data_intg_flowsGet metadata for DataStage flows
POST/v3/data_intg_flowsCreate DataStage flow
GET/v3/data_intg_flows/{data_intg_flow_id}Get DataStage flow
PUT/v3/data_intg_flows/{data_intg_flow_id}Update DataStage flow
PUT/v3/data_intg_flows/{data_intg_flow_id}/attributesModifies attributes of a DataStage flow
POST/v3/data_intg_flows/{data_intg_flow_id}/cloneClone DataStage flow
POST/v3/ds_codegen/compile/{data_intg_flow_id}Compile DataStage flow to generate runtime assets
DELETE/v3/data_intg_flows/subflowsDelete DataStage subflows
GET/v3/data_intg_flows/subflowsGet metadata for DataStage subflows
POST/v3/data_intg_flows/subflowsCreate DataStage subflow
GET/v3/data_intg_flows/subflows/{data_intg_subflow_id}Get DataStage subflow
PUT/v3/data_intg_flows/subflows/{data_intg_subflow_id}Update DataStage subflow
PUT/v3/data_intg_flows/subflows/{data_intg_subflow_id}/attributesModifies attributes of DataStage subflow
POST/v3/data_intg_flows/subflows/{data_intg_subflow_id}/cloneClone DataStage subflow
DELETE/v3/table_definitionsDelete table definitions
GET/v3/table_definitionsList table definitions
POST/v3/table_definitionsCreate table definition
DELETE/v3/table_definitions/{table_id}Delete a table definition
GET/v3/table_definitions/{table_id}Get table definition
PATCH/v3/table_definitions/{table_id}Patch a table definition
PUT/v3/table_definitions/{table_id}Update a table definition with a replacement
POST/v3/table_definitions/{table_id}/cloneClone table definition
DELETE/v3/assetsDelete assets and their attachments
GET/v3/assetsList assets
POST/v3/assetsCreate asset
PUT/v3/assetsCreate/update asset based on the given zip file.
GET/v3/assets/{asset_id}Get asset
PUT/v3/assets/{asset_id}Update asset with a replacement
DELETE/v3/assets/{asset_id}/attachmentsDelete attachments
POST/v3/assets/{asset_id}/attachmentsCreate attachment
GET/v3/assets/{asset_id}/attachments/{attachment_id}Get attachment
PATCH/v3/assets/{asset_id}/attachments/{attachment_id}Patch attachment
PUT/v3/assets/{asset_id}/attachments/{attachment_id}Replace attachment
POST/v3/assets/{asset_id}/cloneClone asset and its attachments
GET/v3/assets/{asset_id}/exportExport the asset with its all attachments as a zip
GET/v3/schema_librariesList DataStage XML schema libraries
POST/v3/schema_librariesCreate a new DataStage XML schema library
DELETE/v3/schema_libraries/{library_id}Delete a DataStage XML schema library
GET/v3/schema_libraries/{library_id}Get the specify DataStage XML schema library
POST/v3/schema_libraries/{library_id}Update a DataStage XML schema library
PUT/v3/schema_libraries/{library_id}Upload a file to an existing DataStage XML schema library
POST/v3/schema_libraries/{library_id}/cloneClone a DataStage XML schema library
DELETE/v3/schema_libraries/{library_id}/fileDelete files from a DataStage XML schema library
GET/v3/schema_libraries/{library_id}/fileDownload file from a DataStage XML schema library
POST/v3/schema_libraries/{library_id}/renameRename a DataStage XML schema library
GET/v3/schema_libraries/{library_name}/zipExport a XML Schema Library in zip format
PUT/v3/schema_libraries/{library_name}/zipImport/create XML Schema Library from zip stream
GET/v3/quality_stage/rulesList all Standardization Rules in a project.
DELETE/v3/quality_stage/rules/{rule_name}Removes the Standardization Rule from a project.
GET/v3/quality_stage/rules/{rule_name}Get basic information for the Standardization Rule
POST/v3/quality_stage/rules/{rule_name}Create a new Standardization Rule.
POST/v3/quality_stage/rules/{rule_name}/copyCopy the Standardization Rule from from_location to to_location.
POST/v3/quality_stage/rules/{rule_name}/testTest the Standardization Rule against a one-line test string (a single record) before you run it against an entire file.
GET/v3/quality_stage/rules/{rule_name}/zipExport the Standardization Rule in zip format.
PUT/v3/quality_stage/rules/{rule_name}/zipUpload/update the Standardization Rule from the given zip file
GET/v3/migration/git_commitGet the status of a previous git commit request
POST/v3/migration/git_pullImport Datastage components from git.
DELETE/v3/migration/git_pull/{import_id}Cancel a previous import request
GET/v3/migration/git_pull/{import_id}Get the status of a previous git pull request
GET/v3/migration/git_statusGet the status of a git repo
POST/v3/migration/isx_importsCreate V3 data flows from the attached job export file
DELETE/v3/migration/isx_imports/{import_id}Cancel a previous import request
GET/v3/migration/isx_imports/{import_id}Get the status of a previous import request
GET/v3/migration/project_infoGet Project and cache to reduce rate limit issue.
POST/v3/migration/zip_exportsexport flows with dependencies as a zip file.
POST/v3/migration/zip_importsCreate data flows from zip file
DELETE/v3/migration/zip_imports/{import_id}Cancel a previous import request
GET/v3/migration/zip_imports/{import_id}Get the status of a previous import request
GET/v3/assets/test_cases/{flow_id}Analyze a Flow for Unit Testing
POST/v3/assets/test_cases/{flow_id}Create Test Case specification from Flow Analysis
DELETE/v3/assets/{asset_id}Delete asset and their attachments
POST/v3/ds_codegen/generateBuildOp/{data_intg_bldop_id}Generate OPD-code for DataStage buildop
DELETE/v3/ds_codegen/pipeline/cache/{pipeline_id}Delete pipeline cache
POST/v3/ds_codegen/pipeline/compile/{pipeline_id}Compile Watson pipeline to generate runtime code
GET/v3/ds_codegen/pipeline/info/{pipeline_id}Retrieve optimized pipeline info