Orchestration
Endpoints
-
https://api.eu.cloud.talend.com
Endpoint to use for the AWS Europe data center
-
https://api.ap.cloud.talend.com
Endpoint to use for the AWS Asia Pacific data center
-
https://api.us.cloud.talend.com
Endpoint to use for the AWS United States East data center
-
https://api.au.cloud.talend.com
Endpoint to use for the AWS Australia data center
-
https://api.us-west.cloud.talend.com
Endpoint to use for the Azure United States West data center
Security scheme
This scheme can be referenced across the API
Public
Name | Description |
---|
Artifacts
Artifact
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Artifact identifier | string Required |
5cdd2ce2c737973f9d581b99 |
|||||||||
name | Artifact name | string Required |
Test Artifact |
|||||||||
type | Artifact type | string Required |
standard |
|||||||||
versions | array of string Required |
|
||||||||||
workspace | WorkspaceInfo Required |
ArtifactParameter
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Parameter name | string Required |
parameter_url |
value | Parameter value | string Optional |
localhost |
type | Parameter value | string Required |
String |
required | Is parameter required or not | boolean Required | |
comment | Comment about parameter | string Optional |
parameter for test |
ArtifactRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | Id of artifact | string Required |
5c1111d7a4186a4eafed0587 |
version | Artifact version | string Required |
0.1.0 |
ArtifactVersion
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Id of artifact | string Required |
5c1111d7a4186a4eafed0587 |
|||||||||
name | Name of artifact | string Optional |
Hello world artifact |
|||||||||
version | Artifact version | string Required |
0.1.0 |
|||||||||
type | Artifact type | string Required |
standard |
|||||||||
publisher | Artifact publisher | string Required |
admin |
|||||||||
marketplaceProduct | Marketplace product | string Required |
Talend Data Fabric (tp_bd_7.2.1.20190612_1410) |
|||||||||
parameters | array of ArtifactParameter Required |
|
||||||||||
workspace | WorkspaceInfo Required | |||||||||||
description | Artifact description | string Optional |
This is test artifact |
|||||||||
createDate | Artifact date of creation | datetime Required |
RFC3339 |
|||||||||
repository | SourcesRepositoryData Optional |
PageArtifact
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
items | array of Artifact Optional |
|
||||||||||
limit | integer Optional |
INT32 |
||||||||||
offset | integer Optional |
INT32 |
||||||||||
total | integer Optional |
INT32 |
Get available Artifacts
GET /orchestration/artifactsRequest
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
500Status 500
Delete Artifact by id
DELETE /orchestration/artifacts/{artifactId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
artifactId | artifact id | string Required |
Response
204Status 204
Get Artifact by id
GET /orchestration/artifacts/{artifactId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
artifactId | artifact id | string Required |
Response
Get Artifact of a specified version
GET /orchestration/artifacts/{artifactId}/versions/{version}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
artifactId | artifact id | string Required | |
version | artifact version | string Required |
Response
Delete Artifact of a specified version
DELETE /orchestration/artifacts/{artifactId}/versions/{version}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
artifactId | artifact id | string Required | |
version | artifact version | string Required |
Response
204Status 204
Connections
UpdateConnectionRequest
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
name | Connection name | string Optional |
testConnection |
|||||||||
parameters | array of ConnectionParameter Optional |
|
CreateConnectionRequest
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
name | Connection name | string Required |
testConnection |
|||||||||
workspaceId | Workspace ID | string Required |
5b3ee8676e8f510dbb3fa806 |
|||||||||
app | Application name | string Required |
Custom |
|||||||||
parameters | array of ConnectionParameter Required |
|
ConnectionParameter
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Parameter name | string Required |
param1 |
value | Parameter value | string Optional |
value1 |
encrypted | If encrypted or not | boolean Optional |
ConnectionDetails
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Connection ID | string Required | ||||||||||
name | Connection name | string Required | ||||||||||
app | Application name | string Required | ||||||||||
createDate | Creation Date of Connection | datetime Required |
RFC3339 |
|||||||||
parameters | array of ConnectionParameter Required |
|
||||||||||
workspace | WorkspaceInfo Required |
PageConnection
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
items | array of ConnectionDetails Optional |
|
||||||||||
limit | integer Optional |
INT32 |
||||||||||
offset | integer Optional |
INT32 |
||||||||||
total | integer Optional |
INT32 |
Create a Connection
POST /orchestration/connectionsResponse
Get available Connections
GET /orchestration/connectionsRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
offset | integer Optional |
INT32 |
|
name | string Optional | ||
limit | integer Optional |
100 INT32 |
Response
Get a Connection details
GET /orchestration/connections/{connectionId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
connectionId | string Required |
Response
Update a Connection
PUT /orchestration/connections/{connectionId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
connectionId | string Required |
Response
Delete a Connection
DELETE /orchestration/connections/{connectionId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
connectionId | string Required |
Response
204Status 204
Environments
EnvironmentInfo
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | Unique identifier of the Environment | string Required |
57f64991e4b0b689a64feed3 |
name | Functional name of the Environment | string Required |
Development |
description | string Optional |
detailed environment description |
|
maxCloudContainers | maximum number of cloud engines | integer Optional |
INT32 |
default | boolean Optional |
List Environments
GET /orchestration/environmentsRetrieve all the environments according to filters.
If the user is entitled with CLUSTER_MANAGEMENT or ENVIRONMENT_MANAGEMENT role, all environments matching query will be returned.
If the user is entitled with OPERATOR role, environments matching query and the user workspace permissions will be returned.
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
query | search query (FIQL format), e.g. name==Dev*;description==*environment* | string Optional |
Response
200Status 200
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of EnvironmentInfo |
|
401Status 401
403Status 403
500Status 500
Create Environment
POST /orchestration/environmentsCreate an Environment.
Requirements:
- environment name must be unique
- the user account issuing the request must be granted the ENVIRONMENT_MANAGEMENT permission
Environment is created on platform. A CUSTOM workspace is automatically created within this environment with proper ownership permissions assigned onto it.
Upon your request, Cloud Engine could also be assigned to the newly added environment.
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Unique name for the environment to create | string Required |
Production - Asia - Development - Supply Chain |
description | string Optional | ||
maxCloudContainers | Number of Cloud Engines to assign to this Environment | integer Optional |
INT32 |
workspaceName | Name for the custom workspace created along with the Environment | string Required | |
owner | Login name of user to be owner of the custom workspace created along with the Environment | string Optional |
jSmith |
Response
400Status 400
401Status 401
403Status 403
409Status 409
500Status 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
Name | Description | Type | Attributes and examples |
---|---|---|---|
Id | string Required |
Response
204Status 204
400Status 400
401Status 401
403Status 403
Name | Description | Type | Attributes and examples |
---|---|---|---|
Usage Details | Promotions and Engines still using this Environment | string Optional |
404Status 404
500Status 500
Update Environment
PUT /orchestration/environments/{Id}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
Id | string Required |
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | string Required | ||
description | string Optional | ||
maxCloudContainers | integer Optional |
INT32 |
Response
204Status 204
401Status 401
403Status 403
Name | Description | Type | Attributes and examples |
---|---|---|---|
Usage Details | Promotions and Engines still using this Environment | string Optional |
404Status 404
409Status 409
500Status 500
Workspaces
Workspace
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | Workspace identifier | string Required |
57f64991e4b0b689a64feed2 |
name | Workspace name | string Required |
Personal |
description | Workspace description | string Optional |
workspace detail description |
createDate | Date of creation of the workspace | datetime Required |
RFC3339 |
updateDate | Date of update of the workspace | datetime Required |
RFC3339 |
owner | Owner of the workspace | string Optional |
admin |
ownerFullName | Full name of the workspace owner | string Required | |
type | Workspace type | string Required |
|
environmentId | Environment id of the workspace | string Required |
WorkspaceInfo
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | Workspace identifier | string Required |
57f64991e4b0b689a64feed2 |
name | Workspace name | string Required |
Personal |
description | Workspace description | string Optional |
workspace detail description |
owner | Workspace owner | string Optional |
admin |
type | Workspace type | string Required |
custom |
environment | EnvironmentInfo Optional | ||
protectedUpgrade | Allows to control the scope of Tasks upgrades on Artifact new version publicationÂ
|
boolean Optional |
CreateWorkspaceRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Name of the workspace to be created | string Required | |
description | Functional description of your workspace | string Optional | |
owner | Login name of the owner of the workspace | string Optional |
fDupont |
environmentId | Environment this workspace will belong to | string Required |
List Workspaces
GET /orchestration/workspacesRetrieve all the workspaces according to filters.
If the user is entitled with CLUSTER_MANAGEMENT or ENVIRONMENT_MANAGEMENT role, all workspaces matching query will be returned.
If the user is entitled with OPERATOR role, workspaces matching query and the workspace permissions will be returned.
Use cases
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
query | This parameter defines a search query in FIQL format. The Feed Item Query Language is a syntax for expressing filters across the entries. | string Optional |
name==TestWorkspace,environment.name==TestEnvironment |
Response
200Status 200
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of WorkspaceInfo |
|
401Status 401
403Status 403
500Status 500
Create Workspace
POST /orchestration/workspacesCreate a Workspace.
Please ensure the following requirements are met :
- provide environment this workspace will belong to
- provide some unique naming within environment
- user must be granted ENVIRONMENT_MANAGEMENT permission
Owner can be provided. By default, creator user would be owner. Type is Custom.
Response
400Status 400
401Status 401
403Status 403
500Status 500
Update Workspace
PUT /orchestration/workspaces/{id}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | string Required |
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.Â
|
boolean Optional |
Response
204Status 204
400Status 400
401Status 401
403Status 403
404Status 404
500Status 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
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | string Required |
Response
204Status 204
401Status 401
403Status 403
404Status 404
409Status 409
Plans
Step
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Step id | string Optional |
9af64991e4b0b689a64feed0 |
|||||||||
name | Step name | string Required |
Step 1 |
|||||||||
condition | Expected status of successful step | string Required |
|
|||||||||
taskIds | array of string Required |
|
||||||||||
handlerOnFailure | StepErrorHandler Optional | |||||||||||
note | Description to rerun a plan execution from this step | string Optional |
Clear the database for users |
StepErrorHandler
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
taskIds | array of string Optional |
|
||||||||||
planIds | array of string Optional |
|
Plan
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Resource id | string Required |
5cdd2ce2c737973f9d581b98 |
|||||||||
name | Resource name | string Required |
Remote Engine |
|||||||||
description | Resource description | string Optional |
Some description |
|||||||||
workspace | WorkspaceInfo Optional | |||||||||||
createDate | Date of creation of the resource | datetime Required |
RFC3339 |
|||||||||
updateDate | Date of updating of the resource | datetime Optional |
RFC3339 |
|||||||||
author | Plan author | string Required |
operator123 |
|||||||||
steps | array of Step Required |
|
||||||||||
authorType | Plan author type | string Optional |
|
PlanExecutableDetails
Name | Description | Type | Attributes and examples |
---|---|---|---|
executable | Executable identifier | string Required |
57f64991e4b0b689a64feed0 |
name | Executable name | string Required |
simple executable |
workspace | WorkspaceInfo Optional | ||
description | Executable description | string Optional |
plan detail description |
chart | ExecutionStep Optional | ||
status | Plan execution status | string Optional |
|
planPauseDetails | PlanPauseDetails Required |
PlanRequest
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
name | Plan name | string Required |
Plan 1 |
|||||||||
workspaceId | Plan workspace | string Required |
57f64991e4b0b689a64feed2 |
|||||||||
description | Plan description | string Optional |
Some description |
|||||||||
steps | array of Step Required |
|
ExecutionStep
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
stepId | string Optional | |||||||||||
abstractStepId | string Optional | |||||||||||
stepName | string Optional | |||||||||||
status | string Optional |
|
||||||||||
stepOnException | ExecutionStep Optional | |||||||||||
nextStep | ExecutionStep Optional | |||||||||||
flows | array of ExecutionFlow Optional |
|
||||||||||
stepNote | string Optional |
ExecutionFlow
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
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 |
{
"pause": true,
"pauseContext": "Pause for Monthly Prod Op #XYZ"
"pauseDate": "2023-01-13T14:42:58.341Z",
"user": "adminMasterX",
"userType": "HUMAN"
}
PagePlan
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
items | array of PlanExecutableDetails Optional |
|
||||||||||
limit | integer Optional |
INT32 |
||||||||||
offset | integer Optional |
INT32 |
||||||||||
total | integer Optional |
INT32 |
PauseDetails
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 |
{
"pause": true,
"pauseContext": "Pausing execution"
"pauseDate": "2023-01-13T14:42:58.341Z",
"user": "admin",
"userType": "HUMAN"
}
Get available Plans
GET /orchestration/executables/plansRequest
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
Create Plan
POST /orchestration/executables/plansResponse
Get Plan details
GET /orchestration/executables/plans/{planId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
planId | executable ID | string Required |
Response
500Status 500
Delete Plan
DELETE /orchestration/executables/plans/{planId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
planId | executable ID | string Required |
Response
204Status 204
Update plan
PUT /orchestration/executables/plans/{planId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
planId | executable ID | string Required |
Response
Stop schedule for plan
DELETE /orchestration/executables/plans/{planId}/run-configRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
planId | plan id | string Required |
Response
204Status 204
Configure Plan execution
PUT /orchestration/executables/plans/{planId}/run-configRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
planId | plan id | string Required |
Response
Get Plan configuration
GET /orchestration/executables/plans/{planId}/run-configGet Plan configuration applied to your Plan executions.
Please take note :
- the Trigger definition can now have some new value ‘Multiple’ defined when you link your plan to some Multiple Time Trigger schedule.
- whenever such multiple trigger schedule is linked please use the new dedicated endpoints to manage this specific scheduling configuration.
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
planId | plan id | string Required |
Response
Get plan scheduled triggers
GET /orchestration/executables/plans/{planId}/run-config/eventsRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
planId | string Required |
Name | Description | Type | Attributes and examples |
---|---|---|---|
offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional |
INT32 |
to | to date time (milliseconds) | 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
Pause-Resume Plan executions
PUT /orchestration/executables/plans/{planId}/pauseRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
planId | string Required |
Response
202Status 202
204Status 204
400Status 400
401Status 401
403Status 403
404Status 404
500Status 500
Projects
ProjectView
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
Name | Description | Type | Attributes and examples |
---|---|---|---|
owner | Owner name | string Required |
John Doe |
description | Project description | string Optional |
John Doe |
url | Project url | string Required |
https://github.com/example/Example.git |
name | Project name | string Required |
Hello world project |
ProjectRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
owner | Owner name | string Optional |
John Doe |
description | Project description | string Optional |
John Doe |
url | Project url | string Optional |
https://github.com/example/Example.git |
SourcesRepositoryData
Name | Description | Type | Attributes and examples |
---|---|---|---|
project | project name | string Required | |
branch | repository branch | string Optional | |
commit | RepositoryCommitData Optional |
RepositoryCommitData
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | commit id | string Required |
d8a1c8aac0365fb00f32c45ccbd07ad81fe9d60c |
date | commit date time | datetime Required |
RFC3339 |
author | commit author | string Required |
mpidhornyi <mpidhornyi@talend.com> |
PageProject
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
items | array of ProjectView Optional |
|
||||||||||
limit | integer Optional |
INT32 |
||||||||||
offset | integer Optional |
INT32 |
||||||||||
total | integer Optional |
INT32 |
Create Project
POST /orchestration/projectsCreate Project
Please take note only PAT access is supported on this endpoint at current.
Response
Get Projects
GET /orchestration/projectsGet Projects
Please take note only PAT access is supported on this endpoint at current.
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
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
Get Project by id
GET /orchestration/projects/{projectId}Get Project by id
Please take note only PAT access is supported on this endpoint at current.
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
projectId | project ID | string Required |
Response
Update Project
PUT /orchestration/projects/{projectId}Update Project
Please take note only PAT access is supported on this endpoint at current.
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
projectId | project ID | string Required |
Response
Delete project
DELETE /orchestration/projects/{projectId}Delete project
Please take note only PAT access is supported on this endpoint at current.
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
projectId | project ID | string Required |
Response
204Status 204
Projects Authorization
ProjectUserAuthResponse
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
projectId | string Optional | |||||||||||
userIds | array of string Optional |
|
ProjectGroupAuthResponse
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
projectId | string Optional | |||||||||||
groupIds | array of string Optional |
|
Promotions
AdvancedPromotionSpec
Name | Description | Type | Attributes and examples |
---|---|---|---|
artifactId | Advanced Promotion Artifact Id | string Optional |
57f64991e4b0b689a64feed0 |
artifactType | Advanced Promotion Artifact Type. In the following list of allowed values, ‘ACTION’ refers to Artifacts, ‘FLOW’ refers to Tasks, ‘PLAN’ refers to Plans and ‘WORKSPACE’ refers to Workspaces | string Optional |
|
ArtifactPromotionResult
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 |
1.1 |
version | applicable to artifacts with type FLOW only, version of flow in source environment | integer Optional |
INT32 |
UpdateDescriptionRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
description | Promotion description | string Required |
This is new description |
PromotionExecutableDetails
Name | Description | Type | Attributes and examples |
---|---|---|---|
executable | Executable identifier | string Required |
57f64991e4b0b689a64feed0 |
name | Executable name | string Required |
simple executable |
sourceEnvironment | EnvironmentInfo Optional | ||
targetEnvironment | EnvironmentInfo Optional | ||
description | Promotion description (not returned when querying a list of objects) | string Optional |
promotion detail description |
CreatePromotionRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
sourceEnvironmentId | Source environment ID | string Required |
5b3ee8676e8f510dbb3fa806 |
targetEnvironmentId | Target environment ID | string Required |
5b3ee8676e8f510dbb3fa807 |
description | Promotion description | string Optional |
This is description |
TaskAutoUpgradeRequest
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
workspaceId | Workspace id of task to create | string Required |
57f64991e4b0b689a64feed2 |
|||||||||
name | Task name | string Required |
Hello world task |
|||||||||
description | Task description | string Required |
Task detail description |
|||||||||
tags | array of string Optional |
|
||||||||||
connections | Task connections | ObjectOptional | ||||||||||
parameters | Task parameters | ObjectOptional | ||||||||||
resources | Task resources | ObjectOptional | ||||||||||
artifact | ArtifactRequest Required | |||||||||||
autoUpgradeInfo | AutoUpgradeInfo Optional |
UpgradeInfo
Name | Description | Type | Attributes and examples |
---|---|---|---|
upgradable | boolean Optional | ||
autoUpgradeFailed | boolean Optional |
Message
Name | Description | Type | Attributes and examples |
---|---|---|---|
info | string Optional | ||
level | string Optional |
|
PromotionResultInfo
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 |
1.1 |
version | Applicable to flows only, displays version of flow in source environment | integer Optional |
INT32 |
Report
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
status | string Optional |
|
||||||||||
messages | array of Message Optional |
|
RuntimePromotionResult
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 |
|
WorkspacePromotionResult
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 |
|
||||||||||
plans | array of ArtifactPromotionResult Optional |
|
||||||||||
actions | array of ArtifactPromotionResult Optional |
|
||||||||||
connections | array of ArtifactPromotionResult Optional |
|
||||||||||
resources | array of ArtifactPromotionResult Optional |
|
||||||||||
engines | array of RuntimePromotionResult Optional |
|
||||||||||
clusters | array of RuntimePromotionResult Optional |
|
PromotionExecutionStatusV26
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
executionId | Job execution ID | string Required |
7b2b122e-d6b8-42de-b0ba-fa2f0d36306e |
|||||||||
startTimestamp | Start time of job execution (UTC) | datetime 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 |
fupton |
|||||||||
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 |
|
||||||||||
engines | array of RuntimePromotionResult Optional |
|
||||||||||
clusters | array of RuntimePromotionResult Optional |
|
||||||||||
context | Execution context message | string Optional |
255
Free text describing the context for promotion execution |
PromotionAdvancedInfo
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
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/promotionsResponse
409Status 409
Get available Promotions
GET /orchestration/executables/promotionsRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
_s | search query (FIQL format), e.g. “name==dev to prod*” | string Optional |
Response
200Status 200
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of PromotionExecutableDetails |
|
Update a Promotion
PATCH /orchestration/executables/promotions/{promotionId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
promotionId | Promotion ID | string Required |
Response
204Status 204
Perform promotion analysis
POST /orchestration/executables/promotions/{promotionId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
promotionId | Promotion ID | string Required |
Response
Delete a Promotion
DELETE /orchestration/executables/promotions/{promotionId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
promotionId | Promotion ID | string Required |
Response
204Status 204
Get Promotion details
GET /orchestration/executables/promotions/{promotionId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
promotionId | Promotion ID | string Required |
Response
Promotions Authorization
PromotionUsersResponse
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
executable | Promotion ID | string Required |
5d3039de65ff7d3583840bk1 |
|||||||||
userIds | array of string Required |
|
||||||||||
serviceAccountIds | array of string Required |
|
Get users assigned to Promotion
GET /orchestration/executables/promotions/{promotionId}/usersRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
promotionId | Promotion ID | string Required |
Response
Assign user to Promotion
PUT /orchestration/executables/promotions/{promotionId}/users/{userId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
promotionId | Promotion ID | string Required | |
userId | User ID | string Required |
Response
204Status 204
Unassign user from Promotion
DELETE /orchestration/executables/promotions/{promotionId}/users/{userId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
promotionId | Promotion ID | string Required | |
userId | User ID | string Required |
Response
204Status 204
Assign service account to promotion
PUT /orchestration/executables/promotions/{promotionId}/service-accounts/{serviceAccountId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
promotionId | string Required | ||
serviceAccountId | string Required |
Response
204Status 204
400Status 400
401Status 401
403Status 403
404Status 404
500Status 500
Unassign service account from promotion
DELETE /orchestration/executables/promotions/{promotionId}/service-accounts/{serviceAccountId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
promotionId | string Required | ||
serviceAccountId | string Required |
Response
204Status 204
400Status 400
401Status 401
403Status 403
404Status 404
500Status 500
Resources
Resource
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | Id of resource | string Required |
5c1111d7a4186a4eafed0587 |
name | Name of resource | string Required |
Hello world task |
description | Description of resource | string Optional |
task detail description |
workspaceInfo | WorkspaceInfo Required | ||
file | Boolean value which indicates that resource is file | boolean Required |
UpdateResourceRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Resource name | string Optional | |
description | Resource description | string Optional |
PageResource
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
items | array of Resource Optional |
|
||||||||||
limit | integer Optional |
INT32 |
||||||||||
offset | integer Optional |
INT32 |
||||||||||
total | integer Optional |
INT32 |
CreateResourceRequest
{
"name": "resource name",
"description": "resource description",
"workspaceId": "workspace id",
"file": true
}
Create a Resource
POST /orchestration/resourcesRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
resource | CreateResourceRequest Required | ||
file | Resource attachment | file Required |