List Workflow Directories¶

获取当前用户所属组织workflow目录下的所有内容，包括子目录和任务流文件。

前提条件¶

用户必须属于待获取目录所属的OU。

请求格式¶

GET https://{apigw-address}/dataflow-batch-service/v2.0/directories?action=listWorkFlowDirs

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
userId	Query	必需	String	用户ID。如何获取userId信息>>
orgId	Query	必需	String	用户所属的组织ID。如何获取orgId信息>>

响应参数¶

名称

数据类型

描述

data

JSONObject

WorkFlowDir结构体的集合，表示该目录下的所有子项，包括子目录和文件：

如果是子目录，详见 WorkFlowDir结构体
如果是文件，详见 WorkFlowFile结构体

WorkFlowDir结构体¶

示例¶

{
  "children": []
  "title":"newdir",
  "type": 1,
  "key": "dirId",
  "isDirectory"：true
}

参数¶

名称	数据类型	描述
children	List<WorkFlowDir>	子目录或文件列表，列表中每个元素仍然是WorkFlowDir或WorkFlowFile结构体类型。
title	String	目录名。
type	Float	标识目录类型，共有五种目录，分别存放不同类型的模型（0：数据集成；1.0：任务流；2.0：数据资源；3.0：Hql；4.0：Common Resource）。
key	String	目录ID。
isDirectory	Boolean	true表示为目录，false表示为文件。

WorkFlowFile结构体¶

示例¶

{
  "editable": true,
  "title":"newdir",
  "type": 1,
  "key": 3381.0,
  "isDirectory"：false
}

参数¶

名称	数据类型	描述
editable	Boolean	是否可编辑。
title	String	文件名。
type	Float	标识文件类型，共有五种类型（0：数据集成；1.0：任务流；2.0：数据资源；3.0：Hql；4.0：Common Resource）
key	Float	任务流 ID（转换为Float类型）。
isDirectory	Boolean	true表示为目录，false表示为文件。

错误码¶

代码	错误信息	描述
62109	Server internal exception	服务器内部异常

有关其他错误码的描述，参见通用错误码。

示例¶

请求示例¶

url: https://{apigw-address}/dataflow-batch-service/v2.0/directories?action=listWorkFlowDirs&userId={}&orgId={}

method: GET

返回示例¶

{
  "status": 0,
  "msg": " Success",
  "data": [
    {
      "children": [
        {
          "children": [],
          "title": "String1",
          "type": 1,
          "key": "yourDirKey",
          "isDirectory": true
        },
        {
          "children": [
            {
              "editable": true,
              "title": "workflow1",
              "type": 1,
              "key": 2512,
              "isDirectory": false
            }
          ],
          "title": "ffdir",
          "type": 1,
          "key": "your dir key",
          "isDirectory": true
        },
        {
          "children": [],
          "title": "dirt",
          "type": 1,
          "key": "your dir key",
          "isDirectory": true
        }
      ],
      "title": "Workflow",
      "type": 1,
      "key": "your dir key",
      "isDirectory": true
    }
  ]
}