3 Star 6 Fork 2

ThingsKit / ThingsKit物联网平台文档

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
index.md 12.86 KB
一键复制 编辑 原始数据 按行查看 历史
TrueVoid 提交于 2023-01-18 20:20 . docs: release1.0.1

新增组织

接口地址:/api/yt/organization

请求方式:POST

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

响应数据类型:*/*

接口描述:

请求示例:

{
  "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": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
organizationDTO OrganizationDTO body true OrganizationDTO

响应参数:

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

响应示例:

{
	"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": ""
}

修改组织

接口地址:/api/yt/organization

请求方式:PUT

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

响应数据类型:*/*

接口描述:

请求示例:

{
  "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": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
organizationDTO OrganizationDTO body true OrganizationDTO

响应参数:

参数名称 参数说明 类型
body object
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_NEGOTIATES string
statusCodeValue integer(int32)

响应示例:

{
	"body": {},
	"statusCode": "",
	"statusCodeValue": 0
}

删除组织

接口地址:/api/yt/organization

请求方式:DELETE

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

响应数据类型:*/*

接口描述:

请求示例:

{
  "ids": [],
  "tenantId": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
deleteDTO DeleteDTO body true DeleteDTO
  ids 删除ID列表 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)

响应示例:

{}

下拉列表

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

请求参数:暂无

响应参数:

参数名称 参数说明 类型
body object
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_NEGOTIATES string
statusCodeValue integer(int32)

响应示例:

{
	"body": {},
	"statusCode": "",
	"statusCodeValue": 0
}

bindUserToOrganization(待翻译)

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

请求方式:PUT

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

响应数据类型:*/*

接口描述:

请求示例:

[]

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
userId userId path true string
strings string body true array

响应参数:

暂无

1
https://gitee.com/thingskit/thingskit-docs.git
git@gitee.com:thingskit/thingskit-docs.git
thingskit
thingskit-docs
ThingsKit物联网平台文档
master

搜索帮助