集团业务
证书的警告
注意:系统管理员或客户端管理员帐户权限需要执行组操作。系统管理员对组有完全的控制,客户端管理员只能管理客户端的组
得到
/ AppSpiderEnterprise / rest / v1 /组/ GetGroups
描述
检索组列表。
参数
没有参数
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200 |
成功 |
响应包含组列表 |
反应的例子:
JSON模式:
1
{
2
“类型”:“对象”,
3.
“属性”:{
4
“组织”:{
5
“类型”:“数组”,
6
“项目”:[
7
{
8
“类型”:“对象”,
9
“属性”:{
10
“GroupId”:{
11
“类型”:“字符串”
12
},
13
“GroupName”:{
14
“类型”:“字符串”
15
}
16
},
17
“要求”:[
18
“GroupId”,
19
“GroupName”
20.
]
21
}
22
]
23
},
24
“IsSuccess”:{
25
“类型”:“布尔”
26
},
27
“原因”:{
28
“类型”:“零”
29
},
30.
“ErrorMessage”:{
31
“类型”:“零”
32
},
33
“链接”:{
34
“类型”:“数组”,
35
“项目”:[
36
{
37
“类型”:“对象”,
38
“属性”:{
39
“Rel”:{
40
“类型”:“字符串”
41
},
42
“Href”:{
43
“类型”:“字符串”
44
}
45
},
46
“要求”:[
47
“Rel”,
48
“Href”
49
]
50
}
51
]
52
}
53
},
54
“要求”:[
55
“组织”,
56
“IsSuccess”,
57
“原因”,
58
“ErrorMessage”,
59
“链接”
60
]
61
}
得到
/ AppSpiderEnterprise / rest / v1 /组/ GetGroup吗?groupName = <插入groupName > < /插入>
描述
按名称检索组
参数
的名字 |
类型 |
要求 |
描述 |
|---|---|---|---|
groupName |
字符串 |
Y |
组名称 |
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200 |
成功 |
响应包含组信息 |
400 |
未提供所需参数 |
|
400 |
NotFound |
没有发现集团 |
反应的例子:
JSON模式:
1
{
2
“美元模式”:“http://json-schema.org/draft-04/schema”,
3.
“类型”:“对象”,
4
“属性”:{
5
“AccountGroupDetailedInfo”:{
6
“类型”:“对象”,
7
“属性”:{
8
“账户”:{
9
“类型”:“数组”,
10
“项目”:{}
11
},
12
“角色”:{
13
“类型”:“数组”,
14
“项目”:[
15
{
16
“类型”:“对象”,
17
“属性”:{
18
“RoleId”:{
19
“类型”:“字符串”
20.
},
21
“RoleName”:{
22
“类型”:“字符串”
23
}
24
},
25
“要求”:[
26
“RoleId”,
27
“RoleName”
28
]
29
}
30.
]
31
},
32
“GroupName”:{
33
“类型”:“字符串”
34
},
35
“ClientId”:{
36
“类型”:“字符串”
37
},
38
“列出”:{
39
“类型”:“零”
40
},
41
“GroupId”:{
42
“类型”:“字符串”
43
}
44
},
45
“要求”:[
46
“账户”,
47
“角色”,
48
“GroupName”,
49
“ClientId”,
50
“列出”,
51
“GroupId”
52
]
53
},
54
“IsSuccess”:{
55
“类型”:“布尔”
56
},
57
“原因”:{
58
“类型”:“零”
59
},
60
“ErrorMessage”:{
61
“类型”:“零”
62
},
63
“链接”:{
64
“类型”:“数组”,
65
“项目”:[
66
{
67
“类型”:“对象”,
68
“属性”:{
69
“Rel”:{
70
“类型”:“字符串”
71
},
72
“Href”:{
73
“类型”:“字符串”
74
}
75
},
76
“要求”:[
77
“Rel”,
78
“Href”
79
]
80
}
81
]
82
}
83
},
84
“要求”:[
85
“AccountGroupDetailedInfo”,
86
“IsSuccess”,
87
“原因”,
88
“ErrorMessage”,
89
“链接”
90
]
91
}
得到
/ AppSpiderEnterprise / rest / v1 /组/ GetGroup吗?GroupId = <插入GroupId > < /插入>
描述
根据id检索组。
参数
的名字 |
类型 |
要求 |
描述 |
|---|---|---|---|
groupId |
guid |
Y |
组Id |
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200 |
成功 |
响应包含组信息 |
400 |
未提供所需参数 |
|
400 |
NotFound |
没有发现集团 |
反应的例子:
JSON模式:
1
{
2
“美元模式”:“http://json-schema.org/draft-04/schema”,
3.
“类型”:“对象”,
4
“属性”:{
5
“AccountGroupDetailedInfo”:{
6
“类型”:“对象”,
7
“属性”:{
8
“账户”:{
9
“类型”:“数组”,
10
“项目”:{}
11
},
12
“角色”:{
13
“类型”:“数组”,
14
“项目”:[
15
{
16
“类型”:“对象”,
17
“属性”:{
18
“RoleId”:{
19
“类型”:“字符串”
20.
},
21
“RoleName”:{
22
“类型”:“字符串”
23
}
24
},
25
“要求”:[
26
“RoleId”,
27
“RoleName”
28
]
29
}
30.
]
31
},
32
“GroupName”:{
33
“类型”:“字符串”
34
},
35
“ClientId”:{
36
“类型”:“字符串”
37
},
38
“列出”:{
39
“类型”:“零”
40
},
41
“GroupId”:{
42
“类型”:“字符串”
43
}
44
},
45
“要求”:[
46
“账户”,
47
“角色”,
48
“GroupName”,
49
“ClientId”,
50
“列出”,
51
“GroupId”
52
]
53
},
54
“IsSuccess”:{
55
“类型”:“布尔”
56
},
57
“原因”:{
58
“类型”:“零”
59
},
60
“ErrorMessage”:{
61
“类型”:“零”
62
},
63
“链接”:{
64
“类型”:“数组”,
65
“项目”:[
66
{
67
“类型”:“对象”,
68
“属性”:{
69
“Rel”:{
70
“类型”:“字符串”
71
},
72
“Href”:{
73
“类型”:“字符串”
74
}
75
},
76
“要求”:[
77
“Rel”,
78
“Href”
79
]
80
}
81
]
82
}
83
},
84
“要求”:[
85
“AccountGroupDetailedInfo”,
86
“IsSuccess”,
87
“原因”,
88
“ErrorMessage”,
89
“链接”
90
]
91
}
帖子
/ AppSpiderEnterprise / rest / v1 /组/ AddGroup
描述
添加一个新组。
参数
的名字 |
类型 |
要求 |
描述 |
|---|---|---|---|
GroupName |
字符串 |
Y |
组名称 |
ClientId |
guid |
Y |
客户机Id |
账户 |
数组 |
N |
要添加到组的帐户 |
用户标识 |
字符串 |
N |
用户Id(账户) |
用户名 |
字符串 |
N |
用户名(账户) |
ClientId |
guid |
N |
内部用户的客户(账户) |
角色 |
数组 |
Y |
要添加到组的角色 |
RoleId |
guid |
Y |
角色Id(角色) |
RoleName |
字符串 |
Y |
角色名称(角色) |
请求示例:
JSON模式:
1
{
2
“类型”:“对象”,
3.
“属性”:{
4
“账户”:{
5
“类型”:“数组”,
6
“项目”:[
7
{
8
“类型”:“对象”,
9
“属性”:{
10
“标识”:{
11
“类型”:“字符串”
12
},
13
“用户名”:{
14
“类型”:“字符串”
15
},
16
“ClientId”:{
17
“类型”:“字符串”
18
}
19
},
20.
“要求”:[
21
“标识”,
22
“用户名”,
23
“ClientId”
24
]
25
}
26
]
27
},
28
“角色”:{
29
“类型”:“数组”,
30.
“项目”:[
31
{
32
“类型”:“对象”,
33
“属性”:{
34
“RoleId”:{
35
“类型”:“字符串”
36
},
37
“RoleName”:{
38
“类型”:“字符串”
39
}
40
},
41
“要求”:[
42
“RoleId”,
43
“RoleName”
44
]
45
}
46
]
47
},
48
“GroupName”:{
49
“类型”:“字符串”
50
},
51
“ClientId”:{
52
“类型”:“字符串”
53
}
54
},
55
“要求”:[
56
“账户”,
57
“角色”,
58
“GroupName”,
59
“ClientId”
60
]
61
}
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200 |
成功 |
组添加 |
400 |
未提供所需参数 |
反应的例子:
JSON模式:
1
{
2
“美元模式”:“http://json-schema.org/draft-04/schema”,
3.
“类型”:“对象”,
4
“属性”:{
5
“AccountGroupDetailedInfo”:{
6
“类型”:“对象”,
7
“属性”:{
8
“GroupId”:{
9
“类型”:“字符串”
10
}
11
},
12
“要求”:[
13
“GroupId”
14
]
15
},
16
“IsSuccess”:{
17
“类型”:“布尔”
18
},
19
“原因”:{
20.
“类型”:“零”
21
},
22
“ErrorMessage”:{
23
“类型”:“零”
24
},
25
“链接”:{
26
“类型”:“数组”,
27
“项目”:[
28
{
29
“类型”:“对象”,
30.
“属性”:{
31
“Rel”:{
32
“类型”:“字符串”
33
},
34
“Href”:{
35
“类型”:“字符串”
36
}
37
},
38
“要求”:[
39
“Rel”,
40
“Href”
41
]
42
}
43
]
44
}
45
},
46
“要求”:[
47
“AccountGroupDetailedInfo”,
48
“IsSuccess”,
49
“原因”,
50
“ErrorMessage”,
51
“链接”
52
]
53
}
把
/ AppSpiderEnterprise / rest / v1 /组/ UpdateGroup吗?groupId <插入groupId > < /插入>
描述
添加一个新组。
参数
的名字 |
类型 |
要求 |
描述 |
|---|---|---|---|
GroupId |
guid |
Y |
要更新的组Id |
GroupName |
字符串 |
Y |
组名称 |
ClientId |
guid |
Y |
组客户端Id |
账户 |
数组 |
N |
要添加到组的帐户 |
用户标识 |
字符串 |
N |
用户Id(账户) |
用户名 |
字符串 |
N |
用户名(账户) |
ClientId |
guid |
N |
内部用户的客户(账户) |
角色 |
数组 |
Y |
要添加到组的角色 |
RoleId |
guid |
Y |
角色Id(角色) |
RoleName |
字符串 |
Y |
角色名称(角色) |
请求示例:
JSON模式:
1
{
2
“类型”:“对象”,
3.
“属性”:{
4
“账户”:{
5
“类型”:“数组”,
6
“项目”:[
7
{
8
“类型”:“对象”,
9
“属性”:{
10
“标识”:{
11
“类型”:“字符串”
12
},
13
“用户名”:{
14
“类型”:“字符串”
15
},
16
“ClientId”:{
17
“类型”:“字符串”
18
}
19
},
20.
“要求”:[
21
“标识”,
22
“用户名”,
23
“ClientId”
24
]
25
}
26
]
27
},
28
“角色”:{
29
“类型”:“数组”,
30.
“项目”:[
31
{
32
“类型”:“对象”,
33
“属性”:{
34
“RoleId”:{
35
“类型”:“字符串”
36
},
37
“RoleName”:{
38
“类型”:“字符串”
39
}
40
},
41
“要求”:[
42
“RoleId”,
43
“RoleName”
44
]
45
}
46
]
47
},
48
“GroupName”:{
49
“类型”:“字符串”
50
},
51
“ClientId”:{
52
“类型”:“字符串”
53
}
54
},
55
“要求”:[
56
“账户”,
57
“角色”,
58
“GroupName”,
59
“ClientId”
60
]
61
}
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200 |
成功 |
组织更新 |
400 |
未提供所需参数 |
反应的例子:
JSON模式:
1
{
2
“美元模式”:“http://json-schema.org/draft-04/schema”,
3.
“类型”:“对象”,
4
“属性”:{
5
“AccountGroupDetailedInfo”:{
6
“类型”:“对象”,
7
“属性”:{
8
“GroupId”:{
9
“类型”:“字符串”
10
}
11
},
12
“要求”:[
13
“GroupId”
14
]
15
},
16
“IsSuccess”:{
17
“类型”:“布尔”
18
},
19
“原因”:{
20.
“类型”:“零”
21
},
22
“ErrorMessage”:{
23
“类型”:“零”
24
},
25
“链接”:{
26
“类型”:“数组”,
27
“项目”:[
28
{
29
“类型”:“对象”,
30.
“属性”:{
31
“Rel”:{
32
“类型”:“字符串”
33
},
34
“Href”:{
35
“类型”:“字符串”
36
}
37
},
38
“要求”:[
39
“Rel”,
40
“Href”
41
]
42
}
43
]
44
}
45
},
46
“要求”:[
47
“AccountGroupDetailedInfo”,
48
“IsSuccess”,
49
“原因”,
50
“ErrorMessage”,
51
“链接”
52
]
53
}
删除
/ AppSpiderEnterprise / rest / v1 /组/ DeleteGroup吗?groupId <插入groupId > < /插入>
描述
删除一组
参数
没有参数
响应消息
响应状态码 |
原因 |
描述 |
|---|---|---|
200 |
成功 |
组已删除 |
反应的例子:
JSON模式:
1
{
2
“美元模式”:“http://json-schema.org/draft-04/schema”,
3.
“类型”:“对象”,
4
“属性”:{
5
“AccountGroupDetailedInfo”:{
6
“类型”:“零”
7
},
8
“IsSuccess”:{
9
“类型”:“布尔”
10
},
11
“原因”:{
12
“类型”:“零”
13
},
14
“ErrorMessage”:{
15
“类型”:“零”
16
},
17
“链接”:{
18
“类型”:“数组”,
19
“项目”:[
20.
{
21
“类型”:“对象”,
22
“属性”:{
23
“Rel”:{
24
“类型”:“字符串”
25
},
26
“Href”:{
27
“类型”:“字符串”
28
}
29
},
30.
“要求”:[
31
“Rel”,
32
“Href”
33
]
34
}
35
]
36
}
37
},
38
“要求”:[
39
“AccountGroupDetailedInfo”,
40
“IsSuccess”,
41
“原因”,
42
“ErrorMessage”,
43
“链接”
44
]
45
}
这个页面对你有帮助吗?