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结构体 |
错误码¶
代码 | 错误信息 | 描述 |
---|---|---|
62102 | 可显示为以下错误信息:
|
参数不正确 |
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"
}
}
Java SDK调用示例¶
import com.alibaba.fastjson.JSONObject;
import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envision.apim.poseidon.request.PoseidonRequest;
import org.junit.Test;
import java.util.HashMap;
import java.util.Map;
public class SampleCode{
public static class Request extends PoseidonRequest {
public void setQueryParam(String key, Object value){
queryParams().put(key, value);
}
public void setHeaderParam(String key, String value){
headerParams().put(key, value);
}
public void setBodyParam(Map<String, Object> bodyPara){
bodyParams().putAll(bodyPara);
}
public void setMethod(String method) {
this.method = method;
}
private String method;
public String baseUri() {
return "";
}
public String method() {
return method;
}
}
@Test
public void CreateDirTest(){
//1.在EnOS Console的左边导航栏中点击应用注册。
//2.点击需调用API的应用,查看基本信息中的AccessKey即为accessKey、SecretKey即为secretKey
String accessKey = "AccessKey of your APP";
String secretKey = "SecretKey of your APP";
//新建一个request 然后把需要的参数传进去存在Query的map中,key是参数名字,value是参数值
Request request = new Request();
HashMap<String,Object> hashMap = new HashMap<String, Object>(2);
hashMap.put("dirName","newDirName");
hashMap.put("parentId","parentDirId");
request.setBodyParam(hashMap);
request.setMethod("POST");
try {
JSONObject response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
.url("https://{apigw-address}/batch-processing-service/v2.1/directories")
.queryParam("orgId", "yourOrgId")
.queryParam("userId", "yourUserId")
.queryParam("action", "create")
.getResponse(request, JSONObject.class);
System.out.println(response);
} catch (Exception e) {
e.printStackTrace();
}
}
}