1. Overview

supOS对外开放能力:
* OAuth 2.0服务接口
* 人员管理
* 组织管理
* 报警管理
* 用户管理
* 对象管理
* 运行时
* 工作流
* 生产架构管理(工厂信息模型)
* datatable管理

1.1. Version information

Version : v1.0

1.3. Tags

  • alarms : 报警管理

  • datatable : datatable管理

  • health : 健康检查

  • networks : 生产架构管理(工厂信息模型)

  • oauth2 : OAuth 2.0管理

  • objects : 对象管理

  • orgs : 组织管理

  • persons : 人员管理

  • runtime : 运行时

  • users : 用户管理

  • workflows : 工作流

2. Resources

2.1. Alarms

报警管理

2.1.1. 查询实时报警信息

GET /openapi/alarms/v1/current
Description

查询实时报警信息

Parameters
Type Name Description Schema

Query

keyword
optional

对象名称或对象属性名称

string

Query

priority
optional

报警优先级,如:1,2,3,4,5,6,7,8,9,10

string

Responses
HTTP Code Description Schema

200

命令发送成功并后台处理完成

Response 200

400

健康检查成功

GeneralError

Response 200

Name Schema

list
optional

< AlarmCurrentInfo > array

2.1.2. 查询历史报警信息

GET /openapi/alarms/v1/history
Description

查询历史报警信息

Parameters
Type Name Description Schema Default

Query

endTime
optional

结束时间

string

Query

keyword
optional

报警名称或描述

string

Query

page
optional

翻页的页数,从1开始

integer

"1"

Query

per_page
optional

每页返回的元素数量(最大值为100)

integer

"20"

Query

priority
optional

报警优先级,如:1,2,3,4,5,6,7,8,9,10

string

Query

startTime
optional

开始时间

string

Responses
HTTP Code Description Schema

200

命令发送成功并后台处理完成

Response 200

400

健康检查成功

GeneralError

Response 200

Name Schema

list
optional

< AlarmHistoryInfo > array

pagination
optional

Pagination

2.2. Datatable

datatable管理

2.2.1. 增加dataTable数据

POST /openapi/datatable/v1/{objName}/addDataTableEntry
Description

增加dataTable数据

Parameters
Type Name Description Schema

Path

objName
required

对象别名

string

Body

body
required

object

Responses
HTTP Code Description Schema

201

后台已成功接受命令,并处理成功

Created

400

健康检查成功

GeneralError

2.2.2. 删除dataTable数据

POST /openapi/datatable/v1/{objName}/deleteDataTableEntry
Description

删除dataTable数据

Parameters
Type Name Description Schema

Path

objName
required

对象别名

string

Body

body
required

object

Responses
HTTP Code Description Schema

204

后台已成功接受命令并处理成功

No Content

400

健康检查成功

GeneralError

2.2.3. 修改dataTable数据

POST /openapi/datatable/v1/{objName}/updateDataTableEntry
Description

修改dataTable数据

Parameters
Type Name Description Schema

Path

objName
required

对象别名

string

Body

body
required

body

body

Name Description Schema

update
optional

修改信息,例:"name":"dataTable"

object

where
optional

修改条件,例:"id":1

object

Responses
HTTP Code Description Schema

201

后台已成功接受命令,并处理成功

Updated

400

健康检查成功

GeneralError

2.3. Health

健康检查

2.3.1. 健康检查

GET /openapi/health
Responses
HTTP Code Description Schema

200

健康检查成功

Response 200

400

健康检查成功

Response 400

Response 200

Name Schema

result
optional

string

Response 400

Name Schema

result
optional

string

2.4. Networks

生产架构管理(工厂信息模型)

2.4.1. 批量查询生产架构列表

GET /openapi/networks/v1
Description

批量查询生产架构列表

Parameters
Type Name Description Schema Default

Query

page
optional

翻页的页数,从1开始

integer

"1"

Query

per_page
optional

每页返回的元素数量(最大值为100)

integer

"20"

Responses
HTTP Code Description Schema

200

找到该对象事件

Response 200

Response 200

Name Schema

list
optional

< NetworkBaseInfo > array

pagination
optional

Pagination

2.4.2. 查询指定名称的生产架构树

GET /openapi/networks/v1/{networkName}
Description

查询指定名称的生产架构树,networkName必填

