Orchestration

Manage your Artifacts, Tasks, Plans, Promotions and all associated Ressources.

Endpoints

Global security

These security schemes apply to the entire API

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.
Bearer authentication
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.
Bearer authentication
Name Description

Artifacts

Artifact

Object
Name Description Type Attributes and examples
id Artifact identifier string Required
name Artifact name string Required
type Artifact type string Required
versions array of string Required
Datatype details
Type Description Attributes and examples
array Available artifact versions
string
workspace Workspaceinfo Required

ArtifactParameter

Object
Name Description Type Attributes and examples
name Parameter name string Required
value Parameter value string Optional
type Parameter value string Required
required Is parameter required or not boolean Required
comment Comment about parameter string Optional

ArtifactRequest

Object
Name Description Type Attributes and examples
id Id of artifact string Required
version Artifact version string Required

ArtifactVersion

Object
Name Description Type Attributes and examples
id Id of artifact string Required
name Name of artifact string Optional
version Artifact version string Required
type Artifact type string Required
publisher Artifact publisher string Required
marketplaceProduct Marketplace product string Required
parameters array of ArtifactParameter Required
Datatype details
Type Description Attributes and examples
array Artifact parameters
ArtifactParameter
workspace Workspaceinfo Required
description Artifact description string Optional
createDate Artifact date of creation datetime Required
RFC3339
repository SourcesRepositoryData Optional

PageArtifact

Object
Name Description Type Attributes and examples
items array of Artifact Optional
Datatype details
Type Description Attributes and examples
array
Artifact
limit integer Optional
INT32
offset integer Optional
INT32
total integer Optional
INT32

Get available Artifacts

GET /orchestration/artifacts
Get available Artifacts

Request

Query parameters
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

200Status 200
Successful response
Body
Page
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
ErrorResponse
404Status 404
Not found - resource not found
Body
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
ErrorResponse

Get Artifact by id

GET /orchestration/artifacts/{artifactId}
Get Artifact by id

Request

Path variables
Name Description Type Attributes and examples
artifactId artifact id string Required

Response

200Status 200
OK
Body
Artifact
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Delete Artifact by id

DELETE /orchestration/artifacts/{artifactId}
Delete Artifact by id

Request

Path variables
Name Description Type Attributes and examples
artifactId artifact id string Required

Response

204Status 204
No content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
409Status 409
Conflict
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Delete Artifact of a specified version

DELETE /orchestration/artifacts/{artifactId}/versions/{version}
Delete Artifact of a specified version

Request

Path variables
Name Description Type Attributes and examples
artifactId artifact id string Required
version artifact version string Required

Response

204Status 204
No content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
409Status 409
Conflict
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get Artifact of a specified version

GET /orchestration/artifacts/{artifactId}/versions/{version}
Get Artifact of a specified version

Request

Path variables
Name Description Type Attributes and examples
artifactId artifact id string Required
version artifact version string Required

Response

200Status 200
OK
Body
ArtifactVersion
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Connections

UpdateConnectionRequest

Object
Name Description Type Attributes and examples
name Connection name string Optional
parameters array of ConnectionParameter Optional
Datatype details
Type Description Attributes and examples
array Connection parameters
ConnectionParameter

CreateConnectionRequest

Object
Name Description Type Attributes and examples
name Connection name string Required
workspaceId Workspace ID string Required
app Application name string Required
parameters array of ConnectionParameter Required
Datatype details
Type Description Attributes and examples
array Connection parameters
ConnectionParameter

ConnectionParameter

Object
Name Description Type Attributes and examples
name Parameter name string Required
value Parameter value string Optional
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
Datatype details
Type Description Attributes and examples
array Connection parameters
ConnectionParameter
workspace Workspaceinfo Required

PageConnectionDetails

Object
Name Description Type Attributes and examples
items array of ConnectionDetails Optional
Datatype details
Type Description Attributes and examples
array
ConnectionDetails
limit integer Optional
INT32
offset integer Optional
INT32
total integer Optional
INT32

Get available Connections

GET /orchestration/connections

Request

