Retrieval of scheduled runs

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 Management Console workspaceId: ID of the workspace to which the task runs belong. The ID can be retrieved from the URL in Talend 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.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here