New Data integration project APIs

Deploy projects programmatically using export/import and prepare APIS

With the latest Qlik Talend Cloud Pipelines API releases, users are given the opportunity to deploy their projects across spaces and tenants, programmatically.

Released at the end of last year, our new export/import APIs for Qlik Talend Cloud Pipelines offer a programmatic way to export and import projects across tenants and spaces for deployment purposes. They allow programmers to export projects as a .zip file. They also include creating projects and reading or updating the project variables (referred to as bindings) before importing project contents.

5 new endpoints are available:

• Export the project contents as a .zip file:

  POST /v1/di-projects/{projectId}/actions/export

• Retrieve the bindings for a specified project:

  GET/v1/di-projects/{projectId}/bindings

• Create a project:

  POST /v1/di-projects

• Update bindings for a specified project:

  PUT /v1/di-projects/{projectId}/bindings

• Import project contents from a .zip file:

  POST /v1/di-projects/{projectId}/actions/import

Along with the export and import APIs, users now get the possibility to validate and prepare their projects before running them on their production environment. This is an essential complement to enabling end-to-end programmatic deployment of their projects.

Users can programmatically:

• Validate and prepare tasks at the project level, using the internal project orchestration logic:

  • Validate all tasks in a project:

    POST/api/v1/di-projects/{ProjectID}/actions/validate

  • Prepare all tasks in a project:

    POST/api/v1/di-projects/{ProjectID}/actions/prepare

• Validate and prepare tasks at the task level:

  • Validate a task:

    POST/api/v1/di-projects/{ProjectID}/di-tasks/{dataTaskID}/actions/validate

  • Prepare a task:

    POST /api/v1/di-projects/{ProjectID}/di-tasks/{dataTaskID}/actions/prepare

• Monitor the success of validate and prepare operations before running tasks:

  • Get action status:

    GET/api/v1/di-projects/actions/{ActionID}

Once deployed and prepared, tasks can then be started/restarted, and monitored using the Data integration projects APIs.

For more information, see the reference documentation for the Data integration projects API.