Create Directory¶

创建目录

前提条件¶

用户必须是待创建目录的父目录所属OU的用户。

请求格式¶

POST https://{apigw-address}/batch-processing-service/v2.1/directories

请求参数（URI）¶

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

请求参数（Body）¶

名称	必需/可选	数据类型	描述
parentId	必需	String	父目录的ID（ID可通过 List Workflow Directories 接口获取）。
dirName	必需	String	待创建目录的目录名称。

响应参数¶

名称	数据类型	描述
data	JSONObject	包含新创建的目录ID信息。详见 DirectoryId结构体

DirectoryId结构体¶

示例¶

{
  "dirId": "newDirId"
}

参数¶

名称	数据类型	描述
dirId	String	已创建目录的ID。

错误码¶

代码

错误信息

描述

62102

可显示为以下错误信息：

param: dirName cannot be empty
param: parentId cannot be empty
parentId not found
A directory of the same name already exists.

参数不正确

62109

Server internal exception

服务器内部异常

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

示例¶

请求示例¶

url: https://{apigw-address}/batch-processing-service/v2.1/directories?action=create&userId={}&orgId={}

method: POST

requestBody:
{
  "dirName": "directory_name",
  "parentId": "parent_directory_id"
}

返回示例¶

{
  "status": 0,
  "msg": " Success",
  "data": {
    "dirId": "newDirId"
  }
}