Parameters
Type Name Description Schema

Path

networkName
required

生产架构名

string

Query

recursion
optional

是否递归查询,默认不递归查询,如果要递归查询入参:recursion

string

Query

templateName
optional

查询指定模板

< string > array

Responses
HTTP Code Description Schema

200

找到该对象事件

Response 200

400

健康检查成功

GeneralError

Response 200

Name Schema

children
optional

< NetworkObjectSearchList > array

2.5. Oauth2

OAuth 2.0管理

2.5.1. 客户端模式获取Access Token

GET /oauth2/client/v1/accessToken
Parameters
Type Name Description Schema

Query

appid
required

第三方用户唯一凭证

string

Query

grantType
required

授权类型,此值固定为“client_credential”。

string

Query

secret
required

第三方用户唯一凭证密钥,即appsecret

string

Responses
HTTP Code Description Schema

200

如果成功返回,即可在返回包中获取到Access Token

ResponseSuccess

400

常规的错误

GeneralError

2.5.2. 客户端模式通过refreshToken获取AccessToken

GET /oauth2/client/v1/refreshToken
Parameters
Type Name Description Schema

Query

refreshToken
required

刷新密码

string

Responses
HTTP Code Description Schema

200

如果成功返回,即可在返回包中获取到Access Token

ResponseSuccess

400

常规的错误

GeneralError

2.5.3. 授权码模式获取Access Token

GET /oauth2/code/v1/accessToken
Parameters
Type Name Description Schema

Query

appid
required

申请账户登录成功后,分配给应用的appid。

string

Query

code
required

授权码模式获取的authorizeCode

string

Query

grantType
required

授权类型,此值固定为“authorization_code”。

string

Query

logoutUri
optional

APP登出链接

string

Query

secret
required

申请账户登录成功后,分配给应用的appkey。

string

Responses
HTTP Code Description Schema

200

如果成功返回,即可在返回包中获取到Access Token

ResponseSuccess

400

常规的错误

GeneralError

2.5.4. 授权码模式获取authorizeCode

GET /oauth2/code/v1/authorize
Parameters
Type Name Description Schema

Query

appid
required

申请账户登录成功后,分配给应用的appid。

string

Query

redirectUri
required

成功授权后的回调地址。

string

Query

responseType
required

授权类型,此值固定为“code”。

string

Query

scope
optional

授权的列表。

string

Query

state
required

client端的状态值。

string

Responses
HTTP Code Description Schema

200

处理成功后返回的结果

No Content

400

常规的错误

GeneralError

2.5.5. 授权码模式通过refreshToken获取AccessToken

GET /oauth2/code/v1/refreshToken
Parameters
Type Name Description Schema

Query

refreshToken
required

刷新token

string

Responses
HTTP Code Description Schema

200

如果成功返回,即可在返回包中获取到Access Token

ResponseSuccess

400

常规的错误

GeneralError

2.6. Objects

对象管理

2.6.1. 批量查询对象实例元数据

GET /openapi/objects/v1
Parameters
Type Name Description Schema Default

Query

featureName
optional

功能集合名称,拥有该功能集合的对象实例以及继承拥有该功能集合的对象模板的实例

string

Query

keyword
optional

描述及showName,name模糊查询 全匹配

string

Query

modelLabels
optional

根据modelLabel过滤

< string > array

Query

objName
optional

对象实例名称,默认做左匹配

string

Query

page
optional

翻页的页数,从1开始

integer

"1"

Query

per_page
optional

每页返回的元素数量(最大值为100)

integer

"20"

Query

templateName
optional

模板名称,如果为空则查询除了订阅对象和报警对象之外的所有其他对象,如果不为空则按模板名称查询

string

Responses
HTTP Code Description Schema

200

请求成功后返回的内容

Response 200

400

健康检查成功

GeneralError

Response 200

Name Schema

list
optional

< GetObjectBaseInfo > array

pagination
optional

Pagination

2.6.2. 查询对象实例元数据的详细信息

GET /openapi/objects/v1/{objName}
Parameters
Type Name Description Schema

Path

objName
required

对象实例名称

string

Responses
HTTP Code Description Schema

200

找到该对象返回的内容

GetObjectDetailInfo

400

健康检查成功

GeneralError

2.6.3. 查询对象实例的属性元数据

GET /openapi/objects/v1/{objName}/properties
Parameters
Type Name Description Schema Default