Query parameters
Name Description Type Attributes and examples
name string Optional
limit integer Optional
100
INT32
offset integer Optional
INT32

Response

200Status 200
OK
Body
Page
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Create a Connection

POST /orchestration/connections

Request

Body
CreateConnectionRequest

Response

200Status 200
successful operation
Body
ConnectionDetails
201Status 201
Created successfully
Body
ConnectionDetails
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
409Status 409
Connection name already exists
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Delete a Connection

DELETE /orchestration/connections/{connectionId}

Request

Path variables
Name Description Type Attributes and examples
connectionId string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
409Status 409
Connection is in use
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get a Connection details

GET /orchestration/connections/{connectionId}

Request

Path variables
Name Description Type Attributes and examples
connectionId string Required

Response

200Status 200
OK
Body
ConnectionDetails
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Update a Connection

PUT /orchestration/connections/{connectionId}

Request

Path variables
Name Description Type Attributes and examples
connectionId string Required
Body
UpdateConnectionRequest

Response

200Status 200
Updated
Body
ConnectionDetails
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
409Status 409
Connection name already exists
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

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/environments

Create 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
Object
Name Description Type Attributes and examples
name Unique name for the environment to create string Required
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
workspaceName Name for the custom workspace created along with the Environment string Required

Response

201Status 201
Environment has been created
Body
EnvironmentInfo
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
name Workspace name string Required
description Workspace description string Optional
owner Workspace owner string Optional
type Workspace type string Required
environment Environmentinfo Optional

Create Workspace

POST /orchestration/workspaces

Create 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
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
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/workspaces
Get available Workspaces

Request

Query parameters
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
details
Name Description Type Attributes and examples
array of Workspaceinfo
Datatype details
Type Description Attributes and examples
array
Workspaceinfo
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Plans

Step

Object
Name Description Type Attributes and examples
id Step id string Optional
name Step name string Required
condition Expected status of successful step string Required
taskIds array of string Required
Datatype details
Type Description Attributes and examples
array List of step tasks
string
handlerOnFailure StepErrorHandler Optional
note Description to rerun a plan execution from this step string Optional

StepErrorHandler

Object
Name Description Type Attributes and examples
taskIds array of string Optional
Datatype details
Type Description Attributes and examples
array List of handler tasks
string
planIds array of string Optional
Datatype details
Type Description Attributes and examples
array List of handler plans
string

Plan

Object
Name Description Type Attributes and examples
id Resource id string Required
name Resource name string Required
description Resource description string Optional
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
steps array of Step Required
Datatype details
Type Description Attributes and examples
array Plan steps
Step
authorType Plan author type string Optional

PlanExecutable

Object
Name Description Type Attributes and examples
executable Executable identifier string Required
executionPlanId The plan execution identifier in case of re-execution (works starting from V2.4) string Optional
stepId The step identifier to start with (works starting from V2.4) string Optional
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
name Executable name string Required
workspace Workspaceinfo Optional
description Executable description string Optional
chart ExecutionStep Optional
status Plan execution status string Optional

PlanRequest

Object
Name Description Type Attributes and examples
name Plan name string Required
workspaceId Plan workspace string Required
description Plan description string Optional
steps array of Step Required
Datatype details
Type Description Attributes and examples
array Plan steps
Step

PlanRunConfig

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

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
Datatype details
Type Description Attributes and examples
array
ExecutionFlow
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/plans
Get available Plans

Request

Query parameters
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

200Status 200
OK
Body
Page
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Create Plan

POST /orchestration/executables/plans
Create Plan

Request

Body
PlanRequest

Response

201Status 201
Created
Body
Plan
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Delete Plan

DELETE /orchestration/executables/plans/{planId}
Delete Plan

Request

Path variables
Name Description Type Attributes and examples
planId executable ID string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
409Status 409
Conflict
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Update plan

PUT /orchestration/executables/plans/{planId}
Update Plan

Request

Path variables
Name Description Type Attributes and examples
planId executable ID string Required
Body
PlanRequest

Response

200Status 200
OK
Body
Plan
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get Plan details

GET /orchestration/executables/plans/{planId}
Get Plan details

