Orchestration

Manage your Artifacts, Tasks, Plans, Schedules, Environments, Workspaces, Promotions and all associated Ressources

Endpoints

Global security

These security schemes apply to the entire API

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.
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
environmentId environment id string Optional
workspaceId workspace id string Optional
offset the position of the first item. Must be greater than or equal to 0. Default value - 0 integer Optional
INT32
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

Response

200Status 200
Successful response
Body
PageArtifact
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

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

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

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

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

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

PageConnection

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

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

Get available Connections

GET /orchestration/connections

Request

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

Response

200Status 200
OK
Body
PageConnection
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 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

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

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
maxCloudContainers maximum number of cloud engines integer Optional
INT32
default boolean Optional

List Environments

GET /orchestration/environments

Retrieve 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

Query parameters
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
details
Name Description Type Attributes and examples
array of EnvironmentInfo
Datatype details
Type Description Attributes and examples
array
EnvironmentInfo
401Status 401
Status 401
403Status 403
Status 403
500Status 500
Status 500

Create Environment

POST /orchestration/environments

Create 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
Object
Name Description Type Attributes and examples
name Unique name for the environment to create string Required
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

Response

201Status 201
Environment has been created
Body
EnvironmentInfo
400Status 400
Name provided is faulty
401Status 401
User has not the right credentials for completing creation
403Status 403
Status 403
409Status 409
environment name should be unique
500Status 500
Status 500

Remove Environment

DELETE /orchestration/environments/{Id}

Remove the identified Environment and all its subparts : workspaces, executables (tasks and plans), etc.

Make sure the user is entitled with ENVIRONMENT_MANAGEMENT role.

Environment in use won’t be removed : if any engine is assigned to this environment or if any promotion relates to this environment, removal is not achieved.

**Please make sure Environment removal is confirmed before calling this endpoint as removal will be cascading all subsidiary elements within the environment : workspaces, tasks, plans, etc. With no cancellation service available. **

Request

Path variables
Name Description Type Attributes and examples
Id string Required

Response

204Status 204
Environment removed
400Status 400
“To delete the environment, you must remove or re-assign its engine(s) to another environment.” or “Cannot delete environment: it is used in promotions(s)”
401Status 401
User has not the required credentials
403Status 403
Environment is still in use, it shall not be removed
Body
Object
Name Description Type Attributes and examples
Usage Details Promotions and Engines still using this Environment string Optional
404Status 404
Environment is not present
500Status 500
Status 500

Update Environment

PUT /orchestration/environments/{Id}
Update the identified Environment. Make sure the user is entitled with ENVIRONMENT_MANAGEMENT role.

Request

Path variables
Name Description Type Attributes and examples
Id string Required
Body
Object
Name Description Type Attributes and examples
name string Required
description string Optional
maxCloudContainers integer Optional
INT32

Response

204Status 204
Environment removed
401Status 401
User has not the required credentials
403Status 403
Environment is still in use, it shall not be removed
Body
Object
Name Description Type Attributes and examples
Usage Details Promotions and Engines still using this Environment string Optional
404Status 404
Environment is not present
409Status 409
Environment name should be unique
500Status 500
Status 500

Workspaces

Workspace

Object
Name Description Type Attributes and examples
id Workspace identifier string Required
name Workspace name string Required
description Workspace description string Optional
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
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 Required
name Workspace name string Required
description Workspace description string Optional
owner Workspace owner string Optional
type Workspace type string Required
environment EnvironmentInfo Optional
protectedUpgrade

Allows to control the scope of Tasks upgrades on Artifact new version publication 

  • true : tasks are upgraded only when Artifact published within this workspace
  • false : any publish of Artifact will upgrade Tasks
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
environmentId Environment this workspace will belong to string Required

List Workspaces

GET /orchestration/workspaces

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

Request

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

Response

200Status 200
Status 200
Body
details
Name Description Type Attributes and examples
array of WorkspaceInfo
Datatype details
Type Description Attributes and examples
array
WorkspaceInfo
401Status 401
Status 401
403Status 403
Status 403
500Status 500
Status 500

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 granted ENVIRONMENT_MANAGEMENT permission

Owner can be provided. By default, creator user would be owner. Type is Custom.

Request

Body
CreateWorkspaceRequest

Response

201Status 201
Status 201
Body
Workspace
Status 201 application/json
"Personal"
400Status 400
Status 400
401Status 401
Status 401
403Status 403
Status 403
500Status 500
Status 500

Update Workspace

PUT /orchestration/workspaces/{id}
Update the identified Workspace. Make sure the user is entitled with ENVIRONMENT_MANAGEMENT role.

Request

Path variables
Name Description Type Attributes and examples
id string Required
Body
Object
Name Description Type Attributes and examples
name string Required
description string Optional
owner string Optional
protectedUpgrade

Allows to restrict the scope of task upgrades when a new artifact version is publishing. 

  • true : only the tasks that belong to the protected workspaces are upgraded
  • false : tasks that have been set to use the latest version of the published artifact, or any other artifact that has the same name as the newly published artifact, are all upgraded , whether they belong to the given workspace or not
boolean Optional

Response

204Status 204
Status 204
400Status 400
Status 400
401Status 401
Status 401
403Status 403
Status 403
404Status 404
Status 404
500Status 500
Status 500

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

Path variables
Name Description Type Attributes and examples
id string Required

Response

