Processing
Configure Engines and Clusters, manage and browse executions of your Tasks, Plans and Promotions.
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.us-west.cloud.talend.com
Endpoint to use for the Azure United States West data center
-
https://api.au.cloud.talend.com
Endpoint to use for the AWS Australia data center
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.
Name | Description |
---|---|
Format | Bearer <token> |
Task Executions
Executabletask
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
executable | Executable identifier | string Required |
57f64991e4b0b689a64feed0 |
parameters | Executable parameters | ObjectOptional | |
logLevel | Execution log level | string Optional |
WARN |
timeout | Execution timeout in minutes. Minimal value is 1. | integer Optional |
INT32 |
JobExecutionStatus
Execution info
Object
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 |
userType | Type of user who triggered or scheduled the execution | string Required |
|
jobId | Job ID | string Required |
57f64991e4b0b689a64feed0 |
jobVersion | The version of the executed job | string Required |
5.2 |
environmentVersion | Execution environment version | string Required |
1.3 |
executionStatus | Execution status | string Required |
|
executionType | Execution type | string Required |
SCHEDULED |
executionDestination | Destination of execution | string Required |
REMOTE_ENGINE |
containerId | Container ID | string Optional | |
runProfileId | Run profile ID | string Optional |
157f818f-a901-4425-b592-0f9282687784 |
remoteEngineId | Remote engine ID | string Optional |
157f818f-a901-4425-b592-0f9282687784 |
remoteEngineClusterId | Remote engine cluster ID | string Optional | |
numberOfProcessedRows | Number of processed rows | integer Optional |
INT64 1234567890 |
numberOfRejectedRows | Number of rejected rows | integer Optional |
INT64 0 |
accountId | Account ID | string Required |
8494b016-b5ef-4b9c-b16d-8b1f824d7616 |
workspaceId | Workspace ID | string Required |
57ce63d3e4b0681c36d1a1c4 |
planId | Plan execution ID | string Optional | |
errorType | Error type if error occurs | string Optional | |
errorMessage | Error message if error occurs | string Optional | |
timeout | Execution timeout if set (in minutes) | integer Optional |
INT32 |
JobExecutionStatusV21
Execution info
Object
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 |
userType | Type of user who triggered or scheduled the execution | string Required |
|
jobId | Job ID | string Required |
57f64991e4b0b689a64feed0 |
jobVersion | The version of the executed job | string Required |
5.2 |
environmentVersion | Execution environment version | string Required |
1.3 |
executionStatus | Execution status | string Required |
|
executionType | Execution type | string Required |
SCHEDULED |
executionDestination | Destination of execution | string Required |
REMOTE_ENGINE |
containerId | Container ID | string Optional | |
runProfileId | Run profile ID | string Optional |
157f818f-a901-4425-b592-0f9282687784 |
remoteEngineId | Remote engine ID | string Optional |
157f818f-a901-4425-b592-0f9282687784 |
remoteEngineClusterId | Remote engine cluster ID | string Optional | |
numberOfProcessedRows | Number of processed rows | integer Optional |
INT64 1234567890 |
numberOfRejectedRows | Number of rejected rows | integer Optional |
INT64 0 |
accountId | Account ID | string Required |
8494b016-b5ef-4b9c-b16d-8b1f824d7616 |
workspaceId | Workspace ID | string Required |
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 |
execution_successful |
Workspaceinfo
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | Workspace identifier | string Required |
57f64991e4b0b689a64feed2 |
name | Workspace name | string Required |
Personal |
description | Workspace description | string Optional |
workspace detail description |
owner | Workspace owner | string Optional |
admin |
type | Workspace type | string Required |
custom |
environment | Environmentinfo Optional |
TaskExecutionsFilters
Object
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | number Optional | ||||||||||
offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | number Optional | ||||||||||
status | filter on status of execution : ‘dispatching’, ‘deploy_failed’, ‘executing’, ‘execution_successful’, ‘execution_rejected’, ‘execution_failed’, ‘terminated’, ‘terminated_timeout | string Optional |
|
|||||||||
from | Time period filter start date time (milliseconds) | number Optional | ||||||||||
to | Time period filter end date time (milliseconds) | number Optional | ||||||||||
lastDays | Number of days in the past | number Optional |
1 |
|||||||||
environmentId | Environment filter | string Optional |
6148511d6ccc6d41563574e5 |
|||||||||
workspaceId | Workspace filter | string Optional |
6148511d6ccc6d41563574e5 |
|||||||||
tags | array of string Optional |
|
TaskExecutionsFilters
{
"limit": 100,
"offset": 10,
"status": "execution_rejected",
"from": 1646159400000,
"to": 1649183400000,
"lastDays": 5,
"environmentId": "57f64991e4b0b689a64feed3",
"workspaceId": "57f64991e4b0b689a64feed2",
"tags": [
"critical",
"supply-asia"
]
}
Get available Tasks Executions
POST /processing/executables/tasks/executionsGet available Tasks Executions. Available filters are :
- limit to a number of days in recent history (1 : yesterday, 5 : past five days)
- DateTime period in the past
- Status of execution
- some specific Environment : alternate filter to Workspace
- some specific Workspace : alternate filter to Environment
- tags associated with tasks : when multiple tags provided, each one of them will be used as filter (ie logical AND applied)
All those parameters are optional and can be combined at your convenience, apart from Environment and Workspace which are exclusive (ie you should not provide both in a same call)
Use cases
Request
Body
application/json
application/json
{
"limit": 100,
"offset": 10,
"status": "executing",
"from": 1646159400000,
"to": 1649183400000,
"lastDays": 20,
"environmentId": "57f64991e4b0b689a64feed3",
"workspaceId": "57f64991e4b0b689a64feed2",
"tags": [
"critical",
"finance-eu"
]
}
Response
Get Tasks Executions
GET /processing/executables/tasks/executionsGet available Tasks Executions
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
workspaceId | workspace ID the tasks should belong to | string Optional | |
limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional |
INT32 |
status | execution status | string Optional |
|
from | from date time (milliseconds) | integer Optional |
INT64 |
lastDays | lastDays | integer Optional |
INT32 |
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) | integer Optional |
INT64 |
environmentId | environment ID the tasks should belong to | string Optional |
Response
Get Task Executions
GET /processing/executables/tasks/{taskId}/executionsGet task executions
Use cases
- Checking scheduled task runs against your maintenance timetable
- Monitoring a specific task without downloading logs
- Getting a task run log for live monitoring
- Fetching run logs periodically for analysis
- Upgrading a single-triggered task to be multi-triggered
- Troubleshooting a hanging task run
- Using component observability metrics to build reports for task runs
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
taskId | task ID | string Required |
Name | Description | Type | Attributes and examples |
---|---|---|---|
limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional |
INT32 |
status | execution status | string Optional |
|
lastDays | lastDays | integer Optional |
INT32 |
from | from date time (milliseconds) | integer Optional |
INT64 |
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) | integer Optional |
INT64 |
Response
Execute Task
POST /processing/executionsExecute Task
Response
405Status 405
Current Task is paused, it can’t be executed
500Status 500
Server error - something went wrong on server side
Body
application/json
501Status 501
Task cannot be deployed because it is not configured
Body
application/json
Get Task execution status
GET /processing/executions/{executionId}Get Task execution status
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
executionId | execution ID | string Required |
Response
500Status 500
Server error - something went wrong on server side
Body
application/json
Terminate Task execution
DELETE /processing/executions/{executionId}Terminate Task execution
Request
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
Plan Executions
PlanExecutable
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
executable | Executable identifier | string Required |
b91cf8b2-5dd1-4b18-915b-4c447cee5267 |
executionPlanId | The plan execution identifier in case of re-execution | string Optional |
0798b8d1-0e12-472f-be02-a0f04e792daa |
stepId | The step identifier to start with | string Optional |
09043c9f-02d0-41f6-b3cb-0ea53ffde377 |
rerunOnlyFailedTasks | Optionally run only failing tasks | boolean Optional |
PlanExecutionStatus
Plan Execution info
Object
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 |
|||||||||
finishTimestamp | End time of job execution (UTC) | datetime Optional |
RFC3339 |
|||||||||
userId | User who triggered or scheduled the execution | string Required |
fupton |
|||||||||
userType | Type of user who triggered or scheduled the execution | string Required |
|
|||||||||
planId | Plan ID | string Required |
b91cf8b2-5dd1-4b18-915b-4c447cee5267 |
|||||||||
executionStatus | Execution (detailed) status | string Required |
FINISHED |
|||||||||
plannedExecutableCount | Number of planned executables | integer Optional |
INT32 2 |
|||||||||
doneExecutableCount | Number of done executables | integer Optional |
INT32 1 |
|||||||||
doneExecutableDetails | array of JobExecutionStatus Optional |
|
StepExecution
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | string Optional | ||
executionId | string Optional | ||
startTimestamp | datetime Optional |
RFC3339 |
|
finishTimestamp | datetime Optional |
RFC3339 |
|
executionStatus | string Optional |
Execute Plan
POST /processing/executions/plansAllows to run a Plan.
This endpoint also allows for re-running some plan execution from some failed step : you should then provide execution id and step from which you wish to restart execution.
Response
405Status 405
Plan is paused, it can’t be executed
422Status 422
Entity exists but cannot be processed, because too old or plan exec didn’t fail
Body
application/json
500Status 500
Server error - something went wrong on server side
Body
application/json
501Status 501
Plan cannot be deployed because it is not configured
Body
application/json
Get available Plans executions
GET /processing/executables/plans/executionsList all plan executions the user is granted visibility on.
For each plan execution returns execution and plan identifiers, start and finish timestamps, execution status and counters on done and planned executables within plan.
This query is paginated and accepts filters as defined in parameters documented above.
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
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 |
INT32 |
status | execution status | string Optional |
|
lastDays | lastDays | integer Optional |
INT32 |
from | from date time (milliseconds) | integer Optional |
INT64 |
offset | the position of the first item. Must be greater than or equal to 0. Default value - 0 | integer Optional |
INT32 |
environmentId | environment ID the plans should belong to | string Optional | |
to | to date time (milliseconds) | integer Optional |
INT64 |
Response
200Status 200
OK
Body
application/json
Status 200
application/json
{
"items": [
{
"executionId": "7fb48c7a-5ea5-4cb9-9333-e345f28d9dd5",
"startTimestamp": "2022-10-20T14:20:28.582Z",
"finishTimestamp": "2022-10-20T14:20:39.830Z",
"planId": "e7734729-cf3d-4578-939c-30381e95cd10",
"executionStatus": "EXECUTION_SUCCESS",
"plannedExecutableCount": 1,
"doneExecutableCount": 1,
"status": "execution_successful"
},
{
"executionId": "dc57c82f-7f18-4228-9f82-a81e02bae617",
"startTimestamp": "2022-10-20T14:17:56.390Z",
"finishTimestamp": "2022-10-20T14:18:07.865Z",
"planId": "e7734729-cf3d-4578-939c-30381e95cd10",
"executionStatus": "EXECUTION_SUCCESS",
"plannedExecutableCount": 1,
"doneExecutableCount": 1,
"status": "execution_successful"
},
{
"executionId": "4555c45f-9548-41e9-98b4-a9bfa2ee4e5c",
"startTimestamp": "2022-10-20T13:47:37.611Z",
"finishTimestamp": "2022-10-20T13:47:48.864Z",
"planId": "e7734729-cf3d-4578-939c-30381e95cd10",
"executionStatus": "EXECUTION_SUCCESS",
"plannedExecutableCount": 1,
"doneExecutableCount": 1,
"status": "execution_successful"
},
{
"executionId": "f3cfb077-2ea6-4557-bbb2-fd027f3cae4e",
"startTimestamp": "2022-10-20T13:45:04.027Z",
"finishTimestamp": "2022-10-20T13:45:15.929Z",
"planId": "e7734729-cf3d-4578-939c-30381e95cd10",
"executionStatus": "EXECUTION_SUCCESS",
"plannedExecutableCount": 1,
"doneExecutableCount": 1,
"status": "execution_successful"
},
{
"executionId": "b668cd50-6421-4e57-b15a-79b39ac153a8",
"startTimestamp": "2022-10-20T13:18:01.235Z",
"finishTimestamp": "2022-10-20T13:18:16.093Z",
"planId": "e7734729-cf3d-4578-939c-30381e95cd10",
"executionStatus": "EXECUTION_FAILED",
"plannedExecutableCount": 1,
"doneExecutableCount": 1,
"status": "execution_failed"
},
{
"executionId": "226dc12c-a288-4fe0-96f6-f6d51fa2b9ff",
"startTimestamp": "2022-10-20T12:08:48.823Z",
"finishTimestamp": "2022-10-20T12:18:52.729Z",
"planId": "e7734729-cf3d-4578-939c-30381e95cd10",
"executionStatus": "EXECUTION_SUCCESS",
"plannedExecutableCount": 1,
"doneExecutableCount": 1,
"status": "execution_successful"
}
],
"limit": 100,
"offset": 0,
"total": 6
}
Get all steps for a plan execution (order by designed execution, only steps, without error handlers)
GET /processing/executions/plans/{planExecutionId}/stepsGet Steps executions status
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
planExecutionId | Plan execution ID | string Required |
Response
200Status 200
Successful response
Body
application/json
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of StepExecution |
|
500Status 500
Server error - something went wrong on server side
Body
application/json
Get Plan executions
GET /processing/executables/plans/{planId}/executionsGet Plan executions
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
planId | plan ID | string Required |
Name | Description | Type | Attributes and examples |
---|---|---|---|
limit | the number of items to return. Must be in range [1, 100]. Default value - 100 | integer Optional |
INT32 |
status | execution status | string Optional |
|
lastDays | lastDays | integer Optional |
INT32 |
from | from date time (milliseconds) | integer Optional |
INT64 |
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) | integer Optional |
INT64 |
Response
Get Plan Execution status
GET /processing/executions/plans/{id}Get detailed status of one plan execution
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | Execution id | string Required |
Response
Get the step for plan execution without error handlers
GET /processing/executions/plans/{planExecutionId}/steps/{stepExecutionId}Get Step execution status
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
planExecutionId | Plan execution ID | string Required | |
stepExecutionId | Step execution ID | string Required |
Response
500Status 500
Server error - something went wrong on server side
Body
application/json
Get execution status of the handler for the specified step
GET /processing/executions/plans/{planExecutionId}/steps/{stepExecutionId}/error-handlerGet Step handler execution status
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
planExecutionId | Plan execution ID | string Required | |
stepExecutionId | Step execution ID | string Required |
Response
500Status 500
Server error - something went wrong on server side
Body
application/json
Promotion Executions
AdvancedPromotionSpec
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
artifactId | Advanced Promotion Artifact Id | string Optional |
57f64991e4b0b689a64feed0 |
artifactType | Advanced Promotion Artifact Type. In the following list of allowed values, ‘ACTION’ refers to Artifacts, ‘FLOW’ refers to Tasks, ‘PLAN’ refers to Plans and ‘WORKSPACE’ refers to Workspaces | string Optional |
WORKSPACE |
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 |
WORKSPACE |
|||||||||
analyzeReport | Report Optional | |||||||||||
promotionReport | Report Optional | |||||||||||
usedBy | array of 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 1 |
Execution
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
executionId | string Optional | ||
executionReport | PromotionExecutionStatusV26 Optional |
PromotionExecutableTaskV26
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
executable | Executable identifier | string Required |
57f64991e4b0b689a64feed0 |
keepTargetResources | Keep Target Resources flag | boolean Optional | |
keepTargetRunProfiles | Keep Target Run Profiles flag (works starting from V2.2) | boolean Optional | |
advanced | AdvancedPromotionSpec Optional | ||
context | Execution context message | string Optional |
255
Free text describing the context for promotion execution |
PromotionExecutionStatus
Object
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 |
PROMOTED |
|||||||||
statusMessage | Execution status message | string Optional | ||||||||||
workspaces | array of WorkspacePromotionResult Optional |
|
||||||||||
engines | array of RuntimePromotionResult Optional |
|
||||||||||
clusters | array of RuntimePromotionResult Optional |
|
PromotionExecutionStatusV26
Object
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 |
PROMOTED |
|||||||||
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 |
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 |
WORKSPACE |
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
Object
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
status | string Optional |
|
||||||||||
messages | array of Message Optional |
|
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 |
WORKSPACE |
|||||||||
analyzeReport | Report Optional | |||||||||||
promotionReport | Report Optional | |||||||||||
usedBy | array of PromotionResultInfo Optional |
|
||||||||||
runProfiles | array of ArtifactPromotionResult 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 |
WORKSPACE |
|||||||||
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 |
|
Execute a Promotion
POST /processing/executions/promotionsExecute a Promotion
Response
202Status 202
Execution started
501Status 501
Promotions can’t be executed because it has errors
Body
application/json
Get Promotion execution status
GET /processing/executions/promotions/{executionId}Get Promotion execution status
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
executionId | Execution ID | string Required |
Response
Remote Engines
Engine
Object
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Resource id | string Required |
5cdd2ce2c737973f9d581b98 |
|||||||||
name | Resource name | string Required |
Remote Engine |
|||||||||
description | Resource description | string Optional |
Some description |
|||||||||
workspace | Workspaceinfo Optional | |||||||||||
createDate | Date of creation of the resource | datetime Required |
RFC3339 |
|||||||||
updateDate | Date of updating of the resource | datetime Optional |
RFC3339 |
|||||||||
runtimeId | Resource runtime id | string Required |
9e8acf72-00d5-451b-9175-97bd44cd6b13 |
|||||||||
availability | Availability status of engine|cluster | string Optional |
NOT_AVAILABLE |
|||||||||
managed | Indicates whether target runtime (engine/cluster) is managed or not | boolean Optional | ||||||||||
status | Engine status | string Required |
NOT_PAIRED |
|||||||||
runProfiles | array of string Required |
|
||||||||||
debug | EngineDebug Optional | |||||||||||
clusterId | cluster that this engine is part of | string Optional | ||||||||||
preAuthorizedKey | Preauthorized key (only for not paired engine) | string Optional |
123A822BF26DF49045C90D94CD269F3850BFB308B2606019CC63EDADE55B4391 |
|||||||||
esbCompatibilityVersion | ESB compatibility version | string Optional |
7.3.1 |
EngineDebug
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
host | Debug host of engine | string Required |
192.168.0.1 |
EngineRequest
Object
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
name | Engine name | string Required |
Remote Engine |
|||||||||
environmentId | Id of engine environment | string Required |
5c1111d7a4186a4eafed0587 |
|||||||||
workspaceId | Id of engine workspace | string Optional |
5c2222d7a4186a4eafed0587 |
|||||||||
runProfiles | array of string Optional |
|
||||||||||
debug | EngineDebug Optional | |||||||||||
description | Engine|cluster description | string Optional |
Some description |
|||||||||
esbCompatibilityVersion | Data Service Runner/Talend Runtime version. Mandatory if TALEND_RUNTIME or MICROSERVICE profile selected | string Optional |
7.2.1 |
RunProfileRequest
Object
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
name | Run profile name | string Required |
Run profile |
|||||||||
description | Description | string Optional |
Run profile with default options |
|||||||||
jvmArguments | array of string Required |
|
||||||||||
type | Run profile type | string Required |
JOB_SERVER |
|||||||||
runtimeId | Runtime id | string Required |
5e713618de3c75a450447262 |
RunProfileUpdateRequest
Object
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
name | Run profile name | string Required |
Run profile |
|||||||||
description | Description | string Optional |
Run profile with default options |
|||||||||
jvmArguments | array of string Required |
|
RuntimeRunProfile
Object
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string Optional | |||||||||||
name | string Optional | |||||||||||
description | string Optional | |||||||||||
createDate | datetime Optional |
RFC3339 |
||||||||||
updateDate | datetime Optional |
RFC3339 |
||||||||||
type | Run profile type | string Optional |
|
|||||||||
jvmArguments | array of string Optional |
|
||||||||||
runtimeId | string Optional | |||||||||||
version | Run profile version | integer Optional |
INT32 |
Create new Remote Engine
POST /processing/runtimes/remote-enginesCreate new Remote Engine
Response
Get all (available) Remote Engines
GET /processing/runtimes/remote-enginesGet all (available) Remote Engines
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
query | search query (FIQL format) | string Optional |
workspace.environment.id==5cb47ca4b1b5247f6006529e |
Response
200Status 200
OK
Body
application/json
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of Engine |
|
Delete Remote Engine by id
DELETE /processing/runtimes/remote-engines/{id}Delete Remote Engine by id
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | remote engine id | string Required |
Response
204Status 204
No Content
Get Remote Engine by id
GET /processing/runtimes/remote-engines/{id}Get Remote Engine by id
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | remote engine id | string Required |
Response
Unpair Remote Engine
DELETE /processing/runtimes/remote-engines/{id}/pairingUnpair Remote Engine
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | remote engine id | string Required |
Response
200Status 200
OK
Body
text/plain
string
Create engine run profile
POST /processing/runtimes/remote-engines/{engineId}/run-profilesCreate engine run profile
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | remote engine id | string Required |
Body
application/json
Response
Get all engine run profiles
GET /processing/runtimes/remote-engines/{engineId}/run-profilesGet all engine run profiles
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | remote engine id | string Required |
Response
200Status 200
OK
Body
application/json
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of RuntimeRunProfile |
|
Get engine run profile by id
GET /processing/runtimes/remote-engines/{engineId}/run-profiles/{runProfileId}Get engine run profile by id
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | remote engine id | string Required | |
runProfileId | run profile id | string Required |
Response
Update engine run profile
PUT /processing/runtimes/remote-engines/{engineId}/run-profiles/{runProfileId}Update engine run profile
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | remote engine id | string Required | |
runProfileId | run profile id | string Required |
Body
application/json
Response
Delete engine run profile
DELETE /processing/runtimes/remote-engines/{engineId}/run-profiles/{runProfileId}Delete engine run profile
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | remote engine id | string Required | |
runProfileId | run profile id | string Required |
Name | Description | Type | Attributes and examples |
---|---|---|---|
runProfileId | new run profile id | string Optional |
Response
204Status 204
No Content
Remote Engine Clusters
ClusterRequest
Object
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
name | Cluster name | string Required |
Some cluster name |
|||||||||
workspaceId | Workspace identifier | string Required |
5c935c8ba4186a4eafed0592 |
|||||||||
environmentId | Environment identifier | string Required |
5c935c8ba4186a4eafed0592 |
|||||||||
description | Cluster description | string Required |
some description |
|||||||||
remoteEngines | array of string Required |
|
EngineCluster
Object
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Resource id | string Required |
5cdd2ce2c737973f9d581b98 |
|||||||||
name | Resource name | string Required |
Remote Engine |
|||||||||
description | Resource description | string Optional |
Some description |
|||||||||
workspace | Workspaceinfo Optional | |||||||||||
createDate | Date of creation of the resource | datetime Required |
RFC3339 |
|||||||||
updateDate | Date of updating of the resource | datetime Optional |
RFC3339 |
|||||||||
runtimeId | Resource runtime id | string Required |
9e8acf72-00d5-451b-9175-97bd44cd6b13 |
|||||||||
availability | Availability status of engine|cluster | string Optional |
NOT_AVAILABLE |
|||||||||
managed | Indicates whether target runtime (engine/cluster) is managed or not | boolean Optional | ||||||||||
engines | array of string Optional |
|
Create Remote Engine Cluster
POST /processing/runtimes/remote-engine-clustersCreate Remote Engine Cluster
Response
Get all (available) Remote Engine Clusters
GET /processing/runtimes/remote-engine-clustersGet all (available) Remote Engine Clusters
Request
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
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of BaseEngine |
|
Get Remote Engine Cluster by id
GET /processing/runtimes/remote-engine-clusters/{clusterId}Get Remote Engine Cluster by id
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
clusterId | remote engine cluster id | string Required |
Response
Delete Remote Engine Cluster by id
DELETE /processing/runtimes/remote-engine-clusters/{clusterId}Delete Remote Engine Cluster by id
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
clusterId | remote engine cluster id | string Required |
Response
204Status 204
No Content
Add Remote Engine to Remote Engine Cluster
PUT /processing/runtimes/remote-engine-clusters/{clusterId}/engines/{engineId}Add Remote Engine to Remote Engine Cluster
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
clusterId | remote engine cluster id | string Required | |
engineId | remote engine id | string Required |
Response
204Status 204
No Content
Remove Remote Engine from Remote Engine Cluster
DELETE /processing/runtimes/remote-engine-clusters/{clusterId}/engines/{engineId}Remove Remote Engine from Remote Engine Cluster
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
clusterId | remote engine cluster id | string Required | |
engineId | remote engine id | string Required |
Response
204Status 204
No Content
Get cluster run profiles
GET /processing/runtimes/remote-engine-clusters/{clusterId}/run-profilesGet cluster run profiles
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
clusterId | cluster id | string Required |
Response
200Status 200
OK
Body
application/json
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of RuntimeRunProfile |
|
Create cluster run profile
POST /processing/runtimes/remote-engine-clusters/{clusterId}/run-profilesCreate cluster run profile
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
clusterId | cluster id | string Required |
Body
application/json
Response
Update cluster run profile
PUT /processing/runtimes/remote-engine-clusters/{clusterId}/run-profiles/{runProfileId}Update cluster run profile
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
clusterId | cluster id | string Required | |
runProfileId | run profile id | string Required |
Body
application/json
Response
Delete cluster run profile
DELETE /processing/runtimes/remote-engine-clusters/{clusterId}/run-profiles/{runProfileId}Delete cluster run profile
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
clusterId | cluster id | string Required | |
runProfileId | run profile id | string Required |
Name | Description | Type | Attributes and examples |
---|---|---|---|
runProfileId | new run profile id | string Optional |
Response
204Status 204
No Content
Get cluster run profile
GET /processing/runtimes/remote-engine-clusters/{clusterId}/run-profiles/{runProfileId}Get cluster run profile
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
clusterId | cluster id | string Required | |
runProfileId | run profile id | string Required |
Response
200Status 200
OK
Body
application/json
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of RuntimeRunProfile |
|
Remote Engine Gen2
AdvancedRunProfile
Pipeline run profile of type ‘Advanced’
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Name | string Required |
Default run profile |
description | Description | string Optional |
Run profile used by default |
engineId | Pipeline engine id | string Optional |
5f7eff3245ecf259a1c56daa |
definition | Json with definition | string Optional |
{"id": 1} |
BigDataRunProfile
Pipeline run profile of type ‘Big Data’
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Name | string Required |
Default run profile |
description | Description | string Optional |
Run profile used by default |
engineId | Pipeline engine id | string Optional |
5f7eff3245ecf259a1c56daa |
distribution | Distribution | string Optional |
EMR 5.x (Hadoop 2.7) |
executionFramework | Execution framework | string Optional |
Spark on Yarn |
microBatchInterval | Micro-batch interval (in ms) | integer Required |
INT32 1000 |
streamingTimeout | Streaming timeout (in ms) | integer Required |
INT32 10 |
yarnQueue | Yarn queue | string Optional |
q1 |
driverCores | Driver cores | integer Optional |
INT32 1 |
driverMemory | Driver cores (in MB) | integer Optional |
INT32 512 |
temporaryStorage | Temporary storage | string Required |
/tmp-storage |
yarnStrategy | YarnStrategy Required | ||
executorMemoryOverhead | Execution memory overhead (MB) | integer Required |
INT32 384 |
isCheckpointingEnabled | Checkpointing | boolean Optional | |
checkPointFilePath | Checkpoint file path. Required if checkpointing enabled | string Optional |
/file-path |
parameters | Parameters | ObjectOptional | |
id | Run profile id | string Optional |
57f64991e4b0b689a64feed0 |
type | Type | string Optional |
|
createDate | Created on | datetime Optional |
RFC3339 |
updateDate | Updated on | datetime Optional |
RFC3339 |
Databrick
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
endpoint | Endpoint | string Required |
https://endpoint |
token | Token (can also be provided in the Remote Engine configuration) | string Optional |
1 |
stagingLocation | DBFS library staging directory | string Required |
dbfs:/staging/ |
target | DatabricksCluster Required | ||
cloudProvider | Cloud provider | string Required |
AWS |
DatabricksCluster
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
cluster | New or existing cluster | string Required |
new |
id | ID of existing cluster. Required for ‘old’ cluster | string Optional |
132553 |
sparkVersion | Databricks runtime version. Required for ‘new’ cluster | string Optional |
5.5.x-scala2.11 |
nodeTypeId | Node type ID. Required for ‘new’ cluster | string Required |
m4.large |
logsDestination | Logs destination. Required for ‘new’ cluster | string Required |
dbfs:/cluster-logs |
workersNumber | Number of workers. Required for ‘new’ cluster | integer Required |
INT32 2 |
DatabricksRunProfile
Pipeline run profile of type ‘Databricks’
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Name | string Required |
Default run profile |
description | Description | string Optional |
Run profile used by default |
engineId | Pipeline engine id | string Optional |
5f7eff3245ecf259a1c56daa |
microBatchInterval | Micro-batch interval (in ms) | integer Required |
INT32 1000 |
databricks | Databrick Optional | ||
parameters | Parameters | ObjectOptional | |
id | Run profile id | string Optional |
57f64991e4b0b689a64feed0 |
type | Type | string Optional |
|
createDate | Created on | datetime Optional |
RFC3339 |
updateDate | Updated on | datetime Optional |
RFC3339 |
DataIntegrationRunProfile
Object
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
name | string Required | |||||||||||
description | string Optional | |||||||||||
jvmArguments | array of string Optional |
|
DataIntegrationRunProfileResponse
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | string Optional |
"62444fbce9f05d51f8da4031" |
|
name | string Required |
"Default run profile" |
|
description | string Optional |
"run profile description" |
|
engineId | string Optional |
"6246ea2275ca6f0e05bc4a87" |
|
runtimeId | string Optional |
"f4422f10-4152-4a3f-adae-3b97ba3ba918" |
|
jvmArguments | string Optional |
["-XX:MaxHeapFreeRatio=70", "-XX:PermSize=128m"] |
|
type | string Optional |
|
|
createDate | date Optional | ||
updateDate | string Optional |
PipelineEngine
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
id | Resource id | string Required |
5cdd2ce2c737973f9d581b98 |
name | Resource name | string Required |
Remote Engine |
description | Resource description | string Optional |
Some description |
workspace | Workspaceinfo Optional | ||
createDate | Date of creation of the resource | datetime Required |
RFC3339 |
updateDate | Date of updating of the resource | datetime Optional |
RFC3339 |
runtimeId | Resource runtime id | string Required |
9e8acf72-00d5-451b-9175-97bd44cd6b13 |
availability | Availability status of engine|cluster | string Optional |
NOT_AVAILABLE |
managed | Indicates whether target runtime (engine/cluster) is managed or not | boolean Optional | |
status | string Optional |
|
|
preAuthorizedKey | string Optional | ||
cloudRunner | boolean Optional |
PipelineEngineRequest
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Engine name | string Required |
Remote Engine |
environmentId | Id of engine environment | string Required |
5c1111d7a4186a4eafed0587 |
workspaceId | Id of engine workspace | string Optional |
5c2222d7a4186a4eafed0587 |
description | Engine|cluster description | string Optional |
Some description |
PipelineRunProfileResponse
Pipeline run profile response object.
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Name | string Required |
Default run profile |
description | Description | string Optional |
Run profile used by default |
engineId | Pipeline engine id | string Optional |
5f7eff3245ecf259a1c56daa |
id | Run profile id | string Optional |
57f64991e4b0b689a64feed0 |
type | Type | string Optional |
|
createDate | Created on | datetime Optional |
RFC3339 |
updateDate | Updated on | datetime Optional |
RFC3339 |
StandardRunProfile
Pipeline run profile of type ‘Standard’
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Name | string Required |
Default run profile |
description | Description | string Optional |
Run profile used by default |
engineId | Pipeline engine id | string Optional |
5f7eff3245ecf259a1c56daa |
configuration | Configuration Required | ||
executionFramework | Execution framework | string Required |
Spark local |
StandardRunProfileResponse
Pipeline run profile of type ‘Standard’
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
name | Name | string Required |
Default run profile |
description | Description | string Optional |
Run profile used by default |
engineId | Pipeline engine id | string Optional |
5f7eff3245ecf259a1c56daa |
configuration | Configuration Required | ||
executionFramework | Execution framework | string Required |
Spark local |
id | Run profile id | string Optional |
57f64991e4b0b689a64feed0 |
type | Type | string Optional |
|
createDate | Created on | datetime Optional |
RFC3339 |
updateDate | Updated on | datetime Optional |
RFC3339 |
YarnStrategy
Object
Name | Description | Type | Attributes and examples |
---|---|---|---|
type | Yarn strategy type | string Required |
|
initialExecutors | Initial number of executors (for Dynamic strategy) | integer Optional |
INT32 |
minExecutors | Min. number of executors (for Dynamic strategy) | integer Optional |
INT32 |
maxExecutors | Max. number of executors (for Dynamic strategy) | integer Optional |
INT32 |
coresPerExecutor | Cores per executor | integer Optional |
INT32 |
executorMemory | Executor memory (in MB) | integer Optional |
INT32 |
executorsNumber | Number of executors (for Fixed strategy) | integer Optional |
INT32 |
Create new Pipeline Engine
POST /processing/runtimes/pipeline-enginesCreate new Pipeline Engine
Response
Get Pipeline Engines
GET /processing/runtimes/pipeline-enginesGet Pipeline Engines
Request
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
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of PipelineEngine |
|
Delete Pipeline Engine by id
DELETE /processing/runtimes/pipeline-engines/{engineId}Delete Pipeline Engine by id
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | pipeline engine id | string Required |
Response
204Status 204
No Content
Get Pipeline Engine by id
GET /processing/runtimes/pipeline-engines/{engineId}Get Pipeline Engine by id
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | pipeline engine id | string Required |
Response
Unpair Pipeline Engine
DELETE /processing/runtimes/pipeline-engines/{engineId}/pairingUnpair Pipeline Engine
Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | pipeline engine id | string Required |
Response
200Status 200
OK
Body
text/plain
string
Get run profile for engine
GET /processing/runtimes/pipeline-engines/{engineId}/run-profilesRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | run profile id | string Required |
Response
200Status 200
successful operation
Body
application/json
Name | Description | Type | Attributes and examples | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
array of PipelineRunProfileResponse |
|
Create new advanced run profile
POST /processing/runtimes/pipeline-engines/{engineId}/run-profiles/advancedRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | engine id | string Required |
Body
application/json
Response
201Status 201
Created
Update advanced run profile
PUT /processing/runtimes/pipeline-engines/{engineId}/run-profiles/advanced/{runProfileId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | engine id | string Required | |
runProfileId | run profile id | string Required |
Body
application/json
Response
204Status 204
No Content
Get advanced run profile
GET /processing/runtimes/pipeline-engines/{engineId}/run-profiles/advanced/{runProfileId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | engine id | string Required | |
runProfileId | run profile id | string Required |
Response
Create new Big Data run profile
POST /processing/runtimes/pipeline-engines/{engineId}/run-profiles/big-dataRequest
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | engine id | string Required |
Body
application/json
Response
201Status 201
Created
Update Big Data run profile
PUT /processing/runtimes/pipeline-engines/{engineId}/run-profiles/big-data/{runProfileId}Request
Name | Description | Type | Attributes and examples |
---|---|---|---|
engineId | engine id | string Required | |
runProfileId | run profile id | string Required |
Body
application/json
Response
204Status 204
No Content