getWorkflows

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get the list of workflows.

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

Request

Request parameter

Parameter name	Required	Type	Restrictions	Description
page	No	Number		Page
limit	No	Number		Maximum number per page

Response

Field name	Type	Description
list[].workflowId	String	Workflow ID
list[].name	String	Workflow name
list[].createdDate	String	Workflow creation date
list[].updatedDate	String	Last update
list[].lastExecutionDate	String	Last execution date
list[].isTemp	Boolean	Whether to save drafts
list[].triggerRuleType	String	Trigger rule type
list[].nodes[].id	String	Node ID
list[].nodes[].name	String	Node name
list[].nodes[].type	String	Node type
list[].nodes[].parentNodeIds	String	Parent node ID
list[].nodes[].triggerRule	String	Trigger node option
list[].nodes[].jobCondition	Object	Job execution option
list[].nodes[].isValid	Boolean	Deletion status
list[].resourceId	String	Resource ID (same as the workflow ID)
list[].disabled	String	Whether you have permission to view the resource
count	Number	Total count
page	Number	Page
limit	Number	Maximum number per page

Response status

HTTP Status	Desc
200	OK (Successfully searched)
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal 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}

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
}

Was this article helpful?

What's Next

getWorkflowById

Table of contents

Request
Response
Examples