MENU
      getWorkflows

        getWorkflows


        Article summary

        Get the list of workflows.

        GET https://dataflow.apigw.ntruss.com/api/v1/workflows?page={page}&limit={limit}
        HTTP

        Request

        Request parameter

        Parameter nameRequiredTypeRestrictionsDescription
        pageNoNumberPage
        limitNoNumberMaximum number per page

        Response

        Field nameTypeDescriptionRemarks
        list[].workflowIdStringWorkflow ID
        list[].nameStringWorkflow name
        list[].createdDateStringWorkflow creation date
        list[].updatedDateStringLast update
        list[].lastExecutionDateStringLast execution date
        list[].isTempBooleanWhether to save drafts
        list[].triggerRuleTypeStringTrigger rule type
        list[].nodes[].idStringNode ID
        list[].nodes[].nameStringNode name
        list[].nodes[].typeStringNode type
        list[].nodes[].parentNodeIdsStringParent node ID
        list[].nodes[].triggerRuleStringTrigger node option
        list[].nodes[].jobConditionObjectJob execution option
        list[].nodes[].isValidBooleanDeletion status
        list[].resourceIdStringResource ID (same as the workflow ID)
        list[].disabledStringWhether you have permission to view the resource
        countNumberTotal count
        pageNumberPage
        limitNumberMaximum number per page

        Response status

        HTTP StatusDesc
        200OK (Successfully searched)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Examples

        Request example

        GET /api/v1/workflows?page=0&limit=20
        
        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}
        HTTP

        Response example

        {
          "list": [
            {
              "workflowId": "pJ1HCEI7L9ha",
              "name": "test-workflow2",
              "createdDate": "2024-07-10T14:16:01+09:00",
              "updatedDate": "2024-07-24T15:26:09+09:00",
              "isTemp": false,
              "triggerRuleType": "NONE",
              "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"
                }
              ],
              "resourceId": "pJ1HCEI7L9ha",
              "disabled": false
            },
            {
              "workflowId": "saTBhhA5A6DS",
              "name": "test-workflow",
              "createdDate": "2024-06-12T14:41:45+09:00",
              "updatedDate": "2024-07-01T18:15:35+09:00",
              "isTemp": false,
              "triggerRuleType": "NONE",
              "nodes": [
                {
                  "id": "GOIlT1ccQHtq",
                  "name": "cdb",
                  "type": "JOB",
                  "parentNodeIds": [
                    "vMcf5Gvf2x3R"
                  ],
                  "jobCondition": {
                    "workerType": "DEFAULT",
                    "numWorker": 2,
                    "timeout": 360,
                    "nrn": "nrn:PUB:IAM::25****4:Role/****-b05d-****-bebe-****",
                    "scriptPath": "dataflow-33-****/scripts/",
                    "logPath": "dataflow-33-****/sparkHistoryLogs/"
                  }
                },
                {
                  "id": "vMcf5Gvf2x3R",
                  "name": "awefawef",
                  "type": "TRIGGER",
                  "parentNodeIds": [],
                  "triggerRule": "NONE"
                }
              ],
              "resourceId": "saTBhhA5A6DS",
              "disabled": false
            }
          ],
          "count": 2,
          "page": 0,
          "limit": 1000
        }
        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.