Request

Path variables
Name Description Type Attributes and examples
planId executable ID string Required

Response

200Status 200
Successful response
Body
PlanExecutabledetails
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
ErrorResponse
404Status 404
Not found - resource not found
Body
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
ErrorResponse

Configure Plan execution

PUT /orchestration/executables/plans/{planId}/run-config
Configure Plan execution

Request

Path variables
Name Description Type Attributes and examples
planId plan id string Required
Body
PlanRunConfig

Response

200Status 200
OK
Body
PlanRunConfig
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get Plan configuration

GET /orchestration/executables/plans/{planId}/run-config

Get 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

Path variables
Name Description Type Attributes and examples
planId plan id string Required

Response

200Status 200
OK
Body
PlanRunConfig
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Stop schedule for plan

DELETE /orchestration/executables/plans/{planId}/run-config
Stop schedule for plan

Request

Path variables
Name Description Type Attributes and examples
planId plan id string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get plan scheduled triggers

GET /orchestration/executables/plans/{planId}/run-config/events
Get plan triggers for cron schedules

Request

Path variables
Name Description Type Attributes and examples
planId string Required
Query parameters
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

200Status 200
OK
Body
Page
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

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
description Project description string Optional
url Project url string Required
name Project name string Required

ProjectRequest

Object
Name Description Type Attributes and examples
owner Owner name string Optional
description Project description string Optional
url Project url string Optional

PageProjectView

Object
Name Description Type Attributes and examples
items array of ProjectView Optional
Datatype details
Type Description Attributes and examples
array
ProjectView
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
date commit date time datetime Required
RFC3339
author commit author string Required

Create Project

POST /orchestration/projects

Create Project

Please take note only PAT access is supported on this endpoint at current.

Request

Body
ProjectCreateRequest

Response

201Status 201
Created
Body
ProjectView
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
409Status 409
Project already exists
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get Projects

GET /orchestration/projects

Get Projects

Please take note only PAT access is supported on this endpoint at current.

Request

Query parameters
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

200Status 200
OK
Body
Page
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

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

Path variables
Name Description Type Attributes and examples
projectId project ID string Required

Response

200Status 200
OK
Body
ProjectView
400Status 400
Project Id is not valid id.
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Delete project

DELETE /orchestration/projects/{projectId}

Delete project

Please take note only PAT access is supported on this endpoint at current.

Request

Path variables
Name Description Type Attributes and examples
projectId project ID string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Update Project

PUT /orchestration/projects/{projectId}

Update Project

Please take note only PAT access is supported on this endpoint at current.

Request

Path variables
Name Description Type Attributes and examples
projectId project ID string Required
Body
ProjectRequest

Response

200Status 200
OK
Body
ProjectView
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not found
Body
ErrorResponse
409Status 409
Project already exists
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Projects Authorization

ProjectUserAuthResponse

Object
Name Description Type Attributes and examples
projectId string Optional
userIds array of string Optional
Datatype details
Type Description Attributes and examples
array
string

ProjectGroupAuthResponse

Object
Name Description Type Attributes and examples
projectId string Optional
groupIds array of string Optional
Datatype details
Type Description Attributes and examples
array
string

Get group project authorizations

GET /orchestration/projects/{projectId}/groups
Get group project authorizations

Request

Path variables
Name Description Type Attributes and examples
projectId project ID string Required

Response

200Status 200
OK
Body
ProjectGroupAuthResponse
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Add group project authorization

PUT /orchestration/projects/{projectId}/groups/{groupId}
Add group project authorization

Request

Path variables
Name Description Type Attributes and examples
projectId project ID string Required
groupId group ID string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not found
Body
ErrorResponse
409Status 409
Authorization already exists
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Delete group project authorization

DELETE /orchestration/projects/{projectId}/groups/{groupId}
Delete group project authorization

Request

Path variables
Name Description Type Attributes and examples
projectId project ID string Required
groupId group ID string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get user project authorizations

GET /orchestration/projects/{projectId}/users
Get user project authorizations

Request

Path variables
Name Description Type Attributes and examples
projectId project ID string Required

