Processing

Configure Engines and Clusters, manage and browse executions of your Tasks, Plans and Promotions.

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
Format Bearer <token>

Task Executions

Get available Tasks Executions

POST /processing/executables/tasks/executions
Get available Tasks Executions

Use cases

Request

Body
application/json
Object
application/json 
{
  "limit": 100,
  "offset": 10,
  "status": "executing",
  "from": 1646159400000,
  "to": 1649183400000,
  "lastDays": 20,
  "environmentId": "57f64991e4b0b689a64feed3",
  "workspaceId": "57f64991e4b0b689a64feed2",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Response

200Status 200
Ok
Body
application/json
Page
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Get Task Executions

GET /processing/executables/tasks/{taskId}/executions
Get task executions

Use cases

Request

Path variables
Name Description Type Attributes and examples
taskId task ID 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
FormatINT32
from from date time (milliseconds) integer Optional
FormatINT64
to to date time (milliseconds) integer Optional
FormatINT64
limit the number of items to return. Must be in range [1, 100]. Default value - 100 integer Optional
FormatINT32
status execution status string Optional
Enum
  • dispatching
  • deploy_failed
  • executing
  • execution_successful
  • execution_rejected
  • execution_failed
  • terminated
lastDays lastDays integer Optional
FormatINT32

Response

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

Execute Task

POST /processing/executions
Execute Task

Use cases

Request

Body
application/json
Executabletask

Response

201Status 201
Execution started
Body
application/json
Executionidentifier
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
application/json
ErrorResponse
404Status 404
Not found - resource not found
Body
application/json
ErrorResponse
405Status 405
Current Task is paused, it can’t be executed
500Status 500
Server error - something went wrong on server side
Body
application/json
ErrorResponse
501Status 501
Task cannot be deployed because it is not configured
Body
application/json
ErrorResponse

Terminate Task execution

DELETE /processing/executions/{executionId}
Terminate Task execution

Request

Path variables
Name Description Type Attributes and examples
executionId execution ID string Required

Response

200Status 200
Execution already finished
Body
text/plain
string
204Status 204
Execution stopped succesfully
400Status 400
Bad Request
Body
text/plain
ErrorResponse
401Status 401
Unauthorized
Body
text/plain
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
text/plain
ErrorResponse
404Status 404
Not found - resource not found
Body
text/plain
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
text/plain
ErrorResponse

Get Task execution status

GET /processing/executions/{executionId}
Get Task execution status

Request

Path variables
Name Description Type Attributes and examples
executionId execution ID string Required

Response

200Status 200
Successful response
Body
application/json
JobExecutionStatusV21
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
application/json
ErrorResponse
404Status 404
Not found - resource not found
Body
application/json
ErrorResponse
429Status 429
Too many requests
Body
application/json
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
application/json
ErrorResponse

Executabletask

Object
Name Description Type Attributes and examples
executable Executable identifier string Required
Example
57f64991e4b0b689a64feed0
parameters Executable parameters ObjectOptional
logLevel Execution log level string Optional
Enum
  • OFF
  • ERROR
  • WARN
  • INFO
Example
WARN
timeout Execution timeout in minutes. Minimal value is 1. integer 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
Enum
  • STANDARD
  • BIG_DATA_STREAMING
  • BIG_DATA_BATCH
  • ROUTE
  • DATA_SERVICE
  • PIPELINE

JobExecutionStatus

Execution info
Object
Name Description Type Attributes and examples
executionId Job execution ID string Required
Example
7b2b122e-d6b8-42de-b0ba-fa2f0d36306e
startTimestamp Start time of job execution (UTC) datetime Required
FormatRFC3339
triggerTimestamp Trigger time of job execution (UTC) datetime Required
FormatRFC3339
finishTimestamp End time of job execution (UTC) datetime Optional
FormatRFC3339
userId User who triggered or scheduled the execution string Required
Example
fupton
userType Type of user who triggered or scheduled the execution string Required
Enum
  • HUMAN
  • SERVICE
jobId Job ID string Required
Example
57f64991e4b0b689a64feed0
jobVersion The version of the executed job string Required
Example
5.2
environmentVersion Execution environment version string Required
Enum
  • 1.2
  • 1.3
Example
1.3
executionStatus Execution status string Required
Enum
  • EXECUTION_EVENT_RECEIVED
  • DISPATCHING_FLOW
  • STARTING_FLOW_EXECUTION
  • STOPPING_FLOW_EXECUTION
  • EXECUTION_TERMINATED
  • DEPLOY_FAILED
  • EXECUTION_FAILED
  • EXECUTION_REJECTED
  • EXECUTION_SUCCESS
executionType Execution type string Required
Enum
  • MANUAL
  • SCHEDULED
  • WEBHOOK
  • PLAN
Example
SCHEDULED
executionDestination Destination of execution string Required
Enum
  • CLOUD
  • CLOUD_EXCLUSIVE
  • REMOTE_ENGINE
  • REMOTE_ENGINE_CLUSTER
Example
REMOTE_ENGINE
containerId Container ID string Optional
runProfileId Run profile ID string Optional
Example
157f818f-a901-4425-b592-0f9282687784
remoteEngineId Remote engine ID string Optional
Example
157f818f-a901-4425-b592-0f9282687784
remoteEngineClusterId Remote engine cluster ID string Optional
numberOfProcessedRows Number of processed rows integer Optional
FormatINT64
Example
1234567890
numberOfRejectedRows Number of rejected rows integer Optional
FormatINT64
Example
0
accountId Account ID string Required
Example
8494b016-b5ef-4b9c-b16d-8b1f824d7616
workspaceId Workspace ID string Required
Example
57ce63d3e4b0681c36d1a1c4
planId Plan execution ID string Optional
errorType Error type if error occurs string Optional
errorMessage Error message if error occurs string Optional

JobExecutionStatusV21

Execution info
Object
Name Description Type Attributes and examples
executionId Job execution ID string Required
Example
7b2b122e-d6b8-42de-b0ba-fa2f0d36306e
startTimestamp Start time of job execution (UTC) datetime Required
FormatRFC3339
triggerTimestamp Trigger time of job execution (UTC) datetime Required
FormatRFC3339
finishTimestamp End time of job execution (UTC) datetime Optional
FormatRFC3339
userId User who triggered or scheduled the execution string Required
Example
fupton
userType Type of user who triggered or scheduled the execution string Required
Enum
  • HUMAN
  • SERVICE
jobId Job ID string Required
Example
57f64991e4b0b689a64feed0
jobVersion The version of the executed job string Required
Example
5.2
environmentVersion Execution environment version string Required
Enum
  • 1.2
  • 1.3
Example
1.3
executionStatus Execution status string Required
Enum
  • EXECUTION_EVENT_RECEIVED
  • DISPATCHING_FLOW
  • STARTING_FLOW_EXECUTION
  • STOPPING_FLOW_EXECUTION
  • EXECUTION_TERMINATED
  • DEPLOY_FAILED
  • EXECUTION_FAILED
  • EXECUTION_REJECTED
  • EXECUTION_SUCCESS
executionType Execution type string Required
Enum
  • MANUAL
  • SCHEDULED
  • WEBHOOK
  • PLAN
Example
SCHEDULED
executionDestination Destination of execution string Required
Enum
  • CLOUD
  • CLOUD_EXCLUSIVE
  • REMOTE_ENGINE
  • REMOTE_ENGINE_CLUSTER
Example
REMOTE_ENGINE
containerId Container ID string Optional
runProfileId Run profile ID string Optional
Example
157f818f-a901-4425-b592-0f9282687784
remoteEngineId Remote engine ID string Optional
Example
157f818f-a901-4425-b592-0f9282687784
remoteEngineClusterId Remote engine cluster ID string Optional
numberOfProcessedRows Number of processed rows integer Optional
FormatINT64
Example
1234567890
numberOfRejectedRows Number of rejected rows integer Optional
FormatINT64
Example
0
accountId Account ID string Required
Example
8494b016-b5ef-4b9c-b16d-8b1f824d7616
workspaceId Workspace ID string Required
Example
57ce63d3e4b0681c36d1a1c4
planId Plan execution ID string Optional
errorType Error type if error occurs string Optional
errorMessage Error message if error occurs string Optional
status Task execution status string Required
Enum
  • dispatching
  • deploy_failed
  • executing
  • execution_rejected
  • execution_successful
  • execution_failed
  • terminated
Example
execution_successful

PageTaskExecutionStatusV21

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

TaskExecutionStatusV21

Task Execution info
Object
Name Description Type Attributes and examples
executionId Job execution ID string Required
Example
7b2b122e-d6b8-42de-b0ba-fa2f0d36306e
startTimestamp Start time of job execution datetime Required
FormatRFC3339
triggerTimestamp Trigger time of job execution datetime Required
FormatRFC3339
finishTimestamp End time of job execution datetime Optional
FormatRFC3339
userId User who triggered or scheduled the execution string Required
Example
fupton
userType Type of user who triggered or scheduled the execution string Required
Enum
  • HUMAN
  • SERVICE
taskId Task Id string Required
Example
57f64991e4b0b689a64feed0
taskVersion Task version string Required
executionType Execution type string Required
Enum
  • MANUAL
  • SCHEDULED
  • WEBHOOK
  • PLAN
Example
SCHEDULED
status Execution status string Required
Enum
  • dispatching
  • deploy_failed
  • executing
  • execution_successful
  • execution_rejected
  • execution_failed
  • terminated
Example
executing
runtime Runtime Optional
errorMessage Error message if error occurs string Optional
executionStatus Execution (detailed) status string Required
Enum
  • DEPLOY_FAILED
  • EXECUTION_SUCCESS
  • EXECUTION_FAILED
  • EXECUTION_TERMINATED
  • EXECUTION_REJECTED
  • EXECUTION_EVENT_RECEIVED
  • DISPATCHING_FLOW
  • STARTING_FLOW_EXECUTION
  • STOPPING_FLOW_EXECUTION
  • UNKNOWN
Example
DEPLOY_FAILED

Workspaceinfo

Object
Name Description Type Attributes and examples
id Workspace identifier string Required
Example
57f64991e4b0b689a64feed2
name Workspace name string Required
Example
Personal
description Workspace description string Optional
Example
workspace detail description
owner Workspace owner string Optional
Example
admin
type Workspace type string Required
Enum
  • shared
  • personal
  • custom
Example
custom
environment Environmentinfo Optional

Plan Executions

Execute Plan

POST /processing/executions/plans
Allows to run a Plan (starting from V2.4: optionally from specified step)

Request

Body
application/json
PlanExecutable

Response

201Status 201
Execution started
Body
application/json
Executionidentifier
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
application/json
ErrorResponse
404Status 404
Not found - resource not found
Body
application/json
ErrorResponse
422Status 422
Entity exists but cannot be processed, because too old or plan exec didn’t fail
Body
application/json
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
application/json
ErrorResponse
501Status 501
Plan cannot be deployed because it is not configured
Body
application/json
ErrorResponse

Get available Plans executions

GET /processing/executables/plans/executions
Get available Plans executions

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
FormatINT32
from from date time (milliseconds) integer Optional
FormatINT64
environmentId environment ID the plans should belong to string Optional
to to date time (milliseconds) integer Optional
FormatINT64
workspaceId workspace ID the plans should belong to string Optional
limit the number of items to return. Must be in range [1, 100]. Default value - 100 integer Optional
FormatINT32
status execution status string Optional
Enum
  • executing
  • execution_successful
  • execution_failed
lastDays lastDays integer Optional
FormatINT32

Response

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

Get all steps for a plan execution (order by designed execution, only steps, without error handlers)

GET /processing/executions/plans/{planExecutionId}/steps
Get Steps executions status

Request

Path variables
Name Description Type Attributes and examples
planExecutionId Plan execution ID string Required

Response

200Status 200
Successful response
Body
application/json
details
Name Description Type Attributes and examples
array of StepExecution
Datatype details
Type Description Attributes and examples
array
StepExecution
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
application/json
ErrorResponse
404Status 404
Not found - resource not found
Body
application/json
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
application/json
ErrorResponse

Get Plan executions

GET /processing/executables/plans/{planId}/executions
Get Plan executions

Request

Path variables
Name Description Type Attributes and examples
planId plan ID 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
FormatINT32
from from date time (milliseconds) integer Optional
FormatINT64
to to date time (milliseconds) integer Optional
FormatINT64
limit the number of items to return. Must be in range [1, 100]. Default value - 100 integer Optional
FormatINT32
status execution status string Optional
Enum
  • executing
  • execution_successful
  • execution_failed
lastDays lastDays integer Optional
FormatINT32

Response

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

Get the step for plan execution without error handlers

GET /processing/executions/plans/{planExecutionId}/steps/{stepExecutionId}
Get Step execution status

Request

Path variables
Name Description Type Attributes and examples
planExecutionId Plan execution ID string Required
stepExecutionId Step execution ID string Required

Response

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

Get execution status of the handler for the specified step

GET /processing/executions/plans/{planExecutionId}/steps/{stepExecutionId}/error-handler
Get Step handler execution status

Request

Path variables
Name Description Type Attributes and examples
planExecutionId Plan execution ID string Required
stepExecutionId Step execution ID string Required

Response

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

ExecutionStep

Object
Name Description Type Attributes and examples
stepId string Optional
abstractStepId string Optional
stepName string Optional
status string Optional
Enum
  • SUCCESS
  • PARTIAL_SUCCESS
  • FAIL
stepOnException ExecutionStep Optional
nextStep ExecutionStep Optional
flows array of ExecutionFlow Optional
Datatype details
Type Description Attributes and examples
array
ExecutionFlow
stepNote string Optional

PagePlanExecutionStatusV21

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

PlanExecutable

Object
Name Description Type Attributes and examples
executable Executable identifier string Required
Example
b91cf8b2-5dd1-4b18-915b-4c447cee5267
executionPlanId The plan execution identifier in case of re-execution (works starting from V2.4) string Optional
Example
0798b8d1-0e12-472f-be02-a0f04e792daa
stepId The step identifier to start with (works starting from V2.4) string Optional
Example
09043c9f-02d0-41f6-b3cb-0ea53ffde377
rerunOnlyFailedTasks Optionally run only failing tasks (works starting from V2.4) boolean Optional

PlanExecutionStatus

Plan Execution info
Object
Name Description Type Attributes and examples
executionId Job execution ID string Required
Example
7b2b122e-d6b8-42de-b0ba-fa2f0d36306e
startTimestamp Start time of job execution (UTC) datetime Required
FormatRFC3339
finishTimestamp End time of job execution (UTC) datetime Optional
FormatRFC3339
userId User who triggered or scheduled the execution string Required
Example
fupton
userType Type of user who triggered or scheduled the execution string Required
Enum
  • HUMAN
  • SERVICE
planId Plan ID string Required
Example
b91cf8b2-5dd1-4b18-915b-4c447cee5267
executionStatus Execution (detailed) status string Required
Enum
  • UNDEFINED
  • STARTED
  • FINISHED
  • EXECUTION_FAILED
  • EXECUTION_SUCCESS
Example
FINISHED
plannedExecutableCount Number of planned executables integer Optional
FormatINT32
Example
2
doneExecutableCount Number of done executables integer Optional
FormatINT32
Example
1
doneExecutableDetails array of JobExecutionStatus Optional
Datatype details
Type Description Attributes and examples
array Execution activity info
JobExecutionStatus

PlanExecutionStatusV21

Plan Execution info
Object
Name Description Type Attributes and examples
executionId Job execution ID string Required
Example
7b2b122e-d6b8-42de-b0ba-fa2f0d36306e
startTimestamp Start time of job execution datetime Required
FormatRFC3339
finishTimestamp End time of job execution datetime Optional
FormatRFC3339
userId User who triggered or scheduled the execution string Required
Example
fupton
userType Type of user who triggered or scheduled the execution string Required
Enum
  • HUMAN
  • SERVICE
planId Plan ID string Required
Example
b91cf8b2-5dd1-4b18-915b-4c447cee5267
executionStatus Execution (detailed) status string Required
Enum
  • UNDEFINED
  • STARTED
  • FINISHED
  • EXECUTION_FAILED
  • EXECUTION_SUCCESS
Example
FINISHED
plannedExecutableCount Number of planned executables integer Optional
FormatINT32
Example
2
doneExecutableCount Number of done executables integer Optional
FormatINT32
Example
1
doneExecutableDetails array of JobExecutionStatus Optional
Datatype details
Type Description Attributes and examples
array Execution activity info
JobExecutionStatus
status Execution status string Required
Enum
  • executing
  • execution_successful
  • execution_failed
Example
executing

Step

Object
Name Description Type Attributes and examples
id Step id string Optional
Example
9af64991e4b0b689a64feed0
name Step name string Required
Example
Step 1
condition Expected status of successful step string Required
Enum
  • ALL_SUCCEEDED
  • AT_LEAST_ONE_SUCCEEDED
taskIds array of string Required
Datatype details
Type Description Attributes and examples
array List of step tasks
Example
["5d5fc81f79bc197d2483a100","5d5fc81f79bc197d2483a101"]
string
handlerOnFailure StepErrorHandler Optional
note Description to rerun a plan execution from this step string Optional
Example
Clear the database for users

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
Example
["5d5fc81f79bc197d2483a102","5d5fc81f79bc197d2483a103"]
string
planIds array of string Optional
Datatype details
Type Description Attributes and examples
array List of handler plans
Example
["5d5fc81f79bc197d2483a104"]
string

StepExecution

Object
Name Description Type Attributes and examples
id string Optional
executionId string Optional
startTimestamp datetime Optional
FormatRFC3339
finishTimestamp datetime Optional
FormatRFC3339
executionStatus string Optional

StepExecutionDetails

Object
Name Description Type Attributes and examples
id string Optional
executionId string Optional
startTimestamp datetime Optional
FormatRFC3339
finishTimestamp datetime Optional
FormatRFC3339
executionStatus string Optional
plannedExecutableCount integer Optional
FormatINT32
doneExecutableCount integer Optional
FormatINT32
doneTaskExecutableDetails array of JobExecutionStatus Optional
Datatype details
Type Description Attributes and examples
array
JobExecutionStatus
donePlanExecutableDetails array of PlanExecutionStatus Optional
Datatype details
Type Description Attributes and examples
array
PlanExecutionStatus

Promotion Executions

Execute a Promotion

POST /processing/executions/promotions
Execute a Promotion

Request

Body
application/json
PromotionExecutableTaskV26

Response

201Status 201
Execution success
Body
application/json
Execution
202Status 202
Execution started
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse
501Status 501
Promotions can’t be executed because it has errors
Body
application/json
ErrorResponse

Get Promotion execution status

GET /processing/executions/promotions/{executionId}
Get Promotion execution status

Request

Path variables
Name Description Type Attributes and examples
executionId Execution ID string Required

Response

200Status 200
OK
Body
application/json
PromotionExecutionStatus
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Perform promotion analysis

POST /processing/executables/promotions/{promotionId}
Allows to simulate a Promotion and get changes report analysis without actually executing it in real. NB : Please note target version shared in analysis might differ from the real target version you would get when executing the promotion, in case some changes are done in target environment between your simulation and your actual execution of the promotion.

Request

Path variables
Name Description Type Attributes and examples
promotionId Id of the promotion you want to simulate string Required
Body
application/json
PromotionExecutionDetails

Response

200Status 200
Body
application/json
PromotionExecutionStatusV26

AdvancedPromotionSpec

Object
Name Description Type Attributes and examples
artifactId Advanced Promotion Artifact Id string Optional
Example
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
Enum
  • WORKSPACE
  • PLAN
  • FLOW
  • ACTION
Example
WORKSPACE

ArtifactPromotionResult

Object
Name Description Type Attributes and examples
id Artifact ID string Optional
targetId Target Artifact ID string Optional
name Artifact Name string Optional
type Artifact Type string Optional
Enum
  • WORKSPACE
  • PLAN
  • FLOW
  • ACTION
  • CONNECTION
  • RESOURCE
  • ENGINE
  • CLUSTER
  • FOLDER
Example
WORKSPACE
analyzeReport Report Optional
promotionReport Report Optional
usedBy array of PromotionResultInfo Optional
Datatype details
Type Description Attributes and examples
array Used by Artifacts
PromotionResultInfo
targetVersion applicable to artifacts with type FLOW only, version of flow in target environment after promotion execution string Optional
Example
1.1
version applicable to artifacts with type FLOW only, version of flow in source environment integer Optional
FormatINT32
Example
1

AutoUpgradeInfo

Object
Name Description Type Attributes and examples
autoUpgradable Indicates whether to automatically upgrade task after publishing new artifact version boolean Optional
overrideWithDefaultParameters Indicates whether to override task parameters with artifact default parameters during auto upgrade boolean Optional

Execution

Object
Name Description Type Attributes and examples
executionId string Optional
executionReport PromotionExecutionStatusV26 Optional

PromotionExecutableDetails

Object
Name Description Type Attributes and examples
executable Executable identifier string Required
Example
57f64991e4b0b689a64feed0
name Executable name string Required
Example
simple executable
sourceEnvironment Environmentinfo Optional
targetEnvironment Environmentinfo Optional
description Promotion description (not returned when querying a list of objects) string Optional
Example
promotion detail description

PromotionExecutableTask

Object
Name Description Type Attributes and examples
executable Executable identifier string Required
Example
57f64991e4b0b689a64feed0
keepTargetResources Keep Target Resources flag boolean Optional
keepTargetRunProfiles Keep Target Run Profiles flag (works starting from V2.2) boolean Optional
advanced AdvancedPromotionSpec Optional

PromotionExecutableTaskV26

Object
Name Description Type Attributes and examples
executable Executable identifier string Required
Example
57f64991e4b0b689a64feed0
keepTargetResources Keep Target Resources flag boolean Optional
keepTargetRunProfiles Keep Target Run Profiles flag (works starting from V2.2) boolean Optional
advanced AdvancedPromotionSpec Optional
context Execution context message string Optional
Max length255
Example
Free text describing the context for promotion execution

PromotionExecutionDetails

Object
Name Description Type Attributes and examples
keepTargetRunProfiles boolean Optional
keepTargetResources boolean Optional
context string Optional
promotionAdvancedInfo AdvancedPromotionSpec Optional

PromotionExecutionStatus

Object
Name Description Type Attributes and examples
executionId Job execution ID string Required
Example
7b2b122e-d6b8-42de-b0ba-fa2f0d36306e
startTimestamp Start time of job execution (UTC) datetime Required
FormatRFC3339
triggerTimestamp Trigger time of job execution (UTC) datetime Required
FormatRFC3339
finishTimestamp End time of job execution (UTC) datetime Optional
FormatRFC3339
userId User who triggered or scheduled the execution string Required
Example
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
Enum
  • ANALIZED
  • PROMOTION_STARTED
  • PROMOTION_WARNING
  • PROMOTION_FAILED
  • PROMOTED
Example
PROMOTED
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

PromotionExecutionStatusV26

Object
Name Description Type Attributes and examples
executionId Job execution ID string Required
Example
7b2b122e-d6b8-42de-b0ba-fa2f0d36306e
startTimestamp Start time of job execution (UTC) datetime Required
FormatRFC3339
triggerTimestamp Trigger time of job execution (UTC) datetime Required
FormatRFC3339
finishTimestamp End time of job execution (UTC) datetime Optional
FormatRFC3339
userId User who triggered or scheduled the execution string Required
Example
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
Enum
  • ANALIZED
  • PROMOTION_STARTED
  • PROMOTION_WARNING
  • PROMOTION_FAILED
  • PROMOTED
Example
PROMOTED
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
Max length255
Example
Free text describing the context for promotion execution

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
Enum
  • WORKSPACE
  • PLAN
  • FLOW
  • ACTION
  • CONNECTION
  • RESOURCE
  • ENGINE
  • CLUSTER
  • FOLDER
Example
WORKSPACE
analyzeReport Report Optional
promotionReport Report Optional
targetVersion Applicable to flows only, displays version of flow in target environment after promotion execution string Optional
Example
1.1
version Applicable to flows only, displays version of flow in source environment integer Optional
FormatINT32

Report

Object
Name Description Type Attributes and examples
status string Optional
Enum
  • CREATED
  • REPLACED
  • REUSED
  • FAILED
  • SKIPPED
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 Target Artifact ID string Optional
name Artifact Name string Optional
type Artifact Type string Optional
Enum
  • WORKSPACE
  • PLAN
  • FLOW
  • ACTION
  • CONNECTION
  • RESOURCE
  • ENGINE
  • CLUSTER
  • FOLDER
Example
WORKSPACE
analyzeReport Report Optional
promotionReport Report Optional
usedBy array of PromotionResultInfo Optional
Datatype details
Type Description Attributes and examples
array Used by Artifacts
PromotionResultInfo
runProfiles array of ArtifactPromotionResult Optional
Datatype details
Type Description Attributes and examples
array Run profiles
ArtifactPromotionResult

UpgradeInfo

Object
Name Description Type Attributes and examples
upgradable boolean Optional
autoUpgradeFailed boolean Optional

WorkspacePromotionResult

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
Enum
  • WORKSPACE
  • PLAN
  • FLOW
  • ACTION
  • CONNECTION
  • RESOURCE
  • ENGINE
  • CLUSTER
  • FOLDER
Example
WORKSPACE
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

Remote Engines

Create new Remote Engine

POST /processing/runtimes/remote-engines
Create new Remote Engine

Request

Body
*/*
EngineRequest

Response

201Status 201
Created
Body
application/json
Engine
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Get all (available) Remote Engines

GET /processing/runtimes/remote-engines
Get all (available) Remote Engines

Request

Query parameters
Name Description Type Attributes and examples
query search query (FIQL format), e.g. “workspace.environment.id==5cb47ca4b1b5247f6006529e”,“status==PAIRED” string Optional

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of Engine
Datatype details
Type Description Attributes and examples
array
Engine
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Delete Remote Engine by id

DELETE /processing/runtimes/remote-engines/{id}
Delete Remote Engine by id

Request

Path variables
Name Description Type Attributes and examples
id remote engine id string Required

Response

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

Get Remote Engine by id

GET /processing/runtimes/remote-engines/{id}
Get Remote Engine by id

Request

Path variables
Name Description Type Attributes and examples
id remote engine id string Required

Response

200Status 200
OK
Body
application/json
Engine
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Unpair Remote Engine

DELETE /processing/runtimes/remote-engines/{id}/pairing
Unpair Remote Engine

Request

Path variables
Name Description Type Attributes and examples
id remote engine id string Required

Response

200Status 200
OK
Body
text/plain
string
400Status 400
Bad Request
Body
text/plain
ErrorResponse
401Status 401
Unauthorized
Body
text/plain
ErrorResponse
403Status 403
Forbidden
Body
text/plain
ErrorResponse
404Status 404
Not Found
Body
text/plain
ErrorResponse
500Status 500
Internal Server Error
Body
text/plain
ErrorResponse

Get all engine run profiles

GET /processing/runtimes/remote-engines/{engineId}/run-profiles
Get all engine run profiles

Request

Path variables
Name Description Type Attributes and examples
engineId remote engine id string Required

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of RuntimeRunProfile
Datatype details
Type Description Attributes and examples
array
RuntimeRunProfile
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Engine not found
Body
application/json
ErrorResponse

Create engine run profile

POST /processing/runtimes/remote-engines/{engineId}/run-profiles
Create engine run profile

Request

Path variables
Name Description Type Attributes and examples
engineId remote engine id string Required
Body
application/json
RunProfileRequest

Response

201Status 201
Created
Body
application/json
RuntimeRunProfile
400Status 400
Bad run profile definition
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
No engine can be found by provided
Body
application/json
ErrorResponse
500Status 500
Internal server error
Body
application/json
ErrorResponse

Update engine run profile

PUT /processing/runtimes/remote-engines/{engineId}/run-profiles/{runProfileId}
Update engine run profile

Request

Path variables
Name Description Type Attributes and examples
engineId remote engine id string Required
runProfileId run profile id string Required
Body
application/json
RunProfileUpdateRequest

Response

200Status 200
OK
Body
application/json
RuntimeRunProfile
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Run profile not found
Body
application/json
ErrorResponse
500Status 500
Internal server error
Body
application/json
ErrorResponse

Get engine run profile by id

GET /processing/runtimes/remote-engines/{engineId}/run-profiles/{runProfileId}
Get engine run profile by id

Request

Path variables
Name Description Type Attributes and examples
engineId remote engine id string Required
runProfileId run profile id string Required

Response

200Status 200
OK
Body
application/json
RuntimeRunProfile
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Run profile not found
Body
application/json
ErrorResponse

Delete engine run profile

DELETE /processing/runtimes/remote-engines/{engineId}/run-profiles/{runProfileId}
Delete engine run profile

Request

Path variables
Name Description Type Attributes and examples
engineId remote engine id string Required
runProfileId run profile id string Required
Query parameters
Name Description Type Attributes and examples
runProfileId new run profile id string Optional

Response

204Status 204
No Content
403Status 403
Forbidden
Body
*/*
ErrorResponse
404Status 404
No run profile can be found
Body
*/*
ErrorResponse
500Status 500
Internal server error
Body
*/*
ErrorResponse

Engine

Object
Name Description Type Attributes and examples
id Resource id string Required
Example
5cdd2ce2c737973f9d581b98
name Resource name string Required
Example
Remote Engine
description Resource description string Optional
Example
Some description
workspace Workspaceinfo Optional
createDate Date of creation of the resource datetime Required
FormatRFC3339
updateDate Date of updating of the resource datetime Optional
FormatRFC3339
runtimeId Resource runtime id string Required
Example
9e8acf72-00d5-451b-9175-97bd44cd6b13
availability Availability status of engine|cluster string Optional
Enum
  • AVAILABLE
  • NOT_AVAILABLE
  • RETIRED
Example
NOT_AVAILABLE
managed Indicates whether target runtime (engine/cluster) is managed or not boolean Optional
status Engine status string Required
Enum
  • PAIRED
  • NOT_PAIRED
Example
NOT_PAIRED
runProfiles array of string Required
Datatype details
Type Description Attributes and examples
array Run profiles of engine
Example
["MICROSERVICE"]
string
debug EngineDebug Optional
clusterId cluster that this engine is part of string Optional
preAuthorizedKey Preauthorized key (only for not paired engine) string Optional
Example
123A822BF26DF49045C90D94CD269F3850BFB308B2606019CC63EDADE55B4391
esbCompatibilityVersion ESB compatibility version string Optional
Example
7.3.1

EngineDebug

Object
Name Description Type Attributes and examples
host Debug host of engine string Required
Example
192.168.0.1

EngineRequest

Object
Name Description Type Attributes and examples
name Engine name string Required
Example
Remote Engine
environmentId Id of engine environment string Required
Example
5c1111d7a4186a4eafed0587
workspaceId Id of engine workspace string Optional
Example
5c2222d7a4186a4eafed0587
runProfiles array of string Optional
Datatype details
Type Description Attributes and examples
array Run profiles of engine
Example
["MICROSERVICE"]
string
debug EngineDebug Optional
description Engine|cluster description string Optional
Example
Some description
esbCompatibilityVersion Data Service Runner/Talend Runtime version. Mandatory if TALEND_RUNTIME or MICROSERVICE profile selected string Optional
Example
7.2.1

RunProfileRequest

Object
Name Description Type Attributes and examples
name Run profile name string Required
Example
Run profile
description Description string Optional
Example
Run profile with default options
jvmArguments array of string Required
Datatype details
Type Description Attributes and examples
array Jvm arguments
Example
["-Xms128m","-Xmx256m"]
string
type Run profile type string Required
Enum
  • JOB_SERVER
  • MICROSERVICE
  • TALEND_RUNTIME
Example
JOB_SERVER
runtimeId Runtime id string Required
Example
5e713618de3c75a450447262

RunProfileRescheduleOptions

Object
Name Description Type Attributes and examples
method Run profile reschedule method string Optional
Enum
  • DEFAULT
  • DUPLICATE_RUN_PROFILES
  • CLUSTER_RUN_PROFILE
runProfileId Run profile to be used from cluster string Optional

RunProfileUpdateRequest

Object
Name Description Type Attributes and examples
name Run profile name string Required
Example
Run profile
description Description string Optional
Example
Run profile with default options
jvmArguments array of string Required
Datatype details
Type Description Attributes and examples
array Jvm arguments
Example
["-Xms128m","-Xmx256m"]
string

Runtime

Object
Name Description Type Attributes and examples
type Type of runtime string Optional
Enum
  • CLOUD
  • REMOTE_ENGINE
  • REMOTE_ENGINE_CLUSTER
  • CLOUD_EXCLUSIVE
Example
CLOUD
id Runtime id string Optional
Example
5c9a51dc7b353e43c7fc787c
engineId Remote engine id string Optional
Example
5c9a51dc7b353e43c7fc787c
clusterId Remote engine cluster id string Optional
Example
5c9a51dc7b353e43c7fc787c
runProfileId Pipeline engine run profile id string Optional
Example
5c9a51dc7b353e43c7fc783c

RuntimeRunProfile

Object
Name Description Type Attributes and examples
id string Optional
name string Optional
description string Optional
createDate datetime Optional
FormatRFC3339
updateDate datetime Optional
FormatRFC3339
type Run profile type string Optional
Enum
  • JOB_SERVER
  • MICROSERVICE
  • TALEND_RUNTIME
jvmArguments array of string Optional
Datatype details
Type Description Attributes and examples
array Jvm arguments
string
runtimeId string Optional
version Run profile version integer Optional
FormatINT32

Remote Engine Clusters

Get all (available) Remote Engine Clusters

GET /processing/runtimes/remote-engine-clusters
Get all (available) Remote Engine Clusters

Request

Query parameters
Name Description Type Attributes and examples
_s search query (FIQL format), e.g. “workspace.environment.id==5cb47ca4b1b5247f6006529e”,“name==NewCluster” string Optional

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of BaseEngine
Datatype details
Type Description Attributes and examples
array
BaseEngine
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Create Remote Engine Cluster

POST /processing/runtimes/remote-engine-clusters
Create Remote Engine Cluster

Request

Body
application/json
ClusterRequest

Response

201Status 201
Created
Body
application/json
EngineCluster
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Get Remote Engine Cluster by id

GET /processing/runtimes/remote-engine-clusters/{clusterId}
Get Remote Engine Cluster by id

Request

Path variables
Name Description Type Attributes and examples
clusterId remote engine cluster id string Required

Response

200Status 200
OK
Body
application/json
EngineCluster
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Delete Remote Engine Cluster by id

DELETE /processing/runtimes/remote-engine-clusters/{clusterId}
Delete Remote Engine Cluster by id

Request

Path variables
Name Description Type Attributes and examples
clusterId remote engine cluster 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 Remote Engine to Remote Engine Cluster

PUT /processing/runtimes/remote-engine-clusters/{clusterId}/engines/{engineId}
Add Remote Engine to Remote Engine Cluster

Request

Path variables
Name Description Type Attributes and examples
clusterId remote engine cluster id string Required
engineId remote engine 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

Remove Remote Engine from Remote Engine Cluster

DELETE /processing/runtimes/remote-engine-clusters/{clusterId}/engines/{engineId}
Remove Remote Engine from Remote Engine Cluster

Request

Path variables
Name Description Type Attributes and examples
clusterId remote engine cluster id string Required
engineId remote engine id string Required

Response

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

Get cluster run profiles

GET /processing/runtimes/remote-engine-clusters/{clusterId}/run-profiles
Get cluster run profiles

Request

Path variables
Name Description Type Attributes and examples
clusterId cluster id string Required

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of RuntimeRunProfile
Datatype details
Type Description Attributes and examples
array
RuntimeRunProfile
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Cluster not found
Body
application/json
ErrorResponse

Create cluster run profile

POST /processing/runtimes/remote-engine-clusters/{clusterId}/run-profiles
Create cluster run profile

Request

Path variables
Name Description Type Attributes and examples
clusterId cluster id string Required
Body
application/json
RunProfileRequest

Response

400Status 400
Bad run profile definition
Body
application/json
RuntimeRunProfile
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
No cluster can be found by provided
Body
application/json
ErrorResponse
500Status 500
Internal server error
Body
application/json
ErrorResponse

Get cluster run profile

GET /processing/runtimes/remote-engine-clusters/{clusterId}/run-profiles/{runProfileId}
Get cluster run profile

Request

Path variables
Name Description Type Attributes and examples
clusterId cluster id string Required
runProfileId run profile id string Required

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of RuntimeRunProfile
Datatype details
Type Description Attributes and examples
array
RuntimeRunProfile
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Run profle not found
Body
application/json
ErrorResponse

Update cluster run profile

PUT /processing/runtimes/remote-engine-clusters/{clusterId}/run-profiles/{runProfileId}
Update cluster run profile

Request

Path variables
Name Description Type Attributes and examples
clusterId cluster id string Required
runProfileId run profile id string Required
Body
application/json
RunProfileUpdateRequest

Response

200Status 200
OK
Body
application/json
RuntimeRunProfile
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
No run profile can be found
Body
application/json
ErrorResponse
500Status 500
Internal server error
Body
application/json
ErrorResponse

Delete cluster run profile

DELETE /processing/runtimes/remote-engine-clusters/{clusterId}/run-profiles/{runProfileId}
Delete cluster run profile

Request

Path variables
Name Description Type Attributes and examples
clusterId cluster id string Required
runProfileId run profile id string Required
Query parameters
Name Description Type Attributes and examples
runProfileId new run profile id string Optional

Response

204Status 204
No Content
403Status 403
Forbidden
Body
*/*
ErrorResponse
404Status 404
No run profile can be found
Body
*/*
ErrorResponse
500Status 500
Internal server error
Body
*/*
ErrorResponse

ClusterRequest

Object
Name Description Type Attributes and examples
name Cluster name string Required
Example
Some cluster name
workspaceId Workspace identifier string Required
Example
5c935c8ba4186a4eafed0592
environmentId Environment identifier string Required
Example
5c935c8ba4186a4eafed0592
description Cluster description string Required
Example
some description
remoteEngines array of string Required
Datatype details
Type Description Attributes and examples
array List of remote engine ids
Example
["5d3039de65ff7d3583840bc0","5d3039de65ff7d3583840bk1"]
string

EngineCluster

Object
Name Description Type Attributes and examples
id Resource id string Required
Example
5cdd2ce2c737973f9d581b98
name Resource name string Required
Example
Remote Engine
description Resource description string Optional
Example
Some description
workspace Workspaceinfo Optional
createDate Date of creation of the resource datetime Required
FormatRFC3339
updateDate Date of updating of the resource datetime Optional
FormatRFC3339
runtimeId Resource runtime id string Required
Example
9e8acf72-00d5-451b-9175-97bd44cd6b13
availability Availability status of engine|cluster string Optional
Enum
  • AVAILABLE
  • NOT_AVAILABLE
  • RETIRED
Example
NOT_AVAILABLE
managed Indicates whether target runtime (engine/cluster) is managed or not boolean Optional
engines array of string Optional
Datatype details
Type Description Attributes and examples
array Engines in cluster
Example
["5d3039de65ff7d3583840bc0","5d3039de65ff7d3583840bk1"]
string

Remote Engines Gen2

Get Pipeline Engines

GET /processing/runtimes/pipeline-engines
Get Pipeline Engines

Request

Query parameters
Name Description Type Attributes and examples
query search query (FIQL format), e.g. “workspace.environment.id==5cb47ca4b1b5247f6006529e”,“status==PAIRED” string Optional

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of PipelineEngine
Datatype details
Type Description Attributes and examples
array
PipelineEngine
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Create new Pipeline Engine

POST /processing/runtimes/pipeline-engines
Create new Pipeline Engine

Request

Body
application/json
PipelineEngineRequest

Response

201Status 201
Created
Body
application/json
PipelineEngine
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Delete Pipeline Engine by id

DELETE /processing/runtimes/pipeline-engines/{engineId}
Delete Pipeline Engine by id

Request

Path variables
Name Description Type Attributes and examples
engineId pipeline engine 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 Pipeline Engine by id

GET /processing/runtimes/pipeline-engines/{engineId}
Get Pipeline Engine by id

Request

Path variables
Name Description Type Attributes and examples
engineId pipeline engine id string Required

Response

200Status 200
OK
Body
application/json
PipelineEngine
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Unpair Pipeline Engine

DELETE /processing/runtimes/pipeline-engines/{engineId}/pairing
Unpair Pipeline Engine

Request

Path variables
Name Description Type Attributes and examples
engineId pipeline engine id string Required

Response

200Status 200
OK
Body
text/plain
string
400Status 400
Bad Request
Body
text/plain
ErrorResponse
401Status 401
Unauthorized
Body
text/plain
ErrorResponse
403Status 403
Forbidden
Body
text/plain
ErrorResponse
404Status 404
Not Found
Body
text/plain
ErrorResponse
500Status 500
Internal Server Error
Body
text/plain
ErrorResponse

Get run profile for engine

GET /processing/runtimes/pipeline-engines/{engineId}/run-profiles

Request

Path variables
Name Description Type Attributes and examples
engineId run profile id string Required

Response

200Status 200
successful operation
Body
application/json
details
Name Description Type Attributes and examples
array of PipelineRunProfileResponse
Datatype details
Type Description Attributes and examples
array
PipelineRunProfileResponse
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal server error
Body
application/json
ErrorResponse

Create new advanced run profile

POST /processing/runtimes/pipeline-engines/{engineId}/run-profiles/advanced

Request

Path variables
Name Description Type Attributes and examples
engineId engine id string Required
Body
application/json
AdvancedRunProfile

Response

201Status 201
Created
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Get advanced run profile

GET /processing/runtimes/pipeline-engines/{engineId}/run-profiles/advanced/{runProfileId}

Request

Path variables
Name Description Type Attributes and examples
engineId engine id string Required
runProfileId run profile id string Required

Response

200Status 200
OK
Body
application/json
AdvancedRunProfile
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Update advanced run profile

PUT /processing/runtimes/pipeline-engines/{engineId}/run-profiles/advanced/{runProfileId}

Request

Path variables
Name Description Type Attributes and examples
engineId engine id string Required
runProfileId run profile id string Required
Body
application/json
AdvancedRunProfile

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

Create new Big Data run profile

POST /processing/runtimes/pipeline-engines/{engineId}/run-profiles/big-data

Request

Path variables
Name Description Type Attributes and examples
engineId engine id string Required
Body
application/json
BigDataRunProfile

Response

201Status 201
Created
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Get Big Data run profile

GET /processing/runtimes/pipeline-engines/{engineId}/run-profiles/big-data/{runProfileId}

Request

Path variables
Name Description Type Attributes and examples
engineId engine id string Required
runProfileId run profile id string Required

Response

200Status 200
OK
Body
application/json
BigDataRunProfile
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Update Big Data run profile

PUT /processing/runtimes/pipeline-engines/{engineId}/run-profiles/big-data/{runProfileId}

Request

Path variables
Name Description Type Attributes and examples
engineId engine id string Required
runProfileId run profile id string Required
Body
application/json
BigDataRunProfile

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

Create new DataBricks run profile

POST /processing/runtimes/pipeline-engines/{engineId}/run-profiles/databricks

Request

Path variables
Name Description Type Attributes and examples
engineId engine id string Required
Body
application/json
DatabricksRunProfile

Response

201Status 201
Created
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden
Body
application/json
ErrorResponse
404Status 404
Not Found
Body
application/json
ErrorResponse
500Status 500
Internal Server Error
Body
application/json
ErrorResponse

Get DataBricks run profile

GET /processing/runtimes/pipeline-engines/{engineId}/run-profiles/databricks/{runProfileId}

Request

Path variables
Name Description Type Attributes and examples
engineId engine id string Required
runProfileId run profile id string Required

Response

200Status 200
OK