Path

objName
required

对象实例名称

string

Query

modelLabels
optional

根据modelLabel过滤

< string > array

Query

page
optional

翻页的页数,从1开始

integer

"1"

Query

per_page
optional

每页返回的元素数量 (最大值为100)

integer

"20"

Query

propName
optional

属性名称做左匹配查询

string

Responses
HTTP Code Description Schema

200

找到并返回的结果

Response 200

400

健康检查成功

GeneralError

Response 200

Name Schema

list
optional

< object > array

pagination
optional

Pagination

2.7. Orgs

组织管理

2.7.1. 批量查询组织树基本信息

GET /openapi/orgs/v1
Parameters
Type Name Description Schema Default

Query

keyword
optional

name,showName,description模糊查询

string

Query

modelLabel
optional

根据modelLabel过滤查询

string

Query

page
optional

翻页的页数,从1开始

integer

"1"

Query

per_page
optional

每页返回的元素数量(最大值为100)

integer

"20"

Responses
HTTP Code Description Schema

200

命令发送成功并后台处理完成

Response 200

Response 200

Name Schema

list
optional

< OrganizationTreeQueryInfo > array

pagination
optional

Pagination

2.7.2. 查询指定组织树详细信息

GET /openapi/orgs/v1/{orgName}
Description

查询指定组织树详细信息,orgName必填

Parameters
Type Name Description Schema

Path

orgName
required

组织树别名,必填

string

Responses
HTTP Code Description Schema

200

查询指定组织树详细信息

OrganizationTreeInfo

400

健康检查成功

GeneralError

2.7.3. 批量查询组织树所有节点基本信息,结果为平铺结构

GET /openapi/orgs/v1/{orgName}/nodes
Parameters
Type Name Description Schema Default

Path

orgName
required

组织树别名,必填

string

Query

keyword
optional

showName,name,description模糊查询

string

Query

page
optional

翻页的页数,从1开始

integer

"1"

Query

per_page
optional

每页返回的元素数量(最大值为100)

integer

"20"

Responses
HTTP Code Description Schema

200

命令发送成功并后台处理完成

Response 200

Response 200

Name Schema

list
optional

< OrganizationNodeDetailInfo > array

pagination
optional

Pagination

2.7.4. 查询指定组织节点详细信息

GET /openapi/orgs/v1/{orgName}/nodes/{nodeName}
Description

查询指定组织节点详细信息,orgName必填,nodeName必填

Parameters
Type Name Description Schema

Path

nodeName
required

当前组织节点别名(唯一),必填

string

Path

orgName
required

组织树别名(唯一),必填

string

Responses
HTTP Code Description Schema

200

根据别名查询组织节点详细信息

OrganizationNodeResultDetailInfo

400

健康检查成功

GeneralError

2.7.5. 批量查询组织关联的人员

GET /openapi/orgs/v1/{orgName}/persons
Description

批量查询组织关联的人员

Parameters
Type Name Description Schema Default

Path

orgName
required

组织树别名

string

Query

keyword
optional

showName,account,description模糊查询(筛选人员)

string

Query

nodeName
optional

组织节点别名

string

Query

page
optional

翻页的页数,从1开始

integer

"1"

Query

per_page
optional

每页返回的元素数量(最大值为100)

integer

"20"

Responses
HTTP Code Description Schema

200

命令发送成功并后台处理完成

Response 200

400

健康检查成功

GeneralError

Response 200

Name Schema

list
optional

< PersonInfo > array

pagination
optional

Pagination

2.8. Persons

人员管理

2.8.1. 查询人员列表

GET /openapi/persons/v1
Parameters
Type Name Description Schema Default

Query

hasAccount
optional

如果是true:表示返回有绑定用户信息的人员,如果false:表示返回没有绑定用户的人员;不填写则返回全部人员

boolean

Query

includeOrgs
optional

如果是true:表示返回内容包含人员的组织信息,如果false:表示返回内容不包含人员的组织信息

boolean

Query

name
optional

人员别名

string

Query

page
optional

翻页的页数,从1开始

integer

"1"

Query

per_page
optional

每页返回的元素数量(最大值为100)

integer

"20"

Query

showName
optional

人员名称

string

Responses
HTTP Code Description Schema

200

命令发送成功并后台处理完成

Response 200

Response 200

