ThingsKitAppearance
pageRole（待翻译） ¶
接口地址:/api/yt/role{?orderFiled,orderType,page,pageSize,roleName,status}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| page | page | true | int |
| pageSize | pageSize | true | int |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| items | array | |
| code | 角色Code | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| icon | 租户图标 | string |
| id | ID | string |
| name | 角色名称 | string |
| remark | 备注 | string |
| roleIds | 角色ID列表 | array |
| roleType | 角色类型 | string |
| status | 状态 | boolean |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
| total | integer(int32) |
响应示例:
javascript
{
"items": [
{
"code": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"icon": "",
"id": "",
"name": "",
"remark": "",
"roleIds": [],
"roleType": "",
"status": false,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
],
"total": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
deleteRole（待翻译） ¶
接口地址:/api/yt/role
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
javascript
[]
1
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| strings | string | body | true | array |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| errorCode | Platform error code:\n* 2 - General error (HTTP: 500 - Internal Server Error)\n\n* 10 - Authentication failed (HTTP: 401 - Unauthorized)\n\n* 11 - JWT token expired (HTTP: 401 - Unauthorized)\n\n* 15 - Credentials expired (HTTP: 401 - Unauthorized)\n\n* 20 - Permission denied (HTTP: 403 - Forbidden)\n\n* 30 - Invalid arguments (HTTP: 400 - Bad Request)\n\n* 31 - Bad request params (HTTP: 400 - Bad Request)\n\n* 32 - Item not found (HTTP: 404 - Not Found)\n\n* 33 - Too many requests (HTTP: 429 - Too Many Requests)\n\n* 34 - Too many updates (Too many updates over Websocket session)\n\n* 40 - Subscription violation (HTTP: 403 - Forbidden) | object |
| message | Error message | string |
| status | HTTP Response Status Code | integer(int32) |
| timestamp | Timestamp | string(date-time) |
响应示例:
javascript
{}
1
findRoleInfoList（待翻译） ¶
接口地址:/api/yt/role/find/list
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
javascript
{
"code": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"icon": "",
"id": "",
"name": "",
"remark": "",
"roleIds": [],
"roleType": "",
"status": false,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| roleDTO | RoleDTO | body | true | RoleDTO |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| code | 角色Code | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| icon | 租户图标 | string |
| id | ID | string |
| name | 角色名称 | string |
| remark | 备注 | string |
| roleIds | 角色ID列表 | array |
| roleType | 角色类型 | string |
| status | 状态 | boolean |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
响应示例:
javascript
[
{
"code": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"icon": "",
"id": "",
"name": "",
"remark": "",
"roleIds": [],
"roleType": "",
"status": false,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
getPermissions（待翻译） ¶
接口地址:/api/yt/role/me/permissions
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:暂无
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| errorCode | Platform error code:\n* 2 - General error (HTTP: 500 - Internal Server Error)\n\n* 10 - Authentication failed (HTTP: 401 - Unauthorized)\n\n* 11 - JWT token expired (HTTP: 401 - Unauthorized)\n\n* 15 - Credentials expired (HTTP: 401 - Unauthorized)\n\n* 20 - Permission denied (HTTP: 403 - Forbidden)\n\n* 30 - Invalid arguments (HTTP: 400 - Bad Request)\n\n* 31 - Bad request params (HTTP: 400 - Bad Request)\n\n* 32 - Item not found (HTTP: 404 - Not Found)\n\n* 33 - Too many requests (HTTP: 429 - Too Many Requests)\n\n* 34 - Too many updates (Too many updates over Websocket session)\n\n* 40 - Subscription violation (HTTP: 403 - Forbidden) | object |
| message | Error message | string |
| status | HTTP Response Status Code | integer(int32) |
| timestamp | Timestamp | string(date-time) |
响应示例:
javascript
[
{}
]
1
2
3
2
3
saveOrUpdateRoleInfoWithMenu（待翻译） ¶
接口地址:/api/yt/role/save_with_menu
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
javascript
{
"id": "",
"menu": [],
"name": "",
"remark": "",
"roleType": "",
"status": 0
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| roleReqDTO | RoleReqDTO | body | true | RoleReqDTO |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| code | 角色Code | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| icon | 租户图标 | string |
| id | ID | string |
| name | 角色名称 | string |
| remark | 备注 | string |
| roleIds | 角色ID列表 | array |
| roleType | 角色类型 | string |
| status | 状态 | boolean |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
响应示例:
javascript
{
"code": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"icon": "",
"id": "",
"name": "",
"remark": "",
"roleIds": [],
"roleType": "",
"status": false,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
pageTenantRole（待翻译） ¶
接口地址:/api/yt/role/tenant{?orderFiled,orderType,page,pageSize,roleName,status}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| page | page | true | int |
| pageSize | pageSize | true | int |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| items | array | |
| code | 角色Code | string |
| createTime | 创建时间 | string(date-time) |
| creator | 创建用户 | string |
| defaultConfig | 租户默认配置 | string |
| description | 租户描述 | string |
| icon | 租户图标 | string |
| id | ID | string |
| name | 角色名称 | string |
| remark | 备注 | string |
| roleIds | 角色ID列表 | array |
| roleType | 角色类型 | string |
| status | 状态 | boolean |
| tenantExpireTime | 租户到期时间 | string(date-time) |
| tenantId | 租户ID | string |
| tenantProfileId | 租户配置 | string |
| tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
| updateTime | 更新时间 | string(date-time) |
| updater | 更新用户 | string |
| total | integer(int32) |
响应示例:
javascript
{
"items": [
{
"code": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"icon": "",
"id": "",
"name": "",
"remark": "",
"roleIds": [],
"roleType": "",
"status": false,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
],
"total": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
updateRoleStatus（待翻译） ¶
接口地址:/api/yt/role/update_status/{roleId}/{status}
请求方式:PUT
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| roleId | roleId | path | true | string |
| status | status | path | true | integer(int32) |
响应参数:
暂无
响应示例:
javascript
1