Skip to content
本页目录

 

ThingsKit物联网平台

开箱即用的物联网低代码平台

新增组织

接口地址:/api/yt/organization

请求方式:POST

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

响应数据类型:*/*

接口描述:

请求示例:

javascript
{
  "children": [
    {
      "children": [],
      "createTime": "",
      "creator": "",
      "defaultConfig": "",
      "description": "",
      "enabled": false,
      "icon": "",
      "id": "",
      "name": "",
      "parentId": "",
      "remark": "",
      "roleIds": [],
      "sort": 0,
      "tenantExpireTime": "",
      "tenantId": "",
      "tenantProfileId": "",
      "tenantStatus": "",
      "updateTime": "",
      "updater": ""
    }
  ],
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "name": "",
  "parentId": "",
  "remark": "",
  "roleIds": [],
  "sort": 0,
  "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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

请求参数:

参数名称参数说明请求类型是否必须数据类型
organizationDTOOrganizationDTObodytrueOrganizationDTO

响应参数:

参数名称参数说明类型
children子集array
  children子集array
  createTime创建时间string(date-time)
  creator创建用户string
  defaultConfig租户默认配置string
  description租户描述string
  enabled租户状态:启用/禁用boolean
  icon租户图标string
  idIDstring
  name组织名称string
  parentId组织父IDstring
  remark备注string
  roleIds租户角色列表array
  sort排序integer(int32)
  tenantExpireTime租户到期时间string(date-time)
  tenantId租户IDstring
  tenantProfileId租户配置string
  tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
  updateTime更新时间string(date-time)
  updater更新用户string
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态:启用/禁用boolean
icon租户图标string
idIDstring
name组织名称string
parentId组织父IDstring
remark备注string
roleIds租户角色列表array
sort排序integer(int32)
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

javascript
{
	"children": [
		{
			"children": [],
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"parentId": "",
			"remark": "",
			"roleIds": [],
			"sort": 0,
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"parentId": "",
	"remark": "",
	"roleIds": [],
	"sort": 0,
	"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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

修改组织

接口地址:/api/yt/organization

请求方式:PUT

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

响应数据类型:*/*

接口描述:

请求示例:

javascript
{
  "children": [
    {
      "children": [],
      "createTime": "",
      "creator": "",
      "defaultConfig": "",
      "description": "",
      "enabled": false,
      "icon": "",
      "id": "",
      "name": "",
      "parentId": "",
      "remark": "",
      "roleIds": [],
      "sort": 0,
      "tenantExpireTime": "",
      "tenantId": "",
      "tenantProfileId": "",
      "tenantStatus": "",
      "updateTime": "",
      "updater": ""
    }
  ],
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "name": "",
  "parentId": "",
  "remark": "",
  "roleIds": [],
  "sort": 0,
  "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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

请求参数:

参数名称参数说明请求类型是否必须数据类型
organizationDTOOrganizationDTObodytrueOrganizationDTO

响应参数:

参数名称参数说明类型
bodyobject
statusCode可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATESstring
statusCodeValueinteger(int32)

响应示例:

javascript
{
	"body": {},
	"statusCode": "",
	"statusCodeValue": 0
}
1
2
3
4
5

删除组织

接口地址:/api/yt/organization

请求方式:DELETE

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

响应数据类型:*/*

接口描述:

请求示例:

javascript
{
  "ids": [],
  "tenantId": ""
}
1
2
3
4

请求参数:

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

响应参数:

参数名称参数说明类型
errorCodePlatform 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
messageError messagestring
statusHTTP Response Status Codeinteger(int32)
timestampTimestampstring(date-time)

响应示例:

javascript
{}
1

下拉列表

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

请求参数:暂无

响应参数:

参数名称参数说明类型
bodyobject
statusCode可用值:ACCEPTED,ALREADY_REPORTED,BAD_GATEWAY,BAD_REQUEST,BANDWIDTH_LIMIT_EXCEEDED,CHECKPOINT,CONFLICT,CONTINUE,CREATED,DESTINATION_LOCKED,EXPECTATION_FAILED,FAILED_DEPENDENCY,FORBIDDEN,FOUND,GATEWAY_TIMEOUT,GONE,HTTP_VERSION_NOT_SUPPORTED,IM_USED,INSUFFICIENT_SPACE_ON_RESOURCE,INSUFFICIENT_STORAGE,INTERNAL_SERVER_ERROR,I_AM_A_TEAPOT,LENGTH_REQUIRED,LOCKED,LOOP_DETECTED,METHOD_FAILURE,METHOD_NOT_ALLOWED,MOVED_PERMANENTLY,MOVED_TEMPORARILY,MULTIPLE_CHOICES,MULTI_STATUS,NETWORK_AUTHENTICATION_REQUIRED,NON_AUTHORITATIVE_INFORMATION,NOT_ACCEPTABLE,NOT_EXTENDED,NOT_FOUND,NOT_IMPLEMENTED,NOT_MODIFIED,NO_CONTENT,OK,PARTIAL_CONTENT,PAYLOAD_TOO_LARGE,PAYMENT_REQUIRED,PERMANENT_REDIRECT,PRECONDITION_FAILED,PRECONDITION_REQUIRED,PROCESSING,PROXY_AUTHENTICATION_REQUIRED,REQUESTED_RANGE_NOT_SATISFIABLE,REQUEST_ENTITY_TOO_LARGE,REQUEST_HEADER_FIELDS_TOO_LARGE,REQUEST_TIMEOUT,REQUEST_URI_TOO_LONG,RESET_CONTENT,SEE_OTHER,SERVICE_UNAVAILABLE,SWITCHING_PROTOCOLS,TEMPORARY_REDIRECT,TOO_EARLY,TOO_MANY_REQUESTS,UNAUTHORIZED,UNAVAILABLE_FOR_LEGAL_REASONS,UNPROCESSABLE_ENTITY,UNSUPPORTED_MEDIA_TYPE,UPGRADE_REQUIRED,URI_TOO_LONG,USE_PROXY,VARIANT_ALSO_NEGOTIATESstring
statusCodeValueinteger(int32)

响应示例:

javascript
{
	"body": {},
	"statusCode": "",
	"statusCodeValue": 0
}
1
2
3
4
5

bindUserToOrganization(待翻译)

接口地址:/api/yt/organization/save_organization_mapping/{userId}

请求方式:PUT

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

响应数据类型:*/*

接口描述:

请求示例:

javascript
[]
1

请求参数:

参数名称参数说明请求类型是否必须数据类型
userIduserIdpathtruestring
stringsstringbodytruearray

响应参数:

暂无