Name Schema

list
optional

< PersonBaseInfo > array

pagination
optional

Pagination

2.8.2. 查询指定人员详细信息

GET /openapi/persons/v1/{name}
Description

根据人员别名查询人员详情,name必填

Parameters
Type Name Description Schema

Path

name
required

当前人员别名(唯一),必填

string

Responses
HTTP Code Description Schema

200

根据人员别名查询人员详情

PersonQueryInfo

400

健康检查成功

GeneralError

2.9. Runtime

运行时

2.9.1. 查询对象属性的实时数据

POST /openapi/objects/v1/properties/current
Description

如果查询对象不存在,则返回"未找到对象";如果查询属性不存在,则返回null;

Parameters
Type Name Schema

Body

body
required

PropCurrentReq

Responses
HTTP Code Description Schema

200

请求成功后返回的内容

object

400

健康检查成功

GeneralError

2.9.2. 查询对象属性的历史数据

POST /openapi/objects/v1/properties/history
Parameters
Type Name Schema

Body

body
required

PropHistoryReq

Responses
HTTP Code Description Schema

200

成功返回数据历史记录

Response 200

400

健康检查成功

GeneralError

Response 200

Name Schema

results
optional

< PropHistoryResp > array

2.10. Users

用户管理

2.10.1. 查询用户列表

GET /openapi/users/v1
Parameters
Type Name Description Schema Default

Query

keyword
optional

模糊匹配关键字

string

Query

page
optional

翻页的页数,从1开始

integer

"1"

Query

per_page
optional

每页返回的元素数量(最大值为100)

integer

"20"

Responses
HTTP Code Description Schema

200

找到该对象返回的内容

Response 200

Response 200

Name Schema

list
optional

< UserBaseInfo > array

pagination
optional

Pagination

2.10.2. 查询指定用户详细信息

GET /openapi/users/v1/{username}
Description

查询指定用户详细信息,username必填

Parameters
Type Name Description Schema

Path

username
required

用户名称,必填

string

Responses
HTTP Code Description Schema

200

查询指定用户详细信息

QueryUser

400

健康检查成功

GeneralError

2.11. Workflows

工作流

2.11.1. 根据流程编号启动流程

POST /openapi/workflows/v1/start/{diagramCode}
Description

根据流程编号启动流程

Parameters
Type Name Description Schema

Path

diagramCode
required

流程编号

string

Body

body
required

body

body

Name Description Schema

appId
optional

appId

string

audit
optional

Audit

data
optional

业务数据, json格式

object

userId
optional

用户ID

string

userName
optional

用户名称

string

Responses
HTTP Code Description Schema

201

后台已成功接受命令,并处理成功

Created

400

健康检查成功

GeneralError

3. Definitions

3.1. AddUser

增加用户的相关信息

Polymorphism : Composition

Name Description Schema

email
optional

邮箱

string

password
optional

用户密码

string

phone
optional

手机

string

timeZone
optional

时区

string

userDesc
optional

用户描述

string

username
optional

用户名

string

3.2. AlarmCurrentInfo

实时报警

Polymorphism : Composition

Name Description Schema

ackStatus
optional

确认状态

integer(int64)

ackTime
optional

确认时间

string(date-time)

ackUserName
optional

确认人

string

alarmType
optional

报警类型

string

description
optional

描述

string

priority
optional

integer(int64)

showName
optional

报警名称

string

sourceObjName
optional

来源对象别名

string

sourceObjShowName
optional

来源对象名称

string

sourcePropName
optional

来源对象属性别名

string

sourcePropShowName
optional

来源对象属性名称

string

startTime
optional

开始时间

string(date-time)

status
optional

状态

integer(int64)

value
optional

最新的值

string

3.3. AlarmHistoryInfo

历史报警

Polymorphism : Composition

Name Description Schema

ackStatus
optional

确认状态

string

ackTime
optional

确认时间

string(date-time)

ackUserName
optional

确认人

string

alarmType
optional

报警类型

string

description
optional

描述

string

priority
optional

integer(int64)

showName
optional

报警名称

string

sourceObjName
optional

来源对象别名

string

sourceObjShowName
optional

来源对象名称

string

sourcePropName
optional

来源对象属性别名

string

sourcePropShowName
optional

来源对象属性名称

string

startTime
optional

开始时间

string(date-time)

