MENU
      createWorkflow

        createWorkflow


        記事の要約

        ワークフローを作成します。

        POST https://dataflow.apigw.ntruss.com/api/v1/workflows
        HTTP

        リクエスト

        リクエストボディ

        パラメータ名必須の有無タイプ制限事項説明
        nameYesString- 先頭文字は英字まはたアンダースコア「
        - 英数字、アンダースコア「
        」、ハイフン「-」を使用可能
        - 3~20文字以内で入力
        ジョブ名
        nodes[].idYesStringノード ID
        nodes[].nameYesStringノード名
        nodes[].typeYesStringTRIGGER, JOBノードタイプ
        nodes[].parentNodeIdsYesString上位ノード ID
        nodes[].triggerRuleNoStringトリガーノードオプション
        nodes[].jobConditionObjectジョブ実行オプション

        レスポンス

        フィールド名タイプ説明備考
        workflowIdStringワークフロー ID
        nameStringワークフロー名
        nodes[].idStringノード ID
        nodes[].nameStringノード名
        nodes[].typeStringノードタイプ
        nodes[].parentNodeIdsString上位ノード ID
        nodes[].triggerRuleStringトリガーノードオプション
        nodes[].jobConditionObjectジョブ実行オプション
        nodes[].isValidBoolean削除の有無
        createdDateStringジョブ作成日
        updatedDateString最終アップデート
        isTempBoolean下書き保存するかどうか

        レスポンスステータス

        HTTP StatusDesc
        201Created(作成完了)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        リクエスト例

        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"
            }
          ]
        }
        HTTP

        レスポンス例

        {
          "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
        }
        JSON

        この記事は役に立ちましたか?

        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.