204Status 204
Status 204
401Status 401
Status 401
403Status 403
Status 403
404Status 404
Status 404
409Status 409
There are objects in custom workspace that could not be removed

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

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
planPauseDetails PlanPauseDetails Required

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
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 The type of this User, either personal or service type UserType Optional
pauseDate The date time when this pause started datetime Optional
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
Datatype details
Type Description Attributes and examples
array
PlanExecutableDetails
limit integer Optional
INT32
offset integer Optional
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 The type of this User, either personal or service type UserType Optional
pauseDate The date time when this pause started datetime Optional
PauseDetails
{
  "pause": true,
  "pauseContext": "Pausing execution"
  "pauseDate": "2023-01-13T14:42:58.341Z",
  "user": "admin",
  "userType": "HUMAN"
 }

Get available Plans

GET /orchestration/executables/plans
Get available Plans

Request

Query parameters
Name Description Type Attributes and examples
environmentId environment id string Optional
taskId task Id string Optional
workspaceId workspace id string Optional
offset the position of the first item. Must be greater than or equal to 0. Default value - 0 integer Optional
INT32
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

Response

200Status 200
OK
Body
PagePlan
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

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

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

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

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

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
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) string Required
from from date time (milliseconds) string Optional
limit the number of items to return. Must be in range [1, 100]. Default value - 100 integer Optional
INT32

Response

200Status 200
OK
Body
PageEvents
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

Pause-Resume Plan executions

PUT /orchestration/executables/plans/{planId}/pause
Allow to pause and resume plan executions

Request

Path variables
Name Description Type Attributes and examples
planId string Required
Body
PlanPauseDetails

Response

202Status 202
Status 202
204Status 204
Status 204
400Status 400
Status 400
401Status 401
Status 401
403Status 403
Status 403
404Status 404
Status 404
500Status 500
Status 500

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

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

PageProject

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

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
offset the position of the first item. Must be greater than or equal to 0. Default value - 0 integer Optional
INT32
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

Response

200Status 200
OK
Body
PageProject
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

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

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

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

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

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

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

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
analyzeReport Report Optional
promotionReport Report Optional
usedBy Used by Artifacts PromotionResultInfo Optional
targetVersion applicable to artifacts with type FLOW only, version of flow in target environment after promotion execution string Optional
version applicable to artifacts with type FLOW only, version of flow in source environment integer Optional
INT32

UpdateDescriptionRequest

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

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

Message

Object
Name Description Type Attributes and examples
info string Optional
level string Optional

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
analyzeReport Report Optional
promotionReport Report Optional
targetVersion Applicable to flows only, displays version of flow in target environment after promotion execution string Optional
version Applicable to flows only, displays version of flow in source environment integer Optional
INT32

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

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
analyzeReport Report Optional
promotionReport Report Optional
usedBy Used by Artifacts PromotionResultInfo Optional
runProfiles array of ArtifactPromotionResult Optional
Datatype details
Type Description Attributes and examples
array Run profiles
ArtifactPromotionResult

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
analyzeReport Report Optional
promotionReport Report Optional
flows array of ArtifactPromotionResult Optional
Datatype details
Type Description Attributes and examples
array Flows Promotion Execution Info
ArtifactPromotionResult
plans array of ArtifactPromotionResult Optional
Datatype details
Type Description Attributes and examples
array Plans Promotion Execution Info
ArtifactPromotionResult
actions array of ArtifactPromotionResult Optional
Datatype details
Type Description Attributes and examples
array Actions Promotion Execution Info
ArtifactPromotionResult
connections array of ArtifactPromotionResult Optional
Datatype details
Type Description Attributes and examples
array Connections Promotion Execution Info
ArtifactPromotionResult
resources array of ArtifactPromotionResult Optional
Datatype details
Type Description Attributes and examples
array Resources Promotion Execution Info
ArtifactPromotionResult
engines array of RuntimePromotionResult Optional
Datatype details
Type Description Attributes and examples
array Engines Promotion Execution Info
RuntimePromotionResult
clusters array of RuntimePromotionResult Optional
Datatype details
Type Description Attributes and examples
array Clusters Promotion Execution Info
RuntimePromotionResult

PromotionExecutionStatusV26

Object
Name Description Type Attributes and examples
executionId Job execution ID string Required
startTimestamp Start time of job execution (UTC) datetime Required
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
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
statusMessage Execution Status Message string Optional
workspaces array of WorkspacePromotionResult Optional
Datatype details
Type Description Attributes and examples
array Workspace Promotion Execution Info
WorkspacePromotionResult
engines array of RuntimePromotionResult Optional
Datatype details
Type Description Attributes and examples
array Remote Engines Promotion Execution Info
RuntimePromotionResult
clusters array of RuntimePromotionResult Optional
Datatype details
Type Description Attributes and examples
array Remote Engine Clusters Promotion Execution Info
RuntimePromotionResult
context Execution context message string Optional
255

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

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 Advanced optional detailed scoping of promotion PromotionAdvancedInfo 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

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

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

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

Response

200Status 200
Body
PromotionExecutionStatusV26
400Status 400
Body
ErrorResponse
401Status 401
Body
ErrorResponse
403Status 403
Body
ErrorResponse
404Status 404
Body
ErrorResponse
500Status 500
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

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 array of string Required
Datatype details
Type Description Attributes and examples
array Assigned Service accounts
string

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

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

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

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

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

CreateResourceRequest

Resource detail : json payload with resource attributes
string
CreateResourceRequest
{
    "name": "resource name",
    "description": "resource description",
    "workspaceId": "workspace id",
    "file": true
}

Create a Resource

POST /orchestration/resources

Request

Body
Object
Name Description Type Attributes and examples
resource CreateResourceRequest Required
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