ThingsKit物联网平台API文档-系统管理（组织管理）

云腾小编

2024年11月12日2024年11月11日

新增组织

接口地址:/api/yt/organization

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
    "parentId": "f85dab7d-69e3-424d-89d3-8ed5f45ab396",
    "name": "测试组织",
    "sort": 0,
    "remark":"备注"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
parentId	上级组织id	body	true	string
name	组织名称	body	true	string
sort	组织排序	body	true	string
remark	备注	body	false	string

响应参数:

参数名称	参数说明	类型
id	主键id	String
creator	创建人	String
createTime	创建时间	LocalDateTime
updater	修改人	String
updateTime	修改时间	LocalDateTime
name	名称	String
enabled	租户状态：启用/禁用	Boolean
tenantId	租户id	String
parentId	上级id	String
sort	排序	int
children	子集	array

响应示例:

{
    "id": "943af5dc-b669-4d83-85e7-0430c3300615",
    "creator": "d2dd7aeb-6b97-426e-a3b8-2c8759d0e6be",
    "createTime": "2024-08-21 16:01:37",
    "updater": "d2dd7aeb-6b97-426e-a3b8-2c8759d0e6be",
    "updateTime": "2024-08-21 16:01:37",
    "name": "测试组织2",
    "enabled": false,
    "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
    "parentId": "f85dab7d-69e3-424d-89d3-8ed5f45ab396",
    "sort": 2,
    "children": []
}

修改组织

接口地址:/api/yt/organization

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
    "parentId": "f85dab7d-69e3-424d-89d3-8ed5f45ab396",
    "name": "测试组织",
    "sort": 0,
    "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
    "id": "1e58d4d8-23bd-41f3-8fec-9724c84a8afa"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
parentId	上级组织id	body	true	string
name	组织名称	body	true	string
sort	组织排序	body	true	string
remark	备注	body	false	string
tenantId	租户id	body	true	string

响应参数:

参数名称	参数说明	类型
id	主键id	String
name	名称	String
enabled	租户状态：启用/禁用	Boolean
tenantId	租户id	String
parentId	上级id	String
sort	排序	int
children	子集	array

响应示例:

{
    "id": "1e58d4d8-23bd-41f3-8fec-9724c84a8afa",
    "name": "测试组织",
    "enabled": false,
    "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
    "parentId": "f85dab7d-69e3-424d-89d3-8ed5f45ab396",
    "sort": 0,
    "children": []
}

删除组织

接口地址:/api/yt/organization

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "ids": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
ids	删除ID列表		true	array

响应参数:

参数名称	参数说明	类型
msg	错误信息	string
code	错误码	string
data	返回值

树形列表

接口地址:/api/yt/organization/me/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:暂无

响应参数:

参数名称	参数说明	类型
organizationId	组织id(查询某组织及其下级)	String

响应参数:

参数名称	参数说明	类型
id	主键id	String
creator	创建人	String
createTime	创建时间	LocalDateTime
updater	修改人	String
updateTime	修改时间	LocalDateTime
name	名称	String
enabled	租户状态：启用/禁用	Boolean
tenantId	租户id	String
parentId	上级id	String
sort	排序	int
children	子集（子集中还可能存在子集，一直往下）	array

响应示例:

[
    {
        "id": "f85dab7d-69e3-424d-89d3-8ed5f45ab396",
        "creator": "80808080-8080-8080-8080-808080808080",
        "createTime": "2024-08-19 11:28:18",
        "updater": "d2dd7aeb-6b97-426e-a3b8-2c8759d0e6be",
        "updateTime": "2024-08-19 14:04:05",
        "name": "默认",
        "enabled": false,
        "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
        "sort": 0,
        "children": [
            {
                "id": "1e58d4d8-23bd-41f3-8fec-9724c84a8afa",
                "creator": "d2dd7aeb-6b97-426e-a3b8-2c8759d0e6be",
                "createTime": "2024-08-21 15:57:33",
                "updater": "d2dd7aeb-6b97-426e-a3b8-2c8759d0e6be",
                "updateTime": "2024-08-21 16:06:56",
                "name": "测试组织",
                "enabled": false,
                "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
                "parentId": "f85dab7d-69e3-424d-89d3-8ed5f45ab396",
                "sort": 0,
                "children": []
            },
            {
                "id": "943af5dc-b669-4d83-85e7-0430c3300615",
                "creator": "d2dd7aeb-6b97-426e-a3b8-2c8759d0e6be",
                "createTime": "2024-08-21 16:01:37",
                "name": "测试组织2",
                "enabled": false,
                "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
                "parentId": "f85dab7d-69e3-424d-89d3-8ed5f45ab396",
                "sort": 2,
                "children": []
            }
        ]
    }
]