status
optional

状态

string

value
optional

最新的值

string

3.4. Audit

审批

Name Description Schema

comment
optional

审批意见

string

name
optional

名称

string

value
optional

string

3.5. BaseInfo

基本信息

Polymorphism : Composition

Name Description Schema

name
required

人员别名

string

showName
required

人员名称

string

3.6. BindInfo

对象实例绑定信息

Name Schema

bindingInfo
optional

Binding

3.7. Binding

对象实例绑定信息

Name Description Schema

source
optional

远程对象属性全路径

string

target
optional

在本对象实例中将要被绑定的属性名称

string

3.8. CommonEvent

对象事件的标准结构

Name Description Schema

dataStruct
required

数据结构

string

modelLabels
optional

< SimpleModelLabel > array

override
optional

Default : false

boolean

3.9. CommonField

通用字段信息,有两个子字段:ServiceInputField 和 DataStructField

Polymorphism : Composition

Name Description Schema

defaultValue
optional

字段默认值

object

description
optional

元数据对象的描述信息

string

hasDefault
optional

字段是否有默认值

boolean

name
required

元数据对象的名称

string

primitiveType
optional

类型名称

string

primitiveTypeDefinition
optional

类型定义,包含该类型的额外约束条件和是否支持默认值

primitiveTypeDefinition

structType
optional

0:基础类型 1:List

integer

3.10. CommonMetadata

元数据对象的通用结构,提供name和description属性

Name Description Schema

description
optional

元数据对象的描述信息

string

name
required

元数据对象的名称

string

3.11. CommonObjectInstance

对象实例的查询结果

Polymorphism : Composition

Name Description Schema

code
optional

string

createTime
optional

string(date-time)

createUsername
optional

string

description
optional

元数据对象的描述信息

string

name
required

元数据对象的名称

string

showName
optional

string

3.12. CommonProperty

对象属性的标准结构

Name Description Schema

code
optional

string

commonTypeValues
optional

commonTypeValues

defaultValue
optional

默认值,可为空{}有值时{"value":"abc"}{"value":123}

object

logged
optional

Default : false

boolean

modelLabels
optional

< SimpleModelLabel > array

override
optional

Default : false

boolean

persisted
optional

Default : false

boolean

primitiveType
required

数据类型

string

range
optional

范围

string

readonly
optional

Default : false

boolean

showName
optional

string

structType
optional

0:基础类型 1:List

integer

commonTypeValues

Name Schema

fields
optional

< FieldTypeAnonymity > array

3.13. CorrelationOrganization

关联组织信息

Polymorphism : Composition

Name Description Schema

nodeName
optional

组织节点别名

string

orgName
optional

组织树别名

string

orgPath
optional

组织节点名称路径,格式为:XXX集团/XXX公司/XXX部门/XXX组

string

3.14. CorrelationUser

人员关联用户信息

Name Schema

name
optional

string

relationUser
optional

string

3.15. Created

后台已成功接受命令,并处理成功

Name Description Schema

Location
optional

所访问资源的URL

string

3.16. DataStructField

dataStruct数据结构

Polymorphism : Composition

Name Description Schema

defaultValue
optional

字段默认值

object

description
optional

元数据对象的描述信息

string

hasDefault
optional

字段是否有默认值

boolean

name
required

元数据对象的名称

string

primary
optional

是否为主键

boolean

primitiveType
optional

类型名称

string

primitiveTypeDefinition
optional

类型定义,包含该类型的额外约束条件和是否支持默认值

primitiveTypeDefinition

structType
optional

0:基础类型 1:List

integer

3.17. ErrorCode

openapi-service请求返回的信息码
* 800000:操作成功
* 800001:操作失败
* 800002:系统内部异常
* 800003:参数错误

Type : enum (, , , )

3.18. Event

对象事件完整结构

Polymorphism : Composition

Name Description Schema

dataStruct
required

数据结构

string

description
optional

元数据对象的描述信息

string

modelLabels
optional

< SimpleModelLabel > array

name
required

元数据对象的名称

string

override
optional

Default : false

boolean

3.19. FieldType

The Field struct

Polymorphism : Composition

Name Description Schema

description
optional

元数据对象的描述信息

string

name
required

元数据对象的名称

string

primitiveType
optional

The PrimitivyType name

string

structType
optional

0:基础类型 1:List

