Orchestration
Manage your Artifacts, Tasks, Plans, Promotions and all associated Ressources.
Endpoints
-
https://api.eu.cloud.talend.com
Endpoint to use for the AWS Europe data center
-
https://api.ap.cloud.talend.com
Endpoint to use for the AWS Asia Pacific data center
-
https://api.us.cloud.talend.com
Endpoint to use for the AWS United States East data center
-
https://api.au.cloud.talend.com
Endpoint to use for the AWS Australia data center
-
https://api.us-west.cloud.talend.com
Endpoint to use for the Azure United States West data center
Security schemes
These schemes can be referenced across the API
Public_merge
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 |
|---|
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 |
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 |
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 |
|---|---|---|---|
| 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 |
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional |
INT32 |
| environmentId | environment id | string Optional | |
| workspaceId | workspace id | string Optional |
Response
500Status 500
Server error - something went wrong on server side
Body
application/json
Get Artifact by id
GET /orchestration/artifacts/{artifactId}Get Artifact by id
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| artifactId | artifact id | string Required |
Response
Delete Artifact by id
DELETE /orchestration/artifacts/{artifactId}Delete Artifact by id
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| artifactId | artifact id | string Required |
Response
204Status 204
No content
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 | artifact id | string Required | |
| version | artifact version | string Required |
Response
204Status 204
No content
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 | artifact id | string Required | |
| version | artifact version | string Required |
Response
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 | ||||||||||
| createDate | Creation Date of Connection | datetime Required |
RFC3339 |
|||||||||
| parameters | array of ConnectionParameter Required |
|
||||||||||
| workspace | Workspaceinfo Required |
PageConnectionDetails
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of ConnectionDetails Optional |
|
||||||||||
| limit | integer Optional |
INT32 |
||||||||||
| offset | integer Optional |
INT32 |
||||||||||
| total | integer Optional |
INT32 |
Get available Connections
GET /orchestration/connectionsRequest
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | string Optional | ||
| limit | integer Optional |
100 INT32 |
|
| offset | integer Optional |
INT32 |
Response
Create a Connection
POST /orchestration/connectionsResponse
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
Update a Connection
PUT /orchestration/connections/{connectionId}Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| connectionId | string Required |
Body
application/json
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 | |
| name | Functional name of the Environment | string Required | |
| description | string Optional | ||
| default | boolean Optional |
Create Environment
POST /orchestration/environmentsCreate an Environment.
Please ensure the following requirements are met :
- provide some unique naming
- make sure the user is entitled with ENVIRONMENT_MANAGEMENT permission
Environment with proper name is created on platform, some CUSTOM workspace is also created within and current user or user passed-in is assigned ownership permissions onto it.
Some Cloud Engine would also be assigned to the newly created environment according to your request.
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 | Your functional description of this Environment | string Optional | |
| maxCloudContainers | Number of Cloud Engines to assign to this Environment | integer Optional |
INT32 |
| owner | Login name of user to be owner of the custom workspace created. The current user would be default owner. | string Optional |
jSmith, mDupont |
| workspaceName | Name for the custom workspace created along with the Environment | string Required |
Response
400Status 400
Name provided is faulty
401Status 401
User does not have the right credentials for completing creation
403Status 403
Status 403
409Status 409
Environment name should be unique
500Status 500
Status 500
Workspaces
Workspaceinfo
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 |
| owner | Workspace owner | string Optional |
admin |
| type | Workspace type | string Required |
custom |
| environment | Environmentinfo Optional |
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 entitled as role ENVIRONMENT_MANAGEMENT
Owner can be provided. By default, creator user would be owner. Type is Custom.
Request
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | string Required | ||
| description | string Optional | ||
| owner | string Optional | ||
| environmentId | Workspace environment | string Required |
Response
201Status 201
Status 201
Body
application/json
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | Workspace name | string Required | |
| description | Workspace detail description | string Optional | |
| owner | Workspace owner | string Optional | |
| environmentId | Workspace environment | string Required |
Status 201
application/json
"Personal"400Status 400
Status 400
401Status 401
Status 401
403Status 403
Status 403
500Status 500
Status 500
Get available Workspaces
GET /orchestration/workspacesGet available Workspaces
Use cases
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| query | search query (FIQL format), e.g. “name==TestWorkspace”,“environment.name==TestEnvironment” | string Optional |
Response
200Status 200
OK
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of Workspaceinfo |
|
|||||||||||
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 |
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 |
|
PlanExecutable
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| executable | Executable identifier | string Required |
b91cf8b2-5dd1-4b18-915b-4c447cee5267 |
| executionPlanId | The plan execution identifier in case of re-execution (works starting from V2.4) | string Optional |
0798b8d1-0e12-472f-be02-a0f04e792daa |
| stepId | The step identifier to start with (works starting from V2.4) | string Optional |
09043c9f-02d0-41f6-b3cb-0ea53ffde377 |
| rerunOnlyFailedTasks | Optionally run only failing tasks (works starting from V2.4) | boolean Optional |
PlanExecutabledetails
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| executable | Executable identifier | string Required |
57f64991e4b0b689a64feed0 |
| name | Executable name | string Required |
simple executable |
| workspace | Workspaceinfo Optional | ||
| description | Executable description | string Optional |
plan detail description |
| chart | ExecutionStep Optional | ||
| status | Plan execution status | string 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 |
|
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 | string Optional | ||
| name | string Optional | ||
| version | string Optional | ||
| description | string Optional | ||
| destination | string Optional | ||
| workspaceId | string Optional | ||
| abstractPlanId | string Optional | ||
| plan | boolean Optional | ||
| artifactVersion | ArtifactVersion Optional | ||
| upgradeInfo | UpgradeInfo Optional | ||
| jobType | string Optional |
|
Get available Plans
GET /orchestration/executables/plansGet available Plans
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| 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 |
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional |
INT32 |
| environmentId | environment id | string Optional | |
| workspaceId | workspace id | string Optional | |
| taskId | task Id | string Optional |
Response
Create Plan
POST /orchestration/executables/plansCreate Plan
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
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
Get Plan details
GET /orchestration/executables/plans/{planId}Get Plan details
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| planId | executable ID | string Required |
Response
500Status 500
Server error - something went wrong on server side
Body
application/json
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 |
|---|---|---|---|
| limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional |
INT32 |
| to | to date time (milliseconds) | string Required | |
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional |
INT32 |
| from | from date time (milliseconds) | string Optional |
Response
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 |
PageProjectView
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of ProjectView Optional |
|
||||||||||
| limit | integer Optional |
INT32 |
||||||||||
| offset | integer Optional |
INT32 |
||||||||||
| total | integer Optional |
INT32 |
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 Required |
RFC3339 |
| author | commit author | string Required |
mpidhornyi <mpidhornyi@talend.com> |
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 |
|---|---|---|---|
| name | 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
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
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
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 |
UpdateDescriptionRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| description | Promotion description | string Required |
This is new description |
Report
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| status | string Optional |
|
||||||||||
| messages | array of Message Optional |
|
PromotionExecutableTask
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| executable | Executable identifier | string Required |
57f64991e4b0b689a64feed0 |
| keepTargetResources | Keep Target Resources flag | boolean Optional | |
| keepTargetRunProfiles | Keep Target Run Profiles flag (works starting from V2.2) | boolean Optional | |
| advanced | AdvancedPromotionSpec Optional |
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 |
Create a Promotion
POST /orchestration/executables/promotionsCreate a Promotion
Response
409Status 409
Promotion with same source and target already exists
Body
application/json
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 |
|
|||||||||||
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
Get Promotion details
GET /orchestration/executables/promotions/{promotionId}Get Promotion details
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| promotionId | Promotion ID | string Required |
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 | Assigned Service accounts | string Required |
["uJVPVLjjK0IpVmHLFHaIMdjqbiDyN8h3", "MUQArbY58teouJLlbPdNFo10fYl7Sd2h"] |
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
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
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
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
400Status 400
Status 400
401Status 401
Status 401
403Status 403
Status 403
404Status 404
Status 404
500Status 500
Status 500
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
400Status 400
Status 400
401Status 401
Status 401
403Status 403
Status 403
404Status 404
Status 404
500Status 500
Status 500
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 |
CreateResourceRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | Resource name | string Required | |
| description | Resource description | string Optional | |
| workspaceId | Workspace Id | string Required | |
| file | is resource of file type | boolean Required |
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 |
Create a Resource
POST /orchestration/resourcesRequest
Body
multipart/form-data
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| file | Resource attachment | file Required |
Response
Get Resources
GET /orchestration/resourcesRequest
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| 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 |
| offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional |
INT32 |
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
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
400Status 400
Status 400
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 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
Schedules
ScheduleTrigger
Elementary Scheduling item. Also known as ‘trigger’, this schedule object can take different types : CRON, ONCE, DAILY, WEEKLY, MONTHLY.
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 | ||||||||||||||||||||||||||||||||||||||
| 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",
"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 * ? *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 |
400Status 400
Status 400
401Status 401
Status 401
403Status 403
Status 403
500Status 500
Status 500
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.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| 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 |
| descriptionFilter | Search in Description with regular expression | string Optional |
"Finance Q*", "Monthly Supply", etc. |
| environmentId | Environment to narrow the search | string Optional | |
| onlyBound | Only bound schedulers, ie in use for scheduling some executable | boolean Optional |
Body
application/json
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Some name to identify your scheduler within a list | string Required | ||||||||||
| Tags | array of string Optional |
|
||||||||||
| Trigger | ScheduleTrigger Optional |
Response
400Status 400
Status 400
401Status 401
Status 401
403Status 403
Status 403
500Status 500
Status 500
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.