Orchestration
Manage your Artifacts, Tasks, Plans, Schedules, Environments, Workspaces, Promotions and all associated Ressources
Endpoints
- https://api.eu.cloud.talend.comURL for the AWS Europe region
- https://api.ap.cloud.talend.comURL for the AWS Asia Pacific region
- https://api.us.cloud.talend.comURL for the AWS United States East region
- https://api.au.cloud.talend.comURL for the AWS Australia region
- https://api.us-west.cloud.talend.comURL for the Azure United States West region
Security scheme
This scheme can be referenced across the API
Public
This Bearer authentication can be set in the Authorization header of your requests. Authentication tokens and Personal Access Tokens are supported. Personal Access Tokens can be generated in the Profile Preferences page of the Talend Cloud Portal.
| Name | Description |
|---|
Artifacts
Artifact
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Artifact identifier | string Required | 5cdd2ce2c737973f9d581b99 | |||||||||
| name | Artifact name | string Required | Test Artifact | |||||||||
| type | Artifact type | string Required | standard | |||||||||
| versions | array of string Required |
| ||||||||||
| workspace | WorkspaceInfo Required |
ArtifactParameter
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | Parameter name | string Required | parameter_url |
| value | Parameter value | string Optional | localhost |
| type | Parameter value | string Required | String |
| required | Is parameter required or not | boolean Required | |
| comment | Comment about parameter | string Optional | parameter for test |
ArtifactRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Id of artifact | string Required | 5c1111d7a4186a4eafed0587 |
| version | Artifact version | string Required | 0.1.0 |
ArtifactRequest
{
"id": "5c1111d7a4186a4eafed0587",
"version": "0.1.0"
}ArtifactVersion
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Id of artifact | string Required | 5c1111d7a4186a4eafed0587 | |||||||||
| name | Name of artifact | string Optional | Hello world artifact | |||||||||
| version | Artifact version | string Required | 0.1.0 | |||||||||
| type | Artifact type | string Required | standard | |||||||||
| publisher | Artifact publisher | string Required | admin | |||||||||
| marketplaceProduct | Marketplace product | string Required | Talend Data Fabric (tp_bd_7.2.1.20190612_1410) | |||||||||
| parameters | array of ArtifactParameter Required |
| ||||||||||
| workspace | WorkspaceInfo Required | |||||||||||
| description | Artifact description | string Optional | This is test artifact | |||||||||
| createDate | Artifact date of creation | datetime Required | RFC3339 | |||||||||
| repository | SourcesRepositoryData Optional | |||||||||||
| publisherType | Artifact publisher type | string Required | HUMAN |
PageArtifact
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of Artifact Optional |
| ||||||||||
| limit | integer Optional | INT32 | ||||||||||
| offset | integer Optional | INT32 | ||||||||||
| total | integer Optional | INT32 |
Get available Artifacts
GET /orchestration/artifactsGet available Artifacts
Request
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| environmentId | environment id | string Optional | ||||||||||
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional | INT32 | |||||||||
| workspaceId | workspace id | string Optional | ||||||||||
| name | artifact name filter | string Optional | ||||||||||
| limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional | INT32 | |||||||||
| types | array of string Optional |
|
Response
Delete Artifact by id
DELETE /orchestration/artifacts/{artifactId}Delete Artifact by id
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| artifactId | string Required |
Response
204Status 204
No content
Get Artifact by id
GET /orchestration/artifacts/{artifactId}Get Artifact by id
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| artifactId | string Required |
Response
Get Artifact of a specified version
GET /orchestration/artifacts/{artifactId}/versions/{version}Get Artifact of a specified version
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| artifactId | string Required | ||
| version | string Required |
Response
Delete Artifact of a specified version
DELETE /orchestration/artifacts/{artifactId}/versions/{version}Delete Artifact of a specified version
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| artifactId | string Required | ||
| version | string Required |
Response
204Status 204
No content
Get archive metadata of an artifact for a specified version
POST /orchestration/artifacts/{artifactId}/versions/{version}/archiveGet archive metadata of an artifact for a specified version
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| artifactId | string Required | ||
| version | string Required |
Response
ArtifactArchive
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| presignedUrl | Temporary presigned URL to download the archive | string Required | https://storage.example.com/archive/artifact-123.zip?signature=abc123 |
| metadata | Metadata of the artifact | ArtifactMetadata Required | |
| icon | Icon binaries for the artifact, encoded in Base64 | string Optional | data:image/png;base64,dzdz... |
| screenshot | Screenshot binaries for the artifact, encoded in Base64 | string Optional | data:image/png;base64,ddzdz |
| expiresAt | Expiration timestamp of the presigned url | number Optional | 1780668426316 |
ArtifactMetadata
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Id of the artifact | string Required | SayHello | |||||||||
| name | Name of the artifact | string Optional | SayHello | |||||||||
| version | Version of the artifact | string Optional | 0.1.0.20260906080839 | |||||||||
| groupId | Group id | string Optional | SayHello | |||||||||
| studioVersion | Studio version used to publish | string Optional | 8.0.1.20260521_1039-patch | |||||||||
| marketplaceProduct | A product of market place | string Required | Qlik Talend Cloud Enterprise Edition (qtc_e_8.0.1.20260521_1039-patch) | |||||||||
| jobType | Job type | string Required | standard | |||||||||
| artifactType | Artifact type | string Optional | OSGI | |||||||||
| origin | string Optional | standalone | ||||||||||
| config | array of ArtifactItemModel Required |
| ||||||||||
| contexts | ObjectOptional | |||||||||||
| title | Title | string Optional | SayHello | |||||||||
| repository | Repository info | SourcesRepositoryData Optional | ||||||||||
| application | array of string Optional |
| ||||||||||
| metadata | A map : key=String; value=List | ObjectOptional | ||||||||||
| path | Request Path | string Optional | Examples | |||||||||
| icon | An icon | string Optional | ||||||||||
| description | Description | string Optional | Creates a welcome text.\r\n\r\n### Parameters ###\r\n- name: type your name | |||||||||
| java | Artifact Java info | JavaInfo Optional | ||||||||||
| serviceType | Service type | string Optional | SOAP | |||||||||
| additionalProperties | ObjectOptional | |||||||||||
JavaInfo
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| compliance | Java version | string Optional | 17 |
| addOpens | boolean Optional |
ArtifactItemModel
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | Name | string Required | endpoint |
| value | Value | string Required | \"http://localhost:8040/services/customers/\" |
| description | Description | string Optional | |
| required | If required or not | boolean Optional | false |
| type | Java type | string Optional | String |
ArtifactContext
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default | boolean Optional | |||||||||||
| parameters | array of ArtifactParameter Optional |
|
Connections
UpdateConnectionRequest
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | Connection name | string Optional | testConnection | |||||||||
| parameters | array of ConnectionParameter Optional |
|
CreateConnectionRequest
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | Connection name | string Required | testConnection | |||||||||
| workspaceId | Workspace ID | string Required | 5b3ee8676e8f510dbb3fa806 | |||||||||
| app | Application name | string Required | Custom | |||||||||
| parameters | array of ConnectionParameter Required |
|
ConnectionParameter
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | Parameter name | string Required | param1 |
| value | Parameter value | string Optional | value1 |
| encrypted | If encrypted or not | boolean Optional |
ConnectionDetails
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Connection ID | string Required | ||||||||||
| name | Connection name | string Required | ||||||||||
| app | Application name | string Required | ||||||||||
| parameters | array of ConnectionParameter Required |
| ||||||||||
| workspace | WorkspaceInfo Required | |||||||||||
| createDate | Creation Date of Connection | datetime Required | RFC3339 | |||||||||
| updateDate | Update Date of Connection | datetime Optional | RFC3339 |
PageConnection
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of ConnectionDetails Optional |
| ||||||||||
| limit | integer Optional | INT32 | ||||||||||
| offset | integer Optional | INT32 | ||||||||||
| total | integer Optional | INT32 |
Create a Connection
POST /orchestration/connectionsResponse
Get available Connections
GET /orchestration/connectionsRequest
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| offset | integer Optional | INT32 | |
| name | string Optional | ||
| limit | integer Optional | 100 INT32 | |
| environmentId | Connection environment id filter | string Optional | |
| workspaceId | Connection workspace id filter | string Optional |
Response
Update a Connection
PUT /orchestration/connections/{connectionId}Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| connectionId | string Required |
Body
application/json
Response
Delete a Connection
DELETE /orchestration/connections/{connectionId}Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| connectionId | string Required |
Response
204Status 204
No Content
Get a Connection details
GET /orchestration/connections/{connectionId}Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| connectionId | string Required |
Response
Move a Connection
PUT /orchestration/connections/{connectionId}/move/{targetWorkspaceId}Move a connection to another workspace. The target workspace must be in the same environment as the original one.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| connectionId | string Required | ||
| targetWorkspaceId | string Required |
Response
Environments
EnvironmentInfo
An Environment is some uniquely named space allowing you to organize your workspaces and subsidiary jobs definition within the cloud platform.
Everything in TMC is related to an Environment : engines, workspaces, artifacts, tasks, plans, etc.
Default preconisation is to define Environments according to your Software Process life cycle, for instance Development, QA, Pre-Production, Production.
Workspace entity will allow you to organize your work within this Environment, according to your Business organization and security isolation rules.
Of course, you can already choose to define Environments as subparts of your IT, for instance ‘Production - Supply Chain’, and choose the right grain of organization.
Using Promotions, you would be able afterwards to define detailed rules for your software to be promoted across your Environments.
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Unique identifier of the Environment | string Required | 57f64991e4b0b689a64feed3 |
| name | Functional name of the Environment | string Required | Development |
| description | string Optional | detailed environment description | |
| maxCloudContainers | maximum number of cloud engines | integer Optional | INT32 |
| default | boolean Optional |
Create Environment
POST /orchestration/environmentsCreate an Environment.
Requirements:
- environment name must be unique
- the user account issuing the request must be granted the ENVIRONMENT_MANAGEMENT permission
Environment is created on platform. A CUSTOM workspace is automatically created within this environment with proper ownership permissions assigned onto it.
Upon your request, Cloud Engine could also be assigned to the newly added environment.
Request
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | Unique name for the environment to create | string Required | Production - Asia - Development - Supply Chain |
| description | string Optional | ||
| maxCloudContainers | Number of Cloud Engines to assign to this Environment | integer Optional | INT32 |
| workspaceName | Name for the custom workspace created along with the Environment | string Required | |
| owner | Login name of user to be owner of the custom workspace created along with the Environment | string Optional | jSmith |
Response
401Status 401
User has not the right credentials for completing creation
Body
application/json
List Environments
GET /orchestration/environmentsRetrieve all the environments according to filters.
If the user is entitled with CLUSTER_MANAGEMENT or ENVIRONMENT_MANAGEMENT role, all environments matching query will be returned.
If the user is entitled with OPERATOR role, environments matching query and the user workspace permissions will be returned.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| query | search query (FIQL format), e.g. name==Dev*;description==*environment* | string Optional |
Response
200Status 200
List of candidate environments provided
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of EnvironmentInfo |
| |||||||||||
Update Environment
PUT /orchestration/environments/{Id}Update the identified Environment.
Make sure the user is entitled with ENVIRONMENT_MANAGEMENT role.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| Id | string Required |
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | string Required | ||
| description | string Optional | ||
| maxCloudContainers | integer Optional | INT32 |
Response
204Status 204
Environment removed
Remove Environment
DELETE /orchestration/environments/{Id}Delete the specified environment.
Before deleting the environment, you must delete all spaces belonging to it.
Ensure that the user has the ENVIRONMENT_MANAGEMENT role.
Confirm the environment removal before calling this endpoint. Removing the environment also removes subsidiary elements, including engines and promotions.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| Id | string Required |
Response
204Status 204
Environment removed
400Status 400
“To delete the environment, you must first delete all its spaces.”
Body
application/json
Workspaces
Workspace
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Workspace identifier | string Required | 57f64991e4b0b689a64feed2 |
| name | Workspace name | string Required | Personal |
| description | Workspace description | string Optional | workspace detail description |
| createDate | Date of creation of the workspace | datetime Required | RFC3339 |
| updateDate | Date of update of the workspace | datetime Required | RFC3339 |
| owner | Owner of the workspace | string Optional | admin |
| ownerFullName | Full name of the workspace owner | string Required | |
| type | Workspace type | string Required | |
| environmentId | Environment id of the workspace | string Required |
WorkspaceInfo
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Workspace identifier | string Optional | 57f64991e4b0b689a64feed2 |
| name | Workspace name | string Optional | Personal |
| description | Workspace description | string Optional | workspace detail description |
| owner | Workspace owner | string Optional | admin |
| type | Workspace type | string Optional | custom |
| environment | EnvironmentInfo Optional | ||
| protectedArtifactUpdate | Allows to restrict the scope of task updates when a new artifact version is published.
| boolean Optional |
CreateWorkspaceRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | Name of the workspace to be created | string Required | |
| description | Functional description of your workspace | string Optional | |
| owner | Login name of the owner of the workspace | string Optional | fDupont |
| environmentId | Environment this workspace will belong to | string Required |
Create Workspace
POST /orchestration/workspacesCreate a Workspace.
Please ensure the following requirements are met :
- provide environment this workspace will belong to
- provide some unique naming within environment
- user must be granted ENVIRONMENT_MANAGEMENT permission
Owner can be provided. By default, creator user would be owner. Type is Custom.
Response
List Workspaces
GET /orchestration/workspacesRetrieve all the workspaces according to filters.
If the user is entitled with CLUSTER_MANAGEMENT or ENVIRONMENT_MANAGEMENT role, all workspaces matching query will be returned.
If the user is entitled with OPERATOR role, workspaces matching query and the workspace permissions will be returned.
Use cases
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| query | This parameter defines a search query in FIQL format. The Feed Item Query Language is a syntax for expressing filters across the entries. | string Optional | name==TestWorkspace,environment.name==TestEnvironment |
Response
200Status 200
Successful response
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of WorkspaceInfo |
| |||||||||||
Remove Workspace
DELETE /orchestration/workspaces/{id}Remove the Workspace and all its subparts : executables (tasks and plans), permissions, etc.
Make sure the user is entitled with ENVIRONMENT_MANAGEMENT role.
Custom Workspaces only can be removed using this API. (Shared and Personal are linked either to Environment or User’s life cycle)
Workspace in use won’t be removed : if any task, artifact, resource, connection is used in any other workspace, removal is not achieved. Please make sure Workspace removal is confirmed before calling this endpoint as removal will be cascading all subsidiary elements within. With no cancellation service available.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | string Required |
Response
204Status 204
Successful response - No Content
409Status 409
There are objects in custom workspace that could not be removed
Body
application/json
Update Workspace
PUT /orchestration/workspaces/{id}Update the identified Workspace.
Make sure the user is entitled with ENVIRONMENT_MANAGEMENT role.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | string Required |
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | string Required | ||
| description | string Optional | ||
| owner | string Optional | ||
| protectedArtifactUpdate | Allows to restrict the scope of task updates when a new artifact version is published.
| boolean Optional |
Response
204Status 204
Successful response - No Content
Plans
Step
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Step id | string Optional | 9af64991e4b0b689a64feed0 | |||||||||
| name | Step name | string Required | Step 1 | |||||||||
| condition | Expected status of successful step | string Required | ||||||||||
| taskIds | array of string Required |
| ||||||||||
| handlerOnFailure | StepErrorHandler Optional | |||||||||||
| note | Description to rerun a plan execution from this step | string Optional | Clear the database for users |
Step
[
{
"condition": "ALL_SUCCEEDED",
"handlerOnFailure": {
"planIds": [
"5d5fc81f79bc197d2483a104"
],
"taskIds": [
"5d5fc81f79bc197d2483a102",
"5d5fc81f79bc197d2483a103"
]
},
"id": "9af64991e4b0b689a64feed0",
"name": "Step 1",
"note": "Clear the database for users",
"successfulStepCondition": "ALL_SUCCEEDED",
"taskIds": [
"5d5fc81f79bc197d2483a100",
"5d5fc81f79bc197d2483a101"
]
}
]StepErrorHandler
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| taskIds | array of string Optional |
| ||||||||||
| planIds | array of string Optional |
|
Plan
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Resource id | string Required | 5cdd2ce2c737973f9d581b98 | |||||||||
| name | Resource name | string Required | Remote Engine | |||||||||
| description | Resource description | string Optional | Some description | |||||||||
| workspace | WorkspaceInfo Optional | |||||||||||
| createDate | Date of creation of the resource | datetime Required | RFC3339 | |||||||||
| updateDate | Date of updating of the resource | datetime Optional | RFC3339 | |||||||||
| author | Plan author | string Required | operator123 | |||||||||
| steps | array of Step Required |
| ||||||||||
| authorType | Plan author type | string Optional |
PlanExecutableDetails
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| executable | Executable identifier | string Required | 57f64991e4b0b689a64feed0 |
| name | Executable name | string Required | simple executable |
| workspace | WorkspaceInfo Required | ||
| description | Executable description | string Optional | plan detail description |
| chart | PlanStep Required | ||
| status | Plan execution status | string Optional | |
| planPauseDetails | PlanPauseDetails Optional |
PlanRequest
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | Plan name | string Required | Plan 1 | |||||||||
| workspaceId | Plan workspace | string Required | 57f64991e4b0b689a64feed2 | |||||||||
| description | Plan description | string Optional | Some description | |||||||||
| steps | array of Step Required |
|
PlanRequest
{
"description": "Some description",
"name": "Plan 1",
"steps": [
{
"condition": "ALL_SUCCEEDED",
"handlerOnFailure": {
"planIds": [
"5d5fc81f79bc197d2483a104"
],
"taskIds": [
"5d5fc81f79bc197d2483a102",
"5d5fc81f79bc197d2483a103"
]
},
"id": "9af64991e4b0b689a64feed0",
"name": "Step 1",
"note": "Clear the database for users",
"successfulStepCondition": "ALL_SUCCEEDED",
"taskIds": [
"5d5fc81f79bc197d2483a100",
"5d5fc81f79bc197d2483a101"
]
}
],
"workspaceId": "57f64991e4b0b689a64feed2"
}PlanStep
Plan Steps for work with required tasks.
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Id of Plan Step | string Optional | ||||||||||
| abstractStepId | Abstract id of the Step | string Optional | ||||||||||
| name | Step name | string Optional | ||||||||||
| status | Status of the current step | string Optional | ||||||||||
| stepOnException | PlanStep Optional | |||||||||||
| nextStep | PlanStep Optional | |||||||||||
| flows | array of PlanTask Optional |
| ||||||||||
| note | Note, added to the current step | string Optional | ||||||||||
| taskIds | array of string Optional |
|
PlanTask
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Id of the current plan task | string Optional | |
| name | Name of the current plan task | string Optional | |
| version | Version of the current plan task | string Optional | |
| description | Plan task description | string Optional | |
| destination | Destination of the the current plan task | string Optional | |
| workspaceId | Id of the plan task’s workspace | string Optional | |
| abstractPlanId | Id of the abstract plan | string Optional | |
| artifact | BaseArtifactVersion Optional | ||
| taskPauseDetails | TaskPauseDetails Optional |
PlanRunConfig
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| trigger | Trigger Required | ||
| parallelExecutionAllowed | Indicates whether this executable is allowed to run in parallel. ‘false’ by default | boolean Optional |
ExecutionStep
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| stepId | string Optional | |||||||||||
| abstractStepId | string Optional | |||||||||||
| stepName | string Optional | |||||||||||
| status | string Optional | |||||||||||
| stepOnException | ExecutionStep Optional | |||||||||||
| nextStep | ExecutionStep Optional | |||||||||||
| flows | array of ExecutionFlow Optional |
| ||||||||||
| stepNote | string Optional |
ExecutionFlow
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Id of current execution flow | string Optional | |
| name | Name of current execution flow | string Optional | |
| version | Version of current execution flow | string Optional | |
| description | Execution flow description | string Optional | |
| destination | Destination of current flow | string Optional | |
| workspaceId | string Optional | ||
| abstractPlanId | string Optional | ||
| plan | boolean Optional | ||
| artifactShortVersion | ArtifactVersion Optional | ||
| upgradeInfo | UpgradeInfo Optional | ||
| jobType | string Optional | ||
| pauseDetails | PauseDetails Optional |
PlanPauseDetails
Contains status of Plan regarding Pause/Resume capacity, as well as optional contextual explanation for the pause. You can use this context for audit purpose to link information on the IT event that led to this pause (eg. maintenance window for prod operation).
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| pause | If true, paused | boolean Required | |
| pauseContext | Plan pause description | string Optional | |
| user | User that took the action to pause | string Optional | |
| userType | UserType Optional | ||
| pauseDate | The date time when this pause started | datetime Optional | RFC3339 |
PlanPauseDetails
{
"pause": true,
"pauseContext": "Pause for Monthly Prod Op #XYZ",
"pauseDate": "2023-01-13T14:42:58.341Z",
"user": "adminMasterX",
"userType": "HUMAN"
}PagePlan
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of PlanExecutableDetails Optional |
| ||||||||||
| limit | integer Required | INT32 | ||||||||||
| offset | integer Required | INT32 | ||||||||||
| total | integer Optional | INT32 |
PauseDetails
Contains status regarding Pause/Resume capacity, as well as optional contextual explanation for the pause. You can use this context to link information on the production event that led to this pause (eg. maintenance window for prod operation).
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| pause | If true, paused | boolean Required | |
| pauseContext | Plan pause description | string Optional | |
| user | User that took the action to pause | string Optional | |
| userType | UserType Optional | ||
| pauseDate | The date time when this pause started | datetime Optional | RFC3339 |
PauseDetails
{
"pause": true,
"pauseContext": "Pausing execution",
"pauseDate": "2023-01-13T14:42:58.341Z",
"user": "admin",
"userType": "HUMAN"
}Create Plan
POST /orchestration/executables/plansCreate Plan
Response
Get available Plans
GET /orchestration/executables/plansGet available Plans
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| environmentId | environment id | string Optional | |
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional | INT32 |
| workspaceId | workspace id | string Optional | |
| taskId | task Id | string Optional | |
| name | plan name filter | string Optional | |
| limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional | INT32 |
| planId | plan id | string Optional |
Response
Delete Plan
DELETE /orchestration/executables/plans/{planId}Delete Plan
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | executable ID | string Required |
Response
204Status 204
No Content
Get Plan details
GET /orchestration/executables/plans/{planId}Get Plan details
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | executable ID | string Required |
Response
Update plan
PUT /orchestration/executables/plans/{planId}Update Plan
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | executable ID | string Required |
Body
application/json
Response
Configure Plan execution
PUT /orchestration/executables/plans/{planId}/run-configConfigure Plan execution
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | plan id | string Required |
Body
application/json
Response
Get Plan configuration
GET /orchestration/executables/plans/{planId}/run-configGet Plan configuration applied to your Plan executions.
Please take note :
- the Trigger definition can now have some new value ‘Multiple’ defined when you link your plan to some Multiple Time Trigger schedule.
- whenever such multiple trigger schedule is linked please use the new dedicated endpoints to manage this specific scheduling configuration.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | plan id | string Required |
Response
Stop schedule for plan
DELETE /orchestration/executables/plans/{planId}/run-configStop schedule for plan
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | plan id | string Required |
Response
204Status 204
No Content
Get plan scheduled triggers
GET /orchestration/executables/plans/{planId}/run-config/eventsGet plan triggers for cron schedules
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | string Required |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional | INT32 |
| to | to date time (milliseconds) | integer Required | INT64 |
| limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional | INT32 |
| from | from date time (milliseconds) | integer Optional | INT64 |
Response
Pause-Resume Plan executions
PUT /orchestration/executables/plans/{planId}/pauseAllow to pause and resume plan executions
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | string Required |
Body
application/json
Response
202Status 202
Successful response - Accepted (work is done in background)
204Status 204
Successful response - No content
Projects
ProjectView
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | string Optional | ||
| name | string Optional | ||
| technicalLabel | string Optional | ||
| description | string Optional | ||
| url | string Optional | ||
| author | string Optional | ||
| owner | string Optional | ||
| projectType | string Optional | ||
| repoType | string Optional | ||
| createDate | datetime Optional | RFC3339 | |
| updateDate | datetime Optional | RFC3339 |
ProjectCreateRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| owner | Owner name | string Required | John Doe |
| description | Project description | string Optional | John Doe |
| url | Project url | string Required | https://github.com/example/Example.git |
| name | Project name | string Required | Hello world project |
ProjectRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| owner | Owner name | string Optional | John Doe |
| description | Project description | string Optional | John Doe |
| url | Project url | string Optional | https://github.com/example/Example.git |
SourcesRepositoryData
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| project | project name | string Required | |
| branch | repository branch | string Optional | |
| commit | RepositoryCommitData Optional |
RepositoryCommitData
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | commit id | string Required | d8a1c8aac0365fb00f32c45ccbd07ad81fe9d60c |
| date | commit date time | datetime Optional | RFC3339 |
| author | commit author | string Required | mpidhornyi <mpidhornyi@talend.com> |
PageProject
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of ProjectView Optional |
| ||||||||||
| limit | integer Optional | INT32 | ||||||||||
| offset | integer Optional | INT32 | ||||||||||
| total | integer Optional | INT32 |
Create Project
POST /orchestration/projectsCreate Project
Please take note only PAT access is supported on this endpoint at current.
Response
Get Projects
GET /orchestration/projectsGet Projects
Please take note only PAT access is supported on this endpoint at current.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| projectName | project name filter | string Optional | |
| limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional | INT32 |
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional | INT32 |
Response
Delete project
DELETE /orchestration/projects/{projectId}Delete project
Please take note only PAT access is supported on this endpoint at current.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| projectId | project ID | string Required |
Response
204Status 204
No Content
Get Project by id
GET /orchestration/projects/{projectId}Get Project by id
Please take note only PAT access is supported on this endpoint at current.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| projectId | project ID | string Required |
Response
Update Project
PUT /orchestration/projects/{projectId}Update Project
Please take note only PAT access is supported on this endpoint at current.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| projectId | project ID | string Required |
Body
application/json
Response
Projects Authorization
ProjectUserAuthResponse
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| projectId | string Optional | |||||||||||
| userIds | array of string Optional |
|
ProjectGroupAuthResponse
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| projectId | string Optional | |||||||||||
| groupIds | array of string Optional |
|
Promotions
AdvancedPromotionSpec
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| artifactId | Advanced Promotion Artifact Id | string Optional | 57f64991e4b0b689a64feed0 |
| artifactType | Advanced Promotion Artifact Type. In the following list of allowed values, ‘ACTION’ refers to Artifacts, ‘FLOW’ refers to Tasks, ‘PLAN’ refers to Plans and ‘WORKSPACE’ refers to Workspaces | string Optional | WORKSPACE |
ArtifactPromotionResult
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Artifact ID | string Optional | ||||||||||
| targetId | Target Artifact ID | string Optional | ||||||||||
| name | Artifact Name | string Optional | ||||||||||
| type | Artifact Type | string Optional | WORKSPACE | |||||||||
| analyzeReport | Report Optional | |||||||||||
| promotionReport | Report Optional | |||||||||||
| usedBy | array of FlowPromotionResult Optional |
| ||||||||||
| targetVersion | Artifact Version In Target Environment | string Optional | "0.1.1.20223008022926" | |||||||||
| version | Artifact Version In Source Environment | string Optional | "0.1.1.20223008022926" | |||||||||
| versions | array of ArtifactPromotionResult Optional |
| ||||||||||
| jobType | Action Job Type | string Optional | STANDARD | |||||||||
| workspaceId | Promoted Artifact Workspace ID | string Optional | ||||||||||
| artifactId | Flow artifact name | string Optional |
FlowPromotionResult
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Artifact ID | string Optional | ||||||||||
| targetId | Target Artifact ID | string Optional | ||||||||||
| name | Artifact Name | string Optional | ||||||||||
| type | Artifact Type | string Optional | WORKSPACE | |||||||||
| analyzeReport | Report Optional | |||||||||||
| promotionReport | Report Optional | |||||||||||
| usedBy | array of FlowPromotionResult Optional |
| ||||||||||
| targetVersion | Promoted Flow Target Version | string Optional | "1.1" | |||||||||
| version | Source Flow Version | integer Optional | INT32 1 | |||||||||
| versions | array of ArtifactPromotionResult Optional |
| ||||||||||
| jobType | Flow Job Type | string Optional | STANDARD | |||||||||
| workspaceId | Promoted Flow Workspace ID | string Optional | ||||||||||
| artifactId | Flow artifact Id | string Optional |
UpdateDescriptionRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| description | Promotion description | string Required | This is new description |
PromotionExecutableDetails
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| executable | Executable identifier | string Required | 57f64991e4b0b689a64feed0 |
| name | Executable name | string Required | simple executable |
| sourceEnvironment | EnvironmentInfo Optional | ||
| targetEnvironment | EnvironmentInfo Optional | ||
| description | Promotion description (not returned when querying a list of objects) | string Optional | promotion detail description |
CreatePromotionRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| sourceEnvironmentId | Source environment ID | string Required | 5b3ee8676e8f510dbb3fa806 |
| targetEnvironmentId | Target environment ID | string Required | 5b3ee8676e8f510dbb3fa807 |
| description | Promotion description | string Optional | This is description |
TaskAutoUpgradeRequest
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| workspaceId | Workspace id of task to create | string Required | 57f64991e4b0b689a64feed2 | |||||||||
| name | Task name | string Required | Hello world task | |||||||||
| description | Task description | string Required | Task detail description | |||||||||
| tags | array of string Optional |
| ||||||||||
| connections | Task connections | ObjectOptional | ||||||||||
| parameters | Task parameters | ObjectOptional | ||||||||||
| resources | Task resources | ObjectOptional | ||||||||||
| artifact | ArtifactRequest Required | |||||||||||
| autoUpgradeInfo | AutoUpgradeInfo Optional | |||||||||||
UpgradeInfo
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| upgradable | boolean Optional | ||
| autoUpgradeFailed | boolean Optional |
Message
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| info | string Optional | ||
| level | string Optional | INFO |
PromotionResultInfo
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Artifact ID | string Optional | |
| targetId | Target Artifact ID | string Optional | |
| name | Artifact Name | string Optional | |
| type | Artifact Type | string Optional | WORKSPACE |
| analyzeReport | Report Optional | ||
| promotionReport | Report Optional | ||
| targetVersion | Applicable to flows only, displays version of flow in target environment after promotion execution | string Optional | 1.1 |
| version | Applicable to flows only, displays version of flow in source environment | integer Optional | INT32 |
| workspaceId | Artifact Workspace Id | string Optional |
Report
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| status | string Optional | CREATED | ||||||||||
| messages | array of Message Optional |
|
RuntimePromotionResult
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Artifact ID | string Optional | ||||||||||
| targetId | Artifact Target ID | string Optional | ||||||||||
| name | Artifact Name | string Optional | ||||||||||
| type | Artifact Type | string Optional | WORKSPACE | |||||||||
| analyzeReport | Report Optional | |||||||||||
| promotionReport | Report Optional | |||||||||||
| usedBy | array of FlowPromotionResult Optional |
| ||||||||||
| runProfiles | array of ArtifactPromotionResult Optional |
|
WorkspacePromotionResult
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Artifact ID | string Optional | ||||||||||
| targetId | Artifact Target ID | string Optional | ||||||||||
| name | Artifact Name | string Optional | ||||||||||
| type | Artifact Type | string Optional | WORKSPACE | |||||||||
| analyzeReport | Report Optional | |||||||||||
| promotionReport | Report Optional | |||||||||||
| flows | array of FlowPromotionResult Optional |
| ||||||||||
| plans | array of ArtifactPromotionResult Optional |
| ||||||||||
| actions | array of ArtifactPromotionResult Optional |
| ||||||||||
| connections | array of ArtifactPromotionResult Optional |
| ||||||||||
| resources | array of ArtifactPromotionResult Optional |
| ||||||||||
| engines | array of RuntimePromotionResult Optional |
| ||||||||||
| clusters | array of RuntimePromotionResult Optional |
| ||||||||||
| workspaceType | Promoted Workspace Type | string Optional | Shared |
PromotionExecutionStatusV26
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| executionId | Job execution ID | string Required | 7b2b122e-d6b8-42de-b0ba-fa2f0d36306e | |||||||||
| startTimestamp | Start time of job execution (UTC) | datetime Optional | RFC3339 | |||||||||
| triggerTimestamp | Trigger time of job execution (UTC) | datetime Required | RFC3339 | |||||||||
| finishTimestamp | End time of job execution (UTC) | datetime Optional | RFC3339 | |||||||||
| userId | User who triggered or scheduled the execution | string Required | fupton | |||||||||
| userType | Promotion Executor user type | string Required | SERVICE | |||||||||
| promotionId | Promotion ID | string Optional | ||||||||||
| pipelineId | Deprecated! Use Promotion ID instead | string Optional | ||||||||||
| keepTargetResources | Keep Target Resources flag | boolean Optional | ||||||||||
| keepTargetRunProfiles | Keep Target Run Profiles flag (not returned for API versions earlier V2.2) | boolean Optional | ||||||||||
| advanced | AdvancedPromotionSpec Optional | |||||||||||
| defective | Defective Promotion flag | boolean Optional | ||||||||||
| status | Execution status | string Optional | ANALIZED | |||||||||
| statusMessage | Execution Status Message | string Optional | ||||||||||
| workspaces | array of WorkspacePromotionResult Optional |
| ||||||||||
| engines | array of RuntimePromotionResult Optional |
| ||||||||||
| clusters | array of RuntimePromotionResult Optional |
| ||||||||||
| context | Execution context message | string Optional | 255 Free text describing the context for promotion execution |
PromotionAdvancedInfo
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Artifact ID | string Optional | |
| name | Artifact Name | string Optional | |
| workspaceId | Artifact workspace ID | string Optional | |
| type | Defines the scope of the promotion execution | string Optional | WORKSPACE |
PromotionExecutionDetails
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| keepTargetRunProfiles | Dont touch run profiles on target | boolean Optional | |
| keepTargetResources | Dont touch resources on target | boolean Optional | |
| context | Optional context for audit log the promotion execution | string Optional | |
| promotionAdvancedInfo | PromotionAdvancedInfo Optional |
Get available Promotions
GET /orchestration/executables/promotionsGet available Promotions
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| _s | search query (FIQL format), e.g. “name==dev to prod*” | string Optional |
Response
200Status 200
OK
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of PromotionExecutableDetails |
| |||||||||||
Create a Promotion
POST /orchestration/executables/promotionsCreate a Promotion
Response
Get Promotion details
GET /orchestration/executables/promotions/{promotionId}Get Promotion details
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| promotionId | Promotion ID | string Required |
Response
Delete a Promotion
DELETE /orchestration/executables/promotions/{promotionId}Delete a Promotion
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| promotionId | Promotion ID | string Required |
Response
204Status 204
No Content
Perform promotion analysis
POST /orchestration/executables/promotions/{promotionId}Simulate upcoming executions of a promotion and get reports about its change analysis without executing it in real. Note that the target version displayed in the analysis could differ from the target version from the real promotion execution, if some changes are made in the target environment between the simulation and the actual execution of the promotion.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| promotionId | Promotion ID | string Required |
Body
application/json
Response
Update a Promotion
PATCH /orchestration/executables/promotions/{promotionId}Update a Promotion
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| promotionId | Promotion ID | string Required |
Body
application/json
Response
204Status 204
No Content
Promotions Authorization
PromotionUsersResponse
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| executable | Promotion ID | string Required | 5d3039de65ff7d3583840bk1 | |||||||||
| userIds | array of string Required |
| ||||||||||
| serviceAccountIds | array of string Required |
|
Get users assigned to Promotion
GET /orchestration/executables/promotions/{promotionId}/usersGet users assigned to Promotion
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| promotionId | Promotion ID | string Required |
Response
Unassign user from Promotion
DELETE /orchestration/executables/promotions/{promotionId}/users/{userId}Unassign user from Promotion
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| promotionId | Promotion ID | string Required | |
| userId | User ID | string Required |
Response
204Status 204
No Content
Assign user to Promotion
PUT /orchestration/executables/promotions/{promotionId}/users/{userId}Assign user to Promotion
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| promotionId | Promotion ID | string Required | |
| userId | User ID | string Required |
Response
204Status 204
No Content
Assign service account to promotion
PUT /orchestration/executables/promotions/{promotionId}/service-accounts/{serviceAccountId}Assign service account to promotion
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| promotionId | string Required | ||
| serviceAccountId | string Required |
Response
204Status 204
Service Account has been assigned to promotion
Unassign service account from promotion
DELETE /orchestration/executables/promotions/{promotionId}/service-accounts/{serviceAccountId}Unassign service account from promotion
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| promotionId | string Required | ||
| serviceAccountId | string Required |
Response
204Status 204
Service account has been unassigned from promotion
Resources
Resource
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Id of resource | string Required | 5c1111d7a4186a4eafed0587 |
| name | Name of resource | string Required | Hello world task |
| description | Description of resource | string Optional | task detail description |
| workspaceInfo | WorkspaceInfo Required | ||
| file | Boolean value which indicates that resource is file | boolean Required |
UpdateResourceRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | Resource name | string Optional | |
| description | Resource description | string Optional |
PageResource
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of Resource Optional |
| ||||||||||
| limit | integer Optional | INT32 | ||||||||||
| offset | integer Optional | INT32 | ||||||||||
| total | integer Optional | INT32 |
CreateResourceRequest
Resource detail : json payload with resource attributes
stringCreateResourceRequest
{
"name": "resource name",
"description": "resource description",
"workspaceId": "workspace id",
"file": true
}Get Resources
GET /orchestration/resourcesRequest
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional | INT32 |
| name | Resource name filter | string Optional | |
| limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional | INT32 |
| environmentId | Resource environment id filter | string Optional | |
| workspaceId | Resource workspace id filter | string Optional |
Response
Create a Resource
POST /orchestration/resourcesRequest
Body
multipart/form-data
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| resource | CreateResourceRequest Required | ||
| file | Attach a resource file you need to use with your tasks. To ensure that your tasks run smoothly without any security-related interruptions, it is recommended to encode the file in base64 and add a decoding step directly in the Jobs that require it. This design not only helps protect your data but also avoids any potential security issues that may arise from Talend Cloud’s security mechanism interpreting the file. | file Required |
Response
Get Resource by id
GET /orchestration/resources/{resourceId}Get Resource by id
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| resourceId | Resource id | string Required |
Response
Delete a Resource
DELETE /orchestration/resources/{resourceId}Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| resourceId | Resource id | string Required |
Response
204Status 204
no content
Update a Resource
PATCH /orchestration/resources/{resourceId}Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| resourceId | Resource id | string Required |
Body
application/json
Response
204Status 204
no content
Update a Resource attachment
PUT /orchestration/resources/{resourceId}/uploadRequest
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| resourceId | Resource ID | string Required |
Body
multipart/form-data
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| file | Resource attachment | file Optional |
Response
204Status 204
no content
Move a Resource attachment
PUT /orchestration/resources/{resourceId}/move/{targetWorkspaceId}Move a resource to another workspace. The target workspace must be in the same environment as the original one.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| resourceId | string Required | ||
| targetWorkspaceId | string Required |
Response
Schedules
ScheduleTrigger
Elementary Scheduling item. Also known as ‘trigger’, this schedule object can take different types : CRON, ONCE, DAILY, WEEKLY, MONTHLY.
Note that schedule updates that are made within three minutes prior to the scheduled execution time immediately impact the execution. For this reason, avoid making schedule changes when an execution is about to be triggered.
Object
| Name | Description | Type | Attributes and examples | |||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | Name of your trigger, unique within a schedule | string Required | ||||||||||||||||||||||||||||||||||||||
| type | Type of schedule = [‘ONCE’, ‘DAILY’, ‘WEEKLY’, ‘MONTHLY’, ‘CRON’], | string Required | ||||||||||||||||||||||||||||||||||||||
| interval | Interval between task/plan running in days/weeks/months, required only if type of schedule is not equal to ‘ONCE | integer Optional | INT32 1 | |||||||||||||||||||||||||||||||||||||
| startDate | Date when the schedule should start to be active | string Optional | ||||||||||||||||||||||||||||||||||||||
| startTime | Time when the schedule should start to be active | string Optional | 05:30 | |||||||||||||||||||||||||||||||||||||
| timeZone | Time zone for task schedule | string Optional | ||||||||||||||||||||||||||||||||||||||
| atTimes | Specific ‘at Times’ schedule | ObjectOptional | ||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||
| atDays | Specific ‘at Days’ schedule | ObjectOptional | ||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||
| cronExpression | CRON Optional | |||||||||||||||||||||||||||||||||||||||
| timeout | Timeout to apply (in minutes) to this trigger executions only. This value would override the default timeout possibly set on Task definition. | integer Optional | INT32 | |||||||||||||||||||||||||||||||||||||
ScheduleTrigger
{
"name": "Once trigger example",
"startDate": "2022-06-16",
"startTime": "05:30",
"timeZone": "Europe/Kiev",
"type": "ONCE",
"atTimes": {
"type": "AT_TIME",
"time": "11:00"
}
}Schedule
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Unique identifier | string Required | ||||||||||
| description | Functional description | string Optional | ||||||||||
| triggers | array of ScheduleTrigger Optional |
| ||||||||||
| environmentId | Id of the environment this schedule is part of | string Required | ||||||||||
| executableId | Id the task or plan this schedule is applied to. When empty, means the schedule is not in action. | string Optional | ||||||||||
| executableType | Executable type, ie Task or Plan, to which this schedule applies to | string Optional |
PageSchedule
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of Schedule Required |
| ||||||||||
| limit | integer Required | INT32 | ||||||||||
| offset | integer Required | INT32 | ||||||||||
| total | integer Required | INT32 |
CRON
- CRON expression following https://www.freeformatter.com/cron-expression-generator-quartz.html)
- seconds are not supported
CRON
0 0 1W * ? *Get all schedules
GET /orchestration/schedulesRetrieve schedules present on your account according to several optional search criteria :
- Environment
- Description
- Bound status : filter in or out orphan schedules or schedules in action on a task or plan
Please be aware user would need VIEW permission on the workspace where the schedule is in action and at least on one workspace within the environment for unlinked schedules.
Use cases
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| descriptionFilter | Search in Description with regular expression | string Optional | "Finance Q*", "Monthly Supply", etc. |
| environmentId | Environment to narrow the search | string Optional | |
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional | INT32 |
| onlyBound | Only bound schedulers, ie in use for scheduling some executable | boolean Optional | |
| limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional | INT32 |
Response
Create a schedule
POST /orchestration/schedulesCreate a new schedule providing one initial trigger item.
You would be able to add some more triggers, update one trigger or remove it using the unique ressource endpoint for your created schedule.
The created schedule is orphan, it means it is not related yet to any task or plan for your executions.
User should be TMC_OPERATOR and have EXECUTOR Permission at least for one workspace in the environment.
Use cases
Request
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| description | Some description related to the usage of the scheduler | string Optional | |
| environmentId | Environment where this schedule will be available | string Required | |
| trigger | ScheduleTrigger Required |
Response
201Status 201
Scheduler created
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Unique identifier of your schedule object | string Required |
Update the schedule
PATCH /orchestration/schedules/{scheduleId}Apply partial changes to the scheduler object. Actually allows you to update the functional description of your schedule.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| scheduleId | string Required |
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| description | Functional description to update | string Optional |
Response
204Status 204
Scheduler has been successfully updated
Clone the schedule
POST /orchestration/schedules/{scheduleId}Duplicate the current schedule : all the triggers present in the source schedule will be duplicated on the copy.
If no name is provided for the schedule copy, some “copy of” source name will be given to target schedule copy.
The newly created schedule wont be linked to any executable, but ready to be.
Use cases
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| scheduleId | string Required |
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| description | Target description of the schedule | string Optional |
Response
201Status 201
Successful response - Created
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | string Required |
Retrieve the schedule
GET /orchestration/schedules/{scheduleId}Retrieve whole details of the schedule definition.
Please be aware user would need VIEW permission on the workspace when the schedule is in action on some task or plan. When not in action, User should have VIEW permission at least on one workspace within the environment.
Use cases
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| scheduleId | string Required |
Response
Delete the schedule
DELETE /orchestration/schedules/{scheduleId}Delete the schedule object. Please note only orphan Schedules can be deleted. When the schedule is being used by an executable, It cannot be deleted.
Therefore, when you need to perform a schedule cleanup, unlink your schedule before removing it.
Use cases
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| scheduleId | string Required |
Response
204Status 204
No Content
Append some trigger to your schedule
POST /orchestration/schedules/{scheduleId}/triggersAppend some elementary trigger in the list. Some pre-conditions are checked :
- the Trigger object must be valid
- Trigger name provided must be unique
- you can add up to 15 elementary triggers in one schedule
- the Trigger can’t be identical to one existing trigger : no duplicate allowed
- the new Trigger added should not bring new scheduled events that are concurrent to current events in the existing schedule : interval between two executions of the same task must not be less than 5 minutes. The concurrency of triggers are checked up to 5 years, allowing bissextile years case to be taken into consideration.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| scheduleId | string Required |
Body
application/json
Response
200Status 200
Trigger added to your Scheduler object
409Status 409
“Duplicate name or trigger definition” or "
New trigger causes too many concurrent events with current triggers in schedule"
Body
application/json
Remove a trigger from your schedule
DELETE /orchestration/schedules/{scheduleId}/triggersRemove some trigger from the list within this schedule.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| scheduleId | string Required |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | Name of the trigger to remove | string Required |
Response
204Status 204
Trigger removed from your Scheduler object
Update an existing trigger within the schedule
PUT /orchestration/schedules/{scheduleId}/triggersApply changes to an existing trigger in the list. The same preconditions are applied as when adding some new trigger.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| scheduleId | string Required |
Body
application/json
Response
200Status 200
Successful response
409Status 409
“Duplicate name or trigger definition” or "
New trigger causes too many concurrent events with current triggers in schedule"
Body
application/json
Simulate next triggered events
GET /orchestration/schedules/{scheduleId}/eventsRetrieve all the events that would be triggered by the schedule for a given date-time period. When no first datetime provided, the current datetime is taken as default value. This endpoint is useful for checking the design of your schedule before putting it in use or when some changes is needed.
Each triggered event is provided with the name of the elementary trigger that generated it : using this information you would be able to easily adapt the right trigger when needed.
User should have VIEW permission on the workspace when the schedule is in action on some task or plan. When not in action, User should have VIEW permission at least on one workspace within the environment.
Use cases
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| scheduleId | string Required |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional | INT32 |
| to | Date time (milliseconds) limit to compute next events till | integer Required | INT64 |
| limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional | INT32 |
| from | Date time (milliseconds) to compute next events from. | integer Optional | INT64 |
Response
200Status 200
Successful response
Body
application/json
| Name | Description | Type | Attributes and examples | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of Object |
| ||||||||||||||||||||||||||
Retrieve task schedule
GET /orchestration/executables/tasks/{taskId}/scheduleRetrieve the schedule associated to this task. User should be TMC_OPERATOR and have VIEW Permission on the workspace this task belongs to.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | string Required |
Response
Associate a schedule to a Task.
PUT /orchestration/executables/tasks/{taskId}/scheduleApply a schedule to the executions of a Task. When some trigger is already in run-config for this task, the new schedule object will be replacing it right away.
User should be TMC_OPERATOR and have EXECUTOR Permission on the workspace this task belongs to.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | string Required |
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| scheduleId | Id of the scheduler to associate with the task | string Required |
Response
200Status 200
Association successfully created
400Status 400
Configuration error to associate the schedule to a task.
Body
application/json
Remove the association between a Task and a Schedule
DELETE /orchestration/executables/tasks/{taskId}/scheduleUnassign a schedule to a Task. Once unassigned no further scheduled execution will happen. Your task would still be executed through direct calls (UI or API) or within some plan.
User should be TMC_OPERATOR and have EXECUTOR Permission on the workspace this task belongs to.
Use cases
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | string Required |
Response
204Status 204
Schedule link has been successfully removed
Associate a schedule to a Plan.
PUT /orchestration/executables/plans/{planId}/scheduleApply a schedule to the run configuration of this Plan. When some trigger is already in run-config for this plan, the new schedule object will be replacing it.
User should be TMC_OPERATOR and have EXECUTOR Permission on the workspace this plan belongs to.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | string Required |
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| scheduleId | Id of the schedule to associate with the plan | string Required |
Response
200Status 200
The Scheduler has been associated to the Plan
400Status 400
Configuration error to associate the schedule to a plan.
Body
application/json
Retrieve plan schedule
GET /orchestration/executables/plans/{planId}/scheduleRetrieve any Schedule definition associated to the Plan.
User should be TMC_OPERATOR and have VIEW Permission on the workspace this plan belongs to.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | string Required |
Response
Remove the association between the Schedule and the Plan
DELETE /orchestration/executables/plans/{planId}/scheduleUnassign a schedule to a Plan. Once unassigned no further scheduled execution will happen. Your plan would still be executed through direct calls (UI or API).
User should be TMC_OPERATOR and have EXECUTOR Permission on the workspace this plan belongs to.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | string Required |
Response
204Status 204
The Schedule has been removed from the Plan
Tasks
Webhook
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | Webhook name | string Required | NewWebhook |
| description | Webhook description | string Optional | Webhook description |
| triggerCalls | Endpoint call count to run task|plan | integer Optional | INT64 5 |
| triggerTimeout | Time after which the task will starts from the moment the endpoint is first called | integer Optional | INT64 30000 |
| runAsUser | The user on behalf of whom the task will be launched | string Optional | admin |
| newUrl | Indicates whether to generate new url | boolean Optional | |
| url | Webhook url | string Optional | |
| executionTimeout | Time after which the task execution will be terminated on timeout | integer Optional | |
| runAsUserType | The type of user on behalf of whom the task will be launched (HUMAN or SERVICE) | string Optional |
Trigger
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| type | Type of schedule | string Required | ONCE |
| interval | Interval between task/plan running in days/weeks/months, required only if type of schedule is not equal to ‘ONCE’) | integer Optional | INT32 1 |
| startDate | Date when the task should start to run | string Required | 2019-09-25 |
| startTime | Time when the schedule should start to be active | string Optional | 05:30 |
| timeZone | Time zone for task schedule | string Required | Europe/London |
| atTimes | TimeSchedule Optional | ||
| atDays | DaySchedule Optional | ||
| webhook | Webhook Optional | ||
| cronExpression | Cron expression as string | string Optional | 0 0 1W * ? * |
TimeSchedule
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| type | Type of schedule at times | string Required | AT_TIME | |||||||||
| times | array of string Optional |
| ||||||||||
| time | Timestamp to run task/plan, required only if type of schedule at times equal to AT_TIME | string Optional | 10:00 | |||||||||
| startTime | Interval start timestamp, required only if type of schedule at times equal to AT_INTERVALS | string Optional | 10:00 | |||||||||
| endTime | Interval end timestamp, required only if type of schedule at times equal to AT_INTERVALS | string Optional | 23:00 | |||||||||
| interval | Duration of interval in minutes, required only if type of schedule at times equal to AT_INTERVALS | integer Optional | INT32 10 |
TaskV21
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Id of task | string Required | 5c1111d7a4186a4eafed0587 | |||||||||
| name | Name of task | string Required | Hello world task | |||||||||
| description | Task description | string Optional | task detail description | |||||||||
| workspace | WorkspaceInfo Required | |||||||||||
| version | Task version | string Required | 0.1 | |||||||||
| artifact | BaseArtifactVersion Required | |||||||||||
| tags | array of string Optional |
| ||||||||||
| connections | Task connections. Array of key-value pairs with string key that represents connection name and string value with connection id. | ObjectOptional | ||||||||||
| parameters | Task parameters. Array of key-value pairs with string key that represents parameter name and string value of parameter. | ObjectOptional | ||||||||||
| resources | Task resources. Array of key-value pairs with string key that represents resource name and string value with id of resource. | ObjectOptional | ||||||||||
| autoUpgradeInfo | AutoUpgradeInfo Optional | {
"autoUpgradable": true,
"overrideWithDefaultParameters": true
} | ||||||||||
| taskPauseDetails | TaskPauseDetails Optional | {
"pause": true,
"pauseContext": "Pausing task execution",
"pauseDate": "2023-01-13T14:42:58.341Z",
"user": "admin",
"userType": "HUMAN"
} | ||||||||||
TaskRunConfig
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| trigger | Trigger Required | ||
| runtime | Runtime Required | ||
| parallelExecutionAllowed | Indicates whether this executable is allowed to run in parallel. ‘false’ by default | boolean Optional | |
| logLevel | Execution log level. ‘WARN’ by default | string Optional | ERROR |
| remoteRunAsUser | Remote run user | string Optional | |
| timeout | Execution timeout in minutes. Minimal value is 1. Only available for CE and RE 2.12.2 and onwards. | integer Optional | INT32 |
| deploymentStrategy | Deployment strategy for Route or Data Service jobs that run on Remote Engine Cluster | string Optional | PARALLEL ROLLING |
| lineage | Activates or deactivates the data lineage feature. Data integration Jobs published from Talend Studio to Talend Management Console can generate input and output datasets and lineage information. This information can be sent to Qlik Cloud. You can then view the data lineage, which tracks transformations back to the original source. Accepted values:
| boolean Optional | |
| microservicePort | Specifies microservice port for Routes. | string Optional | "8080" |
TaskV21CreateRequest
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| workspaceId | Workspace id of task to create | string Required | 57f64991e4b0b689a64feed2 | |||||||||
| name | Task name | string Required | Hello world task | |||||||||
| description | Task description | string Optional | Task detail description | |||||||||
| tags | array of string Optional |
| ||||||||||
| connections | Task connections. Array of key-value pairs with string key that represents the connection’s application name and string value with connection id. | ObjectOptional | ||||||||||
| parameters | Task parameters. Array of key-value pairs with string key that represents parameter name and string value. Value can accept both string and numeric data. Value is retrieved as string on GET task. | ObjectOptional | ||||||||||
| resources | Task resources. Array of key-value pairs with string key that represents resource name and string value with resource id. | ObjectOptional | ||||||||||
| artifact | ArtifactRequest Required | {
"id": "5c1111d7a4186a4eafed0587",
"version": "0.1.0"
} | ||||||||||
| autoUpgradeInfo | AutoUpgradeInfo Optional | {
"autoUpgradable": true,
"overrideWithDefaultParameters": true
} | ||||||||||
| environmentId | Environment id of task to create | string Required | 5d7a3d082d909b386943787e | |||||||||
TaskV21CreateRequest
{
"artifact": {
"id": "5c1111d7a4186a4eafed0587",
"version": "0.1.0"
},
"autoUpgradeInfo": {
"autoUpgradable": true,
"overrideWithDefaultParameters": true
},
"connections": {
"aws": "5d405e381f40e07fbab6757c",
"googledrive": "5d405e831f40e07fbab6757d"
},
"tags": ["tag1","tag2"],
"description": "Task detail description",
"environmentId": "5d7a3d082d909b386943787e",
"name": "Hello world task",
"parameters": {
"custom_parameter": "custom",
"parameter_p1": "1111"
},
"resources": {
"resource_file_f1": "5d84adcf38907f16498d5d74"
},
"workspaceId": "57f64991e4b0b689a64feed2"
}TaskUpdateRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| latestArtifact | update task with latest artifact (Route and Data Service are not supported) | boolean Optional | |
| forceUpdate | force update task with latest artifact even if autoUpgradeInfo.autoUpgradable is false | boolean Optional |
TaskUpdateRequest
{
"latestArtifact": true,
"forceUpdate": true
}TaskFiltersRequest
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | Name of task (works as a “contains” filter) | string Optional | task1 | |||||||||
| environmentId | Environment ID of task | string Optional | 57f64991e4b0b689a64feed3 | |||||||||
| workspaceId | Workspace ID of task | string Optional | 57f64991e4b0b689a64feed2 | |||||||||
| limit | Page size, range 0 - 100. | integer Optional | INT32 100 | |||||||||
| offset | Pagination offset, default “0” | integer Optional | INT32 0 | |||||||||
| artifactId | Artifact ID | string Optional | 6268e173f8e37317777bf329 | |||||||||
| runtimeType | Runtime type, valid runtime types are: REMOTE_ENGINE, PIPELINE_ENGINE, REMOTE_ENGINE_CLUSTER, CLOUD, CLOUD_EXCLUSIVE | string Optional | REMOTE_ENGINE | |||||||||
| runtimeId | Runtime ID | string Optional | 6267aca881b6d25f2cc6b6a2 | |||||||||
| runtimeRunProfileId | Runtime Run Profile ID, cannot be used without runtimeType filter | string Optional | 6268e441f8e37317777bf32d | |||||||||
| tags | array of string Optional |
| ||||||||||
| triggerType | Allow to filter according to trigger type applied to tasks | string Optional | once |
TaskFiltersRequest
{
"name": "task1",
"environmentId": "57f64991e4b0b689a64feed3",
"workspaceId": "57f64991e4b0b689a64feed2",
"limit": 100,
"offset": 0,
"artifactId": "6268e173f8e37317777bf329",
"runtimeType": "CLOUD",
"runtimeId": "6267aca881b6d25f2cc6b6a2",
"runtimeRunProfileId": "6268e441f8e37317777bf32d"
"tags": [
"tag1",
"tag2"
],
"triggerType": "daily"
}TaskExtract
Object
| Name | Description | Type | Attributes and examples | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| executable | string Required | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name | string Required | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| workspace | ObjectRequired | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| artifactId | string Required | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| runtime | ObjectOptional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
TaskExtract
{
"executable": "626bd984522077546b230083",
"name": "job1",
"workspace": {
"id": "6267aca881b6d25f2cc6b6a5",
"name": "Personal",
"owner": "admin",
"type": "personal",
"environment": {
"id": "6267aca881b6d25f2cc6b6a2",
"name": "default",
"default": true
}
},
"artifactId": "6268e173f8e37317777bf329",
"runtime": {
"type": "CLOUD"
}
}PageTask
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of TaskExtract Required |
| ||||||||||
| limit | integer Required | INT32 | ||||||||||
| offset | integer Required | INT32 | ||||||||||
| total | integer Required | INT32 |
DaySchedule
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| type | Type of schedule at days | string Required | DAY_OF_WEEK | |||||||||
| day | Day of month to run task/plan, required only if type of schedule at days is equal to DAY_OF_MONTH | integer Optional | INT32 3 | |||||||||
| days | array of string Optional |
|
AutoUpgradeInfo
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| autoUpgradable | Indicates whether to automatically upgrade task after publishing new artifact version | boolean Optional | |
| overrideWithDefaultParameters | Indicates whether to override task parameters with artifact default parameters during auto upgrade | boolean Optional |
AutoUpgradeInfo
{
"autoUpgradable": true,
"overrideWithDefaultParameters": true
}ScheduledEventsResponse
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | The entity’s id for this event | string Required | |
| sourceTriggerName | The source trigger’s name (only for schedule for multiple triggers) | string Required | |
| date | The Trigger’s date for the event | datetime Required | RFC3339 |
| type | The entity’s type for the event, should be one of the following: “TASK”, “PLAN” | string Required | TASK |
PageScheduledEventsResponse
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of ScheduledEventsResponse Required |
| ||||||||||
| limit | integer Required | INT32 | ||||||||||
| offset | integer Required | INT32 | ||||||||||
| total | integer Optional | INT32 |
ScheduledEventsRequestRuntime
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| type | Type of runtime, should be one of the following: “CLOUD”, “REMOTE_ENGINE”, “REMOTE_ENGINE_CLUSTER”, “CLOUD_EXCLUSIVE”, “PIPELINE_ENGINE” | string Optional | CLOUD |
| id | Runtime id | string Optional | 5c9a51dc7b353e43c7fc787c |
ScheduledEventsRequest
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| environmentId | Environment id | string Required | ||||||||||
| workspaceIds | array of string Optional |
| ||||||||||
| from | From date time (milliseconds). Default value - now | integer Optional | INT64 | |||||||||
| to | To date time (milliseconds) | integer Required | INT64 | |||||||||
| tags | array of string Optional |
| ||||||||||
| runtime | ScheduledEventsRequestRuntime Optional | |||||||||||
| limit | The number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional | INT32 | |||||||||
| offset | The position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional | INT32 |
TaskPauseDetails
Holds the definition of a Task Pause / Resume
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| pause | boolean Required | ||
| pauseContext | string Optional | ||
| user | User that took the action to pause | string Optional | |
| userType | UserType Optional | ||
| pauseDate | Date time when this pause started | datetime Optional | RFC3339 |
TaskPauseDetails
{
"pause": true,
"pauseContext": "Pausing task execution",
"pauseDate": "2023-01-13T14:42:58.341Z",
"user": "admin",
"userType": "HUMAN"
}DETaskRunConfig
Task run configuration used for dynamic engine processor
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| parallelExecutionAllowed | Indicates whether this executable is allowed to run in parallel. ‘false’ by default | boolean Optional | |
| logLevel | Execution log level. ‘WARN’ by default | string Optional | ERROR |
| timeout | Execution timeout in minutes. Minimal value is 1. | integer Optional | INT32 |
| runProfileId | The dynamic engine run profile id | string Optional | |
| trigger | Configures the webhook for tasks in Dynamic Engine environments. Accepted values:
| Trigger Required | |
| lineage | Activates or deactivates the data lineage feature. Data integration Jobs published from Talend Studio to Talend Management Console can generate input and output datasets and lineage information. This information can be sent to Qlik Cloud. You can then view the data lineage, which tracks transformations back to the original source. Accepted values:
| boolean Optional |
Create Task
POST /orchestration/executables/tasksCreate Task. By default the created task will have ‘CLOUD’ as its execution environment
Use cases
Response
Get available Tasks
GET /orchestration/executables/tasksGet available Tasks
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| environmentId | environment id | string Optional | |
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional | INT32 |
| runtimeRunProfileId | runtime run profile id | string Optional | |
| runtimeType | runtime type | string Optional | |
| workspaceId | workspace id | string Optional | |
| name | task name filter | string Optional | |
| limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional | INT32 |
| runtimeId | runtime id | string Optional | |
| artifactId | artifact id | string Optional |
Response
Update Task
PUT /orchestration/executables/tasks/{taskId}Update Task
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | task id | string Required |
Body
application/json
Response
Update Task partially
PATCH /orchestration/executables/tasks/{taskId}Update task configuration according to the parameters provided in the request body
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | task id | string Required |
Body
application/json
Response
204Status 204
Task updated successfully
Delete Task
DELETE /orchestration/executables/tasks/{taskId}Delete Task
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | task id | string Required |
Response
204Status 204
No Content
Get Task by id
GET /orchestration/executables/tasks/{taskId}Get Task by id
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | task id | string Required |
Response
Get Task configuration
GET /orchestration/executables/tasks/{taskId}/run-configGet Task configuration currently applied. Please take note :
- the Trigger definition can now have some new value ‘Multiple’ defined when you link your task to some Multiple Time Trigger schedule.
- whenever such multiple trigger schedule is linked please use the new dedicated endpoints to manage this specific scheduling configuration.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | task id | string Required |
Response
Configure Task executions
PUT /orchestration/executables/tasks/{taskId}/run-configConfigure Task regarding executions.
User must be granted
TMC_OPERATOR permission
Timeout default value can be set as option : it would apply for terminating all executions of this task whose duration exceeds the time out provided in minutes. Accuracy is about 10s. Please note that this capability is available for CE, REC and RE version 2.12.2 and onwards.Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | task id | string Required |
Body
application/json
Response
Stop schedule for Task
DELETE /orchestration/executables/tasks/{taskId}/run-configStop schedule for task
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | task id | string Required |
Response
204Status 204
No Content
Configure Task executions for dynamic engine
PUT /orchestration/executables/tasks/{taskId}/de-run-configConfigure how tasks are executed on Dynamic Engines.
- Permission required:
TMC_OPERATOR. - Timeout option: Set a default timeout value (in minutes) to terminate task executions that exceed this duration. Note: Accuracy is within 10 seconds.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | task id | string Required |
Body
application/json
Response
Stop schedule for Task for dynamic engine
DELETE /orchestration/executables/tasks/{taskId}/de-run-configStop the schedule for a given task.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | task id | string Required |
Response
204Status 204
No Content
Get Task configuration for dynamic engine
GET /orchestration/executables/tasks/{taskId}/de-run-configGet Task configuration for dynamic engine currently applied.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | task id | string Required |
Response
Get task scheduled triggers
GET /orchestration/executables/tasks/{taskId}/run-config/eventsGet task triggers for cron schedules
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | string Required |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional | INT32 |
| to | to date time (milliseconds) | integer Required | INT64 |
| limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional | INT32 |
| from | from date time (milliseconds) | integer Optional | INT64 |
Response
Get scheduled executions
POST /orchestration/executables/events/searchGet scheduled executions of all types
Response
Search tasks
POST /orchestration/executables/tasks/searchSearch Tasks according to some filters:
- name
- environment id
- workspace id
- artifact id
- runtime type
- runtime id
- runtime runprofile id
- tags
- trigger type
All those parameters are optional and can be combined at your convenience, apart from Environment and Workspace which are exclusive (ie you should not provide both in a same call)
Response
Pause / Resume a Task
PUT /orchestration/executables/tasks/{taskId}/pauseAllow to pause or resume a Task.
When pausing a task all current executions will be completed, all new executions requests will be discarded, including scheduled, manual (through TMC or API) and webhook ones.
When resuming a task all triggers (cron, webhook, etc.) will be reactivated, all new executions requests will be accepted again.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| taskId | string Required |
Body
application/json
Response
202Status 202
Successful response - Accepted (work is done in background)
204Status 204
Nothing Change
Common
Runtime
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| type | Type of runtime | string Optional | CLOUD |
| id | Target runtime id, either Remote engine id or Remote engine cluster id Empty for cloud engines | string Optional | 5c9a51dc7b353e43c7fc787c |
| engineId | Remote engine id used for execution | string Optional | 5c9a51dc7b353e43c7fc7878 |
| clusterId | Remote engine cluster id used for execution | string Optional | 5c9a51dc7b353e43c7fc7879 |
| runProfileId | Run profile id of Remote engine or Remote engine cluster | string Optional | 5c9a51dc7b353e43c7fc783c |
BaseArtifactVersion
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Id of artifact | string Required | 5c1111d7a4186a4eafed0587 |
| name | Name of artifact | string Optional | Hello world artifact |
| version | Artifact version | string Required | 0.1.0 |
ErrorResponse
Error response object
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| status | HTTP status code | integer Required | 401 |
| message | Info about error for user. | string Optional | Forbidden |
| detail | Info about error for developer. | string Optional | Token authorization is required for access |
| requestId | The unique identification of the request involved with this error | string Optional | 16fefb53-035a-4249-af9d-f80a3b47b132 |
PageEvents
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of datetime Optional |
| ||||||||||
| limit | integer Optional | INT32 | ||||||||||
| offset | integer Optional | INT32 | ||||||||||
| total | integer Optional | INT32 |
UserType
string