integer

3.20. FieldTypeAnonymity

字段类型

Polymorphism : Composition

Name Description Schema

commonTypeValues
optional

commonTypeValues

description
optional

元数据对象的描述信息

string

name
required

元数据对象的名称

string

primitiveType
optional

The PrimitivyType name

string

structType
optional

0:基础类型 1:List

integer

commonTypeValues

Name Schema

fields
optional

< FieldType > array

3.21. GeneralError

常规的错误

Name Description Schema

code
optional

错误编码,例:"404","800001"

string

message
optional

错误信息,例:"未找到对应数据","修改对应数据失败"

string

3.22. GetObjectBaseInfo

查询得到的对象实例详情,比创建对象实例增添了部分字段,如bingdin

Polymorphism : Composition

Name Description Schema

code
optional

string

createTime
optional

string(date-time)

createUsername
optional

string

description
optional

元数据对象的描述信息

string

explain
optional

说明

string

icon
optional

图标

string

modelLabels
optional

< SimpleModelLabel > array

name
required

元数据对象的名称

string

range
optional

范围

string

showName
optional

string

status
optional

状态
Default : false

boolean

valueStream
optional

string

3.23. GetObjectDetailInfo

查询得到的对象实例详情,比创建对象实例增添了部分字段,如bingdin

Polymorphism : Composition

Name Description Schema

code
optional

string

createTime
optional

string(date-time)

createUsername
optional

string

description
optional

元数据对象的描述信息

string

events
optional

< Event > array

explain
optional

说明

string

features
optional

< string > array

icon
optional

图标

string

modelLabels
optional

< SimpleModelLabel > array

name
required

元数据对象的名称

string

properties
optional

< object > array

range
optional

范围

string

services
optional

< Service > array

showName
optional

string

status
optional

状态
Default : false

boolean

subscriptions
optional

< Subscription > array

templateName
optional

string

valueStream
optional

string

3.24. LoginParam

Name Description Schema

password
optional

用户密码

string

username
optional

用户名

string

3.25. NetworkBaseInfo

生产架构基本结构描述

Name Description Schema

description
optional

生产架构描述

string

name
optional

生产架构名

string

showName
optional

生产架构展示名

string

3.26. NetworkObject

生产架构对象查询结构

Polymorphism : Composition

Name Description Schema

description
optional

生产架构描述

string

name
optional

生产架构名

string

properties
optional

< properties > array

showName
optional

生产架构展示名

string

templateName
optional

模板名称

string

properties

Name Description Schema

defaultValue
optional

默认值

object

name
optional

属性名称

string

3.27. NetworkObjectSearchList

生产架构查询返回集合

Polymorphism : Composition

Name Description Schema

children
optional

< NetworkObject > array

description
optional

生产架构描述

string

name
optional

生产架构名

string

properties
optional

< properties > array

showName
optional

生产架构展示名

string

templateName
optional

模板名称

string

properties

Name Description Schema

defaultValue
optional

默认值

object

name
optional

属性名称

string

3.28. OrganizationNodeBase

组织节点基本信息

Polymorphism : Composition

Name Description Schema

name
optional

组织别名(唯一)

string

parent
optional

父组织节点别名

string

root
optional

组织树名称(根节点名称)

string

showName
optional

组织名称

string

3.29. OrganizationNodeDetailInfo

组织节点详情信息

Polymorphism : Composition

Name Description Schema

code
optional

编码(子节点才有编码,顶点没有)

string

description
optional

描述

string

modelLabels
optional

< string > array

name
required

组织别名(唯一)

string

parent
required

父组织节点别名

string

sequenceNumber
optional

展示顺序号

number

showName
required

组织名称

string

3.30. OrganizationNodeResultDetailInfo

组织节点详情信息

Polymorphism : Composition

Name Description Schema

code
optional

编码(子节点才有编码,顶点没有)

string

description
optional

描述

string

modelLabels
optional

< string > array

name
optional

组织别名(唯一)

string

nodes
optional

组织关联的组织节点,(格式为:["XXX集团/XXX公司/XXX部门/XXX组","XXX集团02/XXX公司02/XXX部门02/XXX组02"])

< object > array

parent
optional

父组织节点别名

string

persons
optional

关联的人员编码,格式为:nameCode01,nameCode02

< object > array

root
optional

组织树名称(根节点名称)