Response

200Status 200
OK
Body
ProjectUserAuthResponse
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Delete user project authorization

DELETE /orchestration/projects/{projectId}/users/{userId}
Delete user project authorization

Request

Path variables
Name Description Type Attributes and examples
projectId project ID string Required
userId user ID string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Add user project authorization

PUT /orchestration/projects/{projectId}/users/{userId}
Add user project authorization

Request

Path variables
Name Description Type Attributes and examples
projectId project ID string Required
userId user ID string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not found
Body
ErrorResponse
409Status 409
Authorization already exists
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Promotions

AdvancedPromotionSpec

Object
Name Description Type Attributes and examples
artifactId Advanced Promotion Artifact Id string Optional
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

UpdateDescriptionRequest

Object
Name Description Type Attributes and examples
description Promotion description string Required

Report

Object
Name Description Type Attributes and examples
status string Optional
messages array of Message Optional
Datatype details
Type Description Attributes and examples
array
Message

PromotionExecutableTask

Object
Name Description Type Attributes and examples
executable Executable identifier string Required
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
name Executable name string Required
sourceEnvironment Environmentinfo Optional
targetEnvironment Environmentinfo Optional
description Promotion description (not returned when querying a list of objects) string Optional

CreatePromotionRequest

Object
Name Description Type Attributes and examples
sourceEnvironmentId Source environment ID string Required
targetEnvironmentId Target environment ID string Required
description Promotion description string Optional

TaskAutoUpgradeRequest

Object
Name Description Type Attributes and examples
workspaceId Workspace id of task to create string Required
name Task name string Required
description Task description string Required
tags array of string Optional
Datatype details
Type Description Attributes and examples
array Task tags
string
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/promotions
Create a Promotion

Request

Body
CreatePromotionRequest

Response

201Status 201
Created
Body
PromotionExecutableDetails
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
409Status 409
Promotion with same source and target already exists
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get available Promotions

GET /orchestration/executables/promotions
Get available Promotions

Request

Query parameters
Name Description Type Attributes and examples
_s search query (FIQL format), e.g. “name==dev to prod*” string Optional

Response

200Status 200
OK
Body
details
Name Description Type Attributes and examples
array of PromotionExecutableDetails
Datatype details
Type Description Attributes and examples
array
PromotionExecutableDetails
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Delete a Promotion

DELETE /orchestration/executables/promotions/{promotionId}
Delete a Promotion

Request

Path variables
Name Description Type Attributes and examples
promotionId Promotion ID string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get Promotion details

GET /orchestration/executables/promotions/{promotionId}
Get Promotion details

Request

Path variables
Name Description Type Attributes and examples
promotionId Promotion ID string Required

Response

200Status 200
OK
Body
PromotionExecutableDetails
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Update a Promotion

PATCH /orchestration/executables/promotions/{promotionId}
Update a Promotion

Request

Path variables
Name Description Type Attributes and examples
promotionId Promotion ID string Required
Body
UpdateDescriptionRequest

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Promotions Authorization

PromotionUsersResponse

Object
Name Description Type Attributes and examples
executable Promotion ID string Required
userIds array of string Required
Datatype details
Type Description Attributes and examples
array Assigned users
string
serviceAccountIds Assigned Service accounts string Required

Get users assigned to Promotion

GET /orchestration/executables/promotions/{promotionId}/users
Get users assigned to Promotion

Request

Path variables
Name Description Type Attributes and examples
promotionId Promotion ID string Required

Response

200Status 200
OK
Body
PromotionUsersResponse
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Assign user to Promotion

PUT /orchestration/executables/promotions/{promotionId}/users/{userId}
Assign user to Promotion

Request

Path variables
Name Description Type Attributes and examples
promotionId Promotion ID string Required
userId User ID string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
409Status 409
User is already assigned to the promotion
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Unassign user from Promotion

DELETE /orchestration/executables/promotions/{promotionId}/users/{userId}
Unassign user from Promotion

Request

Path variables
Name Description Type Attributes and examples
promotionId Promotion ID string Required
userId User ID string Required

Response

