Retrieval of scheduled runs - Cloud - 8.0

Talend Release Notes
Version
Cloud
8.0
Language
English
Product
Talend Big Data
Talend Big Data Platform
Talend Cloud API Services Platform
Talend Cloud Big Data
Talend Cloud Big Data Platform
Talend Cloud Data Fabric
Talend Cloud Data Integration
Talend Cloud Data Management Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
Module
Talend Cloud API Designer
Talend Cloud API Tester
Talend Cloud Data Inventory
Talend Cloud Data Preparation
Talend Cloud Data Stewardship
Talend Cloud Management Console
Talend Cloud Pipeline Designer
Talend Data Preparation
Talend Data Stewardship
Talend Studio
Content
Installation and Upgrade
Release Notes

A new Orchestration API endpoint has been added to retrieve a list of all types of runs scheduled for a given period. The TMC_OPERATOR role or the TMC_ENGINE_USE permission is required to use this endpoint.

Access this endpoint via https://api.talend.com/apis/orchestration/2021-03/#operation_get-scheduled-executions.
New Orchestration API endpoint
Method Endpoint Description Query parameters
POST /orchestration/executables/events/search Gets runs of all types of items such as tasks, pipelines or plans for a specific period. It returns a list of dates and times for each of which a run is triggered.
  • environmentId: ID of the environment to which the task runs belong. This ID can be found from the URL in Talend Cloud Management Console
  • workspaceId: ID of the workspace to which the task runs belong. The ID can be retrieved from the URL in Talend Cloud Management Console or by using GET /orchestration/workspaces
  • from: earliest date and time (in milliseconds) of the timespan in which you search for scheduled runs
  • to: latest date and time (in milliseconds) of the timespan in which you search for scheduled runs
  • tags: filter on the runs of items with a specific tag, for example CRITICAL.
  • runtime: type of runtime on which a run is scheduled to take place, for example, CLOUD for a Cloud Engine, REMOTE_ENGINE for a Remote Engine or PIPELINE_ENGINE for a Remote Engine Gen2.
  • limit: number of entries to return. The default value is 100 and the value range is from 1 to 100
  • offset: the start position of the search, greater or equal to 0

The environmentId and the to parameters are required.