createWorkflow
- Print
- PDF
createWorkflow
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Create a workflow.
POST https://dataflow.apigw.ntruss.com/api/v1/workflows
Request
Request body
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| name | Yes | String | - English letters, starting with an underscore () - English letters, numbers, underscores () and hyphens (-) are allowed - Enter between 3 and 20 characters | Job name |
| nodes[].id | Yes | String | Node ID | |
| nodes[].name | Yes | String | Node name | |
| nodes[].type | Yes | String | TRIGGER, JOB | Node type |
| nodes[].parentNodeIds | Yes | String | Parent node ID | |
| nodes[].triggerRule | No | String | Trigger node option | |
| nodes[].jobCondition | Object | Job execution option |
Response
| Field name | Type | Description | Remarks |
|---|---|---|---|
| workflowId | String | Workflow ID | |
| name | String | Workflow name | |
| nodes[].id | String | Node ID | |
| nodes[].name | String | Node name | |
| nodes[].type | String | Node type | |
| nodes[].parentNodeIds | String | Parent node ID | |
| nodes[].triggerRule | String | Trigger node option | |
| nodes[].jobCondition | Object | Job execution option | |
| nodes[].isValid | Boolean | Deletion status | |
| createdDate | String | Job creation date | |
| updatedDate | String | Last update | |
| isTemp | Boolean | Whether to save drafts |
Response status
| HTTP Status | Desc |
|---|---|
| 201 | Created (Successfully created) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
Examples
Request example
POST /api/v1/workflows
Host: dataflow.apigw.ntruss.com
x-ncp-iam-access-key: {Access key}
x-ncp-apigw-signature-v2: {API GW signature}
x-ncp-apigw-timestamp: {timestamp}
{
"isTemp": false,
"name": "test-workflow2",
"nodes": [
{
"id": "RpiB7okASK5W",
"name": "cdb_pg_test",
"type": "JOB",
"parentNodeIds": [
"vMcf5Gvf2x3R"
],
"jobCondition": {
"workerType": "DEFAULT",
"numWorker": 3,
"timeout": 360,
"nrn": "nrn:PUB:IAM::25****4:Role/****-a9d6-****-a85d-****",
"scriptPath": "dataflow-33-****/scripts/",
"logPath": "dataflow-33-****/sparkHistoryLogs/"
}
},
{
"id": "vMcf5Gvf2x3R",
"name": "awefawef",
"type": "TRIGGER",
"parentNodeIds": [],
"triggerRule": "NONE"
}
]
}
Response example
{
"workflowId": "pJ1HCEI7L9ha",
"name": "test-workflow2",
"nodes": [
{
"id": "RpiB7okASK5W",
"name": "cdb_pg_test",
"type": "JOB",
"parentNodeIds": [
"vMcf5Gvf2x3R"
],
"jobCondition": {
"workerType": "DEFAULT",
"numWorker": 3,
"timeout": 360,
"nrn": "nrn:PUB:IAM::25****4:Role/****-a9d6-****-a85d-****",
"scriptPath": "dataflow-33-****/scripts/",
"logPath": "dataflow-33-****/sparkHistoryLogs/"
}
},
{
"id": "vMcf5Gvf2x3R",
"name": "awefawef",
"type": "TRIGGER",
"parentNodeIds": [],
"triggerRule": "NONE"
}
],
"createdDate": "2024-07-10T14:16:01+09:00",
"updatedDate": "2024-07-10T14:16:01+09:00",
"isTemp": false
}
Was this article helpful?