204Status 204
No Content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Unassign service account from promotion

DELETE /orchestration/executables/promotions/{promotionId}/service-accounts/{serviceAccountId}
Unassign service account from promotion

Request

Path variables
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

Path variables
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
name Name of resource string Required
description Description of resource string Optional
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
Datatype details
Type Description Attributes and examples
array
Resource
limit integer Optional
INT32
offset integer Optional
INT32
total integer Optional
INT32

Create a Resource

POST /orchestration/resources

Request

Body
Object
Name Description Type Attributes and examples
file Resource attachment file Required

Response

200Status 200
successful operation
Body
Resource
201Status 201
Created successfully
Body
Resource
400Status 400
Status 400
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Workspace id not founed.
Body
ErrorResponse
413Status 413
Upload limit exceeded
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get Resources

GET /orchestration/resources

Request

Query parameters
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

200Status 200
OK
Body
Page
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Get Resource by id

GET /orchestration/resources/{resourceId}
Get Resource by id

Request

Path variables
Name Description Type Attributes and examples
resourceId Resource id string Required

Response

200Status 200
Success
Body
Resource
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Update a Resource

PATCH /orchestration/resources/{resourceId}

Request

Path variables
Name Description Type Attributes and examples
resourceId Resource id string Required
Body
UpdateResourceRequest

Response

204Status 204
no content
400Status 400
Status 400
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Delete a Resource

DELETE /orchestration/resources/{resourceId}

Request

Path variables
Name Description Type Attributes and examples
resourceId Resource id string Required

Response

204Status 204
no content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
409Status 409
Resource is in use
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

Update a Resource attachment

PUT /orchestration/resources/{resourceId}/upload

Request

Path variables
Name Description Type Attributes and examples
resourceId Resource ID string Required
Body
Object
Name Description Type Attributes and examples
file Resource attachment file Optional

Response

204Status 204
no content
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden
Body
ErrorResponse
404Status 404
Not Found
Body
ErrorResponse
413Status 413
Upload limit exceeded
Body
ErrorResponse
500Status 500
Internal Server Error
Body
ErrorResponse

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
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
Name Description Type Attributes and examples
type Type of schedule at times string Optional
times array of string Optional
Datatype details
Type Description Attributes and examples
array Timestamps to run task/plan, required only if type of schedule at times equal to AT_SPECIFIC_TIMES
string
time Timestamp to run task/plan, required only if type of schedule at times equal to AT_TIME string Optional
startTime Interval start timestamp, required only if type of schedule at times equal to AT_INTERVALS string Optional
endTime Interval end timestamp, required only if type of schedule at times equal to AT_INTERVALS string Optional
interval Duration of interval in minutes, required only if type of schedule at times equal to AT_INTERVALS integer Optional
INT32
atDays Specific ‘at Days’ schedule ObjectOptional
Name Description Type Attributes and examples
type Type of schedule at days string Optional
day Day of month to run task/plan, required only if type of schedule at days is equal to DAY_OF_MONTH number Optional
INT32
days array of string Optional
Datatype details
Type Description Attributes and examples
array List of days of week to run task/plan, required only if type of schedule at days is equal to DAY_OF_WEEK
string
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
Datatype details
Type Description Attributes and examples
array List of elementary triggers defined within schedule
ScheduleTrigger
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
Datatype details
Type Description Attributes and examples
array
Schedule
limit integer Required
INT32
offset integer Required
INT32
total integer Required
INT32

CRON

string
CRON
0 0 1W * ? *

Create a schedule

POST /orchestration/schedules

Create 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.

Request

Body
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
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/schedules

Retrieve 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

Query parameters
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
environmentId Environment to narrow the search string Optional
onlyBound Only bound schedulers, ie in use for scheduling some executable boolean Optional
Body
Object
Name Description Type Attributes and examples
Name Some name to identify your scheduler within a list string Required
Tags array of string Optional
Datatype details
Type Description Attributes and examples
array A list of tags to add to your scheduler
string
Trigger ScheduleTrigger Optional

Response

200Status 200
Schedules list provided
Body
PageSchedule
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.