string

sequenceNumber
optional

展示顺序号

number

showName
optional

组织名称

string

3.31. OrganizationTreeAddInfo

增加组织树信息

Polymorphism : Composition

Name Description Schema

code
optional

编码(子节点才有编码,顶点没有)

string

description
optional

描述

string

leader
required

组织负责人

< object > array

modelLabels
optional

< string > array

name
required

组织别名(唯一)

string

showName
required

组织名称

string

3.32. OrganizationTreeInfo

组织树详情信息

Polymorphism : Composition

Name Description Schema

description
optional

描述

string

modelLabels
optional

< string > array

name
optional

组织别名(唯一)

string

persons
optional

< object > array

showName
optional

组织名称

string

3.33. OrganizationTreeList

组织树结构列表

Polymorphism : Composition

Name Description Schema

children
optional

< object > array

description
optional

描述

string

modelLabels
optional

< string > array

name
optional

组织别名(唯一)

string

persons
optional

关联的人员编码,格式为:staffCode01,staffCode02

< string > array

showName
optional

组织名称

string

3.34. OrganizationTreeQueryInfo

查询组织树信息

Polymorphism : Composition

Name Description Schema

code
optional

编码(子节点才有编码,顶点没有)

string

description
optional

描述

string

modelLabels
optional

< string > array

name
optional

组织别名(唯一)

string

showName
optional

组织名称

string

3.35. OrganizationTreeUpdateInfo

修改组织树信息

Polymorphism : Composition

Name Description Schema

code
optional

编码(子节点才有编码,顶点没有)

string

description
optional

描述

string

leader
required

组织负责人

< object > array

modelLabels
optional

< string > array

showName
required

组织名称

string

3.36. OutputParameter

Polymorphism : Composition

Name Description Schema

description
optional

元数据对象的描述信息

string

name
required

元数据对象的名称

string

primitiveType
optional

输出类型名称

string

structType
optional

0:基础类型 1:List

integer

3.37. Pagination

分页信息

Name Description Schema

pageIndex
optional

当前页数

integer

pageSize
optional

每页条数

integer

total
optional

总条数

integer

3.38. PersonBaseInfo

人员基本信息

Polymorphism : Composition

Name Description Schema

gender
required

性别(male男,female女)

string

name
required

人员别名

string

showName
required

人员名称

string

3.39. PersonInfo

人员信息

Polymorphism : Composition

Name Description Schema

account
optional

UserBaseInfo

gender
optional

性别(male男,female女)

string

name
optional

人员编号

string

organizations
optional

所属组织列表(从root开始按顺序)

< object > array

showName
optional

人员名称

string

3.40. PersonQueryInfo

人员相关详细信息

Polymorphism : Composition

Name Description Schema

account
optional

UserBaseInfo

gender
required

性别(male男,female女)

string

name
required

人员别名

string

organizations
optional

所属组织列表(从root开始按顺序)

< object > array

showName
required

人员名称

string

3.41. PropCurrentReq

Type : object

3.42. PropHistoryReq

Name Description Schema

fill
optional

fill

groupBy
optional

groupBy

limit
optional

返回的元素数目

integer

offset
optional

偏移量

integer

select
optional

< string > array

where
optional

where

fill

Name Description Schema

strategy
optional

补全策略,例previous

string

groupBy

Name Description Schema

time
optional

例1s,1s 前一个为分组周期,后一个为分组偏移量

string

where

Name Schema

and
optional

and

and

Name Schema

timestamp
optional

timestamp

timestamp

Name Description Schema

ge
optional

例:2017-07-21T17:32:28Z,必须格式化到秒

string

gt
optional

例:2017-07-21T17:32:28Z

string

le
optional

例:2017-07-21T17:32:28Z

string

lt
optional

例:2017-07-21T17:32:28Z

string

3.43. PropHistoryResp

Name Schema

results
optional

< results > array

results

Name Schema

datas
optional

< < object > array > array

fields
optional

< string > array

3.44. Property

对象属性完整结构

Polymorphism : Composition

Name Description Schema

bindingInfo
optional

Binding

code
optional

string

commonTypeValues
optional

commonTypeValues

defaultValue
optional

默认值,可为空{}有值时{"value":"abc"}{"value":123}

object

description
optional

元数据对象的描述信息

string

logged
optional

Default : false

boolean

