MENU
      updateWorkflow

        updateWorkflow


        Article summary

        Edit a workflow.

        PUT https://dataflow.apigw.ntruss.com/api/v1/workflows/{workflowId}
        HTTP

        Request

        Request parameter

        Parameter nameRequiredTypeRestrictionsDescription
        workflowIdYesStringWorkflow ID

        Request body

        Parameter nameRequiredTypeRestrictionsDescription
        nameYesString- English letters, starting with an underscore ()
        - English letters, numbers, underscores (
        ) and hyphens (-) are allowed
        - Enter between 3 and 20 characters
        Job name
        nodes[].idYesStringNode ID
        nodes[].nameYesStringNode name
        nodes[].typeYesStringTRIGGER, JOBNode type
        nodes[].parentNodeIdsYesStringParent node ID
        nodes[].triggerRuleNoStringTrigger node option
        nodes[].jobConditionObjectJob execution option

        Response

        Field nameTypeDescriptionRemarks
        workflowIdStringWorkflow ID
        nameStringWorkflow name
        nodes[].idStringNode ID
        nodes[].nameStringNode name
        nodes[].typeStringNode type
        nodes[].parentNodeIdsStringParent node ID
        nodes[].triggerRuleStringTrigger node option
        nodes[].jobConditionObjectJob execution option
        nodes[].isValidBooleanDeletion status
        createdDateStringWorkflow creation date
        updatedDateStringLast update
        lastExecutionDateStringLast execution date
        isTempBooleanWhether to save drafts

        Response status

        HTTP StatusDesc
        201Created (Successfully created)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Examples

        Request example

        PUT /api/v1/workflows/{workflowId}
        
        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": "workflow1",
          "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"
            }
          ]
        }
        HTTP

        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-24T15:26:09+09:00",
          "isTemp": false
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.