modelLabels
optional

< SimpleModelLabel > array

name
required

元数据对象的名称

string

override
optional

Default : false

boolean

persisted
optional

Default : false

boolean

primitiveType
required

数据类型

string

range
optional

范围

string

readonly
optional

Default : false

boolean

showName
optional

string

structType
optional

0:基础类型 1:List

integer

commonTypeValues

Name Schema

fields
optional

< FieldTypeAnonymity > array

3.45. QueryUser

查询用户的相关信息

Polymorphism : Composition

Name Description Schema

email
optional

邮箱

string

person
optional

BaseInfo

phone
optional

手机

string

roles
optional

用户所属角色

< RoleInfo > array

timeZone
optional

时区

string

uploadUrl
optional

头像路径

string

userDesc
optional

用户描述

string

username
optional

用户名

string

3.46. ResponseSuccess

如果成功返回,即可在返回包中获取到Access Token

Name Description Schema

accessToken
optional

授权令牌,accessToken。

string

expiresIn
optional

该access token的有效期,单位为秒。

string

refreshToken
optional

在授权自动续期步骤中,获取新的accessToken时需要提供的参数。

string

3.47. Role

Name Description Schema

description
optional

角色描述

string

name
optional

角色名

string

showName
optional

显示名称

string

3.48. RoleInfo

Polymorphism : Composition

Name Description Schema

createTime
optional

创建时间

string

createUsername
optional

创建人

string

description
optional

角色描述

string

modifyTime
optional

修改时间

string

modifyUsername
optional

修改人

string

name
optional

角色名

string

showName
optional

显示名称

string

3.49. Service

Name Description Schema

description
optional

用户定义的服务的描述

string

inputs
optional

< ServiceInputField > array

modelLabels
optional

< SimpleModelLabel > array

name
optional

服务名称

string

output
optional

OutputParameter

override
optional

Default : false

boolean

script
optional

script代码

string

3.50. ServiceInputField

服务输入输出字段,用于对象服务和对象模板服务

Polymorphism : Composition

Name Description Schema

defaultValue
optional

字段默认值

object

description
optional

元数据对象的描述信息

string

hasDefault
optional

字段是否有默认值

boolean

name
required

元数据对象的名称

string

primitiveType
optional

类型名称

string

primitiveTypeDefinition
optional

类型定义,包含该类型的额外约束条件和是否支持默认值

primitiveTypeDefinition

reqired
optional

是否必须

boolean

structType
optional

0:基础类型 1:List

integer

3.51. SimpleModelLabel

元数据标签,用于对元数据进行分类和筛选 通过/modelLabel 接口进行插入

Type : string

3.52. SimplePropName

单个的对象实例属性

Type : string

3.53. Subscription

订阅完整数据

Polymorphism : Composition

Name Description Schema

description
optional

元数据对象的描述信息

string

enabled
optional

是否启用
Default : false

boolean

event
optional

事件名

string

name
optional

订阅名

string

script
optional

订阅脚本

string

source
optional

对象名

string

3.54. SubscriptionMetadata

订阅元数据(不包括script)

Polymorphism : Composition

Name Description Schema

enabled
optional

是否启用
Default : false

boolean

event
optional

事件名

string

name
optional

订阅名

string

source
optional

对象名

string

3.55. TableCommonInfo

Name Description Schema

createTime
optional

创建时间

string

createUsername
optional

创建人

string

modifyTime
optional

修改时间

string

modifyUsername
optional

修改人

string

3.56. UpdatePersonInfo

修改人员信息

Polymorphism : Composition

Name Description Schema

gender
required

性别(male男,female女)

string

showName
required

人员名称

string

3.57. Updated

后台已成功接受命令,并处理成功

Name Description Schema

Location
optional

所访问资源的URL

string

3.58. UserBaseInfo

Name Description Schema

email
optional

邮箱

string

phone
optional

手机

string

timeZone
optional

时区

string

userDesc
optional

用户描述

string

username
optional

用户名

string

3.59. primitiveTypeDefinition

数据类型的详细定义

Polymorphism : Composition

Name Description Schema

description
optional

元数据对象的描述信息

string

hasDefault
optional

Default : false

boolean

name
required

元数据对象的名称

string

property
optional

property

property

Name Description Schema

aspect
optional

额外约束详情,例如,interger 类型的最大值最小值

object